リストの操作

REST APIを使用して、カスタムリストを追加したり、既存のシステムリストの項目をカスタマイズしたりできます。

概要

リストを操作するには、ALM Octaneで、スペース管理者権限またはワークスペースの管理者として認証されている必要があります。

制限事項: ALM Octaneが特定の言語にローカライズされている場合でも、UDFは英語で定義する必要があります。

リストとリスト値は、名前または論理名でフィルタリングできます。ユーザー定義リストの論理名とリスト値は自動的に生成されます。

トップに戻る

新しいカスタムリストの作成

  1. リストのルートを作成します。 

    POST .../api/shared_spaces/<shared space ID>/workspaces/<workspace ID>/list_nodes
    {"data": 
      [
        {
          "name":"colors"
        }
      ]
    }

    新しく作成されたリストのlogical_nameはルートIDです。たとえば、このPOSTはIDabcd1234を返す場合があります。

  2. IDがabcd1234のリストのリスト項目を作成します。

    POST .../api/shared_spaces/<shared space ID>/workspaces/<workspace ID>/list_nodes
    {"data": 
      [
        {   
          "list_root": {
        "type": "list_node",
        "id": "abcd1234"
      }, 

      "name": "blue"

        }
      ]
    }

トップに戻る

既存のリストに項目を追加する

  1. リストのIDを見つけます。この例では、更新されるリストは、実行ステータスの可能な値を含むリストです。

    GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/list_nodes?query="logical_name EQ ^list_node.run_status^"
    または: 
    GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/list_nodes?query="name EQ ^run_status^"

  2. リストのルートノードのIDが応答で返されます。この値は、list_root idプロパティのリクエストの本文で使用します (手順3)。

  3. 新しい項目をリストに追加します。

    POST .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/list_nodes
    {"data": 
      [
          {  "type": "list_node",
             "list_root" : {
                 "type": "list_node", 
                 "id":<list root ID>},
                 "name":"new item value"  
           }
      ]
    }

トップに戻る

既存のリストから項目を削除する

リストから項目を削除するには、次のことができます。 

  • リスト項目を一時的に無効にします。

  • リスト項目を非推奨にします。

リスト項目のアクティビティレベルを更新することにより、リスト項目を非アクティブ化、非推奨、またはアクティブ化します。

活動レベル 説明
0 アクティブ。
1 非推奨。
2 <内部使用。使用しないでください。>
3 非活性。

例: 項目の非アクティブ化

PUT .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/list_nodes/<list_item_logical_name>?fields=id,name,activity_level
{
"activity_level": 3
}

例: 項目のアクティブ化

PUT .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/list_nodes/<list_item_logical_name>?fields=id,name,activity_level
{
"activity_level": 0
}

トップに戻る

リストの名前を変更する

カスタムリストの名前のみを変更できます。

PUT .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/list_nodes?query="logical_name EQ ^abcd1234^"

または: 

PUT .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/list_nodes?query="name EQ ^colors^"
{"data": 
  [
       { 
         "name":"NEW LIST_NAME"
       }
  ]
}

トップに戻る

参照情報: