REST is usually an HTTP-based protocol. This section describes how your projects' URLs are constructed.
A typical REST URL for looks like this:
The leading portion of the URL locates the server. If you have an evaluation account, your URL will be something like:
If you have a developer or production account, you would use something like:
Depending on your project options, you may or may not be required to
The account/project portion is the name of your API Server account and your project URL. These are created when you signup for the CA Live API Creator service, and when you create a project. Project names must be unique within your account.
The last (darkest) portion of the URL reflects the request you are coding. The first part is the name of the API version you are targeting. Your code might create a prefix for the service/project portion to be pre-pended to the request. Avoid hard-coding the API Version into the URL, to facilitate controlled migration over revisions.
The second part is the actual request. This is your Resource Name, followed by parameters (the primary key, filters, ordering etc). Recall your Resource Name is either a Base Table, or a defined Resource. Resource Names can be specified with dot notation to access contained resources (e.g,
For example, to read Order #1 in the project logicdemo, using API version "v1":
For documentation purposes, we will often shorten this to: