---
title: "Best Practice | URL Format"
slug: "best-practice-url-format"
updated: 2024-02-16T20:13:29Z
published: 2024-02-16T20:13:29Z
canonical: "developers.cmicglobal.com/best-practice-url-format"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Best Practice | URL Format

## 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 Part | Description |
| --- | --- |
| Application name | the name of the application in which the API resides. |
| Version | this is the version number of the API being accessed. |
| Resource | the name of the API looking to be accessed. |
| Key Value | this 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.