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

      Upload Attachments to Entities

      < All Topics

      Overview

      Uploads attachments to entities, that are mentioned in a comment.

      attach.svg

      Example Scenarios

      1. Upload logs or attach a report to security scan and a bug opened from any system
      2. Attach build report to an entity

      Request

      The request URL should contains the system ID, this can be copied from the DevOps Process definition page.

      PODT /api/v1.0/app/DevOpsGate/Enrich/{DevOpsProjectID}/Attachment

      The payload should be in form-data or x-www-form-urlencoded

      ParameterDescription
      commentsComment which contains the entity ids to update with #{Entity ID} for example “String with updated entity keys is ready for other DevOps Gate APIs, #CLS-3933, #CLS-3938”
      attachmentsA file blob with first attachment
      attachmentsIf another attachment is needed add it as parameter with the same name

      Response

      This is the response for the comment “String with updated entity keys is ready for other DevOps Gate APIs, #CLS-3933, #CLS-3938”.

      {
          "updatedEntitiesID": [
              {
                  "systemID": "10",
                  "entityKeys": [
                      {
                          "entityKey": "CLS-3933",
                          "attachmentsID": [
                              "32013"
                          ]
                      },
                      {
                          "entityKey": "CLS-3938",
                          "attachmentsID": [
                              "32014"
                          ]
                      }
                  ]
              }
          ],
          "errors": [],
          "warnings": []
      }
      ParameterDescription
      updatedEntitiesIDAn array of updated entities
      SystemIDThe System where the entities were created
      entityKeysThe entities keys updated , the entity id and the attachment id created
      ErrorErrors which has occurred during adding attachment
      WarningWarnings which has occurred during adding attachment

      Step By Step Instructions

      1. Create a DevOps Gate Process
      2. Create two entities in a target system that should be updated by the DevOps Gate
      1. Go to the DevOps Gate Process Configuration and add 2 allowed projects (for sake of demonstration of update entities from different projects)
      2. Press the How It Works link
      1. Select Upload Attachments
      2. Copy CURL
      1. Paste into a Command Line. Set entity keys of the entities created upper and execute
      1. To all entities from a commits were uploaded attachments
      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