Difference between revisions of "Setting"

From enviPath Wiki
Jump to navigation Jump to search
(Created page with "= REST Operations = == GET == {| class="wikitable" |- !URI !Parameter !Accept Types !Result !Status Codes |- |/setting | |''text/html'' ''application/json'' |List of all s...")
 
 
(One intermediate revision by the same user not shown)
Line 13: Line 13:
|/setting
|/setting
|
|
''optional parameter "delimiter" for<br />
text/csv only, default value: ","''
|''text/html''
|''text/html''


''application/json''
''application/json''


''text/csv''
|List of all settings.
|List of all settings.
|200 - OK
|200 - OK
Line 23: Line 26:
|/setting/<id>
|/setting/<id>
|
|
''optional parameter "delimiter" for<br />
text/csv only, default value: ","''
|''text/html''
|''text/html''


''application/json''
''application/json''


''text/csv''
|The setting identified by the URI.
|The setting identified by the URI.
|200 - OK
|200 - OK
Line 34: Line 40:
500 - Internal Server Error
500 - Internal Server Error
|}
|}


== POST ==
== POST ==
Line 47: Line 52:
|-
|-
|/setting
|/setting
|''isNew'' = 'true'
|''settingName''
 
''settingName''


''packages[]'' - URIs of packages to include
''packages[]'' - URIs of packages to include
Line 70: Line 73:
|-
|-
|}
|}


== DELETE ==  
== DELETE ==  

Latest revision as of 13:40, 18 January 2016

REST Operations

GET

URI Parameter Accept Types Result Status Codes
/setting

optional parameter "delimiter" for
text/csv only, default value: ","

text/html

application/json

text/csv

List of all settings. 200 - OK

500 - Internal Server Error

/setting/<id>

optional parameter "delimiter" for
text/csv only, default value: ","

text/html

application/json

text/csv

The setting identified by the URI. 200 - OK

404 - Not Found

500 - Internal Server Error

POST

URI Parameter Accept Types Result Status Codes
/setting settingName

packages[] - URIs of packages to include

Create a new Setting. The redirect points to the URI of the new Setting. 303 - See Other

500 - Internal Server Error

/setting/<id> settingName Modify the setting identified by the URI. 200 - OK
addedPackages[] - URIs of packages to add 404 - Not Found
removedPackages[] - URIs of packages to remove 500 - Internal Server Error

DELETE

URI Parameter Accept Types Result Status Codes
/setting/<id> Delete the setting identified by the URI. 303 - See Other
404 - Not Found
500 - Internal Server Error



PUT

Not Implemented.