Get Resource Versions

JFrog REST APIs

Content Type
REST API
ft:sourceType
Paligo

Description: Returns a collection of resourceVersions entities. Filter criteria can be supplied via query string parameters.

Security: Requires a valid user

Usage: GET /v1/resourceVersions

Produces: application/json

Parameters:

Query String Parameters:

Parameter

Type

Description

resourceVersionIds

String

A filter on the list based on the `id` property of the resourceVersions. Expects a comma separated string of ids.

resourceIds

String

A filter on the list based on the `resourceId` property of the resourceVersions. Expects a comma separated string of resourceIds.

createdByStepIds

String

A filter on the list based on the `createdByStepId` property of the resourceVersions. Expects a comma separated string of createdByStepIds.

createdByRunIds

String

A filter on the list based on the `createdByRunId` property of the resourceVersions. Expects a comma separated string of createdByRunIds.

pipelineSourceIds

String

A filter on the list based on the `pipelineSourceId` property of the resourceVersions. Expects a comma separated string of pipelineSourceIds.

sortBy

String

The resourceVersion properties to sort the results by. Expects a comma separated list of sorters.

sortOrder

Integer

A sort order based on the `sortBy` defined. If `1`, sorts the list in ascending order. If `-1`, sorts the list in descending order.

limit

Integer

A limit on the number of resourceVersions returned.

skip

Integer

A cursor for use in pagination. `skip` defines the number of resourceVersions skipped.

Request Parameters: Ignored

Response Body:

An array of resourceVersions that satisfy all of the supplied query parameters. Returns all resourceVersions if no query parameters are supplied.

[
    {
        "contentPropertyBag": {
            "path": "tla/ymlTest",
            "sha": "9ddc1f76iy8076j83b4601493ebc7e",
            "shaData": {
                "providerDomain": "github.com",
                "branchName": "master",
                "isPullRequest": false,
                "isPullRequestClose": false,
                "pullRequestNumber": null,
                "pullRequestBaseBranch": null,
                "commitSha": "9ddc1f76iy8076j83b4601493ebc7e",
                "beforeCommitSha": "57bc23e5ba30a7ijh9087jhb7755e31f3",
                "commitUrl": "https://github.com/tla/ymlTest/commit/9ddc1f76iy8076j83b4601493ebc7e",
                "commitMessage": "Update pipelines.yml",
                "baseCommitRef": "",
                "headPROrgName": "",
                "compareUrl": "https://github.com/tla/ymlTest/compare/57bc23e5ba30a7ijh9087jhb7755e31f3...9ddc1f76iy8076j83b4601493ebc7e",
                "skipDecryption": false,
                "isGitTag": false,
                "gitTagName": null,
                "gitTagMessage": null,
                "isRelease": false,
                "releaseName": null,
                "releaseBody": null,
                "releasedAt": null,
                "isPrerelease": false,
                "pullRequestRepoFullName": null,
                "changeId": null,
                "changeSha": null,
                "eventType": null,
                "patchSetNumber": null,
                "changeSubject": null,
                "providerSshPort": null,
                "changeOwner": {},
                "providerUrl": null,
                "committer": {
                    "email": "noreply@github.com",
                    "login": "web-flow",
                    "displayName": "GitHub",
                    "avatarUrl": "https://avatars3.githubusercontent.com/u/13454447?v=4"
                },
                "lastAuthor": {
                    "email": "speedblaze@gmail.com",
                    "login": "ChaitanyaVootla",
                    "displayName": "Vootla Chaitanya",
                    "avatarUrl": "https://avatars0.githubusercontent.com/u/8678710?v=4"
                },
                "triggeredBy": {}
            },
            "commitSha": "9ddc1f76iy8076j83b4601493ebc7e",
            "isPullRequest": false,
            "isPullRequestClose": false,
            "pullRequestNumber": null,
            "branchName": "master",
            "pullRequestBaseBranch": null,
            "beforeCommitSha": "57bc23e5ba30a7ijh9087jhb7755e31f3",
            "commitUrl": "https://github.com/ChaitanyaVootla/ymlTest/commit/9ddc1f76iy8076j83b4601493ebc7e",
            "commitMessage": "Update pipelines.yml",
            "baseCommitRef": "",
            "compareUrl": "https://github.com/ChaitanyaVootla/ymlTest/compare/57bc23e5ba30a7ijh9087jhb7755e31f3...9ddc1f76iy8076j83b4601493ebc7e",
            "isGitTag": false,
            "gitTagName": null,
            "gitTagMessage": null,
            "isRelease": false,
            "releaseName": null,
            "releaseBody": null,
            "releasedAt": null,
            "isPrerelease": false,
            "lastAuthorLogin": "tla",
            "lastAuthorEmail": "speze@gmail.com",
            "committerLogin": "web-flow"
        },
        "id": 14,
        "projectId": 1,
        "pipelineSourceId": 2,
        "resourceId": 21,
        "createdByStepId": null,
        "createdByRunId": null,
        "createdAt": "2021-01-11T05:50:04.598Z",
        "updatedAt": "2021-01-11T05:50:04.598Z"
    }
]

Response Codes:

200: Success