Description: Returns the requested data for the Release Bundle v2 version defined by the One Model GraphQL query.
Since: 7.111.4
Security: Requires a valid token; requires Read permissions to the subject repository
Note
When using One Model GraphQL, make sure your token audience is configured as wildcard, or *@*
. For more information, see Create Token.
Usage: POST /onemodel/api/v1/graphql
Sample query based on 'repositoryKey' in GraphQL format:
{
releaseBundleVersion {
getVersion(
repositoryKey: "jfmd-release-bundles-v2"
name: "metadata"
version: "7.162.0"
) {
createdBy
createdAt
evidenceConnection(first: 3) {
totalCount
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
}
edges {
cursor
node {
name
createdAt
createdBy
verified
signingKey {
alias
}
predicateSlug
}
}
}
artifactsConnection(first: 3) {
totalCount
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
}
edges {
cursor
node {
path
name
sha256
sourceRepositoryPath
packageType
packageName
packageVersion
size
properties {
key
values
}
evidenceConnection {
totalCount
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
}
edges {
cursor
node {
name
createdAt
createdBy
verified
signingKey {
alias
}
predicateSlug
}
}
}
}
}
}
fromBuilds {
name
number
startedAt
repositoryKey
evidenceConnection(first: 3) {
totalCount
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
}
edges {
cursor
node {
name
createdAt
createdBy
verified
signingKey {
alias
}
predicateSlug
}
}
}
}
}
}
}
Sample query based on 'project' in GraphQL format:
{
releaseBundleVersion {
getVersion(
projectKey: "jfmd"
name: "metadata"
version: "7.162.0"
) {
createdBy
createdAt
// etc... [see sample above]
}
Query Criteria
The query uses the following criteria to determine which Release Bundle version to include in the response:
Field | Subfield | Mandatory/Optional | Description |
---|---|---|---|
|
| The criteria that define which Release Bundle v2 version to return. | |
|
| optional | The repository key that contains the Release Bundle version, |
|
| optional | The project key to which the Release Bundle version belongs. ImportantYou must define either the However, if both are defined, only the |
|
| optional | The name of the Release Bundle version. |
| optional | The Release Bundle version. |
Fields to Return
The search query can include one or more of the following fields, which determine the data fields to return from the Release Bundle version:
Field | Description |
---|---|
| The user who created the Release Bundle version. |
| The timestamp of when the Release Bundle version was created. |
| Information about evidence related to the Release Bundle. For complete details, see Search Evidence. |
| Information related to the artifacts in the Release Bundle. See Artifacts (artifactsConnection). |
| Information related to the builds from which the Release Bundle was created (where applicable). See Builds (fromBuilds). |
Artifacts (artifactsConnection)
The artifactsConnection
section of the request returns the following fields about the artifacts in the Release Bundle version:
Field | Description |
---|---|
| The artifact path inside the Release Bundle. |
| The artifact name. |
| The SHA256 of the artifact. |
| The source path from which the artifact was added to the Release Bundle. |
| The package type of the package to which the artifact belongs. |
| The name of the package to which the artifact belongs. |
| The version of the package to which the artifact belongs. |
| The artifact size. |
| User-defined properties defined for the artifact. |
| Information related to the evidence associated with each artifact. For more details about evidence, see Search Evidence. |
Builds (fromBuilds)
When the Release Bundle version is based on a build, the fromBuilds
section returns the following fields about the build:
Property | Description |
---|---|
| The build name. |
| The build number. |
| The timestamp of when the build was started. |
| The repository that contains the build info. |
| Information related to the evidence associated with each artifact. For more details about evidence, see Search Evidence. |
Note
For details about fields that are common across all One Model domains, see One Model GraphQL Common Patterns and Conventions.
Sample Response
{ "data": { "releaseBundleVersion": { "getVersion": { "projectKey": "rtpkg" "name": "package_handler" "version": "5.95.0" "createdBy": "devf-auto-pipelines", "createdAt": "2025-03-23T00:35:13.328Z", "evidenceConnection": { "totalCount": 4, "pageInfo": { "hasNextPage": true, "hasPreviousPage": false, "startCursor": "ZXZpZGVuY2U6MQ==", "endCursor": "ZXZpZGVuY2U6Mw==" }, "edges": [ { "cursor": "ZXZpZGVuY2U6MQ==", "node": { "name": "cyclonedx-sbom-1742690121339.json", "createdAt": "2025-03-23T00:35:21.015Z", "createdBy": "jfxr@01g8dfvqf7z5czyd2e95bdar83", "verified": true, "signingKey": { "alias": "rbv2-gpg-key" }, "predicateSlug": "cyclonedx-sbom" } }, { "cursor": "ZXZpZGVuY2U6Mg==", "node": { "name": "cyclonedx-vex-1742690121379.json", "createdAt": "2025-03-23T00:35:21.061Z", "createdBy": "jfxr@01g8dfvqf7z5czyd2e95bdar83", "verified": true, "signingKey": { "alias": "rbv2-gpg-key" }, "predicateSlug": "cyclonedx-vex" } }, { "cursor": "ZXZpZGVuY2U6Mw==", "node": { "name": "promotion-1742690117602.json", "createdAt": "2025-03-23T00:35:17.602Z", "createdBy": "devf-auto-pipelines", "verified": true, "signingKey": { "alias": "rbv2-gpg-key" }, "predicateSlug": "promotion" } } ] }, "artifactsConnection": { "totalCount": 151, "pageInfo": { "hasNextPage": true, "hasPreviousPage": false, "startCursor": "YXJ0aWZhY3Q6MQ==", "endCursor": "YXJ0aWZhY3Q6Mw==" }, "edges": [ { "cursor": "YXJ0aWZhY3Q6MQ==", "node": { "path": "package_handler/5.95.0/artifacts/maven/com/jfrog/ph/ph-npm/5.95.0", "name": "ph-npm-5.95.0.jar", "packageType": "maven", "sourceRepositoryPath": "dev-releases-maven-local/com/jfrog/ph/ph-npm/5.95.0/ph-npm-5.95.0.jar", "evidenceConnection": { "totalCount": 0, "pageInfo": { "hasNextPage": false, "hasPreviousPage": false, "startCursor": null, "endCursor": null }, "edges": null } } }, { "cursor": "YXJ0aWZhY3Q6Mg==", "node": { "path": "package_handler/5.95.0/artifacts/maven/com/jfrog/ph/ph-npm/5.95.0", "name": "ph-npm-5.95.0.pom", "packageType": "maven", "sourceRepositoryPath": "dev-releases-maven-local/com/jfrog/ph/ph-npm/5.95.0/ph-npm-5.95.0.pom", "evidenceConnection": { "totalCount": 0, "pageInfo": { "hasNextPage": false, "hasPreviousPage": false, "startCursor": null, "endCursor": null }, "edges": null } } }, { "cursor": "YXJ0aWZhY3Q6Mw==", "node": { "path": "package_handler/5.95.0/artifacts/maven/com/jfrog/ph/package-handler-acl/5.95.0", "name": "package-handler-acl-5.95.0-packages-swagger.json", "packageType": "maven", "sourceRepositoryPath": "dev-releases-maven-local/com/jfrog/ph/package-handler-acl/5.95.0/package-handler-acl-5.95.0-packages-swagger.json", "evidenceConnection": { "totalCount": 0, "pageInfo": { "hasNextPage": false, "hasPreviousPage": false, "startCursor": null, "endCursor": null }, "edges": null } } } ] }, "fromBuilds": [ { "name": "package-handler-build-release", "number": "5.95.0-20250322232601-1", "startedAt": "2025-03-22T23:32:29.229Z", "evidenceConnection": { "totalCount": 1, "pageInfo": { "hasNextPage": false, "hasPreviousPage": false, "startCursor": "ZXZpZGVuY2U6MQ==", "endCursor": "ZXZpZGVuY2U6MQ==" }, "edges": [ { "cursor": "ZXZpZGVuY2U6MQ==", "node": { "name": "predicatetype-1742719269605.json", "createdAt": "2025-03-23T08:41:00.894Z", "createdBy": "shays", "verified": false, "signingKey": null, "predicateSlug": "predicatetype" } } ] } } ] } } } }
Status Codes:
Code | Description |
---|---|
200 | OK |
401 | Bad Credentials |
403 | Permission Denied |