Jump to

• Request
• Response
• Examples

Get global publish request status

post

/crmRestApi/resources/11.13.18.05/accessGroupRules/action/getGlobalPublishRequestStatus

This operation helps admin to check the status of global publish based on ESS Request Id.

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

• essRequestID: number
  This is input paraemeter (ESS Request Id) for the action.

{
    "type":"object",
    "properties":{
        "essRequestID":{
            "type":"number",
            "description":"This is input paraemeter (ESS Request Id) for the action.",
            "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
  Return value will be based on the status of ESS Request Id.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Return value will be based on the status of ESS Request Id."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

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

cURL Command

curl -u <username:password> \
 -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/action/getGlobalPublishRequestStatus
  \
 -H 'Content-Type: application/vnd.oracle.adf.action+json'  | json_pp

Example of Request Body

The following shows the contents of the request body in JSON format.

{
"essRequestID":123
}

Example of Response Body

The following shows the contents of the response body in JSON format.

{
    "result": "CANCELLED"
}

Back to Top