Add a Comment to Entities

Overview

The following article explains how to add a comment to any work system entity, the comment can contain information regarding the Build | Release like it’s URL

Usage Examples

1. Add build URL and comment to work system entities comments
2. Add Security | Quality Test URL to work system entities comments

Request

POST /api/v1.0/app/DevOpsGate/Enrich/{DevOpsGateProcessID}?action=comment

[
	{
		"eventRelativeURL": "/relative/url/path",
		"comments": "String with entities unique identifiers from the target system to add comments or remote link. For example, this is a comment in some commit. Need to update entities #sys1-12345, #sys2-SYN-123",
		"commentLinkOrRelationTitle": "Build was triggered in Jenkins"
	}
]

Response

{
    "updatedEntitiesID": [
        {
            "systemID": "10",
            "entityKeys": [
                "CLS-3938",
                "CLS-3933"
            ]
        }
    ],
    "errors": [],
    "warnings": []
}

Step By Step Instructions

1. Create a DevOps Gate Process
2. Create three entities in a target system that should be updated by the DevOps Gate

3. Navigate to the DevOps Gate Process Configuration and press the How It Works link

4. Select add comment
5. Copy the CURL command as shown in the dialog

6. Paste into a Command Line. Set entities keys of the entities created upper and execute

7. A comment was added to all entities