Jump to

• Request
• Response

Initiate a notification request

post

/fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/action/notificationRequest

When you initiate a notification request action, the notification request process generates a payload to initiate the human capital management (HCM) push notification API. The HCM push notification API sends a notification to the user's device.

Request

Path Parameters

• expenseReportsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Expense Reports resource and used to uniquely identify an instance of Expense Reports. The client should not generate the hash key value. Instead, the client should query on the Expense Reports collection resource in order to navigate to a specific instance of Expense Reports to get the hash key.

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

• params: object params
  Additional Properties Allowed: additionalProperties

  The payload with parameters sent to the human capital management (HCM) API.

{
    "type":"object",
    "properties":{
        "params":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The payload with parameters sent to the human capital management (HCM) API.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : params

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"The payload with parameters sent to the human capital management (HCM) API.",
    "nullable":true
}

The payload with parameters sent to the human capital management (HCM) API.

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
  If the request is successful, then this action returns a response code and response description of the human capital management (HCM) push notification API call.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the request is successful, then this action returns a response code and response description of the human capital management (HCM) push notification API call."
        }
    },
    "additionalProperties":false
}

Back to Top