MENU
      View project details

        View project details


        Article summary

        Overview

        Views details of the SourceBuild project.

        Requests

        API URL

        TEnvPlatformConfig

        GET  {SOURCEBUILD_API_URL}/project/{projectId}
        Plain text

        Request parameters

        ItemTypeDescriptionNote
        projectIdstringProject IDView with projectList API

        Request queries

        None

        Request bodies

        None

        Responses

        Response bodies

        {
            "id": "number",
            "name": "string",
            "description": "string",
            "created": {
                "timestamp": "number",
                "user": "string"
            },
            "source": {
                "type": "string",
                "config": "TSourceSourceCommitGithub", | "TSourceBitbucket" |  "TSourceGithubEnterpriseHttps" | "TSourceGithubEnterpriseSsh"
            },
            "env": {
                "compute": {
                    "id": "number",
                    "cpu": "number",
                    "mem": "number"
                },
                "platform": {
                    "type": "string",
                    "config": "TEnvSourceBuild" | "TEnvContainerRegistry" | "TEnvPublicRegistry"
                },
                "docker": {
                    "use": "boolean",
                    "id": "number",
                    "name": "string"
                },
                "timeout": "number",
                "envVars": [
                    {
                        "key": "string",
                        "value": "stirng"
                    }
                ]
            },
            "cmd": {
                "pre": ["string"],
                "build": ["string"],
                "post": ["string"],
                "dockerbuild": {
                    "use": "boolean",
                    "dockerfile": "string",
                    "registry": "string",
                    "image": "string",
                    "tag": "string",
                    "latest": "boolean"
                }
            },
            "artifact": {
                "use": "boolean",
                "path": "string",
                "storage": {
                    "bucket": "string",
                    "path": "string",
                    "filename": "string"
                },
                "backup": "boolean"
            },
            "cache": {
                "use": "boolean",
                "registry": "string",
                "image": "string",
                "tag": "string",
                "latest": "boolean"
            },
            "linked": {
                "CloudLogAnalytics": "boolean",
                "FileSafer": "boolean"
            },
            "lastBuild": {
                "id": "string",
                "timestamp": "number",
                "status": "string"
            }
        }
        JSON
        ItemTypeDescriptionNote
        idnumberProject ID
        namestringProject name
        descriptionstringProject description
        source.type"SourceCommit" , "Github", "Bitbucket", "Github Enterprise Server"Source storage type
        source.configTSourceSourceCommitGithubTSourceBitbucketTSourceGithubEnterpriseHttps
        env.compute.idnumberComputing type ID of the build environmentView with buildEnvComputeList API
        env.compute.cpunumberNumber of vCPUs in the build environment
        env.compute.memnumberMemory capacity in the build environmentUnit: GB
        env.platform.type"SourceBuild""ContainerRegistry""PublicRegistry"
        env.platform.configTEnvSourceBuildTEnvContainerRegistryTEnvPublicRegistry
        env.docker.usebooleanInclusion (use) status of Docker engine in the build environment for Docker
        env.docker.idnumberDocker engine version IDView with buildEnvDockerList API
        env.docker.namestringDocker engine name
        env.timeoutnumberBuild run timeoutUnit: minute
        env.envVars{"key": string, "value": string}[]Build environment variable
        cmd.prestring[]Command before build
        cmd.buildstring[]Command during build
        cmd.poststring[]Command after build
        cmd.dockerbuild.usebooleanUse status of Docker image build settings
        cmd.dockerbuild.dockerfilestringPath including the dockerfile's file nameInclude the dockerfile in the source storage assigned to source.config.repository, and enter the path from the top level of the source storage.
        cmd.dockerbuild.registrystringRegistry name of Container Registry to store the image
        cmd.dockerbuild.imagestringImage name
        cmd.dockerbuild.tagstringTag name
        cmd.dockerbuild.latestbooleanSave status of the latest tag
        artifact.usebooleanSave status of the build results
        artifact.pathstring[]Location of the build resultsEnter the path from the top level of the source storage assigned to source.config.repository. Both file and directory paths can be used.
        artifact.storage.bucketstringBucket name of Object Storage to save the results
        artifact.storage.pathstringPath within the Object Storage bucket to save the results
        artifact.storage.filenameFile name to save the resultsThe results are compressed and saved in zip format. If the extension is not .zip, . will be automatically included in the file name.
        artifact.backupbooleanBackup status of the results
        cache.usebooleanSave status of the build environment after completing your buildThe build environment can be saved into an image after completing your build. This can be set as the image of your build environment for xxx build.
        cache.registrystringRegistry name of Container Registry to save the image of the build environment after completing the build
        cache.imagestringImage name
        cache.tagstringTag name
        cache.latestbooleanSave status of the latest tag
        linked.CloudLogAnalyticsbooleanSave status of build log saved in Cloud Log Analytics
        linked.FileSaferbooleanTest status of the build results with File Safer (File Filter)
        lastBuild.idstringID of build built last
        lastBuild.timestampnumberLast build time
        lastBuild.statusstringCondition of build built last

        TSourceConfig

        TSourceSourceCommitGithub

        {
            "repository": "string",
            "branch": "string"
        }
        Plain text
        ItemTypeDescriptionNote
        repositorystringRepository
        branchstringBranch

        TSourceBitbucket

        {
            "repository": "string",
            "branch": "string",
            "workspace": {
                "id": "string",
                "name": "string"
            }
        }
        Plain text
        ItemTypeDescriptionNote
        repositorystringRepository
        branchstringBranch
        workspace.idstringworkspace id
        workspace.namestringWorkspace name

        TSourceGithubEnterpriseHttps

        {
            "owner": "string",
            "repository": "string",
            "branch": "string",
            "serverUrl": "string"
        }
        Plain text
        ItemTypeDescriptionNote
        ownerstringOwner
        repositorystringRepository
        branchstringBranch
        serverUrlstringServer URL

        TSourceGithubEnterpriseSsh

        {
            "owner": "string",
            "repository": "string",
            "branch": "string",
            "url": "string"
        }
        Plain text
        ItemTypeDescriptionNote
        ownerstringOwner
        repositorystringRepository
        branchstringBranch
        urlstringRepository URL

        TEnvPlatformConfig

        TEnvSourceBuild

        {
            "os": {
                "id": "number",
                "name": "string",
                "version": "string",
                "archi": "string"
            },
            "runtime": {
                "id": "number",
                "name": "string",
                "version": {
                    "id": "number",
                    "name": "string"
                }
            }
        }
        Plain text
        ItemTypeDescriptionNote
        os.idnumberOperating system IDView with buildEnvOSList API
        os.namestringOperating system nameView with buildEnvOSList API
        os.versionstringOperating system versionView with buildEnvOSList API
        os.archistringOperating system architectureView with buildEnvOSList API
        runtime.idnumberRuntime IDView with buildEnvRunTimeList API
        runtime.namestringRuntime nameView with buildEnvRunTimeList API
        runtime.version.idnumberRuntime version IDView with buildEnvRunTimeVersionList API
        runtime.version.namestringRuntime version nameView with buildEnvRunTimeVersionList API

        TEnvContainerRegistry

        {
        		"registry": "string",
        		"image": "string",
        		"tag": "string"
        }
        Plain text
        ItemTypeDescriptionNote
        registrystringRegistry name
        imagestringImage name
        tagstringTag name

        TEnvPublicRegistry

        {
            "image": "string",
            "tag": "string"
        }
        Plain text
        ItemTypeDescriptionNote
        imagestringImage name
        tagstringTag name

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.