REST APIを使用した設定パラメーターの設定

このセクションでは、REST APIを使用してALM Octane構成パラメーターを設定するための情報を提供します。

ヒント: 管理者は、ALM Octane設定で構成パラメーターを設定することもできます。

管理者向けのREST APIクイックスタート

管理者は、これらのクイックスタート手順を使用して構成パラメーターを変更できます。このクイックスタートは、通常REST APIを使用しない管理者に役立ちます。

  1. 認証する。

    ユーザー名とパスワードを送信するこのREST APIリクエストをPOSTします。 

    http[s]://<server>:<port>/authentication/sign_in

    次のヘッダーを指定します。 

    認証方法 ヘッダ 値
    すべて Content-Type application/json
    基本

    ALM-OCTANE-TECH-PREVIEW

    		 true

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

  2. REST APIリクエストを送信して、構成パラメーターを設定します。

    スコープと構文

    REST APIを使用して構成パラメーターを設定するには、次の要求形式を使用できます。

    範囲 管理者 リクエストフォーマット
    サイト サイト管理者

    <operation> .../admin/params/...

    サイト管理者はこの形式を使用して、サイト全体に影響する構成パラメーターを取得および設定します。
    スペース サイト管理者

    <operation> .../admin/context_parameters/...

    サイト管理者は、この形式を使用して、特定のスペースのコンテキストで構成パラメーターを設定します。

    スペースレベルで構成パラメーターを設定するためにREST APIリクエストを送信するときは、必ずスペースIDを指定し、ALM-OCTANE-TECH-PREVIEWヘッダーを値trueで送信してください。
    スペース スペース管理者

    <operation> .../api/shared_spaces/<space_id>/params/...

    スペース管理者は、この形式を使用して、特定のスペースのコンテキストで構成パラメーターを設定します。

    スペースレベルで構成パラメーターを設定するためにREST APIリクエストを送信するときは、必ずスペースIDを指定し、ALM-OCTANE-TECH-PREVIEWヘッダーを値trueで送信してください。

    例

    GETリクエスト

    REST APIを使用して既存の構成パラメーターを取得するには、GET要求を送信します。

    GET .../admin/params

    応答を使用して、構成パラメーター値を設定するためにPUTまたはPOST要求を送信するかどうかを判別します。設定する必要のあるパラメーターがリストされていない場合は、POSTリクエストを送信してください。

    {
  "total_count": 310,
  "data": [
    {
      "id": "SERVER_BASE_URL",
      "value": "http://<server>:<port>",
      "modified_by": "SiteAdminUser@TheCompany.com",
      "last_modified": "2017-03-22T20:04:38Z",
      "type": "param"
    },
    ...
    ...
    ...
    {
      "id": "MAIL_SERVER_HOST",
      "value": null,
      "modified_by": null,
      "last_modified": "1970-01-01T00:00:00Z",
      "type": "param"
    },
    ...
    ...
    ...
    }

    PUTリクエスト

    既存の構成パラメーターの値を設定するには、PUT要求を送信します。

    • 構成パラメーターは、サイトレベルおよびスペースレベルで設定できます。

    • 同じPUTリクエストで複数の設定パラメーターを設定できます。

    • ALM Octaneサーバーを再起動した後、構成パラメーターをリセットする必要はありません。

    • パラメーター値は最大1000文字です。

    PUT .../admin/params

    {

       "data": [

            {
            "id": "<site_param_name>",
            "value": <value>
            }

        ]

    }

    スペース管理者がスペースレベルで構成パラメーターを操作している場合:

    • 必ずPUTにスペースIDを指定してください。

    • パラメーターを設定するリクエストで、値がtrueのALM-OCTANE-TECH-PREVIEWヘッダーを送信します。

    PUT .../api/shared_spaces/<space_id>/params/SUPPORTS_BASIC_AUTHENTICATION
{     
"value":"true"
}

    POSTリクエスト

    新しい構成パラメーターの値を設定するには、POSTリクエストを送信します。

    サイト管理者がスペースレベルで構成パラメーターを操作している場合:

    • スペースIDを指定する必要があります。

    • パラメーターを設定するリクエストで、値がtrueのALM-OCTANE-TECH-PREVIEWヘッダーを送信します。

    POST .../admin/context_parameters/

    {
  "data": [
    {
      "name": "<site_param_name>",
      "sharedspace_id": <id>,
      "value": <value>
    }
  ]
}

トップに戻る

構成パラメーターのリファレンス

使用可能な構成パラメーターのリストについては、構成パラメーターを参照してください。

トップに戻る

例

サイト管理者とスペース管理者の両方が基本認証をアクティブ化できます。

サイト管理者による基本認証のアクティブ化

サイト管理者は、構成パラメーターREST APIを使用した設定パラメーターの設定により、特定のスペースの基本認証をアクティブ化できます。

基本認証を有効にするスペースのIDは、sharedspace_idを使用して指定されます。

POST .../admin/context_parameters/

{
  "data": [
    {
      "name": "SUPPORTS_BASIC_AUTHENTICATION",
      "sharedspace_id": 2001,
      "value": "true"
    }
  ]
}

スペース管理者による基本認証のアクティブ化

スペース管理者は、パラメーター REST APIを使用した設定パラメーターの設定、次の構文を使用して、特定のスペースの基本認証をアクティブ化することもできます。

PUT  .../api/shared_spaces/<space_id>/params/SUPPORTS_BASIC_AUTHENTICATION
{
    "value":"true"
}

トップに戻る