移動先

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

計算スクリプトの名前変更

post

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/scripts/scriptops/rename

指定されたアプリケーションおよびデータベース内のスクリプトの名前を変更し、作成したスクリプトを返します。計算スクリプトの場合のみ適用可能です。

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

本体()

スクリプトの名前変更の詳細。

ルート・スキーマ : ScriptCopy

型: object

ソースの表示

• from(required): string

  スクリプトの元の名前。

• to(required): string

  スクリプトの新しい名前。

{
    "type":"object",
    "required":[
        "from",
        "to"
    ],
    "properties":{
        "from":{
            "type":"string",
            "description":"<p>Script's original name.</p>"
        },
        "to":{
            "type":"string",
            "description":"<p>Script's new name.</p>"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

スクリプトが正常に名前変更されました。スクリプト詳細、スクリプトを取得、編集または削除するためのリンク、その内容を取得するためのリンクが含まれます。

本体()

ルート・スキーマ : Script

型: object

ソースの表示

• content: string

  スクリプトの内容。

• links: array links
• locked: boolean
• lockedBy: string
• lockedTime: integer(int64)
• modifiedTime: integer(int64)
• name: string

  スクリプト名。

• sizeInBytes: integer(int64)

{
    "type":"object",
    "properties":{
        "content":{
            "type":"string",
            "description":"<p>Script contents.</p>"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "lockedTime":{
            "type":"integer",
            "format":"int64"
        },
        "locked":{
            "type":"boolean"
        },
        "modifiedTime":{
            "type":"integer",
            "format":"int64"
        },
        "sizeInBytes":{
            "type":"integer",
            "format":"int64"
        },
        "lockedBy":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"<p>Script name.</p>"
        }
    }
}

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

不正なリクエスト

スクリプトの名前変更に失敗しました。アプリケーション名、データベース名またはスクリプト名が正しくないか、指定したスクリプト名がすでに存在する可能性があります。

415 レスポンス

受入れできません

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

500 レスポンス

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

先頭に戻る

例

次の例では、REST APIを使用してEssbase計算スクリプトの名前を変更する方法を示します。

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

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

call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/scripts/scriptops/rename?links=none" -H "accept: application/json" -H "Content-Type:application/json" -d '{"from": "calc1", "to": "calc_measures"}' -u %User%:%Password%

レスポンス本体の例

{
  "name" : "calc_measures",
  "modifiedTime" : 1721321442534,
  "sizeInBytes" : 38
}

先頭に戻る