Get Build Dependency Graph

Xray REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Get the complete dependency graph for a build

Security: Requires a valid user with the "Read" permission

Usage:POST /dependencyGraph/build

Consumes: application/json

{
 "build_name":"xray-test",
 "build_number":"157",
 "build_repo":"test-build-info",
 "project":"test"
}

Note

The build_repo and project keys are optional. If they are not specified, the default build repository and global scope are used.

Produces: application/json

{
  "build":{
    "name": "<The name of the build who's graph we are obtaining>",
    "path": "<artifactory-name/repo-name/path>",
    "pkg_type": "<Package type>",
    "sha256": "<Artifact's SHA256 checksum>",
    "component_id": "<The component ID>"
  },
  "components":[ 
    {
      "component_name":"<Dependency component name>",
      "component_id":"<Dependency Component ID>",
      "package_type":"<Dependency component package type>",
      "version":"<Dependency component version>",
      "created":"<ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)>",
      "modified":"<ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)>",
      "components":[] 
    }]
}

Sample Usage:

POST /dependencyGraph/build
{
 "build_name":"xray-test",
 "build_number":"157",
 "build_repo":"test-build-info",
 "project":"test"
}

{
    "build": {
        "name": "xray-test",
        "path": "default/test-build-info/xray-test",
        "pkg_type": "Build",
        "sha256": "2e3ccd8c1e952a30f2c2865c9130553bdb11b4ed49b81e6ab08f22a29f5d303b",
        "component_id": "[test-build-info]/xray-test:157"
    },
    "components": [
        {
            "component_name": "multi1-3.7-20230730.132458-7-sources.jar",
            "component_id": "org.jfrog.test:multi1:3.7-20230730.132458-7",
            "package_type": "Maven",
            "created": "2023-07-30T13:25:07Z"
        },
        {
            "component_name": "multi1-3.7-20230730.132458-7-tests.jar",
            "component_id": "org.jfrog.test:multi1:3.7-20230730.132458-7",
            "package_type": "Maven",
            "created": "2023-07-30T13:25:07Z"
        },
        {
            "component_name": "javax.mail:mail:1.4.jar",
            "component_id": "javax.mail:mail:1.4",
            "package_type": "Maven",
            "created": "2022-11-10T13:29:10Z"
        },
        {
            "component_name": "hsqldb:hsqldb:1.8.0.10.jar",
            "component_id": "hsqldb:hsqldb:1.8.0.10",
            "package_type": "Maven",
            "created": "2022-11-10T13:29:24Z"
        }
    ]
}

Response Codes:

200: Success

400: Build '<PATH>' doesn't exist or isn't indexed in Xray

400: Missing build name

400: Missing build number

400: Missing Artifactory ID

401: Bad credentials

415: Failed to parse request