Jump to

• Request
• Response

Get comments and attachments of a transaction

post

/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/fetchCommentsAttachments

Gets comments and attachments of a transaction for which the identification key is passed.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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

• identificationKey: string
  Custom key to identify a set of tasks for which comments and attachments need to be retrieved.
• rootTaskId: string
  Identifier of the root task of the transaction for which comments and attachments need to be retrieved.

{
    "type":"object",
    "properties":{
        "identificationKey":{
            "type":"string",
            "description":"Custom key to identify a set of tasks for which comments and attachments need to be retrieved.",
            "nullable":true
        },
        "rootTaskId":{
            "type":"string",
            "description":"Identifier of the root task of the transaction for which comments and attachments need to be retrieved.",
            "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): array result
  Returns comments and attachments of a transaction.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"array",
            "description":"Returns comments and attachments of a transaction.",
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: array

Returns comments and attachments of a transaction.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Returns comments and attachments of a transaction.",
    "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