Retrieve artifacts related to a risk

This article shows how to use the ADOXX API to retrieve an object's outgoing or incoming relations of a certain type.

The Java snippet below will retrieve the relations from other objects that point to a risk whose ID we already know (e.g. retrieved via a search query).

note

The Java snippet below uses Basic Authentication.

Replace the values in angle brackets with values that fit your setup, e.g. instead of <HOST> use the host at which you access your ADOXX instance.

Click to view the code!

Source Code

public class GetRelatedArtifacts
{
  public static void main (final String [] args) throws ClientProtocolException, IOException
  {
    final CloseableHttpClient aClient = HttpClients.createDefault ();
    
    final String sUser = "<USER>";
    final String sPass = "<PASSWORD>";
    final String sRepoID = "<REPO_ID>";
    final String sObjectID = "<OBJECT_ID>";
    final String sDirection = "incoming";
    final String sRelClass = "RC_RISK_R";
    final String sPath = "http://<HOST>:<PORT>/ADOGRC/rest/2.0/repos/" + sRepoID + "/objects/"+sObjectID+"/relations/"+sDirection+"/"+sRelClass;
    
    final HttpGet aMethod = new HttpGet(sPath);
        
    // The headers controlling the return type and the language do not have to be considered for
    // token generation
    aMethod.addHeader ("Accept", "application/json");
    aMethod.addHeader ("Accept-Language", "en");
    
    // Construction of the header to pass the basic authentication information
    aMethod.addHeader ("Authorization",
                       "Basic " +
                           DatatypeConverter.printBase64Binary ((sUser + ":" + sPass).getBytes ()));
    
    final CloseableHttpResponse aResponse = aClient.execute (aMethod);
    
    try
    {
      final String sResult = EntityUtils.toString (aResponse.getEntity (), "UTF-8");
      final StatusLine aStatusLine = aResponse.getStatusLine ();
      System.out.println ("Status Code: " + aStatusLine.getStatusCode ());
      System.out.println ("Result: \n" + sResult);
    }
    catch (final Exception aEx)
    {
      aEx.printStackTrace ();
    }
    finally
    {
      aResponse.close ();
    }
  }
}

The result should look similar to the following:

Status Code: 200
Result:
{
  "locale":"en",
  "rest_links":[ ... ],
  "relations":
  [
    {
      "rest_links":[ ... ],
      "from":
      {
        "rest_links":[ ... ],
        "id":" ... ",
        "metaName":" ... ",
        "name":"sourceObject",
        "type":" ... ",
        "artefactType":"REPOSITORY_OBJECT"
      },
      "to":
      {
        "rest_links":[ ... ],
        "id":" ... ",
        "metaName":"C_RISK",
        "name":"myRisk",
        "type":" ... ",
        "artefactType":"REPOSITORY_OBJECT"
      },
      "attributes":[ ... ]
    }
  ]
}