Show TOC

Comments Collection (0..n)Locate this document in the navigation structure

Use

This collection relates to the Workflow task collection containing the approver comments.

When performing an action (for example, forwarding or claiming a task), the user has the option to add comments to the work item. These comments are saved in the SAP system as attachments and can be pulled during runtime as part of the collection's results.

The Comments entity contains the following properties:

Property Name

Description

WORKITEM_ID

Workflow item instance ID.

ID

Comment ID encoded in UTF8.

CREATOR_ID

ID of the user who created the comment.

CREATOR_NAME

Name of the user who created the comment.

CREATED_AT

Comment creation date.

TEXT

Comment content (in string format).

  • GET - To retrieve the Comments collection, perform a GET operation on the relevant URL.

To obtain the URL:

  1. On the SAP Gateway system, go to transaction SPRO, open the SAP Reference IMG and navigate to Start of the navigation path SAP NetWeaver Next navigation step SAP Gateway Next navigation step OData Channel Next navigation step Administration Next navigation step General Settings Next navigation step Activate and Maintain Services End of the navigation path.

  2. Select the Workflow service.

  3. Choose Call Browser.

  4. Navigate to WorkflowTaskCollection(<workitem_id>)/Comments.