Project details
- Print
- PDF
Project details
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
View detailed information of a SourcePipeline project.
Requests
API URL
GET {SOURCEPIPELINE_API_URL}/project/{projectId}
Request parameters
| Item | Type | Required | Description | Note |
|---|---|---|---|---|
| projectId | string | Y | Project ID | View with projectList API |
Request queries
None
Request bodies
None
Responses
Response bodies
{
"id": "number",
"name": "string",
"description": "string",
"tasks": [
{
"id": "number",
"name": "string",
"type": "string",
"config": {
"projectId": "number",
"target": {
"type": "string",
"name": "string",
"info": {
"repository": "string",
"branch": "string"
}
}
},
"linkedTasks": ["string"]
}
],
"trigger": {
"repository": [
{
"type": "string",
"name": "string",
"branch": "string"
}
],
"sourcepipeline": [
{
"id" : "number",
"name" : "string"
}
],
"schedule": [
{
"day": ["string"],
"time": "string",
"timeZone": "string",
"scheduleOnlyWithChange" : "boolean"
}
],
}
}
| Item | Type | Description | Note |
|---|---|---|---|
| id | number | Project ID | |
| name | string | Project name | |
| description | string | Project description | |
| tasks.id | number | Task ID | |
| tasks.name | string | Task name | |
| tasks.type | string | Task type | SourceBuild, SourceDeploy |
| tasks.linkedTasks | string[] | Preceding task. Name of the task to be executed beforehand | |
| tasks.config.projectId | number | Task project ID | required both type SourceBuild and SourceDeploy |
| tasks.config.stageId | number | SourceDeploy stage ID | required if tasks.type is SourceDeploy |
| tasks.config.scenarioId | number | SourceDeploy scenario ID | required if tasks.type is SourceDeploy |
| tasks.config.target.type | string | Connection info type | SourceCommit, GitHub, Bitbucket, Github Enterprise Server, SourceBuild, ObjectStorage, KubernetesService |
| tasks.config.target.name | string | Connection info project name | required if tasks.config.target.type is SourceBuild |
| tasks.config.target.info.repository | string | Connection info - Repository | required if tasks.config.target.type is SourceCommit |
| tasks.config.target.info.branch | string | Connection info - Branch | required if tasks.config.target.type is SourceCommit |
| tasks.config.target.info.workspace.id | string | Connection info - Bitbucket workspace ID | required if tasks.config.target.type is Bitbucket |
| tasks.config.target.info.workspace.name | string | Connection info - Bitbucket workspace name | required if tasks.config.target.type is Bitbucket |
| tasks.config.target.info.authType | string | Connection info - Github Enterprise Server login type | require id tasks.config.target.type is Github Enterprise Server |
| tasks.config.target.info.url | string | Connection info - Github Enterprise Server Repository URL | require id tasks.config.target.type is Github Enterprise Server and tasks.config.target.info.authType is ssh |
| tasks.config.target.info.serverUrl | string | Connection info - Github Enterprise Server URL | require id tasks.config.target.type is Github Enterprise Server and tasks.config.target.info.authType is OAuth, Personal Access Token, Username/Password |
| tasks.config.target.info.owner | string | Connection info - Github Enterprise Server owner | require id tasks.config.target.type is Github Enterprise Server |
| tasks.config.target.info.projectName | string | Connection info - Build project name | required if tasks.config.target.type is SourceBuild |
| tasks.config.target.info.file | string | Connection info - Object Storage file name (including path) | required if tasks.config.target.type is ObjectStorage |
| tasks.config.target.info.manifest | string | Connection info - NKS manifest file | required if tasks.config.target.type is KubernetesService |
| tasks.config.target.info.fullManifest | string | Connection info - NKS manifest file list | required if tasks.config.target.type is KubernetesService |
| trigger.repository.type | string | Push trigger - Repository type | "sourcecommit" |
| trigger.repository.name | string | Push trigger - Repository name | |
| trigger.repository.branch | string | Push trigger - Branch | |
| trigger.sourcepipeline.id | number | Pipeline trigger - Pipeline ID | |
| trigger.sourcepipeline.name | string | Pipeline trigger - Pipeline name | |
| trigger.schedule.day | string[] | Scheduled trigger - Day | "MON" | "TUE" | "WED"| "THU" | "FRI" | "SAT" | "SUN" |
| trigger.schedule.time | string | Scheduled trigger - Time | |
| trigger.schedule.timeZone | string | Scheduled trigger - Time zone | |
| trigger.schedule.scheduleOnlyWithChange | boolean | Scheduled trigger - Whether to execute on change |
Was this article helpful?