Entry points and contexts

The ALM Octane model operates on several contexts, which are also the entry points into the REST API.

Also, there are additional authentication entry points for signing in and signing out.

Entry points

Use these entry point URLs to find the ALM Octane REST API.

Context

Entry point

Site

http[s]://{server}:{port}/admin/*

  • Applies to site level entities, such as database servers, shared spaces, and so on.
  • Permissions of the site admin are enforced.

Shared Space

http[s]://{server}:{port}/api/shared_spaces/{uid}/*

  • Applies to resources that are shared for all workspaces, such as list items, permissions, rules, and so on.

  • The shared space is also represented as an entity. It exists in the site context: /admin/shared_spaces

  • /api/shared_spaces can be accessed either by id (numeric) or by uid = logical_name (string).

  • Permissions of the shared space administrator are enforced.

Work space

http[s]://{server}:{port}/api/shared_spaces/{uid}/workspaces/{id}/*

Where: 

  • uid is a unique identifier / logical string.

  • id is a numeric value.

  • A workspace is an entity (resource) and is located in a shared space context. A workspace can be seen from the workspace context entry point, exactly as the model dictates.

  • Permissions on the workspace level are enforced.

Note: Throughout this document, the example URIs are abbreviated, without the server and port context.

https://{server}:{port}/api/shared_spaces/{uid}/workspaces/{id}/<entity_collection>

Becomes:

.../api/shared_spaces/{uid}/workspaces/{id}/<entity_collection>

Back to top

Authentication entry points

The following REST singleton resources enable you to authenticate, sign in, and sign out of the REST API.

Tip: It is possible for your REST API to navigate to an entity URL when not yet authenticated, such as when copying a URL or sending an email with a link to an entity. After prompting for authentication, you are redirected to the details of the entity.

Specify entity-navigation as follows: 

http[s]://<hostname>/ui/entity-navigation?p=<shared_space_id>/<workspace_id>&entityType=work_item&id=<id>

After authentication, this redirects to: 

http[s]://<hostname>/ui/?p=<shared_space_id>/<workspace_id>#/entity-navigation?entityType=work_item&id=<id>

Back to top

See also: