移動

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

新規ジョブ・リクエストの発行

post

ess/rest/scheduler/v1/requests

指定されたスケジュールに従って実行する既存のジョブ定義を使用して、新しいジョブ・リクエストを作成します

リクエスト

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

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

• application/json
• application/vnd.oracle.resource+json

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

ルート・スキーマ: schema

このオブジェクトは、jobDefinitionまたはjobSetのリクエストの作成に使用する情報を指定します。スケジュールとscheduleIdのいずれか1つのみを指定する必要があることに注意してください。

すべてに一致

ソースの表示

• object RequestSystemProperties
• object type

{
    "description":"This object specifies information used to create a request for a jobDefinition or jobSet. Note that only\none of schedule and scheduleId should be specified.\n",
    "allOf":[
        {
            "$ref":"#/components/schemas/RequestSystemProperties"
        },
        {
            "type":"object",
            "properties":{
                "description":{
                    "type":"string",
                    "description":"An optional search tag for the request.\n"
                },
                "requestExecutionContext":{
                    "$ref":"#/components/schemas/RequestExecutionContextIn"
                },
                "jobDefinitionId":{
                    "type":"string",
                    "description":"metadata object ID for the job definition or job set"
                },
                "requestParameters":{
                    "type":"array",
                    "description":"the request submission parameters",
                    "items":{
                        "$ref":"#/components/schemas/RequestParameter"
                    }
                },
                "schedule":{
                    "$ref":"#/components/schemas/ScheduleBase"
                },
                "scheduleId":{
                    "type":"string",
                    "description":"ID for a schedule that is already created as a seperate resource. Only one of scheduleId and schedule\nshould be specified.\n"
                },
                "startTime":{
                    "type":"string",
                    "description":"The requested start time for the request in ISO 8601 date time format. The request will not run prior to\nthis time. If not specified, the current time will be used. If a schedule has been specified or the\nrequest is meant to begin immediately, a start time should not be specified.\n"
                },
                "endTime":{
                    "type":"string",
                    "description":"The time past which this request or its child requests will not be dispatched for execution.\n"
                },
                "application":{
                    "type":"string",
                    "description":"Property that specifies the application name."
                },
                "callbackSubscription":{
                    "$ref":"#/components/schemas/CallbackSubscriptionRequest"
                }
            }
        }
    ]
}

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

型: object

ソースの表示

• executePast: boolean
  実行時間が過去である繰返しリクエストのインスタンスを生成するかどうかを指定するプロパティ。インスタンスは、リクエスト開始時間より前およびリクエスト終了時間より後には生成されません。リクエスト開始時間がnullである場合、現在の時間にデフォルト設定されます。過去のインスタンスが生成されるようにするには、このプロパティをtrueに設定し、リクエストされた開始時間をインスタンスの生成開始時間として指定する必要があります。このプロパティの有効な値: true -- リクエストされた開始時間からリクエストされた終了時間によって指定された範囲内のスケジュールにより指定されたすべてのインスタンスが、生成の時間に関係なく生成されます。false -- スケジュールされた実行時間が過去の時間(生成時間より前)であるインスタンスは生成されません。このプロパティが指定されていない場合、使用されるシステムのデフォルトはtrueです。
• priority: integer
  リクエスト処理の優先度を指定するプロパティ。優先度の範囲は[0..9]であり、0が最下位の優先度を、9が最上位の優先度を示します。このプロパティが指定されていない場合、システムのデフォルト値は4です。
• product: string
  リクエストを発行したアプリケーション内で製品を指定するプロパティ。
• requestCategory: string
  リクエストのラベルを指定するプロパティ。このラベルでは、リソース最適化のジョブ・リクエストをグループ化できます。
• requestLogLevel: string
  リクエスト・ロギングのログ・レベルを指定するプロパティ。このプロパティの値はスケジューラによって内部的に使用されませんが、ジョブに渡して使用できます。
• requestTimeout: integer (int64)
  プロセッサが実行を開始した後に非同期を待機する時間を分数で指定するプロパティ。時間が経過した後、リクエストはタイムアウトとしてマークされます。リクエストの状態にその他の直接的な影響はありません。このプロパティが指定されていない場合、システム・デフォルトはタイムアウトなしです。
• retries: integer
  失敗したリクエストの再試行制限を指定するプロパティ。リクエストの実行に失敗した場合、リクエストが成功するまでこのプロパティで指定された回数までリクエストが再試行されます。再試行上限にゼロ(0)を指定した場合、失敗したリクエストは再試行されません。このプロパティが指定されていない場合、使用されるシステムのデフォルトは0です。

{
    "type":"object",
    "properties":{
        "product":{
            "type":"string",
            "description":"Property that specifies the product within the application that submitted the request.\n"
        },
        "requestCategory":{
            "type":"string",
            "description":"Property that specifies a label for a request. The label allows grouping of\njob requests for resource optimization.\n"
        },
        "priority":{
            "type":"integer",
            "description":"Property that specifies the request processing priority.\nThe priority interval is [0..9] with 0 as the lowest priority\nand 9 as the highest.\nIf this property is not specified, the system default value used is 4.\n"
        },
        "retries":{
            "type":"integer",
            "description":"Property that specifies the retry limit for a failed request.\nIf request execution fails, the request will retried up to the\nnumber of times specified by this property until the request succeeds.\nIf retry limit is zero (0), a failed request will not be retried.\nIf this property is not specified, the system default used is 0.\n"
        },
        "executePast":{
            "type":"boolean",
            "description":"Property that specifies whether instances of a repeating request\nwith an execution time in the past should be generated.  Instances\nwill never be generated before the requested start time nor\nafter the requested end time.\n\nNote that a null requested start time defaults to the current time.\nTo cause past instances to be generated, you must set this property\nto true and specify the requested start time as the initial\ntime from which instances should be generated.\n\nValid values for this property are:\n\ntrue -- All instances specified by a schedule that are\nwithin the range specified by requested start time to requested\nend time will be generated regardless of the time of generation.\n\nfalse Instances with a scheduled execution time in the\npast (that is, before the time of generation) will not be generated.\n\nIf this property is not specified, system default used is true.\n"
        },
        "requestTimeout":{
            "type":"integer",
            "description":"Property that specifies the time, in minutes, that the processor will\nwait for an asynchronous after it has begun execution. After the\ntime elapses, the request will be marked as timed out. There is no\nother direct effect on the state of the request.\n\nIf this property is not specified, the system default is to never timeout.\n",
            "format":"int64"
        },
        "requestLogLevel":{
            "type":"string",
            "description":"Property that specifies the log level for request logging.\n\nThe value of this property is not used internally by the scheduler,\nbut is available to be passed to the job for its use.\n"
        }
    }
}

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

型: object

ソースの表示

• application: string
  アプリケーション名を指定するプロパティ。
• callbackSubscription: object CallbackSubscriptionRequest
  コールバックRESTエンドポイントの起動に必要なプロパティの一般的なセット。これらのプロパティは、指定されたsecuritySchemeに従って指定する必要があります。
• description: string
  リクエストのオプションの検索タグ。
• endTime: string
  このリクエストまたはその子リクエストが実行のためにディスパッチされない経過時間。
• jobDefinitionId: string
  ジョブ定義またはジョブ・セットのメタデータ・オブジェクトID
• requestExecutionContext: object RequestExecutionContextIn
  現在のジョブ・リクエストのリクエスト実行コンテキスト。この識別子は、サブリクエストの作成時にのみ使用されます。
• requestParameters: array requestParameters
  リクエスト発行パラメータ
• schedule: object ScheduleBase
• scheduleId: string
  別個のリソースとしてすでに作成されているスケジュールのID。scheduleIdとスケジュールのいずれか1つのみを指定する必要があります。
• startTime: string
  ISO 8601日時形式のリクエスト開始時刻。リクエストはこの時間より前に実行されません。指定しない場合、現在の時刻が使用されます。スケジュールが指定されている場合、またはリクエストがすぐに開始される予定の場合は、開始時間を指定しないでください。

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"An optional search tag for the request.\n"
        },
        "requestExecutionContext":{
            "$ref":"#/components/schemas/RequestExecutionContextIn"
        },
        "jobDefinitionId":{
            "type":"string",
            "description":"metadata object ID for the job definition or job set"
        },
        "requestParameters":{
            "type":"array",
            "description":"the request submission parameters",
            "items":{
                "$ref":"#/components/schemas/RequestParameter"
            }
        },
        "schedule":{
            "$ref":"#/components/schemas/ScheduleBase"
        },
        "scheduleId":{
            "type":"string",
            "description":"ID for a schedule that is already created as a seperate resource. Only one of scheduleId and schedule\nshould be specified.\n"
        },
        "startTime":{
            "type":"string",
            "description":"The requested start time for the request in ISO 8601 date time format. The request will not run prior to\nthis time. If not specified, the current time will be used. If a schedule has been specified or the\nrequest is meant to begin immediately, a start time should not be specified.\n"
        },
        "endTime":{
            "type":"string",
            "description":"The time past which this request or its child requests will not be dispatched for execution.\n"
        },
        "application":{
            "type":"string",
            "description":"Property that specifies the application name."
        },
        "callbackSubscription":{
            "$ref":"#/components/schemas/CallbackSubscriptionRequest"
        }
    }
}

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

型: object

コールバックRESTエンドポイントの起動に必要なプロパティの一般的なセット。これらのプロパティは、指定されたsecuritySchemeに従って指定する必要があります。

ソースの表示

• accessTokenUri: string
  アイデンティティ・ストアからアクセス・トークンを取得するためのURL。通常、このプロパティはDIRECT_OAUTHセキュリティ・スキームに必要です。
• callbackResourcePath(required): string
  RESTリソースの相対パスを指定するプロパティ。ベース・リソースURLは、callbackUrlPrefixプロパティによって指定されます。このプロパティは、すべてのセキュリティ・スキームに必要です。
• callbackUrlPrefix(required): string
  callbackResourcePathプロパティとともに使用してリソースの完全なURLを提供できるRESTリソースのベースURLを指定するプロパティ。このプロパティは、すべてのセキュリティ・スキームに必要です。
• clientId: string
  クライアント登録時にOAuthサーバーによって発行されるclientIdであり、これは、コールを行う前に資格証明ストアに追加され、ポリシー・パラメータとして提供されます。通常、このプロパティは、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
• clientSecret: string
  クライアント登録時にOAuthサーバーによって発行されるクライアント・シークレットであり、コールを行う前に資格証明ストアに追加され、ポリシー・パラメータとして提供されます。通常、このプロパティは、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
• ouath2ClientCsfKey: string
  クライアントのCSFキーを設定するプロパティ。例: "idcs.client.credentials"。これは、PolicySetFeatureの作成時にOWSMのConfigOverride.CO_OAUTH2_CLIENT_CSF_KEYで指定されます。通常、このプロパティはOWSM_LPAセキュリティ・スキームに必要です。
• securityScheme: string
  指定できる値: [ "OWSM_GPA", "OWSM_LPA", "DIRECT_OAUTH" ]

  "OWSM_GPA"、"OWSM_LPA"、"DIRECT_OAUTH"のいずれか。指定しない場合、デフォルトはOWSM_GPAとみなされます。OWSM_LPAの場合、クライアントからアタッチされるデフォルト・ポリシーは"oracle/http_oauth2_token_client_policy"になります。"OWSM_LAP"セキュリティ・スキームの"ouath2ClientCsfKey"プロパティの場合、サブスクライバは、パスワード資格証明がCSFマップ"oracle.wsm.security"の下のCSFで構成されていることを確認する必要があります。DIRECT_OAUTHセキュリティ・スキームの"clientId"および"clientSecret"プロパティの場合、サブスクライバは、IDCSでclientIdおよびシークレットが構成されていることを確認する必要があります。

{
    "required":[
        "callbackUrlPrefix",
        "callbackResourcePath"
    ],
    "type":"object",
    "properties":{
        "securityScheme":{
            "type":"string",
            "description":"One among \"OWSM_GPA\", \"OWSM_LPA\", \"DIRECT_OAUTH\". \nIf unspecified, the default will be assumed as OWSM_GPA. For OWSM_LPA, the default policy attached from client will be \"oracle/http_oauth2_token_client_policy\".\nFor \"ouath2ClientCsfKey\" property of \"OWSM_LAP\" security scheme, the subscribers need to ensure the password credential is configured in CSF under the csf map \"oracle.wsm.security\".\nFor \"clientId\" and \"clientSecret\" properties of \"DIRECT_OAUTH security\" scheme, the subscribers need to ensure the clientId and secret is configured in IDCS. \n",
            "enum":[
                "OWSM_GPA",
                "OWSM_LPA",
                "DIRECT_OAUTH"
            ]
        },
        "callbackUrlPrefix":{
            "type":"string",
            "description":"Property that specifies the base URL of a REST Resource that can be used in conjunction with callbackResourcePath property to provide a full URL for the resource. This property is required for all the security schemes.\n"
        },
        "callbackResourcePath":{
            "type":"string",
            "description":"Property that specifies the relative Path for REST Resource. The base Resource URL is given by callbackUrlPrefix property. This property is required for all the security schemes.\n"
        },
        "accessTokenUri":{
            "type":"string",
            "description":"URL to obtain access tokens from the Identity store. This property is usually required for DIRECT_OAUTH security scheme.\n"
        },
        "ouath2ClientCsfKey":{
            "type":"string",
            "description":"Property to set the client's CSF key. Eg: \"idcs.client.credentials\". This will be specified in OWSM's ConfigOverride.CO_OAUTH2_CLIENT_CSF_KEY while creating PolicySetFeature. This property is usually required for OWSM_LPA security scheme.\n"
        },
        "clientId":{
            "type":"string",
            "description":"The clientId issued by OAuth server during client registration that shall be added to credential store and provided as a policy parameter before making a call. This property is usually required for OWSM_LPA and DIRECT_OAUTH security schemes.\n"
        },
        "clientSecret":{
            "type":"string",
            "description":"The client secret issued by OAuth server during client registration that shall be added to credential store and provided as a policy parameter before making a call. This property is usually required for OWSM_LPA and DIRECT_OAUTH security schemes.\n"
        }
    },
    "description":"The typical set of properties that are required to invoke the callback rest endpoint. These properties needs to be specified as per the securityScheme specified.\n"
}

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

型: object

現在のジョブ・リクエストのリクエスト実行コンテキスト。この識別子は、サブリクエストの作成時にのみ使用されます。

ソースの表示

• requestHandle(required): string
  実行中のリクエストに関連付けられたリクエスト・ハンドルは、リクエストの実行中のインスタンスに対する不透明な識別子を表します。この値は、実行の開始時にジョブ・リクエストに指定された情報から取得できます。
• requestId(required): integer (int64)
  この操作を起動しているリクエストの識別子です。実行開始時にジョブ・リクエストに指定された情報から取得できます。

{
    "required":[
        "requestHandle",
        "requestId"
    ],
    "type":"object",
    "properties":{
        "requestId":{
            "type":"integer",
            "description":"It is the identifier of the request that is invoking this operation.\nIt can be retrieved from the information supplied to the job\nrequest when execution commenced.\n",
            "format":"int64"
        },
        "requestHandle":{
            "type":"string",
            "description":"The request handle associated with the executing request represents\nan opaque identifer for the executing instance of the request. The\nvalue can be retrieved from information supplied to the job request\nwhen execution commenced.\n"
        }
    },
    "description":"The request execution context of the current job request. This\nidentifier is only used when creating sub-requests.\n"
}

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

型: array

リクエスト発行パラメータ

ソースの表示

• 配列: object RequestParameter
  リクエスト・パラメータ

{
    "type":"array",
    "description":"the request submission parameters",
    "items":{
        "$ref":"#/components/schemas/RequestParameter"
    }
}

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

型: object

ソースの表示

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

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

型: object

リクエスト・パラメータ

ソースの表示

• name(required): string
  パラメータの名前
• paramType(required): string
  指定できる値: [ "BOOLEAN", "LONG", "INTEGER", "DATETIME", "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"
            ]
        }
    },
    "description":"a request parameter"
}

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

型: array

ソースの表示

• 配列: string
  ISO 8601形式の明示的な除外日

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

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

型: array

ソースの表示

• 配列: string
  ISO 8601形式での明示的な包含日

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

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

型: array

一連の繰返し。スケジュールの出現回数は、個々の繰返しによって生成された出現の和集合になります。

ソースの表示

• 配列: 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"
    }
}

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

型: object

ソースの表示

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

リクエスト本文 - application/vnd.oracle.resource+json ()

ルート・スキーマ: schema

このオブジェクトは、jobDefinitionまたはjobSetのリクエストの作成に使用する情報を指定します。スケジュールとscheduleIdのいずれか1つのみを指定する必要があることに注意してください。

すべてに一致

ソースの表示

• object RequestSystemProperties
• object type

{
    "description":"This object specifies information used to create a request for a jobDefinition or jobSet. Note that only\none of schedule and scheduleId should be specified.\n",
    "allOf":[
        {
            "$ref":"#/components/schemas/RequestSystemProperties"
        },
        {
            "type":"object",
            "properties":{
                "description":{
                    "type":"string",
                    "description":"An optional search tag for the request.\n"
                },
                "requestExecutionContext":{
                    "$ref":"#/components/schemas/RequestExecutionContextIn"
                },
                "jobDefinitionId":{
                    "type":"string",
                    "description":"metadata object ID for the job definition or job set"
                },
                "requestParameters":{
                    "type":"array",
                    "description":"the request submission parameters",
                    "items":{
                        "$ref":"#/components/schemas/RequestParameter"
                    }
                },
                "schedule":{
                    "$ref":"#/components/schemas/ScheduleBase"
                },
                "scheduleId":{
                    "type":"string",
                    "description":"ID for a schedule that is already created as a seperate resource. Only one of scheduleId and schedule\nshould be specified.\n"
                },
                "startTime":{
                    "type":"string",
                    "description":"The requested start time for the request in ISO 8601 date time format. The request will not run prior to\nthis time. If not specified, the current time will be used. If a schedule has been specified or the\nrequest is meant to begin immediately, a start time should not be specified.\n"
                },
                "endTime":{
                    "type":"string",
                    "description":"The time past which this request or its child requests will not be dispatched for execution.\n"
                },
                "application":{
                    "type":"string",
                    "description":"Property that specifies the application name."
                },
                "callbackSubscription":{
                    "$ref":"#/components/schemas/CallbackSubscriptionRequest"
                }
            }
        }
    ]
}

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

型: object

ソースの表示

• executePast: boolean
  実行時間が過去である繰返しリクエストのインスタンスを生成するかどうかを指定するプロパティ。インスタンスは、リクエスト開始時間より前およびリクエスト終了時間より後には生成されません。リクエスト開始時間がnullである場合、現在の時間にデフォルト設定されます。過去のインスタンスが生成されるようにするには、このプロパティをtrueに設定し、リクエストされた開始時間をインスタンスの生成開始時間として指定する必要があります。このプロパティの有効な値: true -- リクエストされた開始時間からリクエストされた終了時間によって指定された範囲内のスケジュールにより指定されたすべてのインスタンスが、生成の時間に関係なく生成されます。false -- スケジュールされた実行時間が過去の時間(生成時間より前)であるインスタンスは生成されません。このプロパティが指定されていない場合、使用されるシステムのデフォルトはtrueです。
• priority: integer
  リクエスト処理の優先度を指定するプロパティ。優先度の範囲は[0..9]であり、0が最下位の優先度を、9が最上位の優先度を示します。このプロパティが指定されていない場合、システムのデフォルト値は4です。
• product: string
  リクエストを発行したアプリケーション内で製品を指定するプロパティ。
• requestCategory: string
  リクエストのラベルを指定するプロパティ。このラベルでは、リソース最適化のジョブ・リクエストをグループ化できます。
• requestLogLevel: string
  リクエスト・ロギングのログ・レベルを指定するプロパティ。このプロパティの値はスケジューラによって内部的に使用されませんが、ジョブに渡して使用できます。
• requestTimeout: integer (int64)
  プロセッサが実行を開始した後に非同期を待機する時間を分数で指定するプロパティ。時間が経過した後、リクエストはタイムアウトとしてマークされます。リクエストの状態にその他の直接的な影響はありません。このプロパティが指定されていない場合、システム・デフォルトはタイムアウトなしです。
• retries: integer
  失敗したリクエストの再試行制限を指定するプロパティ。リクエストの実行に失敗した場合、リクエストが成功するまでこのプロパティで指定された回数までリクエストが再試行されます。再試行上限にゼロ(0)を指定した場合、失敗したリクエストは再試行されません。このプロパティが指定されていない場合、使用されるシステムのデフォルトは0です。

{
    "type":"object",
    "properties":{
        "product":{
            "type":"string",
            "description":"Property that specifies the product within the application that submitted the request.\n"
        },
        "requestCategory":{
            "type":"string",
            "description":"Property that specifies a label for a request. The label allows grouping of\njob requests for resource optimization.\n"
        },
        "priority":{
            "type":"integer",
            "description":"Property that specifies the request processing priority.\nThe priority interval is [0..9] with 0 as the lowest priority\nand 9 as the highest.\nIf this property is not specified, the system default value used is 4.\n"
        },
        "retries":{
            "type":"integer",
            "description":"Property that specifies the retry limit for a failed request.\nIf request execution fails, the request will retried up to the\nnumber of times specified by this property until the request succeeds.\nIf retry limit is zero (0), a failed request will not be retried.\nIf this property is not specified, the system default used is 0.\n"
        },
        "executePast":{
            "type":"boolean",
            "description":"Property that specifies whether instances of a repeating request\nwith an execution time in the past should be generated.  Instances\nwill never be generated before the requested start time nor\nafter the requested end time.\n\nNote that a null requested start time defaults to the current time.\nTo cause past instances to be generated, you must set this property\nto true and specify the requested start time as the initial\ntime from which instances should be generated.\n\nValid values for this property are:\n\ntrue -- All instances specified by a schedule that are\nwithin the range specified by requested start time to requested\nend time will be generated regardless of the time of generation.\n\nfalse Instances with a scheduled execution time in the\npast (that is, before the time of generation) will not be generated.\n\nIf this property is not specified, system default used is true.\n"
        },
        "requestTimeout":{
            "type":"integer",
            "description":"Property that specifies the time, in minutes, that the processor will\nwait for an asynchronous after it has begun execution. After the\ntime elapses, the request will be marked as timed out. There is no\nother direct effect on the state of the request.\n\nIf this property is not specified, the system default is to never timeout.\n",
            "format":"int64"
        },
        "requestLogLevel":{
            "type":"string",
            "description":"Property that specifies the log level for request logging.\n\nThe value of this property is not used internally by the scheduler,\nbut is available to be passed to the job for its use.\n"
        }
    }
}

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

型: object

ソースの表示

• application: string
  アプリケーション名を指定するプロパティ。
• callbackSubscription: object CallbackSubscriptionRequest
  コールバックRESTエンドポイントの起動に必要なプロパティの一般的なセット。これらのプロパティは、指定されたsecuritySchemeに従って指定する必要があります。
• description: string
  リクエストのオプションの検索タグ。
• endTime: string
  このリクエストまたはその子リクエストが実行のためにディスパッチされない経過時間。
• jobDefinitionId: string
  ジョブ定義またはジョブ・セットのメタデータ・オブジェクトID
• requestExecutionContext: object RequestExecutionContextIn
  現在のジョブ・リクエストのリクエスト実行コンテキスト。この識別子は、サブリクエストの作成時にのみ使用されます。
• requestParameters: array requestParameters
  リクエスト発行パラメータ
• schedule: object ScheduleBase
• scheduleId: string
  別個のリソースとしてすでに作成されているスケジュールのID。scheduleIdとスケジュールのいずれか1つのみを指定する必要があります。
• startTime: string
  ISO 8601日時形式のリクエスト開始時刻。リクエストはこの時間より前に実行されません。指定しない場合、現在の時刻が使用されます。スケジュールが指定されている場合、またはリクエストがすぐに開始される予定の場合は、開始時間を指定しないでください。

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"An optional search tag for the request.\n"
        },
        "requestExecutionContext":{
            "$ref":"#/components/schemas/RequestExecutionContextIn"
        },
        "jobDefinitionId":{
            "type":"string",
            "description":"metadata object ID for the job definition or job set"
        },
        "requestParameters":{
            "type":"array",
            "description":"the request submission parameters",
            "items":{
                "$ref":"#/components/schemas/RequestParameter"
            }
        },
        "schedule":{
            "$ref":"#/components/schemas/ScheduleBase"
        },
        "scheduleId":{
            "type":"string",
            "description":"ID for a schedule that is already created as a seperate resource. Only one of scheduleId and schedule\nshould be specified.\n"
        },
        "startTime":{
            "type":"string",
            "description":"The requested start time for the request in ISO 8601 date time format. The request will not run prior to\nthis time. If not specified, the current time will be used. If a schedule has been specified or the\nrequest is meant to begin immediately, a start time should not be specified.\n"
        },
        "endTime":{
            "type":"string",
            "description":"The time past which this request or its child requests will not be dispatched for execution.\n"
        },
        "application":{
            "type":"string",
            "description":"Property that specifies the application name."
        },
        "callbackSubscription":{
            "$ref":"#/components/schemas/CallbackSubscriptionRequest"
        }
    }
}

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

型: object

コールバックRESTエンドポイントの起動に必要なプロパティの一般的なセット。これらのプロパティは、指定されたsecuritySchemeに従って指定する必要があります。

ソースの表示

• accessTokenUri: string
  アイデンティティ・ストアからアクセス・トークンを取得するためのURL。通常、このプロパティはDIRECT_OAUTHセキュリティ・スキームに必要です。
• callbackResourcePath(required): string
  RESTリソースの相対パスを指定するプロパティ。ベース・リソースURLは、callbackUrlPrefixプロパティによって指定されます。このプロパティは、すべてのセキュリティ・スキームに必要です。
• callbackUrlPrefix(required): string
  callbackResourcePathプロパティとともに使用してリソースの完全なURLを提供できるRESTリソースのベースURLを指定するプロパティ。このプロパティは、すべてのセキュリティ・スキームに必要です。
• clientId: string
  クライアント登録時にOAuthサーバーによって発行されるclientIdであり、これは、コールを行う前に資格証明ストアに追加され、ポリシー・パラメータとして提供されます。通常、このプロパティは、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
• clientSecret: string
  クライアント登録時にOAuthサーバーによって発行されるクライアント・シークレットであり、コールを行う前に資格証明ストアに追加され、ポリシー・パラメータとして提供されます。通常、このプロパティは、OWSM_LPAおよびDIRECT_OAUTHセキュリティ・スキームに必要です。
• ouath2ClientCsfKey: string
  クライアントのCSFキーを設定するプロパティ。例: "idcs.client.credentials"。これは、PolicySetFeatureの作成時にOWSMのConfigOverride.CO_OAUTH2_CLIENT_CSF_KEYで指定されます。通常、このプロパティはOWSM_LPAセキュリティ・スキームに必要です。
• securityScheme: string
  指定できる値: [ "OWSM_GPA", "OWSM_LPA", "DIRECT_OAUTH" ]

  "OWSM_GPA"、"OWSM_LPA"、"DIRECT_OAUTH"のいずれか。指定しない場合、デフォルトはOWSM_GPAとみなされます。OWSM_LPAの場合、クライアントからアタッチされるデフォルト・ポリシーは"oracle/http_oauth2_token_client_policy"になります。"OWSM_LAP"セキュリティ・スキームの"ouath2ClientCsfKey"プロパティの場合、サブスクライバは、パスワード資格証明がCSFマップ"oracle.wsm.security"の下のCSFで構成されていることを確認する必要があります。DIRECT_OAUTHセキュリティ・スキームの"clientId"および"clientSecret"プロパティの場合、サブスクライバは、IDCSでclientIdおよびシークレットが構成されていることを確認する必要があります。

{
    "required":[
        "callbackUrlPrefix",
        "callbackResourcePath"
    ],
    "type":"object",
    "properties":{
        "securityScheme":{
            "type":"string",
            "description":"One among \"OWSM_GPA\", \"OWSM_LPA\", \"DIRECT_OAUTH\". \nIf unspecified, the default will be assumed as OWSM_GPA. For OWSM_LPA, the default policy attached from client will be \"oracle/http_oauth2_token_client_policy\".\nFor \"ouath2ClientCsfKey\" property of \"OWSM_LAP\" security scheme, the subscribers need to ensure the password credential is configured in CSF under the csf map \"oracle.wsm.security\".\nFor \"clientId\" and \"clientSecret\" properties of \"DIRECT_OAUTH security\" scheme, the subscribers need to ensure the clientId and secret is configured in IDCS. \n",
            "enum":[
                "OWSM_GPA",
                "OWSM_LPA",
                "DIRECT_OAUTH"
            ]
        },
        "callbackUrlPrefix":{
            "type":"string",
            "description":"Property that specifies the base URL of a REST Resource that can be used in conjunction with callbackResourcePath property to provide a full URL for the resource. This property is required for all the security schemes.\n"
        },
        "callbackResourcePath":{
            "type":"string",
            "description":"Property that specifies the relative Path for REST Resource. The base Resource URL is given by callbackUrlPrefix property. This property is required for all the security schemes.\n"
        },
        "accessTokenUri":{
            "type":"string",
            "description":"URL to obtain access tokens from the Identity store. This property is usually required for DIRECT_OAUTH security scheme.\n"
        },
        "ouath2ClientCsfKey":{
            "type":"string",
            "description":"Property to set the client's CSF key. Eg: \"idcs.client.credentials\". This will be specified in OWSM's ConfigOverride.CO_OAUTH2_CLIENT_CSF_KEY while creating PolicySetFeature. This property is usually required for OWSM_LPA security scheme.\n"
        },
        "clientId":{
            "type":"string",
            "description":"The clientId issued by OAuth server during client registration that shall be added to credential store and provided as a policy parameter before making a call. This property is usually required for OWSM_LPA and DIRECT_OAUTH security schemes.\n"
        },
        "clientSecret":{
            "type":"string",
            "description":"The client secret issued by OAuth server during client registration that shall be added to credential store and provided as a policy parameter before making a call. This property is usually required for OWSM_LPA and DIRECT_OAUTH security schemes.\n"
        }
    },
    "description":"The typical set of properties that are required to invoke the callback rest endpoint. These properties needs to be specified as per the securityScheme specified.\n"
}

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

型: object

現在のジョブ・リクエストのリクエスト実行コンテキスト。この識別子は、サブリクエストの作成時にのみ使用されます。

ソースの表示

• requestHandle(required): string
  実行中のリクエストに関連付けられたリクエスト・ハンドルは、リクエストの実行中のインスタンスに対する不透明な識別子を表します。この値は、実行の開始時にジョブ・リクエストに指定された情報から取得できます。
• requestId(required): integer (int64)
  この操作を起動しているリクエストの識別子です。実行開始時にジョブ・リクエストに指定された情報から取得できます。

{
    "required":[
        "requestHandle",
        "requestId"
    ],
    "type":"object",
    "properties":{
        "requestId":{
            "type":"integer",
            "description":"It is the identifier of the request that is invoking this operation.\nIt can be retrieved from the information supplied to the job\nrequest when execution commenced.\n",
            "format":"int64"
        },
        "requestHandle":{
            "type":"string",
            "description":"The request handle associated with the executing request represents\nan opaque identifer for the executing instance of the request. The\nvalue can be retrieved from information supplied to the job request\nwhen execution commenced.\n"
        }
    },
    "description":"The request execution context of the current job request. This\nidentifier is only used when creating sub-requests.\n"
}

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

型: array

リクエスト発行パラメータ

ソースの表示

• 配列: object RequestParameter
  リクエスト・パラメータ

{
    "type":"array",
    "description":"the request submission parameters",
    "items":{
        "$ref":"#/components/schemas/RequestParameter"
    }
}

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

型: object

ソースの表示

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

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

型: object

リクエスト・パラメータ

ソースの表示

• name(required): string
  パラメータの名前
• paramType(required): string
  指定できる値: [ "BOOLEAN", "LONG", "INTEGER", "DATETIME", "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"
            ]
        }
    },
    "description":"a request parameter"
}

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

型: array

ソースの表示

• 配列: string
  ISO 8601形式の明示的な除外日

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

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

型: array

ソースの表示

• 配列: string
  ISO 8601形式での明示的な包含日

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

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

型: array

一連の繰返し。スケジュールの出現回数は、個々の繰返しによって生成された出現の和集合になります。

ソースの表示

• 配列: 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"
    }
}

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

型: object

ソースの表示

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

先頭に戻る

レスポンス

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

• application/json
• application/vnd.oracle.resource+json

201レスポンス

OK

ヘッダー

• 場所:
  新規リソースのURL

本文()

ルート・スキーマ: CreateRequestResponse

型: object

ソースの表示

• id: integer (int64)
• links: array RequestLinks

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "links":{
            "$ref":"#/components/schemas/RequestLinks"
        }
    }
}

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

型: array

ソースの表示

• 配列: object RequestLink

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

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

型: object

ソースの表示

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

400レスポンス

入力が無効です

本文()

ルート・スキーマ: SimpleExceptionDetail

型: object

ソースの表示

• 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

ソースの表示

• 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

ソースの表示

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

409レスポンス

競合

本文()

ルート・スキーマ: SimpleExceptionDetail

型: object

ソースの表示

• 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

ソースの表示

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

先頭に戻る