Skip to content

Company-level Package Methods


Method to Get All Company Packages

GET /registry/company/{companyAlias}/package

The request returns a list of company packages, with the ability to configure the number of objects displayed per page.

Path Variable Type Description
companyAlias String Company alias

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": "fc7f17df-aaaa-aaaa-aaaa-111042a265b8",
                "ownerType": "COMPANY"
            },
            {
                "id": "deb52e29-aaaa-aaaa-aaaa-737eac0eb8f7",
                "name": "Example",
                "version": "1.0.3",
                "groupId": "example",
                "artifactId": "example",
                "type": "nuget",
                "ownerUuid": "fc7f17df-aaaa-aaaa-aaaa-189042a111b8",
                "ownerType": "COMPANY"
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 2,
        "totalPages": 1,
        "number": 0
    }
}
    
  

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Get Company Package by UUID

GET /registry/company/{companyAlias}/package/{packageUuid}

The request returns information about a company package.

Path Variable Type Description
companyAlias String Company alias
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": "fc7f17df-aaaa-aaaa-aaaa-189042a111b8",
    "ownerType": "COMPANY"
}
    
  

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Get List of Company Package Versions

GET /registry/company/{companyAlias}/package/{packageUuid}/version-list

The request returns information about package versions and their contents, with the ability to configure the number of objects displayed per page.

Path Variable Type Description
companyAlias String Company alias
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 - Access denied.

STATUS 404 - No data found for the request.


Method to Get Company Package Version

GET /registry/company/{companyAlias}/package/{packageUuid}/{packageVersion}

The request returns information about a package version and its contents.

Path Variable Type Description
companyAlias String Company alias
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 - Access denied.

STATUS 404 - No data found for the request.


Method to Get Company Package Contents

GET /registry/company/{companyAlias}/package/{packageUuid}/package-file

The request returns information about the contents of different package versions, with the ability to configure the number of objects displayed per page.

Path Variable Type Description
companyAlias String Company alias
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 - Access denied.

STATUS 404 - No data found for the request.


Method to Delete Company Package

POST /registry/company/{companyAlias}/package/{packageUuid}/delete

This method deletes a company package.

Path Variable Type Description
companyAlias String Company alias
packageUuid String Package identifier

Responses

STATUS 200 - Package deleted.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Delete Company Package Version

POST /registry/company/{companyAlias}/package/{packageUuid}/{packageVersion}/delete

This method deletes a package version of a company package.

Path Variable Type Description
companyAlias String Company alias
packageUuid String Package identifier
packageVersion String Package version

Responses

STATUS 200 - Version deleted.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Delete Company Package Version Contents

POST /registry/company/{companyAlias}/package/{packageUuid}/{packageVersion}/{fileUuid}/delete

This method deletes the contents of a package version of a company package.

Path Variable Type Description
companyAlias String Company alias
packageUuid String Package identifier
packageVersion String Package version
fileUuid String File identifier

Responses

STATUS 200 - File deleted.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Get Generic Package Contents

GET /registry/company/{companyAlias}/package/generic/{packageName}/{packageVersion}/{fileName}

The request returns a file of a generic package.

Path Variable Type Description
companyAlias String Company alias
packageName String Package name
packageVersion String Package version
fileName String File name

Responses

STATUS 200 - Package contents received.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Update Generic Package Contents

PUT /registry/company/{companyAlias}/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
companyAlias String Company alias
packageName String Package name
packageVersion String Package version
fileName String File name

Responses

STATUS 200 - Package uploaded.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Get PyPI Package Contents

GET /registry/company/{companyAlias}/package/pypi/{packageName}/{packageVersion}/{fileName}

The request returns a file of a PyPi package.

Path Variable Type Description
companyAlias String Company alias
packageName String Package name
packageVersion String Package version
fileName String File name

Responses

STATUS 200 - Package contents received.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Update PyPI Package Contents

PUT /registry/company/{companyAlias}/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
companyAlias String Company alias
packageName String Package name
packageVersion String Package version
fileName String File name

Responses

STATUS 200 - Package uploaded.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Get Maven Package Contents

GET /registry/company/{companyAlias}/package/maven/{packageUuid}/{packageVersion}/{fileUuid}/download

The request returns a file of a Maven package.

Path Variable Type Description
companyAlias String Company alias
packageUuid String Package identifier
packageVersion String Package version
fileUuid String File identifier

Responses

STATUS 200 - Package contents received.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Update Maven Package Contents

PUT /registry/company/{companyAlias}/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
companyAlias String Company alias
groupId String Group identifier
artifactId String Artifact identifier
version String Package version
fileName String File name

Responses

STATUS 200 - Package uploaded.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Get NPM Package Contents

Depending on the presence of a package group (scope), use one of the methods below:

Get a package without a group (scope):

GET /registry/company/{companyAlias}/package/npm//{packageName}/{packageVersion}/{fileName}

Get a package with a group (scope):

GET /registry/company/{companyAlias}/package/npm/{packageName}/{packageScope}/{packageVersion}/{fileName}

The request returns a file of an NPM package.

Path Variable Type Description
companyAlias String Company alias
packageName String Package name
packageScope String Package group (scope)
packageVersion String Package version
fileName String File name

Responses

STATUS 200 - Package contents received.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Update NPM Package Contents

Depending on the presence of a package group (scope), use one of the methods below:

Update a package without a group (scope):

PUT /registry/company/{companyAlias}/package/npm/{packageName}/{packageVersion}/{fileName}

Update a package with a group (scope):

PUT /registry/company/{companyAlias}/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
companyAlias String Company alias
packageName String Package name
paсkageScope String Scope
packageVersion String Package version
fileName String File name

Responses

STATUS 200 - Package uploaded.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Update Composer Package Contents

PUT /registry/company/{companyAlias}/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
companyAlias String Company alias
packageVersion String Package version

Responses

STATUS 200 - Package uploaded.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Get Composer Package Contents

GET /registry/company/{companyAlias}/package/composer/{groupId}/{artifactId}/{packageVersion}

The request returns a file of a Composer package.

Path Variable Type Description
companyAlias String Company alias
groupId String Group identifier
artifactId String Artifact identifier
packageVersion String Package version

Responses

STATUS 200 - Package contents received.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Update NuGet Package Contents

PUT /registry/company/{companyAlias}/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.

Path Variable Type Description
companyAlias String Company alias

Responses

STATUS 200 - Package uploaded.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Get NuGet Package Contents

GET /registry/company/{companyAlias}/package/nuget/{packageName}/{packageVersion}

The request returns a file of a NuGet package.

Path Variable Type Description
companyAlias String Company alias
packageName String Package name
packageVersion String Package version

Responses

STATUS 200 - Package contents received.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Update OneScript Package Contents

PUT /registry/company/{companyAlias}/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
companyAlias String Company alias
fileName String File name

Responses

STATUS 200 - Package uploaded.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Get OneScript Package Contents

GET /registry/company/{companyAlias}/package/opm/{packageName}/{packageVersion}/{fileName}

The request returns a file of a OneScript package.

Path Variable Type Description
companyAlias String Company alias
packageName String Package name
packageVersion String Package version
fileName String File name

Responses

STATUS 200 - Package contents received.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Update Cran Package Contents

PUT /registry/company/{companyAlias}/package/cran/{languageVersion}/{fileName}

The request returns a file of a Cran package.

Path Variable Type Description
companyAlias String Company alias
languageVersion String Language version
fileName String File name

Responses

STATUS 200 - Package uploaded.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Method to Get Cran Package Contents

GET /registry/company/{companyAlias}/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
companyAlias String Company alias
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 contents received.

STATUS 403 - Access denied.

STATUS 404 - No data found for the request.


Automated translation!

This page was translated using automatic translation tools. The text may contain inaccuracies.