Jump to

• Request
• Response

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

Request Body - application/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.

{ "description":"This object specifies information used for setSubmitArgs function call.\n", "type":"object", "properties":{ "requestParameters":{ "type":"array", "description":"The request submission parameters.", "items":{ "$ref":"#/components/schemas/RequestParameter" } }, "arguments":{ "type":"array", "items":{ "type":"string" } }, "application":{ "type":"string", "description":"Property that specifies the application name." } } }

Nested Schema : arguments

Type: array

Show Source

• Array of: string

{ "type":"array", "items":{ "type":"string" } }

Nested Schema : requestParameters

Type: array

The request submission parameters.

Show Source

• Array of: object RequestParameter
  A request parameter.

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

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

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

Request Body - 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.

{ "description":"This object specifies information used for setSubmitArgs function call.\n", "type":"object", "properties":{ "requestParameters":{ "type":"array", "description":"The request submission parameters.", "items":{ "$ref":"#/components/schemas/RequestParameter" } }, "arguments":{ "type":"array", "items":{ "type":"string" } }, "application":{ "type":"string", "description":"Property that specifies the application name." } } }

Nested Schema : arguments

Type: array

Show Source

• Array of: string

{ "type":"array", "items":{ "type":"string" } }

Nested Schema : requestParameters

Type: array

The request submission parameters.

Show Source

• Array of: object RequestParameter
  A request parameter.

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

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

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

Back to Top

Response

Supported Media Types

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

201 Response

OK

Body ()

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.

{ "description":"This object specifies information used for setSubmitArgs function call.\n", "type":"object", "properties":{ "requestParameters":{ "type":"array", "description":"The request submission parameters.", "items":{ "$ref":"#/components/schemas/RequestParameter" } }, "arguments":{ "type":"array", "items":{ "type":"string" } }, "application":{ "type":"string", "description":"Property that specifies the application name." } } }

Nested Schema : arguments

Type: array

Show Source

• Array of: string

{ "type":"array", "items":{ "type":"string" } }

Nested Schema : requestParameters

Type: array

The request submission parameters.

Show Source

• Array of: object RequestParameter
  A request parameter.

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

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

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

400 Response

Invalid input

Body ()

Root Schema : SimpleExceptionDetail

Type: object

Show Source

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

{ "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 Response

Not allowed for this operation

Body ()

Root Schema : SimpleExceptionDetail

Type: object

Show Source

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

{ "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 Response

Not found

Body ()

Root Schema : SimpleExceptionDetail

Type: object

Show Source

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

{ "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 Response

Conflict

Body ()

Root Schema : SimpleExceptionDetail

Type: object

Show Source

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

{ "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 Response

Scheduling sub-system error

Body ()

Root Schema : SimpleExceptionDetail

Type: object

Show Source

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

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

Back to Top