GO Publisher Workflow Restful API Guide
This document is intended for end users who want to establish an understanding of and gain experience in integrating GO Publisher Workflow into an existing data ordering or work-flow system.
GO Publisher Workflow can be run standalone or integrated into an existing data ordering or work-flow system. This guide provides an overview of how to use the RESTful APIs (Application Programming Interfaces) provided by GO Publisher Workflow for use within business workflows. This is done without interaction with the graphical user interfaces.
See Introducing GO Publisher Workflow for more general background information about GO Publisher Workflow.
Follow the steps to Deploy GO Publisher Workflow WAR files on your application server. GO Publisher Workflow can be deployed in the same manner regardless of whether it will be run standalone or integrated into a business workflow.
Using the APIs
Admin API - Set up Products
- Configure products based on your publishing requirements.
- Upload and manage your products using the Admin API and API calls
Management API - Manage Jobs
- Create a Publish Job, which reference your 'products' and inform the system what to publish.
- Upload and run your jobs using the Management API and API calls
Download API - Download Published Data
- Download completed jobs' published data using the Download API and API calls. The Download API makes data accessible to certain users without exposing the Management API responsible for publishing.
Each API page contains a list of the available RESTful requests.
To test the APIs, you can submit requests using software such as the Dev HTTP Client, or REST Console applications for Google Chrome.
The RESTful response can be returned in an XML or JSON format. The Management API page describes this in more detail.
RESTful response code return pattern
|Call type||Response Status||Comments|
|POST||201 Create||When creating a resource using the POST method (creating a job) the return will be the 201 code along with the new resource location being stored in the headers in "Location"|
|GET||200 OK||When a GET has been called it should return the resource its trying to get along with a 200 code|
|PUT||200 OK||When setting the status of a job via the PUT method it should return a 200 OK when the status is successfully set|