REST API

The REST API lets you manage SkyVault-specific features of content in an on-premise repository, and in SkyVault cloud from your own applications.

The API gives your application access to networks, sites, containers, comments, ratings, tags, and workflow objects. Response and request bodies are all specified with simple JSON.

The REST API Explorer The REST API Explorer documents all the API methods available to you, and lets you try those methods out.
What is an entity? The generic term used in the API for any object in a repository is entity. An entity is of a specific entity type, and has a unique entity id.
What does a request look like? You call a method on the API by issuing an authenticated HTTP request with a URL.
What does a response look like? All responses are JSON objects. The format of the response object depends on the request. The object can contain an entry object, an entry and a relations object, a list object, or an error object. Note that if a property or an entire object has no value, then it is not returned in the parent object.
Using HTTP OPTIONS to get entity metadata The SkyVault REST API supports the use of the HTTP OPTIONS method to retrieve structured information on the methods available on an entity and its relations.
Items and packages When a process is created, a list of items can be given as an input parameter. The items are a list of nodeids. A nodeId is a nodeRef with the workspace://SpacesStore prefix removed. During creation of the process, a new package node is created in the repository. All provided items are associated with that package node.
Entity reference This contains a description of each of the SkyVault Community Edition entities operated on by the REST API, and a pointer to the REST API Explorer section that describes the methods available on that entity.

Parent topic: REST API

Search form

Search form

You are here