このページを共有

# フィールドメタデータリファレンス

ALM OctaneパブリックREST APIは、完全にメタデータ駆動型です。メタデータリソースによって記述されたすべてのエンティティは、リソースコレクションとしてREST APIを介してアクセスできます。

フィールドメタデータAPIは、エンティティで使用可能なフィールドを定義します。フィールドごとに、フィールドのタイプ、フィールドの値が監査されるかどうか、フィールドの検証などのプロパティとフィーチャーがあります。

このトピックの内容:

## URI

ワークスペースレベル | `http[s]://<server>:<port>/api/shared_spaces/<space_id>/workspaces/<workspace_id>/metadata/fields`
共有スペースレベル | `http[s]://<server>:<port>/api/shared_spaces/<space_id>/metadata/fields`
サイトレベル | `http[s]://<server>:<port>/admin/metadata/fields`

URIでパラメーターを指定するための構文については、変数と値を参照してください。

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

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

になる:

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

## URIを使用したフィールドメタデータのフィルタリング

フィールドメタデータをフィルタリングするときに、すべての属性でフィルタリングできます。

エンティティの通常のフィルタリングとは異なり、メタデータをフィルタリングする場合:

- クエリ句のみがサポートされています。limit、offset、total_count、またはorder_by句は使用できません。

- Or演算子 (||) は、クエリステートメントのクエリフェーズ間ではサポートされていません。And演算子 (;) のみがサポートされています。

- entity_nameは、クエリステートメント内の他のクエリフレーズのコンテキストを設定します。

例

- 不具合のみに関連するフィールドを一覧表示するには:

  `http[s]://<server>:<port>/api/shared_spaces/<space_id>/workspaces/<workspace_id>/metadata/fields?query="entity_name EQ 'defect'"`

- 手動テストに必要なフィールドを一覧表示するには:

  `http://<server>:<port>/api/shared_spaces/<space_id>/workspaces/<workspace_id>/metadata/fields?query="entity_name EQ 'test_manual' ; required EQ true"`

- creation_timeプロパティを持つ不具合フィールドを一覧表示するには:

  `http[s]://<server>:<port>/api/shared_spaces/<space_id>/workspaces/<workspace_id>/metadata/fields?query="entity_name EQ 'defect'; "name EQ 'creation_time'"`

- ユーザー定義フィールドのみを一覧表示するには、is_user_defined属性を使用してフィールドメタデータをクエリします。

  `http[s]://<server>:<port>/api/shared_spaces/<space_id>/workspaces/<workspace_id>/metadata/fields?query="is_user_defined EQ true"`

## サポートされているHTTPメソッド

このAPIはGET操作のみをサポートします。

トップに戻る

## プロパティ

以下は、RESTAPIの各フィールドを説明するプロパティです。

注: 各関係は、関係に関係する両方のエンティティの参照フィールドとして表されます。

フィールド | プロパティ
--- | ---
Access level | フィールドにアクセスできるかどうか (PUBLIC、PUBLIC_TECH_PREVIEWなど)。 フィールド名: access_level
Accessible by rules | ルールがこのフィールドにアクセスできるかどうか。 フィールド名: accessible_via_business_rules 値: Boolean
Auto-generated | フィールドがALM Octaneによって自動的に生成されるかどうか。 フィールド名: auto_generated 値: Boolean
Description | フィールドの説明。 フィールド名:description
Entity name | フィールドが属するエンティティ。 フィールド名:entity_name
Features | このフィールドでサポートされているフィーチャーのセット (次のようなもの)。 non-auditable。標準設定では、フィールドの監査がサポートされています。このフィーチャーがリストされている場合、フィールドは監査のために追跡されません。このフィーチャーは次のようにリストされています。"name": "non-auditable". graphable. このフィールドはグラフで使用できます。このフィーチャーは次のようにリストされています。"name": "graphable".
Field type | フィールドの期待値のタイプ。 フィールド名:field_type 使用可能なフィールドタイプについては、フィールドタイプを参照してください。
Filterable | フィールドをフィルタリングできるかどうか。 フィールド名:filterable 値: Boolean
Groupable | このフィールドでグループ化できるかどうか。 フィールド名:groupable 値: Boolean
Label | UIに表示される可能性のあるフィールドのラベル。 Label フィールド名:label
Name | API表現に表示されるフィールドの名前。 フィールド名:name
Returned by default | フィールド選択がない場合にフィールドが標準設定で返されるかどうか。 フィールド名:returned_by_default
Selectable | フィールドをクエリで使用できるかどうか。 一部のフィールドは、返される結果が多すぎる場合、意図的に選択できません。 たとえば、重大度によって不具合を照会できます。ただし、重大度と関連するすべての不具合を照会すると、返される結果が多すぎる可能性があります。 フィールド名:selectable 値: Boolean
Sortable | このフィールドに従ってエンティティを並べ替えることができるかどうか。 フィールド名:sortable 値: Boolean
Supports permissions | フィールドが権限によって制御されているかどうか。 フィールド名:supports_permissions 値: Boolean
User-defined | フィールドがシステム定義かユーザー定義か。 フィールド名:is_user_defined 値: Boolean
Visible | フィールドがALM Octaneユーザーインターフェイスに表示されるかどうか。 フィールド名:visible_in_ui 値: Boolean

トップに戻る

## フィールドタイプ

タイプ | 説明
--- | ---
Boolean | ブール値を含むフィールド。 値:true /false
    “field_type”: “boolean”
DateTime | 「日付のみ」を意味する完全な日付と時刻の情報を含むフィールドはサポートされていません。 予想される日付形式は次のとおりです。ISO-8601、例: 2018-06-10T10:13:15Z 2018-03-12T16:42:11%2B01:00 (エンコードされた2018-03-12T16:42:11 + 01:00 2018-03-12T16:42:11-01:00 日付と時刻はUTCです。 作成、更新、フィルタリングの目的で、APIコンシューマーはUTCおよびISO-8601形式を使用する必要があります。
    “field_type”: “date_time”
Integer | 整数値を含むフィールド。 このタイプの値は、-9007199254740991から+9007199254740991の範囲になります。
    “field_type”: “integer”
注: すべてのIDフィールドは文字列であり、整数ではありません。
Memo | テキスト値を含むフィールド。 通常はHTMLで表されます
    “field_type”: “memo”
Object | 任意の構造を持つフィールド。 JSONドキュメントで定義されているように、JSONオブジェクトとして表されます。
    “field_type”: “object”
- Reference | エンティティコレクションを参照するフィールド。 値はリンクとして設定されます。リンクは、次のものを含むオブジェクトです。 エンティティタイプ エンティティID Example:
      {
           "id": 1001,
           "type": "defect"
      }
- フィールドfield_typeには、フィールドのタイプが含まれています。参照フィールドの場合: “field_type”: “reference” フィールドfield_type_dataには、参照されるタイプに関する情報が含まれています。 複数フィールドがtrueに設定されている場合、複数の参照を表すことができます。複数フィールドがtrueに設定されている場合、値は次の形式で期待されます。
      {
          “total_count”: 2,
          “data”: [
              {
                  “id”: 1001,
                  “type”: “release”
              },
              {
                  “id”: 1002,
                  “type”: “release”
              }
          ]
      }
- 注: POSTおよびPUTリクエストの場合、total_countプロパティは省略できます。 リストノード (list_nodeエンティティ) エンティティは特別なエンティティであり、リストノードへの参照フィールドは他のエンティティとは異なります。 参照フィールドは、複数のエンティティタイプを参照できます。 list_nodeエンティティを除く、単一のエンティティタイプへの参照を表す
      "field_type": "reference",
      "field_type_data": {
          "targets": [
              {
                  "type": "release"
              }
          ],
          "multiple": false
  list_nodeエンティティの参照を表す
      "field_type": "reference",
      "field_type_data": {
          "targets": [
              {
                  "type": "list_node",
                  "logical_name": "list_node.severity"
              }
          ],
          "multiple": false
      }
  list_nodeエンティティを除く、複数のエンティティタイプへの参照の表現
      "field_type": "reference",
      "field_type_data": {
          "targets": [
              {
                  "type": "defect"
              },
              {
                  "type": "story"
              }
          ],
          "multiple": false
      }
リストノードの参照 例: list_nodeエンティティへの参照
    "field_type": "reference",
    "field_type_data": {
        "targets": [
            {
                "type": "list_node",
                "logical_name": "list_node.severity"
            }
        ],
        "multiple": false
    }
String | 文字列値を含むフィールド。 値の長さは、max_length入力検証プロパティによって決定されます。
    “field_type”: “string”
注: すべてのIDフィールドは文字列であり、整数ではありません。

トップに戻る

## データ検証

データ検証では、入力と出力を検証できます。

これは、入力がサーバーに送信される前にコンシューマーが入力を検証し、特定の出力がサーバーから返されることを期待する方法を提供します。

入力と出力の両方を検証できます。

注:

一部の検証はコンテキストによって異なります。

このような場合、ステータスコードとエラーメッセージが返されます。

入力

サーバーに送信された値は検証できます。

一部の検証はオプションです。

一部の検証は、特定のデータ型に対してのみ許可されます。

データ型による入力検証
入力検証 | Integer | Boolean | Date / DateTime | String | Memo | Reference
--- | --- | --- | --- | --- | --- | ---
Final |  |  |  |  |  |
Maximum Length |  |  |  | 必須 |  |
Maximum Value | 必須 |  |  |  |  |
Minimum Value | 必須 |  |  |  |  |
Not Null |  |  |  |  |  |
Read Only |  |  |  |  |  |
Unique |  |  |  |  |  |

入力データ型
データ型 | 説明 | フィールド名 | 値 | 例
--- | --- | --- | --- | ---
Editable | フィールドが読み取り専用かどうかを判別します。 | editable | Boolean | `"editable": true`
Final | エンティティの作成時にのみ、値をフィールドに指定できます。その後、フィールドは読み取り専用になります。これは、フィールドに値を入力しようとすると、400 (Bad Request) エラーが発生することを意味します。 | final | Boolean | `“final”: true`
Maximum Length | 文字列フィールドの最大長を強制します。 | max_length | Integer, >0 | `“max_length”: 70`
Maximum Value | 整数フィールドの最大値を強制します。 | max_value | Integer. 最小値の検証以上である必要があります。 | `"max_value": 10000`
Minimum Value | 整数フィールドの最小値を強制します。 | min_value | Integer. 最大値の検証以下である必要があります。 | `"min_value": 1`
Not Null | null値を許可するかどうかを決定します。 | required | Boolean | `“required”: true`
Read Only | フィールドが読み取り専用かどうかを決定します。これは、フィールドに値を入力しようとすると、400 (Bad Request) エラーが発生することを意味します。 | editable | Boolean | `“editable”: true`
Unique | エンティティタイプ全体のレベルで一意性を適用します。 | unique | Boolean | `“unique”: true`

出力

サーバーから返される値を検証できます。

検証はオプションです。

一部の検証は、特定のデータ型からのみ許可されます。

データ型による出力検証
出力検証 | Integer / Long | Boolean | Date / DateTime | String | Memo | Reference
--- | --- | --- | --- | --- | --- | ---
Sanitization |  |  |  |  |  |

出力データ型
データ型 | 説明 | フィールド名 | 値 | 例
--- | --- | --- | --- | ---
Sanitization | フィールドの出力にサニタイズを適用し、サニタイズのタイプのオプションを提供します。 参照情報: Sanitization | sanitization | 列挙型を表す文字列値: {text, html} | `“sanitization”: “html`

トップに戻る

## 例: 実行フィールドオブジェクトのメタデータ

    {

        "name": "description",

        "entity_name": "run",

        "filterable": false,

        "editable": true,

        "returned_by_default": true,

        "label": "Description",

        "sortable": false,

        "required": false,

        "sanitization": "HTML",

        "unique": false,

        "field_type": "memo",

        "max_length": null

    }

トップに戻る

参照情報:

- エンティティメタデータリファレンス
- メタデータの取得
- メタデータの取得例

https://admhelp.microfocus.com ALM Octane 8942
検索結果を改善するためのヒント... ALM Octaneヘルプセンター ALM Octaneヘルプ 15.1.90 すべて ローカルヘルプセンターを表示 オンラインヘルプセンターを表示 戻る ブラウザーの履歴内を戻る 進む ブラウザーの履歴内を進む 検索のハイライトを削除する 次のトピック 次のトピックに進む 前のトピック 前のトピックに戻る 現在のトピックを印刷 バージョン: