Setting custom properties on SonarQube projects

Question

I'm following the documentation on the Sonarqube web api for getting/setting properties. I'd like to set a property on project pi_core with the property name "appName" and the value "UCFE". Ultimately I want to fully automate this via PowerShell but for now I'm just trying to validate the concepts using curl just like the docs. My command is:

curl -u myID:myPassword -X POST http://myServer.ad1.prod:9000/api/properties?id=appName&value=UCFE&resource=pi_core

I've verified that my ID and password work by executing other generic web api calls that require admin authorization. When I try to run the above I get:

{"err_code":200,"err_msg":"property created"}'value' is not recognized as an internal or external command, operable program or batch file.
'resource' is not recognized as an internal or external command, operable program or batch file.

Any ideas why this command, which seems to me to be identical to the documentation except for the values, gets the above error?

Answer 1

To start with, close the URI in quotes;

curl -u myID:myPassword -X POST 'http://myServer.ad1.prod:9000/api/properties?id=appName&value=UCFE&resource=pi_core'

• The & for a start will send 3 commands into the background if you don't enclose it and run that from a shell

• API Documentation is so often incomplete, has limited testing, is thrown together, or even unintentionally gets caught in the escaping process when displaying on blogs.

When using curl on the command line, remember that the shell interprets the command first.

• Your initial command:

  curl -u myID:myPassword -X POST http://myServer.ad1.prod:9000/api/properties?id=appName&value=UCFE&resource=pi_core

  , looks like this to the shell:

  arg1: curl
  arg2: -u
  arg3: myID:myPassword
  arg4: -X
  arg5: POST
  arg6: http://myServer.ad1.prod:9000/api/properties?id=appName
  arg7: value=UCFE
  arg8: resource=pi_core
  

Therefore, arg7, and arg8 above, were sent to cURL as arguments. cURL wouldn't have a clue what "value=UCFE" means, hence the error:

'value' is not recognized as an internal or external command

When you put quotes around a block of text that you want sent as one argument (say, the URL to cURL), it looks like this:

• Command:

  curl -u myID:myPassword -X POST 'http://myServer.ad1.prod:9000/api/properties?id=appName&value=UCFE&resource=pi_core'

• Interpreted:

   Arg0: curl
   Arg1: -u
   Arg2: myID:myPassword
   Arg3: -X
   Arg4: POST
   Arg5: http://myServer.ad1.prod:9000/api/properties?id=appName&value=UCFE&resource=pi_core 
  

---

Sidenote - for the sake of completion;

It often doesn't matter whether the quotes are single or double, but they are different.

• Case for single quotes: Some APIs, have $ signs in them. For example MYOB has many parameters like the following; In this case, if there are many of them, it may be easier to use single quotes:

  '?$filter=DateOccurred%20ge%20datetime%272016-07-25%2'

  . In this case, if there are many of them, it may be easier to use single quotes.

• Case for double quotes: Lots of variables:

  "?id=$id&refresh=true&paramlist=$params&authredirect=$authlevel"