How Can We Help?

Search for answers or browse our knowledge base.

Recent Comments

    Archives

      Solutions

      Docs

      Contact

      SYNCNOW

      SyncNow logo SyncNow – connect teams , tools and processes

      Add a Comment to Entities

      < All Topics

      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
      ParameterDescription
      eventRelativeURLa relative URL from the source system to which to add a link from a comment in a target
      commentLinkOrRelationTitle Optionally for the link title
      commentsString 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
      [
      	{
      		"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

      ParameterDescription
      updatedEntitiesIDList of Updated entity IDs
      systemIDThe target system id where entities updated
      entityKeysThe updated entities keys
      ErrorErrors which has occurred during the update process
      WarningWarnings which has occurred during the update process
      {
          "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
      1. Navigate to the DevOps Gate Process Configuration and press the How It Works link
      1. Select add comment
      2. Copy the CURL command as shown in the dialog
      1. Paste into a Command Line. Set entities keys of the entities created upper and execute
      1. A comment was added to all entities
      Was this article helpful?
      0 out of 5 stars
      5 Stars 0%
      4 Stars 0%
      3 Stars 0%
      2 Stars 0%
      1 Stars 0%
      5
      How can we improve this article?
      Please submit the reason for your vote so that we can improve the article.
      Table of Contents
      Skip to content