Publishing
The publishing capabilities of the API allow application developers to publish content and includes the following REST calls:
getPublishingChannels
|
Function |
Get the publishing channels for a particular content type. |
||
|
Description |
This request returns the metadata of all the available publishing channels for given content type. Null will be returned in case the channel doesn't exist for the given content type. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getAllPublishingChannels
|
Function |
Get all publishing channels. |
||
|
Description |
This request returns the metadata of all existing Publishing Channels with their parameters. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getDeliveryChannels
|
Function |
Get all delivery channels. |
||
|
Description |
This request returns the metadata of all existing Delivery Channels with their parameters. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
publishAsset
|
Function |
Publish an asset. |
||
|
Description |
This request returns the stream after publishing an asset into a specified format using the publishing channel. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters
|
Name |
Type |
Description |
|
|
string |
The publishing channel used for publishing the content along with publishing parameters (specific to provided publishing channel)(Mandatory) |
|
|
|
int |
The major version number of the asset to be published. Optional. |
|
|
|
int |
The minor version number of the asset to be published. Optional. |
|
|
Returns |
Returns the filestream after publishing an asset into required format. |
||
|
Examples |
URL:
Result: The filestream after publishing an asset into required format. |
||
|
Function |
Deliver an asset. |
||
|
Description |
This request delivers a QPP or Non-QPP asset at any fileserver, sharepoint server, filenet or documentum. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters
|
Name |
Type |
Description |
|
|
string |
The delivery channel used to deliver a QPP asset or published content to any of the available delivery channels. (Mandatory)Delivery channel parameters are specific to the channel and all are mandatory. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
|
Function |
Publish and deliver an asset. |
||
|
Description |
This request publishes any QPP or Non-QPP asset into the required format and delivers the published content at any fileserver, sharepoint server, filenet or documentum at the same time. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters
|
Name |
Type |
Description |
|
|
string |
The publishing channel used for publishing the content along with publishing parameters (specific to provided publishing channel). |
|
|
|
string |
The delivery channel used to deliver the QPP asset or published content to any of the available delivery channels. Delivery channel parameters are specific to the channel and all are mandatory. |
|
|
|
int |
The major version number of the asset to be published. Optional. |
|
|
|
int |
The minor version number of the asset to be published. Optional. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
publishBasedOnURI
|
Function |
Publish a non-Platform resource. |
||
|
Description |
Takes input in the form of URI. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Input a non QPP resource available on any of the URIs. Supported URIs are file, qpp, classpath, SharePoint and http. |
|
|
|
string |
The publishing channel used for publishing the content along with publishing parameters (specific to provided publishing channel). |
|
|
Returns |
Returns the filestream of output after publishing an asset to the required format. |
||
|
Examples |
URL:
Result: The filestream of output after publishing an asset to the required format. |
||
|
Function |
Deliver a non-Platform resource. |
||
|
Description |
Include the file in the request body or as file part. Takes input in the form of URI. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Input the non QPP resource available on any of the URIs. Supported URIs are file, qpp, classpath, SharePoint and http. |
|
|
|
string |
The delivery channel used to deliver the QPP asset or published content to any of the available delivery channels.Delivery channel parameters are specific to the channel and all are mandatory. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
publishBasedOnStreamContext
|
Function |
Publish a non-platform resource. |
||
|
Description |
This request will publish a non-platform resource. Takes input in the form of a file stream. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The publishing channel used for publishing the content along with publishing parameters (specific to provided publishing channel). |
|
|
Returns |
Returns the filestream of output after publishing an asset to the required format. |
||
|
Examples |
URL:
Result: The filestream of output after publishing an asset to the required format. |
||
|
Function |
Deliver a non-Platform resource. |
||
|
Description |
Publish and deliver non-platform resource. Takes input in the form of a file stream. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The delivery channel used to deliver the QPP asset or published content to any of the available delivery channels.Delivery channel parameters are specific to the channel and all are mandatory. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
createDatadoc
|
Function |
Create a Datadoc. |
||
|
Description |
This request creates a datadoc by executing the given datadoc channel and checks it in to the platform with the given metadata. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The Datadoc channel. (Mandatory) |
|
|
|
boolean |
Indicates whether you should create a Minor version. |
|
|
|
string |
See "Request/Response parameter formats." |
|
|
Returns |
Returns the metadata of newly created Datadoc asset. |
||
|
Examples |
URL:
Result:
|
||
getDatadocChannels
|
Function |
Get all datadoc channels. |
||
|
Description |
This request returns all channels of type 'datadoc' that exist in the system. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get DataDoc Channels for Desired Content-Type. |
||
|
Description |
This request returns channels of type DataDoc which are mapped to the given content type. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
fetchDatadocAssets
|
Function |
Fetch Datadoc Assets. |
||
|
Description |
This request returns the metadata of the datadoc assets which had been created by executing the given channel and parameters. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The Datadoc channel. (Mandatory) |
|
|
Returns |
Returns the metadata of the Datadoc asset created through the supplied datadoc channel. |
||
|
Examples |
URL:
Result:
|
||
executeDatadocChannel
|
Function |
Execute Datadoc Channels. |
||
|
Description |
This request executes the given datadoc channel and writes the resulted datadoc content to the given outputstream. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The Datadoc channel. (Mandatory) |
|
|
|
string |
Channel parameters. |
|
|
Returns |
Resultant output is returned in the response body stream. |
||
|
Examples |
URL:
|
||
updateDatadoc
|
Function |
Update a Datadoc. |
||
|
Description |
This request updates the existing datadoc asset by creating its new version. Latest content of the asset is fetched by executing the desired datadoc channel. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The Datadoc channel. (Mandatory) |
|
|
|
boolean |
Indicates whether you should create a Minor version. |
|
|
|
string |
See "Request/Response parameter formats." |
|
|
Returns |
Returns the metadata of the successfully updated Datadoc asset. |
||
|
Examples |
URL:
Result:
|
||
detachDatadocChannel
|
Function |
Detach a DataDoc asset from its source. |
||
|
Description |
This request detaches or unlinks the given datadoc asset from its source content and creates a new version of the asset. After detaching/unlinking, the given asset will no more be a datadoc asset and thus can be checked-out and checked-in by the end user like other conventional assets in the Platform. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The Datadoc channel. (Mandatory) |
|
|
|
boolean |
Indicates whether you should create a Minor version. |
|
|
Returns |
Returns the metadata of newly created asset. |
||
|
Examples |
URL:
Result:
|
||
