エントリポイントとそのコンテキスト

ALM Octaneモデルは、REST APIへのエントリポイントでもあるいくつかのコンテキストで動作します。

また、サインインおよびサインアウトするための追加の認証エントリポイントがあります。

エントリポイント

これらのエントリポイントURLを使用して、ALM Octane REST APIを見つけます。

コンテキスト

エントリポイント

サイト

http[s]://<server>:<port>/admin/*

  • データベースサーバーやスペースなどのサイトレベルのエンティティに適用されます。
  • サイト管理者のアクセス許可が適用されます。

スペース

http[s]://<server>:<port>/api/shared_spaces/<space_id>/*

  • ワークスペースやユーザーなど、すべてのワークスペースで共有されるリソースに適用されます。

  • スペースもエンティティとして表されます。それはサイトのコンテキストに存在します: /admin/shared_spaces

  • /api/shared_spacesには、id (文字列) またはlogical_name (文字列) のいずれかでアクセスできます。

  • スペース管理者のアクセス許可が適用されます。たとえば、スペース管理者はワークスペースを作成および削除できます。
共有エリア

 

http[s]://<server>:<port>/api/shared_spaces/<space_id>/shared_area

ここで、 

  • space_idは一意の識別子 /論理文字列です。

  • shared_areaは、共有アセットを含むスペース内の特別な領域を表すsetキーワードです。

  • スペース管理者のアクセス許可が適用されます。

ワークスペース

http [s] ://<server>:<port>/api/shared_spaces/<space_id>/works/<workspace_id>/*

ここで、 

  • space_idは一意の識別子 /論理文字列です。

  • workspace_idは一意の識別子 /論理文字列です。

  • ワークスペースはエンティティ (リソース) であり、共有スペースコンテキストに配置されます。ワークスペースは、モデルの指示どおりに、ワークスペースコンテキストのエントリポイントから見ることができます。

  • ワークスペースレベルのアクセス許可が適用されます。

このドキュメント全体を通して、サンプルURIは省略されており、サーバーとポートのコンテキストは含まれていません。

http://<server>:<port>/api/shared_spaces/<space_id>/workspaces/<workspace_id>/<entities>

になる:

.../api/shared_spaces/<space_id>/workspaces/<workspace_id>/<entities>

トップに戻る

認証エントリポイント

sign_inRESTシングルトンリソースを使用すると、JSON認証を使用してRESTAPIに認証およびサインインできます。

基本認証を使用して、リクエストごとにユーザー資格情報を含むヘッダーを送信してサインインすることもできます。

詳細については、認証を参照してください。

トップに戻る

非認証エントリポイント

URLをコピーしたり、エンティティへのリンクを含む電子メールを送信したりする場合など、まだ認証されていない場合、REST APIがエンティティのURLに移動する可能性があります。認証のプロンプトが表示された後、エンティティの詳細にリダイレクトされます。

次のようにentity-navigationを指定します。 

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

認証後、これは次の場所にリダイレクトされます。 

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

トップに戻る

参照情報: