Get the promotion history

get/projects/{projectName}/promotions

Returns the promotion history of a project.

Request Samples

1

Response Samples

1{
2 "projectName": "a_project_name",
3 "versions": [
4 {
5 "operation": "CREATE_VERSION",
6 "version": 1,
7 "level": 1,
8 "createdOn": 1682074612,
9 "createdByName": "a_user",
10 "createdByEmail": "a_user@company.com",
11 "commitDetails": {
12 "type": "MAJOR_VERSION",
13 "notes": "Creating a new version",
14 "tags": [
15 "tag1",
16 "tag2"
17 ],
18 "version": 1,
19 "level": 1
20 }
21 },
22 {
23 "operation": "PROMOTE_LEVEL",
24 "version": 1,
25 "level": 2,
26 "createdOn": 1682074613,
27 "createdByName": "a_user",
28 "createdByEmail": "a_user@company.com",
29 "commitDetails": {
30 "type": "PROMOTE",
31 "notes": "Promoting a project version to Test",
32 "tags": [
33 "tag1",
34 "tag2"
35 ],
36 "version": 1,
37 "level": 2
38 }
39 },
40 {
41 "operation": "PROMOTE_LEVEL",
42 "version": 1,
43 "level": 3,
44 "createdOn": 1682074614,
45 "createdByName": "a_user",
46 "createdByEmail": "a_user@company.com",
47 "commitDetails": {
48 "type": "PROMOTE",
49 "notes": "Promoting a project version to Production",
50 "tags": [
51 "tag1",
52 "tag2"
53 ],
54 "version": 1,
55 "level": 3
56 }
57 },
58 {
59 "operation": "CREATE_VERSION",
60 "version": 2,
61 "level": 1,
62 "createdOn": 1682074616,
63 "createdByName": "a_user",
64 "createdByEmail": "a_user@company.com",
65 "commitDetails": {
66 "type": "MAJOR_VERSION",
67 "notes": "Creating a new version",
68 "tags": [
69 "tag1",
70 "tag2"
71 ],
72 "version": 2,
73 "level": 1
74 }
75 }
76 ]
77}

Path Parameters

NameTypeRequiredDescription
projectName
string
true

The project name.

Query Parameters

NameTypeRequiredDescription
filter
string
false

The filter parameter.

forVersion
integer<int32>
false

If specified, then returns the history for this version of the project only. If this parameter is not provided, returns the history for all versions for the project.

includeNotes
boolean
false

If true, then returns the version notes for each version. If false or not specified, returns just the version numbers with empty notes.

Responses

StatusMeaningDescription
200OK

The response contains the version history of the project.

HeadersSchema
401Unauthorized

The request is not authenticated.

Schema
403Forbidden

The user did not have the necessary permissions.

Schema
404Not Found

The project does not exist.

Schema
500Internal Server Error

An internal error has occurred during project versioning. See the application logs for more details.

Schema
503Service Unavailable

Functionality for project packages is not enabled, or functionality for project versions is not enabled.

Schema