Jump to

• Request
• Response
• Examples

Get a status

post

/fscmRestApi/resources/11.13.18.05/advancedControlsRolesProvisioning/action/getRequestStatus

Returns the status of the provisioning simulation request. When the status is Completed, call the Get all results action. This returns conflicts a user will have if the requested roles and data are granted. Results include the control ID and control name, the requested role and its incident path, as well as the roles it conflicts with.

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

• requestId: number
  Unique ID assigned to the provisioning simulation request.

{
    "type":"object",
    "properties":{
        "requestId":{
            "type":"number",
            "description":"Unique ID assigned to the provisioning simulation request.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

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): string
  The status of the provisioning simulation request. Statuses include Started, Completed, Failed, and Queued.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The status of the provisioning simulation request. Statuses include Started, Completed, Failed, and Queued."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

The following example shows how to retrieve a status by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControlsRolesProvisioning/action/getRequestStatus

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
    "requestId": "1"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "result": "<Running>|<Job Completed>|<Canceled>"
}

Back to Top