Oracle Enterprise ManagerのREST API

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

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/deploymentProcedureInstances

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

リクエスト

問合せパラメータ

executionId: string

executionIdを使用してインスタンスを返します
include: string

include=totalの場合は、返されたレコードの合計数に関する情報がレスポンスに含まれます
limit: integer

最小値: 1

最大値: 2000

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

デフォルト値: 20
name: string

名前を使用してインスタンスを返します
owner: string

所有者名を使用してインスタンスを返します
page: string

ページのシステム生成ページ・トークン。
procedureType: string

プロシージャ・タイプを使用してデプロイメント・プロシージャ・インスタンスを返します
sort: string

ソートされたデプロイメント・プロシージャ・インスタンスを返します。指定可能なフィールドは、インスタンス名です。指定可能な方向はDESCとASCです

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

インスタンスのリストが正常に返されました

ルート・スキーマ: DeploymentProcedureInstanceCollection

型: object

これは、インスタンスのリストを表すものです。

ソースの表示

items(必須): array items

インスタンスのリスト

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

すべてに一致

ソースの表示

object CountLinks

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

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

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

型: array

インスタンスのリスト

ソースの表示

配列: object ProcedureInstanceSummary

これは、インスタンスを表すものです。

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

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

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

型: object

これは、インスタンスを表すものです。

すべてに一致

ソースの表示

object DeploymentProcedureInstanceDetails

これは、インスタンスを表すものです。

{
    "description":"This is the representation of an Instance.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureInstanceDetails"
        }
    ]
}

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

型: object

これは、インスタンスを表すものです。

ソースの表示

executionId: string

インスタンスの実行ID

例: CC67DA5B8AD02268E053E00F4B64265F
id: string

インスタンスの一意の識別子

例: B0FBBE587FD201E2E0537013790A7D03
instanceData: object instanceData

デプロイメント・プロシージャの発行中に使用されるデータ
links: object links

インスタンス関連リンク
name: string

インスタンスの名前

例: HOST_COMMAND
owner: string

インスタンスの所有者

例: SYSMAN
procedureType: string

プロシージャのタイプ

例: UserDefined
status: string

インスタンスのステータス

例: Succeeded
statusDetails: object statusDetails

デプロイメント・プロシージャ・インスタンスのステータスの詳細

{
    "description":"This is the representation of an Instance.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for an Instance",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "name":{
            "type":"string",
            "description":"Name of an Instance",
            "example":"HOST_COMMAND"
        },
        "procedureType":{
            "type":"string",
            "description":"Type of a Procedure",
            "example":"UserDefined"
        },
        "executionId":{
            "type":"string",
            "description":"Execution Id of an Instance",
            "example":"CC67DA5B8AD02268E053E00F4B64265F"
        },
        "status":{
            "type":"string",
            "description":"Status of an Instance",
            "example":"Succeeded"
        },
        "owner":{
            "type":"string",
            "description":"Owner of an Instance",
            "example":"SYSMAN"
        },
        "instanceData":{
            "type":"object",
            "description":"Data which used while submitting deployment procedure",
            "allOf":[
                {
                    "$ref":"#/components/schemas/InstanceData"
                }
            ]
        },
        "statusDetails":{
            "type":"object",
            "description":"status details of a deployment procedure instance",
            "allOf":[
                {
                    "$ref":"#/components/schemas/DeploymentProcedureInstanceStatusDetails"
                }
            ]
        },
        "links":{
            "type":"object",
            "description":"Instance related links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

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

型: object

デプロイメント・プロシージャの発行中に使用されるデータ

すべてに一致

ソースの表示

object allOf InstanceData

これは、インスタンス発行データを表すものです。

{
    "type":"object",
    "description":"Data which used while submitting deployment procedure",
    "allOf":[
        {
            "$ref":"#/components/schemas/InstanceData"
        }
    ]
}

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

型: object

インスタンス関連リンク

ソースの表示

self: object Link

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

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

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

型: object

デプロイメント・プロシージャ・インスタンスのステータスの詳細

すべてに一致

ソースの表示

object DeploymentProcedureInstanceStatusDetails

これは、詳細でのプロシージャ・インスタンスのステータスを表すものです。

{
    "type":"object",
    "description":"status details of a deployment procedure instance",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureInstanceStatusDetails"
        }
    ]
}

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

型: object

これは、インスタンス発行データを表すものです。

すべてに一致

ソースの表示

array DeploymentProcedureTargetList

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

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

{
    "description":"This is the representation of instance submission data.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureTargetList"
        },
        {
            "$ref":"#/components/schemas/DeploymentProcedureVariableCollection"
        }
    ]
}

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

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

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

型: object

これは、詳細でのプロシージャ・インスタンスのステータスを表すものです。

ソースの表示

createdBy: string

インスタンスの所有者

例: SYSMAN
dataId: string

データGUIDを表します

例: CC186E3706C349BBE053E00F4B64AB8F
elapsedTime: string

インスタンスの経過時間

例: 8 seconds
errorHandling: string

エラー処理を表します
procedureId: string

プロシージャの一意の識別子

例: CC01BDC5DA734370E053E00F4B64B23D
status: string

インスタンスのステータス

例: FAILED
stepDetails: array stepDetails

ステップの詳細を表します

{
    "description":"This is the representation of procedure instance status in details.",
    "type":"object",
    "properties":{
        "procedureId":{
            "type":"string",
            "description":"Unique identifier for a procedure",
            "example":"CC01BDC5DA734370E053E00F4B64B23D"
        },
        "createdBy":{
            "type":"string",
            "description":"Owner of an Instance",
            "example":"SYSMAN"
        },
        "status":{
            "type":"string",
            "description":"Status of an Instance",
            "example":"FAILED"
        },
        "elapsedTime":{
            "type":"string",
            "description":"elapsed time of an instance",
            "example":"8 seconds"
        },
        "errorHandling":{
            "type":"string",
            "description":"Represents error handling"
        },
        "dataId":{
            "type":"string",
            "description":"Represents data guid",
            "example":"CC186E3706C349BBE053E00F4B64AB8F"
        },
        "stepDetails":{
            "type":"array",
            "description":"Represtents step details",
            "items":{
                "$ref":"#/components/schemas/Phase"
            }
        }
    }
}

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

型: array

ステップの詳細を表します

ソースの表示

配列: object Phase

フェーズとそのステップの情報を表します

{
    "type":"array",
    "description":"Represtents step details",
    "items":{
        "$ref":"#/components/schemas/Phase"
    }
}

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

型: object

フェーズとそのステップの情報を表します

ソースの表示

steps: array steps

ステップを表します

{
    "description":"Represents information of a phase and its steps",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhaseStepDetails"
        }
    ],
    "properties":{
        "steps":{
            "type":"array",
            "description":"Represents step",
            "items":{
                "$ref":"#/components/schemas/StepDetails"
            }
        }
    }
}

すべてに一致

ソースの表示

object PhaseStepDetails

これは、フェーズ・ステップを表すものです。

{
    "description":"Represents information of a phase and its steps",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhaseStepDetails"
        }
    ],
    "properties":{
        "steps":{
            "type":"array",
            "description":"Represents step",
            "items":{
                "$ref":"#/components/schemas/StepDetails"
            }
        }
    }
}

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

型: array

ステップを表します

ソースの表示

配列: object StepDetails

これは、ステップを表すものです。

{
    "type":"array",
    "description":"Represents step",
    "items":{
        "$ref":"#/components/schemas/StepDetails"
    }
}

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

型: object

これは、フェーズ・ステップを表すものです。

ソースの表示

stepDetails: array stepDetails

ステップの詳細を表します
steps: object StepDetails

これは、ステップを表すものです。

{
    "description":"This is the representation of Phase Step.",
    "type":"object",
    "properties":{
        "steps":{
            "$ref":"#/components/schemas/StepDetails"
        },
        "stepDetails":{
            "type":"array",
            "description":"Represents step details",
            "items":{
                "$ref":"#/components/schemas/StepDetails"
            }
        }
    }
}

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

型: object

これは、ステップを表すものです。

ソースの表示

errorMode: string

エラーのモードを表します

例: stop
id: string

ステップIDを表します

例: s1
isEnabled: boolean

ステップが有効かどうかを表します

例: true
parentId: string

親GUIDを表します。

例: default_phase
stateDetails: object StateDetails

これは、状態を表すものです。
stepType: string

ステップのタイプを表します

例: Host Command Step
timeCompleted: string

ステップの完了時間を表します

例: 2021-09-16 07:05:48.0
timeStarted: string

ステップの開始時間を表します

例: 2021-09-16 07:05:44.0
timeUpdated: string

ステップの最終更新時間を表します

例: 2021-09-16 07:05:48.0
typeStep: string

ステップ・タイプを表します

例: Step

{
    "description":"This is the representation of Step.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Represents step id",
            "example":"s1"
        },
        "isEnabled":{
            "type":"boolean",
            "description":"Represents step whether it is enabled or not",
            "example":true
        },
        "stepType":{
            "type":"string",
            "description":"Represents type of the step",
            "example":"Host Command Step"
        },
        "errorMode":{
            "type":"string",
            "description":"Represents mode of error",
            "example":"stop"
        },
        "parentId":{
            "type":"string",
            "description":"Represents parent guid.",
            "example":"default_phase"
        },
        "typeStep":{
            "type":"string",
            "description":"Represents step type",
            "example":"Step"
        },
        "timeStarted":{
            "type":"string",
            "description":"Represents start time of the strp",
            "example":"2021-09-16 07:05:44.0"
        },
        "timeUpdated":{
            "type":"string",
            "description":"Represents last updated time of the step",
            "example":"2021-09-16 07:05:48.0"
        },
        "timeCompleted":{
            "type":"string",
            "description":"Represents completion time of the step",
            "example":"2021-09-16 07:05:48.0"
        },
        "stateDetails":{
            "$ref":"#/components/schemas/StateDetails"
        }
    }
}

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

型: object

これは、状態を表すものです。

ソースの表示

id: string

状態IDを表します

例: CC1871802C4343A3E053E00F4B640973
jobDetails: object JobDetails

これは、ジョブを表すものです
parentId: string

親GUIDを表します

例: CC1871802C4243A3E053E00F4B640973
phaseDetails: object PhaseDetails

これは、フェーズを表すものです
status: string

状態ステータスを表します

例: FAILED
timeCompleted: string

状態の完了時間を表します

例: 2021-09-16 07:05:48.0
timeStarted: string

状態の開始時間を表します

例: 2021-09-16 07:05:44.0
timeUpdated: string

状態の最終更新時間を表します

例: 2021-09-16 07:05:48.0

{
    "description":"This is the representation of State.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Represents state id",
            "example":"CC1871802C4343A3E053E00F4B640973"
        },
        "status":{
            "type":"string",
            "description":"Represents state status",
            "example":"FAILED"
        },
        "parentId":{
            "type":"string",
            "description":"Represents parent guid",
            "example":"CC1871802C4243A3E053E00F4B640973"
        },
        "timeStarted":{
            "type":"string",
            "description":"Represents start time of the state",
            "example":"2021-09-16 07:05:44.0"
        },
        "timeUpdated":{
            "type":"string",
            "description":"Represents last updated time of the state",
            "example":"2021-09-16 07:05:48.0"
        },
        "timeCompleted":{
            "type":"string",
            "description":"Represents completion time of the state",
            "example":"2021-09-16 07:05:48.0"
        },
        "jobDetails":{
            "$ref":"#/components/schemas/JobDetails"
        },
        "phaseDetails":{
            "$ref":"#/components/schemas/PhaseDetails"
        }
    }
}

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

型: object

これは、ジョブを表すものです

ソースの表示

jobDetails: object JobStep

これは、ジョブ・ステップを表すものです
jobExecutionId: string

ジョブ実行IDを表します

例: CC1871802C4643A3E053E00F4B640973
jobId: string

ジョブIDを表します

例: CC1871802C4443A3E053E00F4B640973
jobName: string

ジョブ名を表します

例: S1_CC1871802C4343A3E053E00F4B640973
jobStatus: string

ジョブ・ステータスを表します

例: Aborted
jobType: string

ジョブ・タイプを表します

例: HostCommand
timeStarted: string

ジョブ開始時間を表します

例: 2021-09-16 07:05:46 GMT

{
    "description":"This is the representation of Job",
    "type":"object",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"Represents job id",
            "example":"CC1871802C4443A3E053E00F4B640973"
        },
        "jobExecutionId":{
            "type":"string",
            "description":"Represents job execution id",
            "example":"CC1871802C4643A3E053E00F4B640973"
        },
        "jobName":{
            "type":"string",
            "description":"Represents job name",
            "example":"S1_CC1871802C4343A3E053E00F4B640973"
        },
        "jobType":{
            "type":"string",
            "description":"Represents job type",
            "example":"HostCommand"
        },
        "jobStatus":{
            "type":"string",
            "description":"Represents job status",
            "example":"Aborted"
        },
        "timeStarted":{
            "type":"string",
            "description":"Represents job start time",
            "example":"2021-09-16 07:05:46 GMT"
        },
        "jobDetails":{
            "$ref":"#/components/schemas/JobStep"
        }
    }
}

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

型: object

これは、フェーズを表すものです

ソースの表示

targetName: string

ターゲット名を表します

例: host1.us.oracle.com
targetType: string

ターゲット・タイプを表します

例: host

{
    "description":"This is the representation of phase",
    "type":"object",
    "properties":{
        "targetName":{
            "type":"string",
            "description":"Represents target name",
            "example":"host1.us.oracle.com"
        },
        "targetType":{
            "type":"string",
            "description":"Represents target type",
            "example":"host"
        }
    }
}

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

型: object

これは、ジョブ・ステップを表すものです

ソースの表示

command: string

ジョブ・コマンドを表します

例: remoteOp
name: string

ジョブ名を表します

例: SS_RemoteOp
output: string

ジョブ出力を表します
status: string

ジョブ・ステータスを表します

例: Aborted

{
    "description":"This is the representation of job step",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Represents job name",
            "example":"SS_RemoteOp"
        },
        "command":{
            "type":"string",
            "description":"Represents job command",
            "example":"remoteOp"
        },
        "status":{
            "type":"string",
            "description":"Represent job status",
            "example":"Aborted"
        },
        "output":{
            "type":"string",
            "description":"Represents job output"
        }
    }
}

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

型: array

ステップの詳細を表します

ソースの表示

配列: object StepDetails

これは、ステップを表すものです。

{
    "type":"array",
    "description":"Represents step details",
    "items":{
        "$ref":"#/components/schemas/StepDetails"
    }
}

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

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"
        }
    }
}

先頭に戻る