MENU
      Edit project

        Edit project


        Article summary

        Overview

        Edit a SourcePipeline project.

        Requests

        API URL

        PATCH  {SOURCEPIPELINE_API_URL}/project/{projectId}
        Plain text

        Request parameters

        ItemTypeRequirement statusDescriptionRemarks
        projectIdstringYProject ID

        Request queries

        None

        Request bodies

        {
            "description": "string",
            "tasks": [
                {
                    "name": "string",
                    "type": "string",
                    "config": {
                        "projectId": "number",
                        "target": {
                            "info": {
                                "branch": "string"
                            }
                        }
                    },
                    "linkedTasks": ["string"]
                }
            ],
            "trigger": {
                "repository": [
                    {
                        "type": "string",
                        "name": "string",
                        "branch": "string"
                    }
                ],
                "sourcepipeline": [
                    {
                        "id" : "number"
                    }
                ],
                "schedule": [
                    {
                        "day": ["string"],
                        "time": "string",
                        "timeZone": "string",
                        "scheduleOnlyWithChange" : "boolean"
                    }
                ],
            }
        }
        Plain text
        ItemTypeRequirement statusDescriptionRemarks
        descriptionstringNProject description
        tasks.namestringYTask name
        tasks.typestringYTask typeSourceBuild | SourceDeploy
        tasks.config.projectIdnumberYTask project IDView with sourceBuildProjectList API
        View with sourceDeployProjectList API
        tasks.config.stageIdnumberN
        (Required if tasks.type = SourceDeploy)
        SourceDeploy stage IDView with sourceDeployStageList API
        tasks.config.scenarioIdnumberN
        (Required if tasks.type = SourceDeploy)
        SourceDeploy scenario IDView with sourceDeployScenarioList API
        tasks.config.target.info.branchstringN
        (Optional if tasks.type = SourceBuild)
        Connection info - BranchView with sourceCommitBranchList API
        tasks.linkedTasksstring[]Y
        Preceding task. Name of the task to be executed beforehand
        trigger.repository.typestringN
        (Required if trigger.repository exists)
        Push trigger - Repository type"sourcecommit"
        trigger.repository.namestringN
        (Required if trigger.repository exists)
        Push trigger - Repository nameView with sourceCommitRepositoryList API
        trigger.repository.branchstringN
        (Required if trigger.repository exists)
        Push trigger - BranchView with sourceCommitBranchList API
        trigger.sourcepipeline.idnumberN
        (Required if trigger.sourcepipeline exists)
        Pipeline trigger - Pipeline IDView with sourcePipelineProjectList API
        trigger.schedule.daystring[]N
        (Required if trigger.schedule exists)
        Scheduled trigger - Day"MON" | "TUE" | "WED"| "THU" | "FRI" | "SAT" | "SUN"
        trigger.schedule.timestringN
        (Required if trigger.schedule exists)
        Scheduled trigger - TimeEnter in [HH:mm] format. Example: "13:10"
        trigger.schedule.timeZonestringN
        (Required if trigger.schedule exists)
        Scheduled trigger - Time zoneView with sourcePipelineTimeZone API
        trigger.schedule.scheduleOnlyWithChangebooleanN
        (Required if trigger.schedule exists)
        Scheduled trigger - Whether to execute on change

        Responses

        Response bodies

        {
            "result": "boolean"
        }
        JSON
        ItemTypeDescriptionRemarks
        resultbooleanProject change result

        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.