Service-level Package Methods
Administrator rights for the service are required to use these methods.
Method to Get All Service Packages
GET /registry/package
The request returns a list of service packages, with options to configure the number of objects displayed per page.
Responses
STATUS 200 Example JSON:
Example Response
{
"_embedded": {
"simplePackageInfoModelList": [
{
"id": "23920af6-aaaa-aaaa-aaaa-396811188f65",
"name": "Package",
"version": "1.0.0",
"groupId": "group",
"artifactId": "artefact",
"type": "generic",
"ownerUuid": "",
"ownerType": "GLOBAL"
},
{
"id": "deb52e29-aaaa-aaaa-aaaa-737eac0eb8f7",
"name": "Example",
"version": "1.0.3",
"groupId": "example",
"artifactId": "example",
"type": "nuget",
"ownerUuid": "",
"ownerType": "GLOBAL"
}
]
},
"page": {
"size": 10,
"totalElements": 2,
"totalPages": 1,
"number": 0
}
}
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Get Service Package by UUID
GET /registry/package/{packageUuid}
The request returns information about a service package.
| Path Variable | Type | Description |
|---|---|---|
packageUuid |
String | Package identifier |
Responses
STATUS 200 Example JSON:
Example Response
{
"id": "7eeda8b0-aaaa-aaaa-aaaa-bd1fed06bf95",
"name": "Package",
"version": "1.0.1",
"groupId": "Package",
"artifactId": "Package",
"type": "generic",
"ownerUuid": "",
"ownerType": "GLOBAL"
}
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Get List of Service Package Versions
GET /registry/package/{packageUuid}/version-list
The request returns information about package versions and their contents, with options to configure the number of objects displayed per page.
| Path Variable | Type | Description |
|---|---|---|
packageUuid |
String | Package identifier |
Responses
STATUS 200 Example JSON:
Example Response
{
"_embedded": {
"simplePackageVersionModelList": [
{
"id": "fb97db0e-aaaa-aaaa-aaaa-9a95f4f36e9a",
"baseVersion": "1.2.3",
"version": "1.2.3",
"lowerVersion": "1.2.3",
"downloadCount": 12,
"languageVersion": null,
"packageUploadType": "MANUALLY",
"packageFiles": [
{
"id": "6dd3bea5-aaaa-aaaa-aaaa-c49a0025279c",
"name": "gitflic-helper",
"size": 631382,
"hashMd5": "518e87b56adeaaaaaaaa9b6575399e1e",
"hashSHA1": "d06a0844f92daaaaaaaaaaaaaaaa275c448ce0e1",
"hashSHA256": "ad98cee24564aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac56a27d22ac1",
"packageUploadType": "MANUALLY",
"createdAt": "2024-08-01T06:57:07.150295"
}
],
"internal": null
},
{
"id": "800cad33-aaaa-aaaa-aaaa-8ba5864b4914",
"baseVersion": "2.4.7",
"version": "2.4.7",
"lowerVersion": "2.4.7",
"downloadCount": 31,
"languageVersion": null,
"packageUploadType": "API",
"packageFiles": [
{
"id": "684068a6-aaaa-aaaa-aaaa-bebea0e2b46a",
"name": "gitflic.ssh",
"size": 4325,
"hashMd5": "d41d8cd98f00aaaaaaaa0998ecf8427e",
"hashSHA1": "da39a3ee5e6baaaaaaaaaaaaaaaa1890afd80709",
"hashSHA256": "e3b0c44298fcaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa991b7852b855",
"packageUploadType": "API",
"createdAt": "2024-07-31T14:02:49.393146"
}
],
"internal": null
}
]
},
"page": {
"size": 10,
"totalElements": 2,
"totalPages": 1,
"number": 0
}
}
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Get Service Package Version
GET /registry/package/{packageUuid}/{packageVersion}
The request returns information about a package version and its contents.
| Path Variable | Type | Description |
|---|---|---|
packageUuid |
String | Package identifier |
packageVersion |
String | Package version |
Responses
STATUS 200 Example JSON:
Example Response
{
"id": "fb97db0e-aaaa-aaaa-aaaa-9a95f4f36e9a",
"baseVersion": "1.2.3",
"version": "1.2.3",
"lowerVersion": "1.2.3",
"downloadCount": 12,
"languageVersion": null,
"packageUploadType": "MANUALLY",
"packageFiles": [
{
"id": "6dd3bea5-aaaa-aaaa-aaaa-c49a0025279c",
"name": "gitflic-helper",
"size": 631382,
"hashMd5": "518e87b56adeaaaaaaaa9b6575399e1e",
"hashSHA1": "d06a0844f92daaaaaaaaaaaaaaaa275c448ce0e1",
"hashSHA256": "ad98cee24564aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac56a27d22ac1",
"packageUploadType": "MANUALLY",
"createdAt": "2024-08-01T06:57:07.150295"
}
],
"internal": null
}
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Get Service Package Contents
GET /registry/package/{packageUuid}/package-file
The request returns information about the contents of different package versions, with options to configure the number of objects displayed per page.
| Path Variable | Type | Description |
|---|---|---|
packageUuid |
String | Package identifier |
Responses
STATUS 200 Example JSON:
Example Response
{
"_embedded": {
"simplePackageFileModelList": [
{
"id": "6dd3bea5-aaaa-aaaa-aaaa-c49a0025279c",
"name": "gitflic-helper",
"size": 631382,
"hashMd5": "518e87b56adeaaaaaaaa9b6575399e1e",
"hashSHA1": "d06a0844f92daaaaaaaaaaaaaaaa275c448ce0e1",
"hashSHA256": "ad98cee24564aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac56a27d22ac1",
"packageUploadType": "MANUALLY",
"createdAt": "2024-08-01T06:57:07.150295"
},
{
"id": "684068a6-aaaa-aaaa-aaaa-bebea0e2b46a",
"name": "gitflic.ssh",
"size": 4325,
"hashMd5": "d41d8cd98f00aaaaaaaa0998ecf8427e",
"hashSHA1": "da39a3ee5e6baaaaaaaaaaaaaaaa1890afd80709",
"hashSHA256": "e3b0c44298fcaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa991b7852b855",
"packageUploadType": "API",
"createdAt": "2024-07-31T14:02:49.393146"
}
]
},
"page": {
"size": 10,
"totalElements": 2,
"totalPages": 1,
"number": 0
}
}
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Get Generic Package Content
GET /registry/package/generic/{packageName}/{packageVersion}/{fileName}
The request returns a file from a generic package.
| Path Variable | Type | Description |
|---|---|---|
packageName |
String | Package name |
packageVersion |
String | Package version |
fileName |
String | File name |
Responses
STATUS 200 - Package content received.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Update Generic Package Content
PUT /registry/package/generic/{packageName}/{packageVersion}/{fileName}
The request uploads an attached file to the specified version of a generic package. This method can be used to create a new package version or the package itself if non-existing data is specified.
| Path Variable | Type | Description |
|---|---|---|
packageName |
String | Package name |
packageVersion |
String | Package version |
fileName |
String | File name |
Responses
STATUS 200 - Package uploaded.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Get PyPI Package Content
GET /registry/package/pypi/{packageName}/{packageVersion}/{fileName}
The request returns a file from a PyPI package.
| Path Variable | Type | Description |
|---|---|---|
packageName |
String | Package name |
packageVersion |
String | Package version |
fileName |
String | File name |
Responses
STATUS 200 - Package content received.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Update PyPI Package Content
PUT /registry/package/pypi/{packageName}/{packageVersion}/{fileName}
The request uploads an attached file to the specified version of a PyPI package. This method can be used to create a new package version or the package itself if non-existing data is specified.
| Path Variable | Type | Description |
|---|---|---|
packageName |
String | Package name |
packageVersion |
String | Package version |
fileName |
String | File name |
Responses
STATUS 200 - Package uploaded.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Get Maven Package Content
GET /registry/package/maven/{packageUuid}/{packageVersion}/{fileUuid}/download
The request returns a file from a Maven package.
| Path Variable | Type | Description |
|---|---|---|
packageUuid |
String | Package identifier |
packageVersion |
String | Package version |
fileUuid |
String | File identifier |
Responses
STATUS 200 - Package content received.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Update Maven Package Content
PUT /registry/package/maven/{groupId}/{artifactId}/{version}/{fileName}
The request uploads an attached file to the specified version of a Maven package. This method can be used to create a new package version or the package itself if non-existing data is specified.
| Path Variable | Type | Description |
|---|---|---|
groupId |
String | Group identifier |
artifactId |
String | Artifact identifier |
version |
String | Package version |
fileName |
String | File name |
Responses
STATUS 200 - Package uploaded.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Get NPM Package Content
Depending on the presence of a package group (scope), use one of the following methods:
Get a package without a group (scope):
GET /registry/package/npm/{packageName}/{packageVersion}/{fileName}
Get a package with a group (scope):
GET /registry/package/npm/{packageName}/{packageScope}/{packageVersion}/{fileName}
The request returns a file from an NPM package.
| Path Variable | Type | Description |
|---|---|---|
packageName |
String | Package name |
packageScope |
String | Package group (scope) |
packageVersion |
String | Package version |
fileName |
String | File name |
Responses
STATUS 200 - Package content received.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Update NPM Package Content
Depending on the presence of a package group (scope), use one of the following methods:
Update a package without a group (scope):
PUT /registry/package/npm/{packageName}/{packageVersion}/{fileName}
Update a package with a group (scope):
PUT /registry/package/npm/{packageName}/{packageScope}/{packageVersion}/{fileName}
The request uploads an attached file to the specified version of an NPM package. This method can be used to create a new package version or the package itself if non-existing data is specified.
| Path Variable | Type | Description |
|---|---|---|
packageName |
String | Package name |
packageScope |
String | Scope |
packageVersion |
String | Package version |
fileName |
String | File name |
Responses
STATUS 200 - Package uploaded.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Update Composer Package Content
PUT /registry/package/composer/{packageVersion}
The request uploads an attached file to the specified version of a Composer package. This method can be used to create a new package version or the package itself if non-existing data is specified.
| Path Variable | Type | Description |
|---|---|---|
packageVersion |
String | Package version |
Responses
STATUS 200 - Package uploaded.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Get Composer Package Content
GET /registry/package/composer/{groupId}/{artifactId}/{packageVersion}
The request returns a file from a Composer package.
| Path Variable | Type | Description |
|---|---|---|
groupId |
String | Group identifier |
artifactId |
String | Artifact identifier |
packageVersion |
String | Package version |
Responses
STATUS 200 - Package content received.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Update NuGet Package Content
PUT /registry/package/nuget
The request uploads an attached file to the specified version of a NuGet package. This method can be used to create a new package version or the package itself if non-existing data is specified.
Responses
STATUS 200 - Package uploaded.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Get NuGet Package Content
GET /registry/package/nuget/{packageName}/{packageVersion}
The request returns a file from a NuGet package.
| Path Variable | Type | Description |
|---|---|---|
packageName |
String | Package name |
packageVersion |
String | Package version |
Responses
STATUS 200 - Package content received.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Update OneScript Package Content
PUT /registry/package/opm/{fileName}
The request uploads an attached file to the specified version of a OneScript package. This method can be used to create a new package version or the package itself if non-existing data is specified.
| Path Variable | Type | Description |
|---|---|---|
fileName |
String | File name |
Responses
STATUS 200 - Package uploaded.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Get OneScript Package Content
GET /registry/package/opm/{packageName}/{packageVersion}/{fileName}
The request returns a file from a OneScript package.
| Path Variable | Type | Description |
|---|---|---|
packageName |
String | Package name |
packageVersion |
String | Package version |
fileName |
String | File name |
Responses
STATUS 200 - Package content received.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Update Cran Package Content
PUT /registry/package/cran/{languageVersion}/{fileName}
The request returns a file from a Cran package.
| Path Variable | Type | Description |
|---|---|---|
languageVersion |
String | Language version |
fileName |
String | File name |
Responses
STATUS 200 - Package uploaded.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Method to Get Cran Package Content
GET /registry/package/cran/{fileName}?languageVersion={languageVersion}&platform={platform}
The request uploads an attached file to the specified version of a Cran package. This method can be used to create a new package version or the package itself if non-existing data is specified.
| Path Variable | Type | Description |
|---|---|---|
fileName |
String | File name |
languageVersion |
String | Language version |
platform |
String | Required only for downloading files in .tgz and .zip format. Platform for which the package was created. Possible values: macosx, windows |
Responses
STATUS 200 - Package content received.
STATUS 403 - No access rights.
STATUS 404 - No data found for the request.
Automated translation!
This page was translated using automatic translation tools. The text may contain inaccuracies.