CODEWITHSUNDEEP
teamcity
CapBird
CapBird

Reputation: 33

Trigger build with parameters

Following a TC upgrade to 2018 My previous script of triggering a TC build with parameters is not working

The script we were using uses the following api:

https://[server]/httpAuth/action.html?add2Queue=[build name]&name=[param name]&value=[param value]

I'm trying to migrate to restApi from (https://confluence.jetbrains.com/display/TCD18/REST+API#RESTAPI-QueuedBuilds):

I have tried

https://[server]/app/rest/buildQueue?locator=buildType:[build name],[param name]:[param value]

Currently I have 2 issues:

  1. I get a build triggered successfully - but it has not been triggered
  2. Documentation was not clear, how to I trigger the build with parameters ? Can you please advise on how to trigger the build successfully with parameters (also could be more than 1)

Upvotes: 2

Views: 3520

Answers (1)

fuat
fuat

Reputation: 1842

Firstly you right TeamCity documentation is not clear. Respect to this link;

For triggering a build you must make POST request to this url and send buildType id through body.

http://localhost:8111/httpAuth/app/rest/buildQueue

Also you can pass configuration parameter into body.

XML body for trigger build with parameters:

<build><buildType id="YourBuildTypeId"/>
<properties><property name="PARAM1" value="VALUE1"/></properties>
</build>

JSON body for trigger build with parameters:

{
  "buildType": {
  "id": "YourBuildTypeId"
},
  "properties": {
  "property": [
    {
     "name": "PARAM1",
     "value": "VALUE1"
    },
    {
     "name": "PARAM2",
     "value": "VALUE2"
    }
   ]
  }
}

You can use below curl script.

curl -X POST \
http://localhost:8111/httpAuth/app/rest/buildQueue \
-H 'Accept: application/json' \
-H 'Content-Type: application/xml' \
-d '<build><buildType id="YourBuildTypeId"/>
<properties><property name="PARAM1" value="VALUE1"/></properties>
</build>'

Upvotes: 6

Related Questions