FrameMaker Publishing Server comes with out-of-the-box REST APIs that can be used to create publishing tasks to publish content from Microsoft SharePoint, OpenText Documentum, or Adobe Experience Manager. The APIs work on resources such as users, tasks, presets, and more to create, retrieve, update, and delete resources.
The end-point or the base URL of FMPS APIs is:
http[s]://<FMPS_server>:<port>/
From a client machine, you can query FMPS using the following methods to create, retrieve, update, or delete (CRUD) resources. According to the REST protocol, everything on the server, such as tasks, presets, users, is treated as a resource. For more information on the REST protocol, see http://en.wikipedia.org/wiki/Representational_state_transfer
In the REST API URLs and method types table, the various GET, POST, DELETE, and PUT requests map to CRUD framework as:
REST API method types |
CRUD aspect |
---|---|
Post |
Create |
Get |
Retrieve |
Put |
Update |
Delete |
Delete |
The following topics describe the REST APIs available to you for building your own FMPS custom client. Each API has its a specific URL that you can query. The methods, such as Get and Post, are the type of operations you are performing on the REST API. The URLs include parameters that you can pass to an API.
Create and update (Post and Put) requests have parameters passed in the body of the HTTP request as a JSON file as well as in the URL. Get and Delete have parameters in the URLs only. The various task type links in the Help URL include the schema required for the various tasks.