-
Notifications
You must be signed in to change notification settings - Fork 10
REST: Settings and build related api
bugzmanov edited this page Aug 1, 2012
·
19 revisions
Path: /rest/settings
Type: GET
Request parameters
Parameter | Type | Description |
---|---|---|
prefix | String | Prefix of the setting key name, starts with genesis.system for system settings and genesis.plugin for plugins |
Example
Request:
GET http://localhost:8080/rest/settings?prefix=genesis.system.beat.period.ms
Response body:
[\{"name":"genesis.system.beat.period.ms","value":"1000","readOnly":false,"description":"Workflow execution actors heartbeats period in milliseconds"\}]
Path: /rest/settings/(**key**)
Type: PUT
Request body: consists form a single JSON map contains the following entries:
Entry name | Type | Mandatory | Description |
---|---|---|---|
value | String | Y | New value of the setting |
Example:
Request
PUT http://localhost:8080/rest/settings/genesis.plugin.jclouds.credential
Request body:
{"value":"cred"}
Response body:
{"serviceErrors":{},"variablesErrors":{},"compoundServiceErrors":[],"compoundVariablesErrors":[],"isSuccess":true,"isNotFound":false}
Path: /rest/settings
Type: DELETE
Request parameters
Parameter | Type | Description |
---|---|---|
prefix | String | Prefix of the setting key name, starts with genesis.system for system settings and genesis.plugin for plugins |
Example:
Request
DELETE http://localhost:8080/rest/settings?prefix=genesis.plugin.jclouds.credential
Response body:
{"serviceErrors":{},"variablesErrors":{},"compoundServiceErrors":[],"compoundVariablesErrors":[],"isSuccess":true,"isNotFound":false}
Path: /rest/build-info
Type: GET
Example response:
{
"genesis.build.opengenesis.version":"1.1.0-SNAPSHOT",
"genesis.build.gdgenesis.git.commit.id.abbrev":"bb102fa",
"genesis.build.opengenesis.git.build.time":"29.05.2012 @ 22:06:18 MSK",
"genesis.build.gdgenesis.version":"1.1.0-SNAPSHOT",
"genesis.build.gdgenesis.git.branch":"bb102fae7e06c1579d23da9a9f15ae73e478d1b8",
"genesis.build.opengenesis.git.commit.id":"4769125d7f817486a387258d04e7f11ab91cb126",
"genesis.build.opengenesis.git.branch":"4769125d7f817486a387258d04e7f11ab91cb126",
"genesis.build.gdgenesis.git.commit.id":"bb102fae7e06c1579d23da9a9f15ae73e478d1b8",
"genesis.build.opengenesis.git.commit.id.abbrev":"4769125",
"genesis.build.gdgenesis.git.build.time":"30.05.2012 @ 13:05:03 MSK"
}