移動先

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

グループの追加またはインポート

post

/essbase/rest/v1/groups

1つ以上のグループを追加またはインポートします。

EPM共有サービス・セキュリティ・モードを使用している場合、この操作は実行できません。かわりに、共有サービス・コンソールでユーザー、グループおよび権限を管理します。

リクエスト

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

• application/json
• application/xml

本体()

ヘッダーがContent-Type='application/json'または'application/xml'である場合はグループを追加するグループ詳細、ヘッダーがContent-Type='application/octet-stream'の場合はグループをインポートするCSVファイル。

ルート・スキーマ : GroupBean

型: object

ソースの表示

• description: string
• groups: array groups
• links: array links
• name: string

  グループ名。256文字以内で入力してください。特殊文字; , = + * ? [ ] | < > \ " ' / スペース タブは使用できません。また、ピリオド(.)はグループ名で使用できません。

• role: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "description":{
            "type":"string"
        },
        "groups":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "role":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"<p>The group name. Limit 256 characters. The following special characters are not permitted: <code>; , = + * ? [ ] | < > \\ \" ' / Space Tab</code>. Additionally, a period (<code>.</code>) is not permitted in group names.</p>"
        }
    }
}

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

型: array

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : 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

グループが正常に追加されました。Content-Type='application/json'または'application/xml'の場合は、追加されたグループが返されます。それ以外に、Content-Type='application/octet-stream'の場合は、グループが正常にインポートされました。

本体()

ルート・スキーマ : GroupBean

型: object

ソースの表示

• description: string
• groups: array groups
• links: array links
• name: string

  グループ名。256文字以内で入力してください。特殊文字; , = + * ? [ ] | < > \ " ' / スペース タブは使用できません。また、ピリオド(.)はグループ名で使用できません。

• role: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "description":{
            "type":"string"
        },
        "groups":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "role":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"<p>The group name. Limit 256 characters. The following special characters are not permitted: <code>; , = + * ? [ ] | < > \\ \" ' / Space Tab</code>. Additionally, a period (<code>.</code>) is not permitted in group names.</p>"
        }
    }
}

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

型: array

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : 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グループを追加する方法を示します(WebLogicセキュリティ・モードでのみ機能します)。

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

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

--dataオプションを使用して、グループ情報を提供する本体パラメータのJSONファイルを渡します。

call properties.bat
curl -X POST https://myserver.example.com:9001/essbase/rest/v1/groups -H "accept: application/json" -H "Content-Type: application/json" --data "@./group_create.json" -u %User%:%Password%

サンプルのJSONペイロード

cURLコマンドへの入力ファイルの内容は次のとおりです。

{  
    "name": "ess_power_group", 
    "role": "Power User",
    "description": "Power Group"
}

レスポンス本体の例

{
  "name" : "ess_power_group",
  "description" : "Power Group",
  "role" : "Power User",
  "links" : [ {
    "rel" : "get",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/groups/ess_power_group",
    "method" : "GET"
  }, {
    "rel" : "edit",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/groups/ess_power_group",
    "method" : "PUT"
  }, {
    "rel" : "delete",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/groups/ess_power_group",
    "method" : "DELETE"
  }, {
    "rel" : "provisionReport",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/groups/ess_power_group/provisionReport",
    "method" : "GET"
  } ]
}

先頭に戻る