JSON Schema for content server REST API

Is there a complete JSON schema for content server REST API? It would help developer tremendously. For example, invoking api/v1/nodes/{id}/addablenodetypes returning the following JSON:

{
"data" : { },
"definitions" : { },
"definitions_map" : { },
"definitions_order" : [ ]
}

I cannot find any documentation with a complete list of key/value pairs in JSON response so that I can use tool like jsonschema2pojo to generate the corresponding classes.

Thanks,

Find more posts tagged with

API

Comments

Ferdinand Prantl

I am afraid that there is no JSON schema published for all CS REST API responses. (JSON schema is used only to describe form content - for category attributes, for example.)

You could create the schema on your own, at least for the properties you need. You can find the common node properties at the description of GET .../api/v1/nodes/{id}. Additional properties specific no selected node types can be found at the description of POST .../api/v1/nodes for document, for example.

The properties are dynamic and can vary according to the particular node type. You could generate a fixed object only for the common properties; there can be additional properties coming from dynamic columns or extension roles, for example.

Are you creating a kind of strong object type mapping for CS REST API similar to what you get generated from the CS SOAP WS WSDL?

Ti Teo

Thank you for your response. The answer is YES to your question: Are you creating a kind of strong object type mapping for CS REST API similar to what you get generated from the CS SOAP WS WSDL?
It would be nice to have a schema that defines all JSON responses with properties and their corresponding data types at least for the common properties. Currently, I have to use the JSON response to generate the corresponding model classes. But if the response contains many empty values or nulls, there is no way to figure out what data type for certain property.

Ferdinand Prantl

The following opinion is mine only and is not an official company statement.

Well, it may be nice, but it is currently not planned by OpenText.

SOAP WS are used primarily in strong-typed languages like C++, Java, .NET for compiling componnets for server-to-server communication. The interface proxy generation from WSDL fits well to the environment. The extra generated code is maintained by build tools. The extra data on the network are not much concern either.

On the other hand, REST is used primarily in simpler environments (web browser) without any build tools, in languages with dynamic types (JavaScript) and on devices, where the extra protocol overhead would hinder the usability. While you expect to learn everything about the SOAP WS API right away from WSDL, most REST clients developed nowadays just pick from the response what they need.

We'll see in the future, where the main stream of REST goes. In the meanwhile, it is a small niche and I don't see this getting an appropriate priority on our roadmap.

The documentation at the links from my previous reply contains also types of the properties, which you could use for writing the schema by hand. You don't need to gather actual response results.