移動先

• リクエスト
• レスポンス
• 例

計算スクリプト権限の追加

post

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/permissions

指定されたユーザーまたはグループの権限を、指定されたスクリプトに追加します。計算スクリプトの場合のみ適用可能です。

リクエスト

サポートされているメディア・タイプ

• application/json
• application/xml

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

• scriptName(required): string

  スクリプト名。

本体()

ユーザーまたはグループの詳細。

ルート・スキーマ : permission

型: object

ソースの表示

• group: boolean

  trueまたはfalse。idがグループを参照するかどうか。

• id: string

  ユーザーIDまたはグループID

• links: array links
• name: string

  ユーザー名またはグループ名。

• role: string

  ユーザーまたはグループの役割。

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string",
            "description":"<p>User or group ID.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>User or group name.</p>"
        },
        "role":{
            "type":"string",
            "description":"<p>User or group role.</p>"
        },
        "group":{
            "type":"boolean",
            "description":"<p><b>true</b> or <b>false</b>. Whether the <b>id</b> refers to a group.</p>"
        }
    },
    "xml":{
        "name":"permission"
    }
}

ネストされたスキーマ : links

型: array

ソースの表示

• 配列: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : Link

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json
• application/xml

200 レスポンス

OK

スクリプト権限が正常に追加されました。

本体()

ルート・スキーマ : permission

型: object

ソースの表示

• group: boolean

  trueまたはfalse。idがグループを参照するかどうか。

• id: string

  ユーザーIDまたはグループID

• links: array links
• name: string

  ユーザー名またはグループ名。

• role: string

  ユーザーまたはグループの役割。

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string",
            "description":"<p>User or group ID.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>User or group name.</p>"
        },
        "role":{
            "type":"string",
            "description":"<p>User or group role.</p>"
        },
        "group":{
            "type":"boolean",
            "description":"<p><b>true</b> or <b>false</b>. Whether the <b>id</b> refers to a group.</p>"
        }
    },
    "xml":{
        "name":"permission"
    }
}

ネストされたスキーマ : links

型: array

ソースの表示

• 配列: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : Link

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 レスポンス

不正なリクエスト

スクリプトの権限の追加に失敗しました。アプリケーション名、データベース名またはスクリプト名が正しくないか、ユーザーIDまたはグループIDが正しくないか、指定したユーザーまたはグループに十分な権限がない可能性があります。

415 レスポンス

受入れできません

メディア・タイプがサポートされていないか指定されていません。

500 レスポンス

サーバーの内部エラーです。

先頭に戻る

例

次の例では、Essbase REST APIを使用して、計算スクリプトを実行するユーザーまたはグループ権限を付与する方法を示します。ユーザーまたはグループは、少なくともアプリケーションのデータベース更新権限をプロビジョニングする必要があります。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

cURLコマンドを含むスクリプト

次の例では、Sample Basicキューブに対してactualsという名前の計算スクリプトを実行するuser1権限を付与します。

call properties.bat
curl -X POST https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/scripts/actuals/permissions -H "accept: application/json"  -H "Content-Type:application/json" -d '{"id": "user1"}' -u %User%:%Password%

レスポンス本体の例

{
  "id" : "user1"
}

先頭に戻る