Jump to

• Request
• Response

Schedule a risk management job

post

/fscmRestApi/resources/11.13.18.05/riskManagementJobs/action/scheduleJob

Provide the job schedule status when a job request is successfully submitted.

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• jobParams: object jobParams
  Additional Properties Allowed: additionalProperties

  The parameters to schedule the job.
• jobType: string
  The type of job.
• scheduleInfo: object scheduleInfo
  Additional Properties Allowed: additionalProperties

  The schedule information of the job.

{
    "type":"object",
    "properties":{
        "scheduleInfo":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The schedule information of the job.",
            "nullable":true
        },
        "jobParams":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The parameters to schedule the job.",
            "nullable":true
        },
        "jobType":{
            "type":"string",
            "description":"The type of job.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : jobParams

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"The parameters to schedule the job.",
    "nullable":true
}

The parameters to schedule the job.

Nested Schema : scheduleInfo

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"The schedule information of the job.",
    "nullable":true
}

The schedule information of the job.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Provide job submission success or failure status and all possible errors.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Provide job submission success or failure status and all possible errors."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Provide job submission success or failure status and all possible errors."
}

Provide job submission success or failure status and all possible errors.

Back to Top