This document provides REST API details for Space fields plugin.
GET http://localhost:8090/rest/spacefields/1.0/utility/list/fields?spaceKey={spaceKey}
Query Parameters:
Response: [Status: 200]
$ curl -u"user:pass" -XGET \ http://localhost:8090/rest/spacefields/1.0/utility/list/fields/?spaceKey=DT {"fieldId":2,"spaceKey":"DT","fieldName":"project.owner.name","fieldValue":"Venkat Prasad",\ "lastUpdated":1524976091105,"accessType":"public"} $ |
GET http://localhost:8090/rest/spacefields/1.0/utility/list/fields/space/history/id/{fieldId}
Path Parameters:
POST http://localhost:8090/rest/spacefields/1.0/utility/add/field
Schema Fields:
Response: [Status: 200]
$ 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"} $ |
POST http://localhost:8090/rest/spacefields/1.0/utility/update/field
Schema Fields:
Response: [Status: 200]
$ 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"} $ |
Note. Update creates field if not exists.
POST http://localhost:8090/rest/spacefields/1.0/utility/update/field/force
Schema Fields:
Response: [Status: 200]
Note. This API helps to rename field name.
$ curl -u"user:pass" -XPOST -H "Content-Type: application/json" --data '{"spaceKey":"DT", \ "fieldId":"5", "fieldName":"project.security.key", "fieldValue":"xxxxxxx"}' \ http://localhost:8090/rest/spacefields/1.0/utility/update/field {"field":5,"message":"[Info] Updated Space Field"} $ |
DELETE http://localhost:8090/rest/spacefields/1.0/utility/remove/field?spaceKey={spaceKey}&fieldId={fieldId}
$ curl -u"user:pass" -XDELETE \ http://localhost:8090/rest/spacefields/1.0/utility/remove/field?spaceKey=DT&fieldId=5 {"field":5,"message":"[Info] Removed Space Field"} $ |