Difference between revisions of "REST API:repository Resource"
From LongJump Support Wiki
imported>Aeric m (Text replace - '<tt><nowiki>https://{domain}/networking' to '<tt>{{platformURL}}') |
imported>Aeric |
||
| Line 34: | Line 34: | ||
Retrieves the metadata repository settings | Retrieves the metadata repository settings | ||
;Method:GET | ;Method:GET | ||
;URI:<tt>{{platformURL}}/rest/repository | ;URI:<tt>{{platformURL}}/rest/repository</tt> | ||
;Response: | ;Response: | ||
:<syntaxhighlight lang="xml" enclose="div"> | :<syntaxhighlight lang="xml" enclose="div"> | ||
| Line 55: | Line 55: | ||
;Method:PUT | ;Method:PUT | ||
;URI:<tt>{{platformURL}}/rest/repository | ;URI:<tt>{{platformURL}}/rest/repository</tt> | ||
;Request: | ;Request: | ||
| Line 81: | Line 81: | ||
;Method:POST | ;Method:POST | ||
;URI:<tt>{{platformURL}}/rest/repository/operation/readFrom | ;URI:<tt>{{platformURL}}/rest/repository/operation/readFrom</tt> | ||
;Response: | ;Response: | ||
| Line 96: | Line 96: | ||
Invokes a Write to Repository action | Invokes a Write to Repository action | ||
;Method:POST | ;Method:POST | ||
;URI:<tt>{{platformURL}}/rest/repository/operation/writeTo | ;URI:<tt>{{platformURL}}/rest/repository/operation/writeTo</tt> | ||
;Response: | ;Response: | ||
:<syntaxhighlight lang="xml" enclose="div"> | :<syntaxhighlight lang="xml" enclose="div"> | ||
Revision as of 21:57, 30 March 2012
The Metadata Repository settings. Provides an interface to invoke the Read from Repository and Write to Repository actions using the REST API.
- Access Permissions
- Available to users who have the Installable Version and where Instance Configuration is set to Development in Service Provider Settings
- Fields
Name Type Attributes Required During Add Description Additional Information repositoryEnabled Boolean Editable on Add/Update 
Enables the Metadata Repository repositoryPath String Editable on Add/Update Required when repositoryEnabled = 1 Path for the Metadata Repository
- Error Codes
- See REST API Error Codes
Retrieve Repository Settings
Retrieves the metadata repository settings
- Method
- GET
- URI
- https://na.longjump.com/networking/rest/repository
- Response
<platform> <repository> <repositoryEnabled>1</repositoryEnabled> <repositoryPath>C:\usr\local\project1</repositoryPath> </repository> <message> <code>0</code> <description>Success</description> </message> </platform>
Update the Repository Settings
This example performs these update actions:
- metadata enable functionality to TRUE
- repository path to C:\usr\local\project2
- Method
- PUT
- URI
- https://na.longjump.com/networking/rest/repository
- Request
<platform> <repository> <repositoryEnabled>1</repositoryEnabled> <repositoryPath>C:\usr\local\project2</repositoryPath> </repository> </platform>
- Response
<platform> <message> <code>0</code> <description>Success</description> </message> </platform>
Read from the Repository
Invokes Read from Repository action
- Method
- POST
- URI
- https://na.longjump.com/networking/rest/repository/operation/readFrom
- Response
<platform> <message> <code>0</code> <description>Success</description> </message> </platform>
Write to the Repository
Invokes a Write to Repository action
- Method
- POST
- URI
- https://na.longjump.com/networking/rest/repository/operation/writeTo
- Response
<platform> <message> <code>0</code> <description>Success</description> </message> </platform>