Share this page
Resource URL structure
Every resource in the OpenText Core Software Delivery Platform REST API is addressed by a URL. The URL identifies both the context that the data belongs to and the collection you want to work with.
Contexts
Data is organized in a hierarchy.
-
Workspace. The collection lives within a specific workspace, inside a specific shared space. Most business entities, such as defects and releases, are workspace-level.
-
Shared space. The collection lives within a specific shared space and applies across its workspaces.
URL patterns
The context is expressed by the path that precedes the collection name.
Workspace context. Include both the shared space ID and the workspace ID:
/api/shared_spaces/{shared_space_id}/workspaces/{workspace_id}/{collection}
For example, to address the defects of a workspace:
/api/shared_spaces/1001/workspaces/1002/defects
Shared space context. Include only the shared space ID:
/api/shared_spaces/{shared_space_id}/{collection}
To address a single entity within a collection, append its ID to the collection URL:
/api/shared_spaces/1001/workspaces/1002/defects/4001
The api area
Public resources are served under the api area, shown in the patterns above.
Addressing by logical name
Some entities can be addressed by a stable logical name instead of a numeric ID. A logical name does not change when data is copied between environments, which makes it useful for integrations that must refer to the same entity across sites. Where an entity supports it, use the logical name in place of the ID in the URL.
Shared data across workspaces
Certain data is defined once and shared across the workspaces of a shared space. Such data is addressed through a shared area rather than an individual workspace: the workspace segment of the URL is replaced by a shared-area segment, so that the same definition is returned regardless of the calling workspace.
Case sensitivity
URLs follow the rules of RFC 3986. The scheme and host are case-insensitive, but the path and query string are case-sensitive. In particular, collection names and parameter names are lowercase snake_case, and a field named id is not the same as a field named ID.
