リソース

リソースはURIによって識別されます。

概要

リソースはURIによって識別され、次のいずれかになります。

リソースタイプには、厳密なリクエストメソッドのセットが許可されています。リソースはJSON表現タイプをサポートします。

ヒント: サポートされているパブリックリソースとその詳細の包括的なリストについては、インタラクティブAPIクライアントの説明を参照してください。

トップに戻る

サポートされている公開リソース

パブリックリソースのREST APIリクエストを送信するときに、追加のヘッダー (content-typeヘッダー以外) を送信する必要はありません。

汎用およびCI/CDリソースのドキュメントについては、インタラクティブAPIクライアントを参照してください。

サポートされている公開リソースは次のとおりです。

メタデータリソース

CI/CDリソース

  • ビルド

  • ci_servers

  • パイプライン

一般的なリソース

  • epics

  • features

  • stories

  • defects

  • phases

  • metaphases (GET only) 

  • transitions

  • tasks

  • releases

  • requirements

  • requirement_documents

  • requirement_folders

  • requirement_roots

  • sprints

  • product_areas
    (also known as application modules)

  • manual_tests

  • gherkin_tests

  • teams

  • team_sprints

  • tests

  • test_suites

  • test_suite_link_to_automated_tests

  • test_suite_link_to_gherkin_tests

  • test_suite_link_to_manual_tests

  • manual_runs

  • suite_run

  • run_steps

  • runs

  • automated_runs

  • previous_runs

  • pipeline_run

  • pipeline_node

  • ci_build

  • scm_commit

  • list_nodes

  • users

  • user_items

  • work_items

  • work_item_roots

  • roles

  • workspaces

  • workspace_roles

  • workspace_users

  • user_tags (GET and POST)

  • taxonomy_category_nodes

  • taxonomy_item_nodes

  • taxonomy_nodes

  • attachments

  • comments

カスタムリソース

トップに戻る

テクニカルプレビューリソース

上記に公開されていないリソースは、公開が宣言されるまで変更される可能性があります。これらのリソースにアクセスするには、ヘッダー付きのREST APIリクエストを送信します。

Header: ALM-OCTANE-TECH-PREVIEW

値:true

テクニカルプレビューリソースの2つの例は、カバレッジとログです。詳細については、ALM Octaneへのカバレッジの追加 (テクニカルプレビュー)およびALM Octaneへのログの追加 (テクニカルプレビュー)を参照してください。

トップに戻る

リソース階層

リソースは、コレクションとインスタンスの階層として構築されます。

一部のリソースは、test-results、sign_in、sign_outなどのシングルトンリソースです。

例: 人間のリソースコレクションから始めます。このコレクションには、人間のリソースインスタンスが含まれています。人間には手足があるので、すべての人間には手足のコレクションが含まれています。このコレクションには、limbのリソースインスタンスが含まれています。手足には指があるため、すべての手足には指のコレクションが含まれています。このコレクションには、fingerのリソースインスタンスが含まれています。

humans
     human
          limbs
               limb
                    fingers
                         finger
                         finger
               limb
                    fingers
                         finger
                         finger
     human
          limbs
...

トップに戻る

リソースの命名規則

  • リソースはエンティティを表すため、リソース名はエンティティの名前を表す必要があります (たとえば、 不具合)。

  • リソースインスタンスは、単数形の名前で呼び出す必要があります (たとえば、 不具合)。

  • リソースコレクションは、名前で複数形で呼び出す必要があります (たとえば、不具合)。

  • 名前が複数の単語であるリソースは、アンダースコア記号で区切られます (たとえば、ci_servers)。

トップに戻る

参照情報: