REST API:repository Resource

From LongJump Support Wiki
Revision as of 22:17, 24 July 2012 by imported>Aeric

The Metadata Repository settings. Provides an interface to invoke the Read from Repository and Write to Repository actions using the REST API.

Warn.png

DEPRECATED: Use Sandboxes for collaborative development.

Access Permissions

Lock-tiny.gif

 


Fields
Name Type Attributes Required During Add Description Additional Information
repositoryEnabled Boolean Editable on Add/Update Checkmark.gif 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>