Set Step Args
post
ess/rest/scheduler/v1/requests/submitArgs
Marshals various information in the existing CP style into an ESS request parameters object for a list of steps in a jobset request. It would be invoked prior to submitting the request.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
- application/vnd.oracle.resource+json
Root Schema : schema
Type:
object
This object specifies information used for setSubmitArgs function call.
Show Source
-
application: string
Property that specifies the application name.
-
arguments: array
arguments
-
requestParameters: array
requestParameters
The request submission parameters.
Nested Schema : requestParameters
Type:
array
The request submission parameters.
Show Source
-
Array of:
object RequestParameter
A request parameter.
Nested Schema : RequestParameter
Type:
object
A request parameter.
Show Source
-
name(required): string
The parameter name.
-
paramType(required): string
Allowed Values:
[ "BOOLEAN", "LONG", "INTEGER", "DATETIME", "STRING" ]
-
scope: string
-
value: string
Root Schema : schema
Type:
object
This object specifies information used for setSubmitArgs function call.
Show Source
-
application: string
Property that specifies the application name.
-
arguments: array
arguments
-
requestParameters: array
requestParameters
The request submission parameters.
Nested Schema : requestParameters
Type:
array
The request submission parameters.
Show Source
-
Array of:
object RequestParameter
A request parameter.
Nested Schema : RequestParameter
Type:
object
A request parameter.
Show Source
-
name(required): string
The parameter name.
-
paramType(required): string
Allowed Values:
[ "BOOLEAN", "LONG", "INTEGER", "DATETIME", "STRING" ]
-
scope: string
-
value: string
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json
201 Response
OK
Root Schema : schema
Type:
object
This object specifies information used for setSubmitArgs function call.
Show Source
-
application: string
Property that specifies the application name.
-
arguments: array
arguments
-
requestParameters: array
requestParameters
The request submission parameters.
Nested Schema : requestParameters
Type:
array
The request submission parameters.
Show Source
-
Array of:
object RequestParameter
A request parameter.
Nested Schema : RequestParameter
Type:
object
A request parameter.
Show Source
-
name(required): string
The parameter name.
-
paramType(required): string
Allowed Values:
[ "BOOLEAN", "LONG", "INTEGER", "DATETIME", "STRING" ]
-
scope: string
-
value: string
400 Response
Invalid input
Root Schema : SimpleExceptionDetail
Type:
Show Source
object
-
detail: string
Detailed error message
-
errorCode: string
ESS-specific error code. For example ESS-00500.
-
status: integer
HTTP status code
-
title(required): string
Summary error message
-
type(required): string
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.
403 Response
Not allowed for this operation
Root Schema : SimpleExceptionDetail
Type:
Show Source
object
-
detail: string
Detailed error message
-
errorCode: string
ESS-specific error code. For example ESS-00500.
-
status: integer
HTTP status code
-
title(required): string
Summary error message
-
type(required): string
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.
404 Response
Not found
Root Schema : SimpleExceptionDetail
Type:
Show Source
object
-
detail: string
Detailed error message
-
errorCode: string
ESS-specific error code. For example ESS-00500.
-
status: integer
HTTP status code
-
title(required): string
Summary error message
-
type(required): string
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.
409 Response
Conflict
Root Schema : SimpleExceptionDetail
Type:
Show Source
object
-
detail: string
Detailed error message
-
errorCode: string
ESS-specific error code. For example ESS-00500.
-
status: integer
HTTP status code
-
title(required): string
Summary error message
-
type(required): string
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.
500 Response
Scheduling sub-system error
Root Schema : SimpleExceptionDetail
Type:
Show Source
object
-
detail: string
Detailed error message
-
errorCode: string
ESS-specific error code. For example ESS-00500.
-
status: integer
HTTP status code
-
title(required): string
Summary error message
-
type(required): string
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.