Run all advanced controls
post
/fscmRestApi/resources/11.13.18.05/advancedControlsRuns
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/json
Root Schema : schema
Type:
Show Source
object
-
ControlId: string
Maximum Length:
255
The unique identifier of the advanced control. -
ControlType: string
Whether the job evaluates access or transaction controls.
-
JobRunId: string
The unique identifier of the job.
-
JobType: string
The type of job that's being run.
-
Message: string
The error message returned if input validation fails.
-
RunMode: string
Whether the job runs immediately or on a scheduled date. Possible values are Now and Execute-
.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : advancedControlsRuns-item-response
Type:
Show Source
object
-
ControlId: string
Maximum Length:
255
The unique identifier of the advanced control. -
ControlType: string
Whether the job evaluates access or transaction controls.
-
JobRunId: string
The unique identifier of the job.
-
JobType: string
The type of job that's being run.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Message: string
The error message returned if input validation fails.
-
RunMode: string
Whether the job runs immediately or on a scheduled date. Possible values are Now and Execute-
.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to create an advanced control job by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControlsRuns
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "ControlId": "10011", "RunMode": "RUN" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "ControlId": "10011", "ControlType": null, "RunMode": "RUN", "JobRunId": "2003", "Message": null, "JobType": null, "links": [ { "rel": "self", "href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControlsRuns/2003", "name": "advancedControlsRuns", "kind": "item" }, { "rel": "canonical", "href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControlsRuns/2003", "name": "advancedControlsRuns", "kind": "item" } ] }