AgileApps Support Wiki Pre Release

Difference between revisions of "REST API:developConfig Resource"

From AgileApps Support Wiki
imported>Aeric
m (Text replace - 'Record Identifier' to 'Record Id')
imported>Aeric
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
Manage development configuration details using the [[REST API]].
Manage development configuration setting using the [[REST API]].


===Access Permissions===
===Access Permissions===
{{permissions|Manage Develop Features|use the <tt>developConfig</tt> Resource in the [[REST API]]}}
{{permissions|Use Development Features|use this resource.}}


===Read developConfig Settings ===
===Read developConfig Settings ===
;Method:GET
;Method:GET
   
   
;URI:<tt><nowiki>https://{domain}/networking/rest/developConfig</nowiki></tt>
;URI:<tt>{{platformURL}}/rest/developConfig</tt>


;Response:
;Response:
Line 30: Line 30:
;Method:PUT
;Method:PUT
   
   
;URI:<tt><nowiki>https://{domain}/networking/rest/developConfig/{recordId}</nowiki></tt>  
;URI:<tt>{{platformURL}}/rest/developConfig/{recordId}</tt>  


;Request:
;Request:

Latest revision as of 22:43, 12 June 2014

Manage development configuration setting using the REST API.

Access Permissions

Lock-tiny.gif

Users that have the Use Development Features permission can use this resource. 

Read developConfig Settings

Method
GET
URI
https://{yourDomain}/networking/rest/developConfig
Response
<syntaxhighlight lang="xml" enclose="div">

<platform>

   <developConfig>
       <id>...</id>
       <log_level>3</log_level>
       <namespace>demo</namespace>
   </developConfig>
   <message>
       0
       <description>Success</description>
   </message>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Update developConfig Settings

Method
PUT
URI
https://{yourDomain}/networking/rest/developConfig/{recordId}
Request
<syntaxhighlight lang="xml" enclose="div">

<platform>

   <developConfig>
       <log_level>3</log_level>
       <namespace>demo</namespace>
   </developConfig>

</platform> </syntaxhighlight>

Response
<syntaxhighlight lang="xml" enclose="div">

<platform>

   <message>
       0
       <description>Success</description>
   </message>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Fields

Name Type Attribute Required During Add Description Additional Information
id String Read Only Record Id
log_level Number Editable on Update
namespace String Editable on Update