移動先

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

デプロイメント・プロシージャの取得

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/deploymentProcedures

指定されたフィルタ基準に対するデプロイメント・プロシージャのリストを返します。デフォルトでは、直近に作成された20個のデプロイメント・プロシージャを示します。emcliでは、'get_procedures -procedure='に相当します

リクエスト

問合せパラメータ

• include: string
  include=procedureInputまたはinclude=XmlFormatの場合は、プロシージャ入力またはプロシージャxmlに関する情報がレスポンスに含まれます
• limit: integer
  最小値: 1

  最大値: 2000

  リストのページ分割用。ページ当たりの最大結果数、またはページ分割される"List"コールで返すアイテムの最大数。このAPIでは、limitとして指定した数より多を返すことはありませんが、その数が必ずしも返されるというわけではありません。

  デフォルト値: 20
• name: string
  プロシージャ名を使用してデプロイメント・プロシージャの入力を返します
• owner: string
  所有者名を使用してデプロイメント・プロシージャの入力を返します
• page: string
  ページのシステム生成ページ・トークン。
• parentName: string
  親プロシージャ名を使用してデプロイメント・プロシージャを返します
• sort: string
  ソートされたデプロイメント・プロシージャを返します。指定可能な方向はDESCとASCです
• type: string
  プロシージャ・タイプを使用してデプロイメント・プロシージャを返します

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

プロシージャのリストが正常に返されました

本文()

ルート・スキーマ: DeploymentProcedureCollection

型: object

これは、プロシージャのリストを表すものです。

ソースの表示

• items(必須): array items
  プロシージャのリスト

{
    "description":"This is the representation of list of Procedures.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CountLinks"
        }
    ],
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of Procedures",
            "items":{
                "$ref":"#/components/schemas/DeploymentProcedureSummary"
            }
        }
    }
}

すべてに一致

ソースの表示

• object CountLinks
  これは、countやlinksなどのページ区切りプロパティを表します。

{
    "description":"This is the representation of list of Procedures.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CountLinks"
        }
    ],
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of Procedures",
            "items":{
                "$ref":"#/components/schemas/DeploymentProcedureSummary"
            }
        }
    }
}

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

型: array

プロシージャのリスト

ソースの表示

• 配列: object DeploymentProcedureSummary
  これは、プロシージャを表すものです。

{
    "type":"array",
    "description":"The list of Procedures",
    "items":{
        "$ref":"#/components/schemas/DeploymentProcedureSummary"
    }
}

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

型: object

これは、countやlinksなどのページ区切りプロパティを表します。

ソースの表示

• count: integer
  これは、ページ内の要素の合計数を表します。

  例: 20
• links: object links
  読取り専用: true

  結果セットのナビゲーション・リンク

{
    "description":"This represents pagination properties like count and links.",
    "properties":{
        "count":{
            "description":"This represents total number of elements in a page.",
            "type":"integer",
            "example":"20"
        },
        "links":{
            "type":"object",
            "readOnly":true,
            "description":"The result set navigation links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "previous":{
                    "$ref":"#/components/schemas/Link"
                },
                "next":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

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

型: object

これは、プロシージャを表すものです。

すべてに一致

ソースの表示

• object DeploymentProcedureDetails
  これは、プロシージャを表すものです。

{
    "description":"This is the representation of a Procedure.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureDetails"
        }
    ]
}

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

型: object

これは、プロシージャを表すものです。

ソースの表示

• displayName: string
  プロシージャの表示名

  例: Copy of TEST_DP
• id: string
  プロシージャの一意の識別子

  例: B0FBBE587FD201E2E0537013790A7D53
• links: object links
  プロシージャ関連リンク
• name: string
  プロシージャの名前

  例: DP_CC67765EF65F51A5E053E00F4B64D991
• owner: string
  プロシージャの所有者

  例: SYSMAN
• parentName: string
  プロシージャの親プロシージャ

  例: TEST_DP
• procedureInput: object procedureInput
  プロシージャの発行時に指定された入力
• type: string
  プロシージャのタイプ

  例: UserDefined
• version: string
  プロシージャのバージョン番号

  例: Succeeded
• xmlFormat: string
  登録に再利用できるDP xmlを返します。

{
    "description":"This is the representation of a Procedure.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a Procedure",
            "example":"B0FBBE587FD201E2E0537013790A7D53"
        },
        "name":{
            "type":"string",
            "description":"Name of a Procedure",
            "example":"DP_CC67765EF65F51A5E053E00F4B64D991"
        },
        "type":{
            "type":"string",
            "description":"Type of a Procedure",
            "example":"UserDefined"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of a Procedure",
            "example":"Copy of TEST_DP"
        },
        "version":{
            "type":"string",
            "description":"Version Number of a Procedure",
            "example":"Succeeded"
        },
        "owner":{
            "type":"string",
            "description":"Owner of a Procedure",
            "example":"SYSMAN"
        },
        "parentName":{
            "type":"string",
            "description":"Parent procedure of a Procedure",
            "example":"TEST_DP"
        },
        "procedureInput":{
            "type":"object",
            "description":"input which given during submit procedure",
            "allOf":[
                {
                    "$ref":"#/components/schemas/DescribeProcedureInput"
                }
            ]
        },
        "xmlFormat":{
            "type":"string",
            "description":"returns DP xml which can be reused to register."
        },
        "links":{
            "type":"object",
            "description":"Procedure related links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

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

型: object

プロシージャ関連リンク

ソースの表示

• self: object Link
  リンクを表します(self、previous、nextのいずれか)

{
    "type":"object",
    "description":"Procedure related links",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

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

型: object

プロシージャの発行時に指定された入力

すべてに一致

ソースの表示

• object DescribeProcedureInput
  これは、デプロイメント・プロシージャの発行時に指定された入力を表すものです。

{
    "type":"object",
    "description":"input which given during submit procedure",
    "allOf":[
        {
            "$ref":"#/components/schemas/DescribeProcedureInput"
        }
    ]
}

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

型: object

リンクを表します(self、previous、nextのいずれか)

ソースの表示

• href: string
  リンクのためのURL

  例: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

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

型: object

これは、デプロイメント・プロシージャの発行時に指定された入力を表すものです。

ソースの表示

• links: object links
  セルフ・リンク
• schedule: object Schedule
  スケジュールの詳細
• targets: array DeploymentProcedureTargetList
  プロシージャ・ターゲットのリストの定義
• variables: object DeploymentProcedureVariableCollection
  プロシージャ変数のコレクション

{
    "description":"This is the representation of an input given while submitting deployment procedure.",
    "type":"object",
    "properties":{
        "targets":{
            "$ref":"#/components/schemas/DeploymentProcedureTargetList"
        },
        "variables":{
            "$ref":"#/components/schemas/DeploymentProcedureVariableCollection"
        },
        "schedule":{
            "$ref":"#/components/schemas/Schedule"
        },
        "links":{
            "type":"object",
            "description":"Self link",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

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

型: object

セルフ・リンク

ソースの表示

• self: object Link
  リンクを表します(self、previous、nextのいずれか)

{
    "type":"object",
    "description":"Self link",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

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

型: object

スケジュールの詳細

ソースの表示

• isTargetZone: boolean
  時間をターゲット・タイムゾーンで解釈するかどうかを示します。時間にタイムゾーンが指定されていて、isTargetZoneがtrueの場合、エラー条件としてレポートされます
• recurring: string
  操作を繰り返し実行する必要がある頻度

  例: frequency:weekly;days:2,
• scheduleType: string
  現在、ICAL仕様のデフォルトはICALをサポートしていますが、将来的には、CRONなどの他のタイプに拡張される可能性があります。
• startGracePeriodInMinutes: integer
  開始されていない場合にジョブがスキップとしてマークされるまでの時間(分)。NULLまたは負の値は、猶予期間がないことを意味します。

  例: 60
• timeToEnd: string (date-time)
  終了時間
• timeToStart: string (date-time)
  開始時間

{
    "description":"Schedule details",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"Start time",
            "format":"date-time"
        },
        "timeToEnd":{
            "type":"string",
            "description":"End time",
            "format":"date-time"
        },
        "isTargetZone":{
            "type":"boolean",
            "description":"To indicate if the time should be interpreted in the target timezone or not. If timezone is specified in time and isTargetZone is true, it will be reported as an ERROR condition"
        },
        "scheduleType":{
            "type":"string",
            "description":"Currently we support ICAL specification default is ICAL, in the future it can be extended to other types e.g CRON."
        },
        "recurring":{
            "type":"string",
            "description":"Frequency at which the operation must be executed repeatedly",
            "example":"frequency:weekly;days:2,"
        },
        "startGracePeriodInMinutes":{
            "type":"integer",
            "description":"Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.",
            "example":"60"
        }
    }
}

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

型: array

プロシージャ・ターゲットのリストの定義

ソースの表示

• 配列: object items

{
    "description":"Defining list of procedure targets",
    "type":"array",
    "items":{
        "properties":{
            "name":{
                "type":"string",
                "description":"name of target type",
                "example":"host"
            },
            "targets":{
                "$ref":"#/components/schemas/DeploymentProcedureTargetCollection"
            }
        }
    }
}

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

型: object

プロシージャ変数のコレクション

ソースの表示

• items: array items
  プロシージャ変数のリスト

{
    "description":"Collections of Procedure Variable",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of procedure variables",
            "items":{
                "$ref":"#/components/schemas/DeploymentProcedureVariableSummary"
            }
        }
    }
}

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

型: object

ソースの表示

• name: string
  ターゲット・タイプの名前

  例: host
• targets: object DeploymentProcedureTargetCollection
  プロシージャ・ターゲットのコレクション

{
    "properties":{
        "name":{
            "type":"string",
            "description":"name of target type",
            "example":"host"
        },
        "targets":{
            "$ref":"#/components/schemas/DeploymentProcedureTargetCollection"
        }
    }
}

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

型: object

プロシージャ・ターゲットのコレクション

ソースの表示

• items: array items
  ターゲットのリスト

{
    "description":"Collections of Procedure Target",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of targets",
            "items":{
                "$ref":"#/components/schemas/DeploymentProcedureTargetSummary"
            }
        }
    }
}

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

型: array

ターゲットのリスト

ソースの表示

• 配列: object DeploymentProcedureTargetSummary
  これは、プロシージャ・ターゲットを表すものです

{
    "type":"array",
    "description":"The list of targets",
    "items":{
        "$ref":"#/components/schemas/DeploymentProcedureTargetSummary"
    }
}

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

型: object

これは、プロシージャ・ターゲットを表すものです

すべてに一致

ソースの表示

• object DeploymentProcedureTargetDetails
  デプロイメント・プロシージャのターゲットの定義

{
    "description":"This is the representation of Procedure Target",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureTargetDetails"
        }
    ]
}

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

型: object

デプロイメント・プロシージャのターゲットの定義

ソースの表示

• credentialReferences: array CredentialReference
  これは、資格証明参照を表すものです。
• targetName: string
  ターゲット名

  例: host1.oracle.com
• targetType: string
  ターゲット・タイプ

  例: host

{
    "description":"Defining Target for Deployment Procedure",
    "type":"object",
    "properties":{
        "targetName":{
            "type":"string",
            "description":"Target Name",
            "example":"host1.oracle.com"
        },
        "targetType":{
            "type":"string",
            "description":"Target Type",
            "example":"host"
        },
        "credentialReferences":{
            "$ref":"#/components/schemas/CredentialReference"
        }
    }
}

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

型: array

これは、資格証明参照を表すものです。

ソースの表示

• 配列: object items

{
    "description":"This is the representation of credential references.",
    "type":"array",
    "items":{
        "properties":{
            "usage":{
                "type":"string",
                "description":"Represents credential usage",
                "example":"defaultHostCred"
            },
            "credentialType":{
                "type":"string",
                "description":"Represents type of the credential",
                "example":"NAMED"
            },
            "owner":{
                "type":"string",
                "description":"Represents owner of the credential",
                "example":"SYSMAN"
            },
            "credentialName":{
                "type":"string",
                "description":"Represents credential name",
                "example":"EMGA"
            }
        }
    }
}

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

型: object

ソースの表示

• credentialName: string
  資格証明名を表します

  例: EMGA
• credentialType: string
  資格証明のタイプを表します

  例: NAMED
• owner: string
  資格証明の所有者を表します

  例: SYSMAN
• usage: string
  資格証明の使用方法を表します

  例: defaultHostCred

{
    "properties":{
        "usage":{
            "type":"string",
            "description":"Represents credential usage",
            "example":"defaultHostCred"
        },
        "credentialType":{
            "type":"string",
            "description":"Represents type of the credential",
            "example":"NAMED"
        },
        "owner":{
            "type":"string",
            "description":"Represents owner of the credential",
            "example":"SYSMAN"
        },
        "credentialName":{
            "type":"string",
            "description":"Represents credential name",
            "example":"EMGA"
        }
    }
}

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

型: array

プロシージャ変数のリスト

ソースの表示

• 配列: object DeploymentProcedureVariableSummary
  これは、プロシージャ変数を表すものです

{
    "type":"array",
    "description":"The list of procedure variables",
    "items":{
        "$ref":"#/components/schemas/DeploymentProcedureVariableSummary"
    }
}

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

型: object

これは、プロシージャ変数を表すものです

すべてに一致

ソースの表示

• object DeploymentProcedureVariableDetails
  デプロイメント・プロシージャの変数の定義

{
    "description":"This is the representation of Procedure Variable",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureVariableDetails"
        }
    ]
}

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

型: object

デプロイメント・プロシージャの変数の定義

ソースの表示

• variableName: string
  デプロイメント・プロシージャの変数名を表示します

  例: userId
• variableValue: string
  デプロイメント・プロシージャの変数値を表示します

  例: 10001

{
    "description":"Defining Variable for Deployment Procedure",
    "type":"object",
    "properties":{
        "variableName":{
            "type":"string",
            "description":"Displays Deployment Procedure varibale name",
            "example":"userId"
        },
        "variableValue":{
            "type":"string",
            "description":"Displays Deployment Procedure varibale value",
            "example":"10001"
        }
    }
}

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

型: object

読取り専用: true

結果セットのナビゲーション・リンク

ソースの表示

• next: object Link
  リンクを表します(self、previous、nextのいずれか)
• previous: object Link
  リンクを表します(self、previous、nextのいずれか)
• self: object Link
  リンクを表します(self、previous、nextのいずれか)

{
    "type":"object",
    "readOnly":true,
    "description":"The result set navigation links",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

400レスポンス

不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401レスポンス

未認可。ユーザーにはリクエストされた操作を実行する権限がありません

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403レスポンス

禁止。ユーザーは、リクエストされた操作の実行を禁止されています

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500レスポンス

内部サーバー・エラー。REST APIの実行中に例外が発生しました。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503レスポンス

サービスが使用できません。サーバーはリクエストを処理できません。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

先頭に戻る