移動先

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

Essbaseスクリプト権限の取得

get

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

指定されたスクリプトの権限を取得します。計算スクリプトの場合のみ適用可能です。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

• scriptName(required): string

  スクリプト名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

スクリプト権限を正常に取得しました。

本体()

ルート・スキーマ : schema

型: array

ソースの表示

• 配列: object result

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

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

型: object

ソースの表示

• count: integer(int64)
• hasMore: boolean
• items: array items
• limit: integer(int64)
• offset: integer(int64)
• properties: object properties
  使用可能なその他のプロパティ: additionalProperties
• totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserGroupProvisionInfo"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "xml":{
        "name":"result"
    }
}

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

型: array

ソースの表示

• 配列: object permission

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

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

型: object

使用可能なその他のプロパティ

ソースの表示

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"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"
        }
    }
}

400 レスポンス

不正なリクエスト

スクリプトの権限の取得に失敗しました。アプリケーション名、データベース名またはスクリプト名が正しくない可能性があります。

500 レスポンス

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

先頭に戻る

例

次の例では、Essbase REST APIを使用して、計算スクリプトに関連付けられたユーザーまたはグループ権限を取得する方法を示します。

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

計算スクリプトの権限の取得

call properties.bat
curl -X GET https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/scripts/actuals/permissions -H "accept: application/json" -u %User%:%Password%

レスポンス本体の例

{
  "items" : [ {
    "id" : "user1"
  } ]
}

先頭に戻る