Difference between revisions of "REST API:repository Resource"
From LongJump Support Wiki
imported>Aeric |
imported>Aeric m (Text replace - 'permission rights' to 'permission') |
||
| Line 7: | Line 7: | ||
}} | }} | ||
<!-- need confirmation from eng 3/8/10 | <!-- need confirmation from eng 3/8/10 | ||
*Users with ''[[Manage Tenants and Company Capabilities]]'' permission | *Users with ''[[Manage Tenants and Company Capabilities]]'' permission can manage ''[[:Category:Sys Admin Guide|Administration Controls]]'' | ||
*Users with ''[[Manage Develop Features]]'' can use [[:Category:Develop|Developer Tools]]--> | *Users with ''[[Manage Develop Features]]'' can use [[:Category:Develop|Developer Tools]]--> | ||
Latest revision as of 21:05, 16 October 2012
The Metadata Repository settings. Provides an interface to invoke the Read from Repository and Write to Repository actions using the REST API.
DEPRECATED: Use Sandboxes for collaborative development.
- 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>