View Reconciliation Comments

Returns all the comments, including attachments, for the specified reconciliation.

REST Resource

GET       /armARCS/rest/{api_version}/period/{period}/reconciliation/{accountId}/comments

Required Roles

Service Administrator, Power User, User, Viewer

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request specific to this job.

Table 17-64 VIEW RECONCILIATION COMMENTS

Name	Description	Type	Required	Default
api_version	Version of the API you are working with: v1	Path	Yes	None
period	The name of the reconciliation's period	Path	Yes	None
accountId	The Account ID of the reconciliation for which comments must be retrieved	Path	Yes	None

Example URL

https:// <SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/armARCS/rest/v1/period/Jan 2022/reconciliation/101-BC2-Premapped/comments

Response

Supported Media Types: application/json

Example of Response Body

The following is an example of a reconciliation with one comment and two attachments.

[
    {
        "commentId": 100000002580008,
        "parentObjectId": 100000001956143,
        "commentText": "Please investigate the alert on the account. The Risk Rating has been increased.",
        "postedBy": "admin1",
        "postedDate": "Oct 6, 2022 4:03 PM",
        "carryForward": null,
        "references": [
            {
                "referenceId": 100000002580012,
                "type": "FILE",
                "url": null,
                "name": "adjustment1.pdf",
                "fileDownloadLink": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/arm/rest/fcmapi/v1/rc/references/100000002580012/file"
            },
            {
                "referenceId": 100000002580010,
                "type": "URL",
                "url": "https://www.my-example.com",
                "name": "my-example",
                "fileDownloadLink": null
            }
        ]
    }
]