Jump to

• Request
• Response

Update alert configuration

post

/hcmRestApi/resources/11.13.18.05/businessProcessUserAlertConfigurations/action/updateAlertConfiguration

Updates alert configuration for a specific transaction type.

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

• alertParams: object alertParams
  Additional Properties Allowed: additionalProperties

  Alert configuration related parameters as name value pairs.
• processId: string
  Identifier of the process for which alert configurations need to be updated.
• userConfigList: array userConfigList
  List of user specific alert configuration data.

{
    "type":"object",
    "properties":{
        "processId":{
            "type":"string",
            "description":"Identifier of the process for which alert configurations need to be updated.",
            "nullable":true
        },
        "alertParams":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Alert configuration related parameters as name value pairs.",
            "nullable":true
        },
        "userConfigList":{
            "type":"array",
            "description":"List of user specific alert configuration data.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : alertParams

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Alert configuration related parameters as name value pairs.",
    "nullable":true
}

Alert configuration related parameters as name value pairs.

Nested Schema : userConfigList

Type: array

List of user specific alert configuration data.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"List of user specific alert configuration data.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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
  Alert configuration update result. Return values are either success or failure.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Alert configuration update result. Return values are either success or failure."
        }
    },
    "additionalProperties":false
}

Back to Top