View project details

Article summary

Did you find this summary helpful?

Thank you for your feedback

Overview

Views details of the SourceBuild project.

Requests

API URL

TEnvPlatformConfig

GET  {SOURCEBUILD_API_URL}/project/{projectId}

Request parameters

Item	Type	Description	Note
projectId	string	Project ID	View 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"
    }
}

Item	Type	Description	Note
id	number	Project ID
name	string	Project name
description	string	Project description
source.type	"SourceCommit" , "Github", "Bitbucket", "Github Enterprise Server"	Source storage type
source.config	TSourceSourceCommitGithub	TSourceBitbucket	TSourceGithubEnterpriseHttps
env.compute.id	number	Computing type ID of the build environment	View with buildEnvComputeList API
env.compute.cpu	number	Number of vCPUs in the build environment
env.compute.mem	number	Memory capacity in the build environment	Unit: GB
env.platform.type	"SourceBuild"	"ContainerRegistry"	"PublicRegistry"
env.platform.config	TEnvSourceBuild	TEnvContainerRegistry	TEnvPublicRegistry
env.docker.use	boolean	Inclusion (use) status of Docker engine in the build environment for Docker
env.docker.id	number	Docker engine version ID	View with buildEnvDockerList API
env.docker.name	string	Docker engine name
env.timeout	number	Build run timeout	Unit: minute
env.envVars	{"key": string, "value": string}[]	Build environment variable
cmd.pre	string[]	Command before build
cmd.build	string[]	Command during build
cmd.post	string[]	Command after build
cmd.dockerbuild.use	boolean	Use status of Docker image build settings
cmd.dockerbuild.dockerfile	string	Path including the dockerfile's file name	Include 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.registry	string	Registry name of Container Registry to store the image
cmd.dockerbuild.image	string	Image name
cmd.dockerbuild.tag	string	Tag name
cmd.dockerbuild.latest	boolean	Save status of the latest tag
artifact.use	boolean	Save status of the build results
artifact.path	string[]	Location of the build results	Enter 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.bucket	string	Bucket name of Object Storage to save the results
artifact.storage.path	string	Path within the Object Storage bucket to save the results
artifact.storage.filename		File name to save the results	The results are compressed and saved in zip format. If the extension is not .zip, . will be automatically included in the file name.
artifact.backup	boolean	Backup status of the results
cache.use	boolean	Save status of the build environment after completing your build	The 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.registry	string	Registry name of Container Registry to save the image of the build environment after completing the build
cache.image	string	Image name
cache.tag	string	Tag name
cache.latest	boolean	Save status of the latest tag
linked.CloudLogAnalytics	boolean	Save status of build log saved in Cloud Log Analytics
linked.FileSafer	boolean	Test status of the build results with File Safer (File Filter)
lastBuild.id	string	ID of build built last
lastBuild.timestamp	number	Last build time
lastBuild.status	string	Condition of build built last

TSourceConfig

TSourceSourceCommitGithub

{
    "repository": "string",
    "branch": "string"
}

Item	Type	Description	Note
repository	string	Repository
branch	string	Branch

TSourceBitbucket

{
    "repository": "string",
    "branch": "string",
    "workspace": {
        "id": "string",
        "name": "string"
    }
}

Item	Type	Description
repository	string	Repository
branch	string	Branch
workspace.id	string	workspace id
workspace.name	string	Workspace name

TSourceGithubEnterpriseHttps

{
    "owner": "string",
    "repository": "string",
    "branch": "string",
    "serverUrl": "string"
}

Item	Type	Description
owner	string	Owner
repository	string	Repository
branch	string	Branch
serverUrl	string	Server URL

TSourceGithubEnterpriseSsh

{
    "owner": "string",
    "repository": "string",
    "branch": "string",
    "url": "string"
}

Item	Type	Description
owner	string	Owner
repository	string	Repository
branch	string	Branch
url	string	Repository URL

TEnvPlatformConfig

TEnvSourceBuild

{
    "os": {
        "id": "number",
        "name": "string",
        "version": "string",
        "archi": "string"
    },
    "runtime": {
        "id": "number",
        "name": "string",
        "version": {
            "id": "number",
            "name": "string"
        }
    }
}

Item	Type	Description	Note
os.id	number	Operating system ID	View with buildEnvOSList API
os.name	string	Operating system name	View with buildEnvOSList API
os.version	string	Operating system version	View with buildEnvOSList API
os.archi	string	Operating system architecture	View with buildEnvOSList API
runtime.id	number	Runtime ID	View with buildEnvRunTimeList API
runtime.name	string	Runtime name	View with buildEnvRunTimeList API
runtime.version.id	number	Runtime version ID	View with buildEnvRunTimeVersionList API
runtime.version.name	string	Runtime version name	View with buildEnvRunTimeVersionList API

TEnvContainerRegistry

{
		"registry": "string",
		"image": "string",
		"tag": "string"
}

Item	Type	Description
registry	string	Registry name
image	string	Image name
tag	string	Tag name

TEnvPublicRegistry

{
    "image": "string",
    "tag": "string"
}

Item	Type	Description	Note
image	string	Image name
tag	string	Tag name

Was this article helpful?

What's Next

Create Project

Table of contents

Overview
Requests
Responses