Oracle Fusion Cloud Applications共通機能のためのREST API

機械翻訳について

ページ区切りを使用したジョブ・リクエストの問合せ

get

ess/rest/scheduler/v1/query/{application}/requests

ページ区切りを使用して、アプリケーションのジョブ・リクエストを問い合せます。

リクエスト

パス・パラメータ

application(required): string

リクエストされたアプリケーション

問合せパラメータ

excludeFields: string

返される情報で除外するフィールドの共通区切りのリスト。例: ?excludeFields="jobDefinitionId"
fields: string

返されるフィールドの共通区切りのリスト。たとえば、?fields="requestId"
orderBy: string

結果の順序付けに使用する問合せフィールドを指定します。この問合せパラメータの値は、fieldName[:(asc/desc)の形式に従う必要があります。たとえば、?orderBy=name:ascです。複数のフィールドがリストされている場合は、最初のフィールドのみが使用されます。
pageIndex: integer(int32)

リクエスト・インデックス番号
q: string

SCIMフィルタリング形式の問合せ文字列。問い合せることができるフィールドには、次のものが含まれます[requestId, absParentRequestId, description, product, requestCategory, runAsUser, executionType, jobDefinitionId, state, scheduleDefinition, priority, processStartTime, processEndTime, requestedStartTime, requestedEndTime, submissionTime, parentRequestId, elapsedTime, waitTime, scheduledTime, processor, submitter, submitterGUID, instanceParentId, requestType, errorType, processPhase, completedTime, retriedCount, readyWaitTime, enterpriseId, isTimedOut, isAsynchronous, logicalClusterName, submitterDmsECID, submitterFlowId, requestDmsECID, requestFlowId, elapsedTime, className, jobType, externalJobType, externalId]

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

トップに戻る

レスポンス

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

application/json;charset=utf-8
application/vnd.oracle.resource+json;type=collection

200 レスポンス

ルート・スキーマ : RequestQueryResponse

タイプ: object

Show Source

batch: array batch

複数選択用に返されるアイテム。この要素は、通常の問合せでは返されません。
count: integer

このレスポンスで返品された品目の数。複数選択を使用すると、この要素は返されません。
items: array items

通常の問合せで返されるリソース・アイテム。複数選択を使用すると、この要素は返されません。
links(required): array Links
pageIndex: integer

ユーザーによってリクエストされたページ番号。

{
    "required":[
        "links"
    ],
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The resource items returned for a normal query. This element is not\nreturned when multi-select is used.\n",
            "items":{
                "$ref":"#/components/schemas/RequestDetails"
            }
        },
        "links":{
            "$ref":"#/components/schemas/Links"
        },
        "pageIndex":{
            "type":"integer",
            "description":"The page number requested by the user."
        },
        "count":{
            "type":"integer",
            "description":"The number of items returned in this response. This element is not\nreturned when multi-select is used.\n"
        },
        "batch":{
            "type":"array",
            "description":"The items returned for multi-selection. This element is not returned\nfor a normal query.\n",
            "items":{
                "$ref":"#/components/schemas/RequestBatchItem"
            }
        }
    }
}

ネストされたスキーマ : バッチ

タイプ: array

複数選択用に返されるアイテム。この要素は、通常の問合せでは返されません。

Show Source

Array of: object RequestBatchItem

{
    "type":"array",
    "description":"The items returned for multi-selection. This element is not returned\nfor a normal query.\n",
    "items":{
        "$ref":"#/components/schemas/RequestBatchItem"
    }
}

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

タイプ: array

通常の問合せで返されるリソース・アイテム。複数選択を使用すると、この要素は返されません。

Show Source

Array of: object RequestDetails

{
    "type":"array",
    "description":"The resource items returned for a normal query. This element is not\nreturned when multi-select is used.\n",
    "items":{
        "$ref":"#/components/schemas/RequestDetails"
    }
}

ネストされたスキーマ : リンク

タイプ: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

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

タイプ: object

Show Source

body: object RequestDetails
code: integer

HTTPコード

{
    "type":"object",
    "properties":{
        "code":{
            "type":"integer",
            "description":"HTTP code"
        },
        "body":{
            "$ref":"#/components/schemas/RequestDetails"
        }
    }
}

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

タイプ: object

Show Source

absParentRequestId: integer (int64)

送信済リクエストID。そのリクエストにかわって作成されたすべての子リクエストには、同じ絶対親があります。
application: string

このリクエストに関連付けられたアプリケーション名。
cause: string

許可された値: [ "NON_TERMINAL", "REQUEST_EXPIRED", "REQUEST_LOGIN_ERROR", "REQUEST_AUTHORIZATION_FAILED", "SYSTEM_ERROR", "VALIDATION_ERROR", "METADATA_NOT_FOUND", "OPERATOR_CANCEL", "RECOVER_CANCEL", "RECOVER_GROUP_CANCEL", "PARENT_NOT_PAUSED", "PROCESS_WARNING", "PROCESS_ERROR", "PROCESS_CANCEL", "PROCESS_SUCCESS", "PROCESS_SYSTEM_ERROR", "PROCESS_BIZ_ERROR", "PROCESS_TIMED_OUT", "PROCESS_UNKNOWN_STATUS", "PROCESS_RECOVER", "PROCESS_MANUAL_RECOVER_ERROR", "PROCESS_MANUAL_RECOVER_ERROR_FINALIZE", "PROCESS_SUSPEND", "PROCESS_KILLED", "POSTPROCESS_SYSTEM_ERROR", "POSTPROCESS_CANCEL", "POSTPROCESS_WARNING", "POSTPROCESS_ERROR", "POSTPROCESS_BIZ_ERROR", "PROCESS_UPDATE_WARNING", "PROCESS_UPDATE_ERROR", "PROCESS_UPDATE_CANCEL", "PROCESS_UPDATE_BIZ_ERROR", "MANUAL_RECOVER_ERROR", "PREPROCESS_SYSTEM_ERROR", "PREPROCESS_CANCEL", "PREPROCESS_INITIATE_CANCEL", "PREPROCESS_ERROR", "PREPROCESS_BIZ_ERROR" ]

リクエストが終端状態になる原因。
causeDescription: string

ジョブ・リクエストの状態の一般的な原因を説明するローカライズされた文字列。
completedTime: string

ISO 8601日時書式の、このリクエストに関連付けられたすべてのタスクがESSによって終了した時間。これは、リクエスト・プロセス・フェーズがProcessPhase.Completeに設定された時間を表します。この値は、なんらかの理由でリクエストが実行されなかった場合でも、リクエストのすべてのタスクが完了すると常に設定されます。 ESSがこのリクエストのすべての作業をまだ終了していない場合は、Nullが返されます。
deployedApplicationName: string

このリクエストに関連付けられたdeployedApplicationName名。
description: string

このリクエストの説明。
dispatcher: string

リクエストをディスパッチした中間層インスタンス名。
dmsRID: string
ecid: string

このリクエストの処理に関連付けられたDMS ExecutionContextのECID。
elapsedTime: integer (int64)

リクエストの処理に費やされた経過時間(ミリ秒)。リクエスト処理が開始されていない場合は、0(ゼロ)になります。
enterpriseId: integer (int64)
errorType: string

許可された値: [ "SYSTEM", "BUSINESS", "TIMEOUT", "MIXED_NON_BUSINESS", "MIXED_BUSINESS" ]

リクエストのエラー・タイプ。
errorTypeDescription: string

ローカライズされたエラー・タイプ・メッセージ。
errorWarningDetail: string

このリクエストの処理中に発生したエラーまたは警告の詳細(スタック・トレースなど)。
errorWarningMessage: string

このリクエストの処理中に発生したエラーまたは警告に関連付けられたメッセージ。
errorWarningTime: string

このリクエストの処理中にエラーが発生した場合のエラーまたは警告の、ISO 8601日時書式の時間。
executableState: string
executionAttempt: integer

このリクエストに対する現在の実行の試行。最初の実行試行は1です。
executionMode: string
executionType: string

リクエストの実行タイプ。現在サポートされているタイプはRESTのみです。
expiration: string

リクエストが期限切れになるISO 8601日時書式の時間。リクエストが失効しない可能性があります。
flowId: string
instanceParentExecAttempt: integer

このリクエストが作成されたときのインスタンスの親リクエストの実行試行の値。このリクエストにインスタンスの親がない場合、この値はゼロになります
instanceParentId: integer (int64)

このリクエストのインスタンスの親のリクエストID。インスタンス親リクエストのリクエスト・ツリーの子リクエストには、同じインスタンスの親IDがあります。たとえば、サブリクエストやJobSetステップ・リクエストとその子リクエストは、同じインスタンスの親IDを持ちます。スケジュールなしでリクエストが送信された場合、送信されたリクエストはインスタンスの親とみなされます。インスタンスの親ID値は、絶対親IDの値と同じです。スケジュールを使用してリクエストが送信されると、スケジュールが発生するたびに新しい子リクエストが作成され、各子リクエストはインスタンスの親リクエストを表します。
isAsynchronous: boolean

リクエストが非同期かどうかを示します。 'true'の値は、これが非同期リクエストであることを示します。
isAsyncRecoverable: boolean
isCancellable: boolean

リクエストが取消可能かどうかを示します。これは、このリクエストのリクエスト・タイプと現在の状態に基づいています。これは、このリクエストを取り消すことができるかどうかに関する保証ではなく、単なるヒントです。
isForceCancelAllowed: boolean

forceCancelAsyncRequestを使用してリクエストをCANCELLEDに強制するための前提条件が満たされているかどうかを確認します。チェックには、ジョブ・リクエストが実行されていないことの確認は含まれません。このチェックは手動で行う必要があります。
isHoldable: boolean

リクエストが保留可能かどうかを示します。これは、このリクエストのリクエスト・タイプと現在の状態に基づいています。これは、このリクエストを保留できるかどうかに関する保証ではなく、単なるヒントです。
isRecoverable: boolean
isTimedOut: boolean

リクエストがタイムアウトしたかどうかを示します。
jobDefinitionId: string

このリクエストに関連付けられているジョブまたはジョブ・セット定義。
jobDescription: string

このリクエストに指定されたジョブ定義またはジョブ・セットの摘要
jobDisplayName: string

このリクエストのジョブ定義/ ジョブ・セットの表示名。
jobType: string

このリクエストに関連付けられているジョブ・タイプ識別子。
lastScheduleInstanceId: integer (int64)

このリクエストに関連付けられた最後のスケジュール・インスタンス・リクエストID。この値は、特定のリクエスト・タイプに対してのみ有効です。その他のリクエスト・タイプでは意味がなく、ゼロ(0)になります。 RequestType.RECUR_PARENTまたはRequestType.JOBSET_RECUR_PARENTリクエストの場合、この値は最近作成されたインスタンスの親リクエストのIDを表します。スケジュールが終了した場合または取り消された場合、これはスケジュールに対して最後に作成されたインスタンス・リクエストのIDです。 RequestType.RECUR_CHILDまたはRequestType.JOBSET_RECUR_CHILDリクエストの場合、この値はスケジュールの前のインスタンスのリクエストのIDを表します。スケジュールの最初のインスタンス・リクエストの値はゼロ(0)です。
lastSubRequestSet: integer

現在の実行試行中にこのリクエストによって送信された最後のサブリクエストに割り当てられたセット番号。このリクエストによってサブリクエストが送信されていない場合、この値はゼロになります。 pausedCountがlastSubrequestSetの場合、このリクエストは最後のサブリクエストが送信されてから一時停止しています。この値は、それらのサブリクエストに割り当てられたセット番号を表します。 pausedCountがlastSubrequestSetと等しくない場合、このリクエストが最後に一時停止してから1つ以上のサブリクエストが送信されています。この値は、このリクエストの一時停止を待機しているサブリクエストに割り当てられたセット番号を表します。
links: array RequestLinks
logicalClusterName: string
notificationUrl: string

リクエストが完了したときのオプションの通知コールバックのURLで、リクエストを送信したユーザーとして作成されます。
parentExecAttempt: integer

このリクエストが作成されたときの直接の親リクエストの実行試行の値。このリクエストに即時親がない場合、この値はゼロになります。
parentRequestId: integer (int64)

このリクエストの直接の親のリクエストID。リクエストに即時親がない場合、このメソッドによって返される値は意味がありません。
pausedCount: integer

このリクエストが現在の実行試行中に一時停止された回数。この値は、サブリクエストの実行を許可するためにリクエストが一時停止されると増分されます。このリクエストが一時停止されなかった場合、この値はゼロになります。
postProcessMessage: string
postProcessStatus: string
preProcessMessage: string
preprocessStatus: string
previousState: string

このリクエストの以前の状態。リクエストの状態が変更されていない場合、空である可能性があります。
priority: integer

リクエスト優先度。賞品の範囲は[0..9]で、最も低い優先度は0、最も高い優先度は9です。
processEndTime: string

リクエストの時間処理がISO 8601日時書式で終了しました。
processGroup: string

リクエストのプロセス・グループ。
processor: string

リクエストを処理した中間層インスタンス名。
processPhase: string

このリクエストの処理フェーズ。
processPhaseDescription: string

プロセス・フェーズのローカライズされた摘要。
processStartTime: string

リクエストの処理がISO 8601日時形式で開始されました。
product: string

リクエストに関連付けられている製品。これは、SYS_productシステム・プロパティの値に対応します。
requestCategory: string

このリクエストのリクエスト・カテゴリ・プロパティ。
requestedEndTime: string

リクエストのリクエストされた終了時間を表します。文字列はISO 8601日時書式です。
requestedStartTime: string

リクエストの実行がリクエストされた時間。文字列はISO 8601日時書式です。
requestId: integer (int64)
requestMode: string
requestParameters: array requestParameters

このリクエストに関連付けられているすべてのリクエスト・パラメータ(システム・プロパティを含む)。
requestType: string

許可された値: [ "SINGLETON", "RECUR_PARENT", "RECUR_CHILD", "JOBSET_SINGLETON", "JOBSET_STEP", "JOBSET_RECUR_PARENT", "JOBSET_RECUR_CHILD", "SUB_REQUEST", "UNKNOWN" ]

リクエストの不変タイプ。
retriedCount: integer

このリクエストが再試行された回数。
runAsUser: string

リクエストのRunAsユーザー。
スケジュール: ScheduleOut
scheduleDefinition: string

スケジュールが個別のリソースの場合にのみ、このリクエストに関連付けられたスケジュールを識別します。リクエスト送信中にインラインで指定したスケジュール(アドホック・スケジュール)については、スケジュール・フィールドを参照してください。
scheduledTime: string

リクエストのスケジュールされた開始時間。文字列はISO 8601日時書式です。
state: string

リクエストの状態。
stateChangeTime: string

リクエスト状態が最後にISO 8601日時形式で変更された時間。リクエストの状態が変更されていない場合、空である可能性があります。
stateDescription: string

ジョブ・リクエストの状態を記述するローカライズされた文字列。
stepId: string

このリクエストのJobSet stepID。リクエストは、stepID値で示されるJobSet内のステップである場合とない場合があります。
submissionTime: string

ISO8601日時書式でのリクエスト送信時間。
submitter: string

リクエストを発行したユーザー名。
submitterDmsECID: string
submitterDmsRID: string
submitterFlowId: string
submitterGUID: string

リクエストを送信したユーザーのGUID。
subRequestSet: integer

サブ要求が送信されたときに割り当てられたセット番号。親が複数のサブリクエストを送信してから一時停止すると、それらのサブリクエストはすべて同じセット番号になります。これはサブリクエストに対してのみ意味があり、その場合はこの値がゼロより大きくなります。サブリクエストではないリクエストの値はゼロです。

{
    "type":"object",
    "properties":{
        "requestId":{
            "type":"integer",
            "format":"int64",
            "x-o:queryable":true,
            "x-o:fieldGroups":{
                "detailType":[
                    "basic",
                    "full",
                    "monitoring"
                ]
            }
        },
        "description":{
            "type":"string",
            "description":"The description of this request.",
            "x-o:queryable":true,
            "x-o:fieldGroups":{
                "detailType":[
                    "basic",
                    "full",
                    "monitoring"
                ]
            }
        },
        "requestParameters":{
            "type":"array",
            "description":"All request parameters, including system properties, associated with this request.",
            "items":{
                "$ref":"#/components/schemas/RequestParameter"
            }
        },
        "absParentRequestId":{
            "type":"integer",
            "description":"The submitted request ID. All child requests created on behalf of that request have the same absolute parent.\n",
            "format":"int64",
            "x-o:queryable":true
        },
        "jobDescription":{
            "type":"string",
            "description":"the description of the job definition or job set specified for this request",
            "x-o:queryable":true
        },
        "jobDefinitionId":{
            "type":"string",
            "description":"The job or job set definition associated with this request.",
            "x-o:queryable":true
        },
        "application":{
            "type":"string",
            "description":"The application name associated with this request.",
            "x-o:queryable":true
        },
        "deployedApplicationName":{
            "type":"string",
            "description":"The deployedApplicationName name associated with this request.",
            "x-o:queryable":true
        },
        "scheduleDefinition":{
            "type":"string",
            "description":"Identifies the schedule associated with this request only if the schedule is a separate resource.\nFor a schedule specified inline during request submission (ad-hoc schedule), see 'schedule' field.\n",
            "x-o:queryable":true
        },
        "state":{
            "type":"string",
            "description":"The state of the request.",
            "x-o:queryable":true
        },
        "stateDescription":{
            "type":"string",
            "description":"A localized string describing the state of the job request."
        },
        "errorType":{
            "type":"string",
            "description":"The error type of the request.",
            "enum":[
                "SYSTEM",
                "BUSINESS",
                "TIMEOUT",
                "MIXED_NON_BUSINESS",
                "MIXED_BUSINESS"
            ],
            "x-o:queryable":true
        },
        "errorTypeDescription":{
            "type":"string",
            "description":"Localized error type message."
        },
        "priority":{
            "type":"integer",
            "description":"The request priority. The priorty range is [0..9] with 0 as the lowest priority and 9 as the highest priority.\n",
            "x-o:queryable":true
        },
        "executionType":{
            "type":"string",
            "description":"The execution type of the request. The only type supported now is REST.",
            "x-o:queryable":true
        },
        "requestCategory":{
            "type":"string",
            "description":"The request category property of this request.",
            "x-o:queryable":true
        },
        "product":{
            "type":"string",
            "description":"The product associated with the request. This corresponds to the value of SYS_product system property.",
            "x-o:queryable":true
        },
        "requestType":{
            "type":"string",
            "description":"The immutable type of the request.",
            "enum":[
                "SINGLETON",
                "RECUR_PARENT",
                "RECUR_CHILD",
                "JOBSET_SINGLETON",
                "JOBSET_STEP",
                "JOBSET_RECUR_PARENT",
                "JOBSET_RECUR_CHILD",
                "SUB_REQUEST",
                "UNKNOWN"
            ],
            "x-o:queryable":true
        },
        "processPhase":{
            "type":"string",
            "description":"The process phase for this request.",
            "x-o:queryable":true
        },
        "processPhaseDescription":{
            "type":"string",
            "description":"Localized description of the process phase."
        },
        "cause":{
            "type":"string",
            "description":"The cause that led to the request being in a terminal state.",
            "enum":[
                "NON_TERMINAL",
                "REQUEST_EXPIRED",
                "REQUEST_LOGIN_ERROR",
                "REQUEST_AUTHORIZATION_FAILED",
                "SYSTEM_ERROR",
                "VALIDATION_ERROR",
                "METADATA_NOT_FOUND",
                "OPERATOR_CANCEL",
                "RECOVER_CANCEL",
                "RECOVER_GROUP_CANCEL",
                "PARENT_NOT_PAUSED",
                "PROCESS_WARNING",
                "PROCESS_ERROR",
                "PROCESS_CANCEL",
                "PROCESS_SUCCESS",
                "PROCESS_SYSTEM_ERROR",
                "PROCESS_BIZ_ERROR",
                "PROCESS_TIMED_OUT",
                "PROCESS_UNKNOWN_STATUS",
                "PROCESS_RECOVER",
                "PROCESS_MANUAL_RECOVER_ERROR",
                "PROCESS_MANUAL_RECOVER_ERROR_FINALIZE",
                "PROCESS_SUSPEND",
                "PROCESS_KILLED",
                "POSTPROCESS_SYSTEM_ERROR",
                "POSTPROCESS_CANCEL",
                "POSTPROCESS_WARNING",
                "POSTPROCESS_ERROR",
                "POSTPROCESS_BIZ_ERROR",
                "PROCESS_UPDATE_WARNING",
                "PROCESS_UPDATE_ERROR",
                "PROCESS_UPDATE_CANCEL",
                "PROCESS_UPDATE_BIZ_ERROR",
                "MANUAL_RECOVER_ERROR",
                "PREPROCESS_SYSTEM_ERROR",
                "PREPROCESS_CANCEL",
                "PREPROCESS_INITIATE_CANCEL",
                "PREPROCESS_ERROR",
                "PREPROCESS_BIZ_ERROR"
            ]
        },
        "causeDescription":{
            "type":"string",
            "description":"A localized string describing the general cause of the state of the job request."
        },
        "parentRequestId":{
            "type":"integer",
            "description":"The request ID of the immediate parent of this request. If the request has no immediate parent,\nthe value returned by this method as not meaningful.\n",
            "format":"int64",
            "x-o:queryable":true
        },
        "stepId":{
            "type":"string",
            "description":"The JobSet stepID for this request. The request may or may not be a step within a JobSet, which\ncan be indicated by the stepID value.\n"
        },
        "instanceParentId":{
            "type":"integer",
            "description":"The request id of the instance parent of this request. Any child requests of request tree of the\ninstance parent request have he same instance parent id. For example, any sub-requests or JobSet\nstep requests, and any of their children, will have the same instance parent id.\n\nIf a request is submitted without a Schedule the submitted request is considered the instance parent.\nThe instance parent id value is the same as the absolute parent id value.\n\nIf a request is submitted with a Schedule, a new child request is created for each occurance of the\nSchedule and each child request represents an instance parent request.\n",
            "format":"int64",
            "x-o:queryable":true
        },
        "processGroup":{
            "type":"string",
            "description":"The process group of the request."
        },
        "isAsynchronous":{
            "type":"boolean",
            "description":"Indicates if the request is asynchronous. A value of 'true' indicates that this is an asynchronous request.\n",
            "x-o:queryable":true
        },
        "jobDisplayName":{
            "type":"string",
            "description":"The display name for job definition/ job set of this request."
        },
        "jobType":{
            "type":"string",
            "description":"The job type identifier associated with this request."
        },
        "processor":{
            "type":"string",
            "description":"The mid-tier instance name that processed the request.",
            "x-o:queryable":true
        },
        "dispatcher":{
            "type":"string",
            "description":"The mid-tier instance name that dispatched the request."
        },
        "executionAttempt":{
            "type":"integer",
            "description":"The current execution attempt for this request. The first execution attempt is 1."
        },
        "retriedCount":{
            "type":"integer",
            "description":"The number of times this request has been retried.",
            "x-o:queryable":true
        },
        "isCancellable":{
            "type":"boolean",
            "description":"Indicates if the request is cancellable. This is based on the request type and current state of this request. This is only a hint, not a guarantee, as to whether or not this request can be cancelled."
        },
        "isHoldable":{
            "type":"boolean",
            "description":"Indicates if the request is holdable. This is based on the request type and current state of this request. This is only a hint, not a guarantee, as to whether or not this request can be held."
        },
        "submitter":{
            "type":"string",
            "description":"The name of the user who submitted the request.",
            "x-o:queryable":true
        },
        "submitterGUID":{
            "type":"string",
            "description":"The GUID of the user who submitted the request."
        },
        "runAsUser":{
            "type":"string",
            "description":"The RunAs user for the request."
        },
        "requestedStartTime":{
            "type":"string",
            "description":"The time at which the request was requested to run. The string is in ISO 8601 date time format.",
            "x-o:queryable":true
        },
        "requestedEndTime":{
            "type":"string",
            "description":"This represents the requested end time of the request. The string is in ISO 8601 date time format.",
            "x-o:queryable":true
        },
        "scheduledTime":{
            "type":"string",
            "description":"The scheduled start time of the request. The string is in ISO 8601 date time format.",
            "x-o:queryable":true
        },
        "submissionTime":{
            "type":"string",
            "description":"Time of request submission in ISO8601 date time format.",
            "x-o:queryable":true
        },
        "processStartTime":{
            "type":"string",
            "description":"Time processing of the request began in ISO 8601 date time format.",
            "x-o:queryable":true
        },
        "processEndTime":{
            "type":"string",
            "description":"Time processing of the request ended in ISO 8601 date time format.",
            "x-o:queryable":true
        },
        "elapsedTime":{
            "type":"integer",
            "description":"The elapsed milliseconds spent processing request. This will be zero 0 if the request processing not started.\n",
            "format":"int64",
            "x-o:queryable":true
        },
        "completedTime":{
            "type":"string",
            "description":"The time, in ISO 8601 date time format, that ESS finished all tasks associated with this request.\nThis represents the time that the request process phase was set to ProcessPhase.Complete.\nThis value will always be set once all tasks for the request has finished, even if the request was\nnever executed for some reason. Null is returned if ESS has not yet finished all work for this requests.\n",
            "x-o:queryable":true
        },
        "expiration":{
            "type":"string",
            "description":"The time, in ISO 8601 date time format, that the request will expire. A request may not expire.\n"
        },
        "errorWarningMessage":{
            "type":"string",
            "description":"The message associated with an error or warning that occured while processing this request.\n"
        },
        "errorWarningTime":{
            "type":"string",
            "description":"The time, in ISO 8601 date time format, of the error or warning if one occurred while\nprocessing this request.\n"
        },
        "errorWarningDetail":{
            "type":"string",
            "description":"The details, such as stack trace, of the error or warning, if one occurred while processing this request.\n"
        },
        "ecid":{
            "type":"string",
            "description":"The ECID of the DMS ExecutionContext associated with the processing of this request.\n"
        },
        "lastScheduleInstanceId":{
            "type":"integer",
            "description":"The last Schedule instance request id associated with this request. This value is meaningful only for\ncertain request types. For other request types it is meaningless and will be zero (0).\n\nFor a RequestType.RECUR_PARENT or RequestType.JOBSET_RECUR_PARENT request, this value represents\nthe id of the instance parent request that was most recently created. If the Schedule has ended, or been\ncancelled, this is the id of the last instance request created for the Schedule.\n\nFor a RequestType.RECUR_CHILD or RequestType.JOBSET_RECUR_CHILD request, this value represents the\nid of the request for the previous instance of the Schedule. The value is zero (0) for the first instance\nrequest of the Schedule.\n",
            "format":"int64"
        },
        "isTimedOut":{
            "type":"boolean",
            "description":"Indicates if the request has timed out.",
            "x-o:queryable":true
        },
        "parentExecAttempt":{
            "type":"integer",
            "description":"The value of execution attempt of the immediate parent request when this request was created.\nThis value will be zero if this request does not have an immediate parent.\n"
        },
        "instanceParentExecAttempt":{
            "type":"integer",
            "description":"The value of execution attempt of the instance parent request when this request was created.\nThis value will be zero if this request does not have an instance parent\n"
        },
        "pausedCount":{
            "type":"integer",
            "description":"The number of times this request has been paused during its current execution attempt.\nThis value is incremented when a request has been paused to allow to allow sub-requests to run.\nThis value will be zero if this request has never been paused.\n"
        },
        "lastSubRequestSet":{
            "type":"integer",
            "description":"The set number assigned to the last subrequest submitted by this request during its current execution attempt.\nThis value will be zero if no subrequests have been submitted by this request.\n\nIf pausedCount equals lastSubrequestSet, then this request has paused since the last subrequests were\nsubmitted. This value represents the set number assigned to those subrequests.\n\nIf pausedCount is not equal to lastSubrequestSet, then one or more subrequests have been submitted\nsince this request last paused. This value represents the set number assigned to those subrequests\nthat are waiting for this request to pause.\n"
        },
        "subRequestSet":{
            "type":"integer",
            "description":"The set number assigned to a subrequest when it was submitted. If a parent submits multiple subrequests\nbefore it pauses all those subrequests will have the same set number.\n\nThis is meaningful only for a subrequest, in which case this value will be greater than zero.\nThe value is zero for a request that is not a subrequest.\n"
        },
        "preprocessStatus":{
            "type":"string"
        },
        "preProcessMessage":{
            "type":"string"
        },
        "postProcessStatus":{
            "type":"string"
        },
        "postProcessMessage":{
            "type":"string"
        },
        "executableState":{
            "type":"string"
        },
        "isAsyncRecoverable":{
            "type":"boolean"
        },
        "isRecoverable":{
            "type":"boolean"
        },
        "requestMode":{
            "type":"string"
        },
        "executionMode":{
            "type":"string"
        },
        "logicalClusterName":{
            "type":"string",
            "x-o:queryable":true
        },
        "submitterDmsECID":{
            "type":"string",
            "x-o:queryable":true
        },
        "submitterDmsRID":{
            "type":"string"
        },
        "submitterFlowId":{
            "type":"string",
            "x-o:queryable":true
        },
        "previousState":{
            "type":"string",
            "description":"The previous state for this request. It may be empty if the request has never changed state."
        },
        "stateChangeTime":{
            "type":"string",
            "description":"The time the request state was last changed in ISO 8601 date time format. It may be empty if the request\nhas never changed state.\n"
        },
        "enterpriseId":{
            "type":"integer",
            "format":"int64"
        },
        "dmsRID":{
            "type":"string"
        },
        "flowId":{
            "type":"string",
            "x-o:queryable":true
        },
        "isForceCancelAllowed":{
            "type":"boolean",
            "description":"Check whether the prerequisites for forcing a request to CANCELLED using\nforceCancelAsyncRequest are met.\n\nThe checks do NOT include verification that  the job request is no longer executing. That check must be done\nmanually.\n"
        },
        "schedule":{
            "$ref":"#/components/schemas/ScheduleOut"
        },
        "notificationUrl":{
            "type":"string",
            "description":"URL for an optional notification callback when the request is complete to be made as the user who submitted\nthe request.\n"
        },
        "links":{
            "$ref":"#/components/schemas/RequestLinks"
        }
    }
}

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

タイプ: array

Show Source

Array of: object RequestLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RequestLink"
    }
}

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

タイプ: array

このリクエストに関連付けられているすべてのリクエスト・パラメータ(システム・プロパティを含む)。

Show Source

Array of: object RequestParameter

リクエスト・パラメータ。

{
    "type":"array",
    "description":"All request parameters, including system properties, associated with this request.",
    "items":{
        "$ref":"#/components/schemas/RequestParameter"
    }
}

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

すべてに一致

Show Source

object ScheduleBase
object ScheduleOut-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleBase"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"resource ID"
                },
                "name":{
                    "type":"string",
                    "description":"The unique name to be given to this resource. It must not be null.\nThe name is also used as the default display name unless otherwise specifially set.\n"
                },
                "description":{
                    "type":"string"
                },
                "displayName":{
                    "type":"string"
                },
                "packageName":{
                    "type":"string",
                    "description":"The namespace for this metadata object."
                },
                "resourceBundles":{
                    "type":"array",
                    "description":"Java resource bundles associated with this job.",
                    "items":{
                        "type":"string"
                    }
                },
                "permissions":{
                    "type":"array",
                    "description":"The set of permissions the current user of this API has on this resource.",
                    "items":{
                        "type":"string",
                        "enum":[
                            "READ",
                            "CREATE",
                            "UPDATE",
                            "DELETE",
                            "EXECUTE"
                        ]
                    }
                }
            }
        }
    ]
}

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

タイプ: object

Show Source

href(required): string
rel(required): string

許可された値: [ "self", "parentRequest", "cancel", "forceCancel", "hold", "release", "subscribe", "permissions", "executionStatus", "absParentRequest", "instanceParent" ]

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "enum":[
                "self",
                "parentRequest",
                "cancel",
                "forceCancel",
                "hold",
                "release",
                "subscribe",
                "permissions",
                "executionStatus",
                "absParentRequest",
                "instanceParent"
            ]
        },
        "href":{
            "type":"string"
        }
    }
}

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

タイプ: object

リクエスト・パラメータ。

Show Source

name(required): string

パラメータ名。
paramType(required): string

許可された値: [ "BOOLEAN", "LONG", "INTEGER", "DATETIME", "STRING" ]
scope: string
value: string

{
    "required":[
        "name",
        "paramType"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The parameter name."
        },
        "value":{
            "type":"string"
        },
        "paramType":{
            "type":"string",
            "enum":[
                "BOOLEAN",
                "LONG",
                "INTEGER",
                "DATETIME",
                "STRING"
            ]
        },
        "scope":{
            "type":"string"
        }
    },
    "description":"A request parameter."
}

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

タイプ: object

Show Source

exclusions: array exclusions
inclusions: array inclusions
recurrences: array recurrences

一連の繰返し。生成されるスケジュールのオカレンスは、個々の繰り返しによって生成されるオカレンスの和になります。
timezone: string

Olsonデータベース形式のタイムゾーンです。

{
    "type":"object",
    "properties":{
        "recurrences":{
            "type":"array",
            "description":"A set of recurrences. The resulting occurrences for the schedule would be the union of\noccurrences generated by the individual recurrences.\n",
            "items":{
                "$ref":"#/components/schemas/Recurrence"
            }
        },
        "timezone":{
            "type":"string",
            "description":"Timezone in Olson database format."
        },
        "inclusions":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Explicit inclusion date in ISO 8601 format."
            }
        },
        "exclusions":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Explicit exclusion date in ISO 8601 format."
            }
        }
    }
}

ネストされたスキーマ : ScheduleOut-allOf[1]

タイプ: object

Show Source

description: string
displayName: string
id: string

リソースID
name: string

このリソースに指定する一意の名前。 nullにできません。特に指定のないかぎり、この名前はデフォルトの表示名としても使用されます。
packageName: string

このメタデータ・オブジェクトのネームスペース。
permissions: array permissions

このAPIの現在のユーザーにこのリソースに対する権限のセット。
resourceBundles: array resourceBundles

このジョブに関連付けられたJavaリソース・バンドル。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"resource ID"
        },
        "name":{
            "type":"string",
            "description":"The unique name to be given to this resource. It must not be null.\nThe name is also used as the default display name unless otherwise specifially set.\n"
        },
        "description":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "packageName":{
            "type":"string",
            "description":"The namespace for this metadata object."
        },
        "resourceBundles":{
            "type":"array",
            "description":"Java resource bundles associated with this job.",
            "items":{
                "type":"string"
            }
        },
        "permissions":{
            "type":"array",
            "description":"The set of permissions the current user of this API has on this resource.",
            "items":{
                "type":"string",
                "enum":[
                    "READ",
                    "CREATE",
                    "UPDATE",
                    "DELETE",
                    "EXECUTE"
                ]
            }
        }
    }
}

ネストされたスキーマ : 除外

タイプ: array

Show Source

Array of: string

ISO 8601形式の明示的な除外日。

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Explicit exclusion date in ISO 8601 format."
    }
}

ネストされたスキーマ : 包含

タイプ: array

Show Source

Array of: string

ISO 8601形式の明示的な包含日。

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Explicit inclusion date in ISO 8601 format."
    }
}

ネストされたスキーマ : 繰り返し

タイプ: array

一連の繰返し。生成されるスケジュールのオカレンスは、個々の繰り返しによって生成されるオカレンスの和になります。

Show Source

Array of: object Recurrence

{
    "type":"array",
    "description":"A set of recurrences. The resulting occurrences for the schedule would be the union of\noccurrences generated by the individual recurrences.\n",
    "items":{
        "$ref":"#/components/schemas/Recurrence"
    }
}

ネストされたスキーマ : 繰返し

タイプ: object

Show Source

endDate: string

この繰り返しオブジェクトの終了日時を設定します。オブジェクトは、秒までの時間のみを抽出します。ミリ秒精度はサポートされていません。値はISO 8601形式の文字列です。
icalString(required): string

スケジュールで使用する繰返しパターンを定義します。文字列はRFC 5445 RRULEに準拠している必要があります。 UNTIL、COUNT、BYSETPOS、WKSTなどの制限はサポートされていません。 RRULEのBY*句(Rotors)には、最小値 -1を指定できます。たとえば、BYDAY=-2MO(second to last monday)はサポートされていません。 BYMONTHおよびBYWEEKNOは、1つのRECUR式に存在できません。 BYDAY、BYMONTHDAYおよびBYYEARDAYは、1つのRECUR式に存在できません。
startDate: string

この繰り返しオブジェクトの開始日時を設定します。オブジェクトは、秒までの時間のみを抽出します。ミリ秒精度はサポートされていません。値はISO 8601形式の文字列です。

{
    "required":[
        "icalString"
    ],
    "type":"object",
    "properties":{
        "icalString":{
            "type":"string",
            "description":"Defines a recurrence pattern for use by a schedule. The string must conform to RFC 5445 RRULE.\nRestrictions include\n  UNTIL, COUNT, BYSETPOS and WKST are not supported.\n  \n  BY* clauses (Rotors) in the RRULE can have minimun value of -1. i.e. for eg, BYDAY=-2MO(second to last monday)\n  is not supported.\n  \n  BYMONTH and BYWEEKNO can't be present in one RECUR expression.\n  \n  BYDAY, BYMONTHDAY and BYYEARDAY can't be present in one RECUR expression.\n"
        },
        "startDate":{
            "type":"string",
            "description":"Sets the start date/time for this Recurrence object. The object only extracts the time up to the seconds. Milliseconds precision is not supported. The value is a string in ISO 8601 format."
        },
        "endDate":{
            "type":"string",
            "description":"Sets the end date/time for this Recurrence object. The object only extracts the time up to the seconds. Milliseconds precision is not supported. The value is a string in ISO 8601 format."
        }
    }
}

ネストされたスキーマ : 権限

タイプ: array

このAPIの現在のユーザーにこのリソースに対する権限のセット。

Show Source

Array of: string

許可された値: [ "READ", "CREATE", "UPDATE", "DELETE", "EXECUTE" ]

{
    "type":"array",
    "description":"The set of permissions the current user of this API has on this resource.",
    "items":{
        "type":"string",
        "enum":[
            "READ",
            "CREATE",
            "UPDATE",
            "DELETE",
            "EXECUTE"
        ]
    }
}

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

タイプ: array

このジョブに関連付けられたJavaリソース・バンドル。

Show Source

Array of: string

{
    "type":"array",
    "description":"Java resource bundles associated with this job.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : リンク

タイプ: object

Show Source

href(required): string
rel(required): string

許可された値: [ "self", "cancel", "forceCancel", "hold", "release", "subscribe", "permissions", "executionStatus" ]

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "enum":[
                "self",
                "cancel",
                "forceCancel",
                "hold",
                "release",
                "subscribe",
                "permissions",
                "executionStatus"
            ]
        },
        "href":{
            "type":"string"
        }
    }
}

400 レスポンス

入力が無効です

ルート・スキーマ : SimpleExceptionDetail

タイプ: object

Show Source

detail: string

詳細エラー・メッセージ
errorCode: string

ESS固有のエラー・コード。たとえば、ESS-00500です。
status: integer

HTTPステータス・コード
title(required): string

要約エラー・メッセージ
type(required): string

URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

403 レスポンス

この操作には使用できません

ルート・スキーマ : SimpleExceptionDetail

タイプ: object

Show Source

detail: string

詳細エラー・メッセージ
errorCode: string

ESS固有のエラー・コード。たとえば、ESS-00500です。
status: integer

HTTPステータス・コード
title(required): string

要約エラー・メッセージ
type(required): string

URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

404 レスポンス

見つかりません

ルート・スキーマ : SimpleExceptionDetail

タイプ: object

Show Source

detail: string

詳細エラー・メッセージ
errorCode: string

ESS固有のエラー・コード。たとえば、ESS-00500です。
status: integer

HTTPステータス・コード
title(required): string

要約エラー・メッセージ
type(required): string

URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

500 レスポンス

スケジューリング・サブシステム・エラーが発生しました

ルート・スキーマ : SimpleExceptionDetail

タイプ: object

Show Source

detail: string

詳細エラー・メッセージ
errorCode: string

ESS固有のエラー・コード。たとえば、ESS-00500です。
status: integer

HTTPステータス・コード
title(required): string

要約エラー・メッセージ
type(required): string

URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

「トップに戻る」