機械翻訳について

ジャンプ先

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

エクスポートの開始

post

<servername>/fscmUI/applcoreApi/v2/csm/export

CSMアーカイブ・エクスポート・プロセスを開始します。

リクエスト

この操作のリクエスト・パラメータはありません。

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ : schema

タイプ: object

Show Source

• description(required): string
  エクスポートする構成セットの説明。
• isFullExport: string
  許可された値: [ "Y", "N" ]

  フラグをYに設定すると、デルタ移行ではなく完全移行が強制されます。
• name(required): string
  エクスポートする構成セットの名前。
• optionalModules: array optionalModules
  エクスポートされた構成セットに含めるオプション・モジュールのリスト。
• options: object ExportOption
  オプションの(文字列、ブール型)マップ。 `SKIP_TARGET_CHECK`はキーの例です。

{
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the configuration set to be exported."
        },
        "description":{
            "type":"string",
            "description":"Description of the configuration set to be exported."
        },
        "isFullExport":{
            "type":"string",
            "description":"Setting the flag to 'Y' will force a full migration instead of delta migration.",
            "enum":[
                "Y",
                "N"
            ]
        },
        "optionalModules":{
            "type":"array",
            "description":"List of optional modules to be included in the exported configuration set.",
            "items":{
                "type":"string"
            }
        },
        "options":{
            "$ref":"#/components/schemas/ExportOption"
        }
    }
}

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

タイプ: array

エクスポートされた構成セットに含めるオプション・モジュールのリスト。

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of optional modules to be included in the exported configuration set.",
    "items":{
        "type":"string"
    }
}

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

タイプ: object

オプションの(文字列、ブール型)マップ。 `SKIP_TARGET_CHECK`はキーの例です。

Show Source

• SKIP_TARGET_CHECK: boolean
  フラグを`true`に設定すると、ソース環境と登録済ターゲット環境のリリース・バージョンの比較がスキップされます。

{
    "type":"object",
    "properties":{
        "SKIP_TARGET_CHECK":{
            "type":"boolean",
            "description":"Setting the flag to `true` will skip release version comparison between source and registered target environment."
        }
    },
    "description":"A (string, boolean) map of options. `SKIP_TARGET_CHECK` is an example key."
}

トップに戻る

レスポンス

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

• application/json

200 レスポンス

操作はすでに進行中です。

本文 ()

ルート・スキーマ : StandardResponse

タイプ: object

Show Source

• csId: string
  作成された構成セットの識別子。
• csmSandboxId: string
  `インポート`操作の一部としてターゲット環境で作成されたCSMサンドボックスの識別子。
• detailedLog: string
  現在の操作の詳細なログ。
• message: string
  現在の動作状態の説明。
• status: string
  現在の操作ステータスの短いステータス・コード。
• targetPushStatus: string
  ターゲット環境にアップロードされている構成セット・アーカイブのステータス。
• userDetails: string
  ユーザーがアクションを実行するための指示またはヒント。

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Short status code of the current operational status."
        },
        "message":{
            "type":"string",
            "description":"Description of the current operational state."
        },
        "csId":{
            "type":"string",
            "description":"The identifier of created Configuration Set."
        },
        "userDetails":{
            "type":"string",
            "description":"Instructions or hint for user to action upon."
        },
        "detailedLog":{
            "type":"string",
            "description":"Detailed log of current operation."
        },
        "targetPushStatus":{
            "type":"string",
            "description":"Status of the configuration set archive being uploaded to target environment."
        },
        "csmSandboxId":{
            "type":"string",
            "description":"The identifier of the CSM Sandbox created on target environment as part of `Import` operation."
        }
    }
}

201 レスポンス

操作を開始しました。

本文 ()

ルート・スキーマ : StandardResponse

タイプ: object

Show Source

• csId: string
  作成された構成セットの識別子。
• csmSandboxId: string
  `インポート`操作の一部としてターゲット環境で作成されたCSMサンドボックスの識別子。
• detailedLog: string
  現在の操作の詳細なログ。
• message: string
  現在の動作状態の説明。
• status: string
  現在の操作ステータスの短いステータス・コード。
• targetPushStatus: string
  ターゲット環境にアップロードされている構成セット・アーカイブのステータス。
• userDetails: string
  ユーザーがアクションを実行するための指示またはヒント。

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Short status code of the current operational status."
        },
        "message":{
            "type":"string",
            "description":"Description of the current operational state."
        },
        "csId":{
            "type":"string",
            "description":"The identifier of created Configuration Set."
        },
        "userDetails":{
            "type":"string",
            "description":"Instructions or hint for user to action upon."
        },
        "detailedLog":{
            "type":"string",
            "description":"Detailed log of current operation."
        },
        "targetPushStatus":{
            "type":"string",
            "description":"Status of the configuration set archive being uploaded to target environment."
        },
        "csmSandboxId":{
            "type":"string",
            "description":"The identifier of the CSM Sandbox created on target environment as part of `Import` operation."
        }
    }
}

400 レスポンス

操作を開始できませんでした。

本文 ()

ルート・スキーマ : ErrorResponse

タイプ: object

Show Source

• message: string
  エラーの説明。
• status: string
  エラーの短いステータス・コード。
• userDetails: string
  ユーザーがアクションを実行するための指示またはヒント。

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Short status code of the error."
        },
        "message":{
            "type":"string",
            "description":"Description of the error."
        },
        "userDetails":{
            "type":"string",
            "description":"Instructions or hint for user to action upon."
        }
    }
}

「トップに戻る」