Best Practice | URL Format
  • 16 Feb 2024
  • 1 Minute to read
  • Dark
    Light

Best Practice | URL Format

  • Dark
    Light

Article summary

CMiC JSON API url formatting

The url format for the actions list above are as follows. Please note the url terms definitions

https://hostname.com/hostdomain/[applicationname]/rest/[version]/[resource]

URL PartDescription
Application namethe name of the application in which the API resides.
Versionthis is the version number of the API being accessed.
Resourcethe name of the API looking to be accessed.
Key Valuethis is the unique identifier of the record. Please see API documentation for specific values recommended per API.

GET and POST

https://hostname.com/hostdomain/[applicationname]/rest/[version]/[resource]

PATCH

https://hostname.com/hostdomain/[applicationname]/rest/[version]/[resource]/[keyvalue]

For more information on url formatting and parameters that can be used for best results, please see the URL Attributes documentation.