Jump to

• Request
• Response

Get BIP notification content for a report

post

/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/getBIPContent

Gets BIP notification content for a given report metadata and report parameter values.

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

• reportMetaData: object reportMetaData
  Additional Properties Allowed: additionalProperties

  Metadata such as the path of the BIP report, format in which BIP content needs to be fetched.
• reportParameters: object reportParameters
  Additional Properties Allowed: additionalProperties

  Report parameters in the form of key value pairs.

{
    "type":"object",
    "properties":{
        "reportMetaData":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Metadata such as the path of the BIP report, format in which BIP content needs to be fetched.",
            "nullable":true
        },
        "reportParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Report parameters in the form of key value pairs.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : reportMetaData

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Metadata such as the path of the BIP report, format in which BIP content needs to be fetched.",
    "nullable":true
}

Metadata such as the path of the BIP report, format in which BIP content needs to be fetched.

Nested Schema : reportParameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Report parameters in the form of key value pairs.",
    "nullable":true
}

Report parameters in the form of key value pairs.

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 (byte)
  Returns BIP notification content.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Returns BIP notification content.",
            "format":"byte"
        }
    },
    "additionalProperties":false
}

Back to Top