Get Release Bundle v2 Version Promotions

JFrog REST APIs

Products

JFrog Xray

Content Type

REST API

ft:sourceType

Paligo

Description: Returns the details of all promotions for the specified Release Bundle v2 version. All promotion records are provided regardless of status, including failed attempts.

Since: 7.63.2

Security: Requires Read permissions to the target Release Bundle path.

Usage:GET /lifecycle/api/v2/promotion/records/{name}/{version}

Query Parameters (optional):

Field	Type	Description
`include {messages}`	string	Returns any error messages generated when creating the promotion.
`offset`	integer	Sets the number of records to skip before returning the query response. Used for pagination purposes.
`limit`	integer	Sets the maximum number of versions to return at one time. Used for pagination purposes.
`filter_by`	string	Defines a filter for the list of promotions.
`order_by {created\|created_millis\|created_by\|environment}`	string	Defines the criterion by which to order the list of promotions: `created` (standard timestamp or milliseconds), `created_by`, `environment`
`order_asc {true\|false}`	boolean	Defines whether to list the promotions in ascending (true) or descending (false) order. The default value is `false`.

Note

See Common Optional Query Parameters for additional query parameters that are available for all Release Lifecycle Management APIs.

Request Body: {none}

Sample Response:

{
    "promotions": [
        {
            "status": "FAILED",
            "repository_key": "release-bundles-v2",
            "release_bundle_name": "Commons-Bundle",
            "release_bundle_version": "1.0.0",
            "environment": "QA",
            "service_id": "jfrt@01h0nvs1pwjtzs15x7kbtv1sve",
            "created_by": "admin",
            "created": "2023-05-19T06:47:56.518Z",
            "created_millis": 1684478876518,
            "xray_retrieval_status": "NOT_APPLICABLE",
            "messages": [
                {
                    "text": "Target artifact already exists: commons-qa-generic-local/commons/release-notes-1.0.0.txt"
                }
            ]
        },
        {
            "status": "COMPLETED",
            "repository_key": "release-bundles-v2",
            "release_bundle_name": "Commons-Bundle",
            "release_bundle_version": "1.0.0",
            "environment": "QA",
            "service_id": "jfrt@01h0nvs1pwjtzs15x7kbtv1sve",
            "created_by": "admin",
            "created": "2023-05-19T06:21:44.916Z",
            "created_millis": 1684477304916,
            "xray_retrieval_status": "NOT_APPLICABLE"
        }
    ],
    "total": 2,
    "limit": 1000,
    "offset": 0
}

The response includes the following information:

Property	Description
`status`	Status of the promotion: SUBMITTED, STARTED, PENDING, FAILED, REJECTED
`repository_key`	Unique identifier for the Release Bundles repository.
`release_bundle_name`	Name of the Release Bundle.
`release_bundle_version`	Release Bundle version.
`environment`	Name of the target environment for the promotion.
`service_id`	The unique identifier of the Artifactory instance where the Release Bundle was promoted.
`created_by`	Name of the user who initiated the promotion.
`created`	Timestamp when the promotion was created (ISO 8601 standard).
`created_millis`	Timestamp when the promotion was created in milliseconds.
`xray_retrieval_status`	The current status of the processing of this promotion by Xray.
`messages`	(Optional) Error messages related to the processing of the operation.
`total`	The total number of promotions for the specified Release Bundle version.
`limit`	Defines the maximum number of versions returned at one time. Used for pagination purposes.
`offset`	Sets the number of records that are skipped before returning the query response. Used for pagination purposes.

Status Codes:

Code	Description
200	Fetched
401	Bad Credentials
403	Permission Denied