Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

GET http://localhost:8090/rest/spacefields/1.0/utility/list/fields/space/key/{spaceKey}GET http://localhost:8090/rest/spacefields/1.0/utility/list/fields/space/key/{spaceKey}/field/id/{fieldId}?spaceKey={spaceKey}

Query Parameters:

  • spaceKey (String) (Required)
  • fieldId (Number)
  • fieldName (String)
  • search (String) e.g. %project%

Response: [Status: 200]

Code Block
$ curl -u"user:pass" -XGET \
http://localhost:8090/rest/spacefields/1.0/utility/list/fields/space/key/DT/field/id/2?spaceKey=DT
{"fieldId":2,"spaceKey":"DT","fieldName":"project.owner.name","fieldValue":"Venkat Prasad",\
"lastUpdated":1524976091105,"accessType":"public"}
$


Get Space Fields History

GET http://localhost:8090/rest/spacefields/1.0/utility/list/fields/space/history/id/{fieldId}

Path Parameters:

  • fieldId (Number) - Confluence Space Field ID


Add Space Field

POST http://localhost:8090/rest/spacefields/1.0/utility/add/field

...

  • spaceKey (String)
  • fieldName (String)
  • fieldValue (String)
  • accessType (String) - Optional
  • history (Boolean) - Optional

Response: [Status: 200]

Code Block
$ curl -u"user:pass" -XPOST  -H "Content-Type: application/json" --data '{"spaceKey":"DT", \
"fieldName":"project.security.key", "fieldValue":"nxoedoew","accessType":"public"}' \
http://localhost:8090/rest/spacefields/1.0/utility/add/field
{"field":5,"message":"[Info] Added Space Field"}
$

...

  • spaceKey (String)
  • fieldName (String)
  • fieldValue (String)
  • accessType (String) - Optional
  • history (Boolean) - Optional

Response: [Status: 200]

Code Block
$ curl -u"user:pass" -XPOST  -H "Content-Type: application/json" --data '{"spaceKey":"DT", \
"fieldName":"project.security.key", "fieldValue":"xxxxxxx"}' \
http://localhost:8090/rest/spacefields/1.0/utility/update/field 
{"field":5,"message":"[Info] Updated Space Field"}
$

...

  • spaceKey (String)
  • fieldId (Number)
  • fieldName (String)
  • fieldValue (String)
  • accessType (String) - Optional
  • history (Boolean) - Optional

Response: [Status: 200]

...

DELETE http://localhost:8090/rest/spacefields/1.0/utility/remove/fields/space/key/field?spaceKey={spaceKey}/field/id/&fieldId={fieldId}

Code Block
$ curl -u"user:pass" -XDELETE \
http://localhost:8090/rest/spacefields/1.0/utility/remove/fields/space/key/DT/field/id/field?spaceKey=DT&fieldId=5
{"field":5,"message":"[Info] Removed Space Field"}
$

...