Quark application API

AssetService

abortCheckout

Releases the asset from checked-out state and publishes ASSET_CHECKOUT_ABORT message. The asset must be locked before abort checkout operation and unlocked afterwards. Abort check-out also deletes the asset draft(if any exists) of the given asset.

Request

POST /api/v1/assetService/abortCheckout[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.

Responses

Status Code	Description	Samples
200	return an asset with abort checkout
400	QppServiceException: unhandled server execption

cancelCheckin

Request will cancel the checkin for an asset

Request

POST /api/v1/assetService/cancelCheckin[?contextId]

Parameters

Name	Type	Value	Notes
contextId	string		Variable contextId should refer to the QPP Server's Asset upload context id.

Responses

Status Code	Description	Samples
200	succefully canceled
400	QppServiceException: Unhandled server exception.

cancelDraft

Request will cancel the draft for checkin asset

Request

POST /api/v1/assetService/cancelDraft[?contextId]

Parameters

Name	Type	Value	Notes
contextId	string		Variable contextId should refer to the QPP Server's Asset upload context id.

Responses

Status Code	Description	Samples
200	succefully canceled
400	QppServiceException: Unhandled server exception.

checkOut

Marks the asset with the given assetId

Request

POST /api/v1/assetService/checkOut[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.
AttributeValue			Represents the value of an attribute along with other metadata that is required to recognize the attribute value.

Responses

Status Code	Description	Samples
200	return an asset with checkout	Download
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

createAssetRelations

Creates a new relation between two assets, After successful creation of asset relation , message of object type and change type ASSET_RELATION_ADDED is published..

Request

POST /api/v1/assetService/createAssetRelations

Parameters

Name	Type	Value	Notes
AssetRelation			Encapsulates information of a relation between the two QPP assets. This include parent asset id, child asset id, child asset version

Responses

Status Code	Description	Samples
200	will return asset relation ids array
400	QppServiceException: unhandled server execption
401	InvalidAssetRelationException :This exception is thrown while creating an asset relation.

createAssetRelationsWithParentVersions

Request will create relation with parent version of asset

Request

POST /api/v1/assetService/createAssetRelationsWithParentVersions

Responses

Status Code	Description	Samples
200	will return relation ids array
400	QppServiceException: unhandled server execption
401	InvalidAssetRelationException :This exception is thrown while creating an asset relation.

createAssetVersion

This request will create version to an Asset

Request

POST /api/v1/assetService/createAssetVersion[?keepCheckedOut&createMinorVersion]

Parameters

Name	Type	Notes
keepCheckedOut	boolean	Variable keepCheckedOut should refer to either we want to checkout the asset default will be false
createMinorVersion	boolean	Variable createMinorVersion should refer to true or false for creating version for check in
Asset		Contains asset metadata in the form of array of attribute values..

Responses

Status Code	Description	Samples
200	created version successfully
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

deleteAsset

Deletes the asset with the given id and publishes ASSET_DELETED message. All associated asset relations would also get deleted on deletion of assset. The asset must be locked before deleting it.

Request

POST /api/v1/assetService/deleteAsset[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.

Responses

Status Code	Description	Samples
200	will delete the asset
401	AssetNotFoundException: If no asset corresponding to the given id exists or the asset lies in a collection that is not accessible to the logged in user.The specific reason for the exception can be determined by calling getExceptionCode()

deleteAssetRelations

Deletes asset relations with the given ids,After successful delete of asset relation , message of object type and change type ASSET_RELATION_DELETED is published for each asset relation deleted.

Request

POST /api/v1/assetService/deleteAssetRelations

Responses

Status Code	Description	Samples
200	delte the relation with respect to relation ids provide
400	QppServiceException: unhandled server execption

duplicateAsset

Duplicates the given asset and returns the Asset object of newly created asset.

Request

POST /api/v1/assetService/duplicateAsset[?assetId&createMinorVersion]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
createMinorVersion	boolean	Variable createMinorVersion should refer to creating version for duplicate asset.
DuplicateAssetInfo		Contains asset attribute values to be overridden and relations options to be used while duplicating asset.

Responses

Status Code	Description	Samples
200	return duplicate Asset
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

ApplicableContentPrivileges for Asset

Request will return the privillages

Request

GET /api/v1/assetService/getApplicableContentPrivileges[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.

Responses

Status Code	Description	Samples
200	return list of content privillages
400	QppServiceException: Unhandled server exception.

getAsset

GetAssetMetaData

Request

GET /api/v1/assetService/getAsset

Responses

Status Code	Description	Samples
200	Found the Asset data	Download
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user

getAssetDownloadInfo

Request will return asset download info

Request

GET /api/v1/assetService/getAssetDownloadInfo[?assetId&minorVersion&majorVersion]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	Will return asset download info	Download
400	QppServiceException: Unhandled server exception.

getAssetIdByPath

Request

GET /api/v1/assetService/getAssetIdByPath

Responses

Status Code	Description	Samples
200	successful operation

getAssetIdByPathAndName

Request will return asset id by path name

Request

GET /api/v1/assetService/getAssetIdByPathAndName[?collectionPath&assetName]

Parameters

Name	Type	Value	Notes
collectionPath	string		Variable collectionPath should refer to the QPP Server's Asset collection path.
assetName	string		Variable collectionPath should refer to the QPP Server's Assetname

Responses

Status Code	Description	Samples
200	return Asset id
400	QppServiceException: Unhandled server exception.

getAssetPublicUrl

Request

GET /api/v1/assetService/getAssetPublicUrl

Responses

Status Code	Description	Samples
200	successful operation

getAssetRelations

This request will the list of relation of an asset

Request

GET /api/v1/assetService/getAssetRelations

Responses

Status Code	Description	Samples
200	Will return the list of asset relation
400	QppServiceException: Unhandled server exception.

getAssetRelationsWithParentVersions

This request will the list of relation of an parent asset version with relation ids

Request

GET /api/v1/assetService/getAssetRelationsWithParentVersions

Responses

Status Code	Description	Samples
200	Will return the list of asset relation
400	QppServiceException: Unhandled server exception.

getAssetRenditionDownloadInfo

Request will return list of asset redition download info

Request

GET /api/v1/assetService/getAssetRenditionDownloadInfo[?assetId&minorVersion&majorVersion&renditionType]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.
renditionType	integer	rendition type

Responses

Status Code	Description	Samples
200	Will return asset redition download info
400	QppServiceException: Unhandled server exception.

getAssetRenditionPartDownloadInfo

Request will return asset redition download info

Request

GET /api/v1/assetService/getAssetRenditionPartDownloadInfo[?assetId&minorVersion&majorVersion&renditionType&layoutNumber&pageNumber]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.
renditionType	integer	rendition type
layoutNumber	integer	layout number
pageNumber	integer	page number

Responses

Status Code	Description	Samples
200	Will return asset redition download info
400	QppServiceException: Unhandled server exception.

getAssetRenditionsInfo

Request

GET /api/v1/assetService/getAssetRenditionsInfo[?assetId&minorVersion&majorVersion&renditionType]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.
renditionType	integer	By Specifying rendition type, emtadata of that redition will be return. Available redition are: PREVIEW,THUMBNAIL,ARTICLE_PAGE_PICTURE,TEXT"

Responses

Status Code	Description	Samples
200	Returns an assetReditionInfoList object containing an array of all available reditions of the same asset.
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getAssetStatus

This request will provide the status of an asset

Request

GET /api/v1/assetService/getAssetStatus[?contextId]

Parameters

Name	Type	Value	Notes
contextId	string		Variable contextId should refer to the QPP Server's Asset info contextId

Responses

Status Code	Description	Samples
200	will return the status of asset	Download
400	QppServiceException :Unhandled server exception.

getAssetVersion

GetAssetVersion

Request

GET /api/v1/assetService/getAssetVersion

Responses

Status Code	Description	Samples
200	Found the Asset data with Asset version	Download
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getAssetVersionNumbers

This request will return asset versions

Request

GET /api/v1/assetService/getAssetVersionNumbers[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's parent Asset.

Responses

Status Code	Description	Samples
200	Returns an list of asset versions	Download
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getAttributeValues

GetAttributeValue

Request

GET /api/v1/assetService/getAttributeValues

Responses

Status Code	Description	Samples
200	Found the Asset attribute values by id	Download
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getAttributeValuesByName

GetAttributeByName

Request

GET /api/v1/assetService/getAttributeValuesByName[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.

Responses

Status Code	Description	Samples
200	Found the Asset attribute values by id	Download
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getAttributeValuesForAssetVersion

GetAttributeByName

Request

GET /api/v1/assetService/getAttributeValuesForAssetVersion[?assetId&minorVersion&majorVersion]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	Found the Asset attribute values by id	Download
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getAttributeValuesForAssetVersions

Returns metadata of asset-versions of the given assetId in descending order (latest to oldest version) after (excluding) the specified versionOffset. If versionOffset is NULL, then metadata will be returned for asset-versions starting from the latest version. The number of asset-versions whose metadata is to be retrieved is specified by versionsCount. If versionsCount is less than 0, then metadata of all versions after the versionOffset will be returned. The attributes whose value is to be returned for the versions are specified by attributeIds. Major version, minor version and content-type attributes will always be returned.

Request

GET /api/v1/assetService/getAttributeValuesForAssetVersions[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.

Responses

Status Code	Description	Samples
200	return list of asset
400	QppServiceException: unhandled server execption

getChildAssetRelations

Request

GET /api/v1/assetService/getChildAssetRelations[?parentAssetId]

Parameters

Name	Type	Value	Notes
parentAssetId	integer		Variable assetId should refer to the QPP Server's parent Asset.

Responses

Status Code	Description	Samples
200	Returns an assetRelationInfoList between assets.
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getChildAssetRelationsOfType

Request

GET /api/v1/assetService/getChildAssetRelationsOfType[?parentAssetId]

Parameters

Name	Type	Value	Notes
parentAssetId	integer		Variable assetId should refer to the QPP Server's parent Asset.

Responses

Status Code	Description	Samples
200	Returns an childern's relation list of parent assets.
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getChildAssetRelationsVersion

Request

GET /api/v1/assetService/getChildAssetRelationsVersion[?parentAssetId&minorVersion&majorVersion]

Parameters

Name	Type	Notes
parentAssetId	integer	Variable assetId should refer to the QPP Server's parent Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	Returns an childern's version list of parent assets.
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getChildAssetRelationsVersionOfType

This request will the list of relation of an child asset version with type id

Request

GET /api/v1/assetService/getChildAssetRelationsVersionOfType[?minorVersion&majorVersion]

Parameters

Name	Type	Value	Notes
minorVersion	integer		"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer		"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	Will return the list of asset relation
400	QppServiceException: Unhandled server exception.

getDraftAttributeValues

Request will return attribute draft values

Request

GET /api/v1/assetService/getDraftAttributeValues[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset id.

Responses

Status Code	Description	Samples
200	return draft attribute value
400	QppServiceException: Unhandled server exception.

getDraftDownloadInfo

Request will return draft asset download info

Request

GET /api/v1/assetService/getDraftDownloadInfo[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset id.

Responses

Status Code	Description	Samples
200	return asset download info
400	QppServiceException: unhandled server execption

getLastManualSavedAssetVersion

Request will return the last saved asset version

Request

GET /api/v1/assetService/getLastManualSavedAssetVersion[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.

Responses

Status Code	Description	Samples
200	returnasset version
400	QppServiceException: unhandled server execption

getParentAssetRelations

This request will the list of relation of an parent asset relation

Request

GET /api/v1/assetService/getParentAssetRelations[?childAssetId]

Parameters

Name	Type	Value	Notes
childAssetId	integer		Variable childAssetId should refer to the QPP Server's child asset which has raltion with parent.

Responses

Status Code	Description	Samples
200	Will return the list of asset relation
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If no asset corresponding to the given id exists or the asset lies in a collection that is not accessible to the logged in user.The specific reason for the exception can be determined by calling getExceptionCode()

getParentAssetRelationsOfType

This request will the list of relation of an parent asset with type

Request

GET /api/v1/assetService/getParentAssetRelationsOfType[?childAssetId]

Parameters

Name	Type	Value	Notes
childAssetId	integer		Variable assetId should refer to the QPP Server's child asset which has relation with parent asset.

Responses

Status Code	Description	Samples
200	Will return the list of asset relation
400	QppServiceException: Unhandled server exception.

getParentAssetRelationsVersion

This request will the list of relation of an parent asset relation version

Request

GET /api/v1/assetService/getParentAssetRelationsVersion[?childAssetId&minorVersion&majorVersion]

Parameters

Name	Type	Notes
childAssetId	integer	Variable childAssetId should refer to the QPP Server's child asset which has raltion with parent.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	Will return the list of asset relation
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If no asset corresponding to the given id exists or the asset lies in a collection that is not accessible to the logged in user.The specific reason for the exception can be determined by calling getExceptionCode()

getParentAssetRelationsVersionOfType

This request will the list of relation of an parent asset version with type id

Request

GET /api/v1/assetService/getParentAssetRelationsVersionOfType[?childAssetId&minorVersion&majorVersion]

Parameters

Name	Type	Notes
childAssetId	integer	Variable assetId should refer to the QPP Server's child asset which has relation with parent asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	Will return the list of asset relation
400	QppServiceException: Unhandled server exception.

getValidAssetIds

Request will return list valid asset ids

Request

GET /api/v1/assetService/getValidAssetIds

Responses

Status Code	Description	Samples
200	return duplicate Asset

getWorkflowAttributes

Request will return list of attribute

Request

GET /api/v1/assetService/getWorkflowAttributes

Responses

Status Code	Description	Samples
200	return list attributes
400	QppServiceException: Unhandled server exception.

initCheckin

Request will checkIn a local file, specified in variable "filePath", to QPP an asset.

Request

POST /api/v1/assetService/initCheckin[?createMinorVersion]

Parameters

Name	Type	Value	Notes
createMinorVersion	integer		Variable createMinorVersion should refer to true or false for creating version for checking.
Asset			Contains asset metadata in the form of array of attribute values..

Responses

Status Code	Description	Samples
200	checkin asset successfully	Download
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

initCheckinWithRelations

This request will checkin asset with relations

Request

POST /api/v1/assetService/initCheckinWithRelations[?createMinorVersion]

Parameters

Name	Type	Value	Notes
createMinorVersion	boolean		Variable createMinorVersion should refer to true or false for creating version for checkin
AssetWithRelations			Encapsulates information of asset relations including its metadata.

Responses

Status Code	Description	Samples
200	will return the upload info for the asset
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

initDraftUpload

Request will initialise draft upload

Request

POST /api/v1/assetService/initDraftUpload[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset id.

Responses

Status Code	Description	Samples
200	return asset upload info
400	QppServiceException: unhandled server execption

initGeometryUpdate

Request will return asset upload info

Request

POST /api/v1/assetService/initGeometryUpdate[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset id.

Responses

Status Code	Description	Samples
200	return asset upload info
400	QppServiceException: Unhandled server exception.

initNewCheckin

Request will checkIn a local file, specified in variable "filePath", to QPP as new asset.

Request

POST /api/v1/assetService/initNewCheckin[?createMinorVersion]

Parameters

Name	Type	Value	Notes
createMinorVersion	boolean		Variable createMinorVersion should refer to true or false for creating version for checking.
Asset			Contains asset metadata in the form of array of attribute values..

Responses

Status Code	Description	Samples
200	checkin asset successfully	Download
400	QppServiceException: unhandled server execption
401	MinorVersionNotSupportedException :This exception is thrown while trying to create asset's minor version when it is not allowed in the revision control settings of the collection(in which the asset is being checked-in) for the given content type.

initNewCheckinWithInitialVersion

Request will create a new context for asset checkin with the specified asset version.

Request

POST /api/v1/assetService/initNewCheckinWithInitialVersion[?createMinorVersion&initialMajorVersion&initialMinorVersion]

Parameters

Name	Type	Notes
createMinorVersion	boolean	Variable createMinorVersion should refer to true or false for creating version for checking.
Asset		Contains asset metadata in the form of array of attribute values..
initialMajorVersion	integer	Initial Major version. Default is 0.
initialMinorVersion	integer	Initial Minor version. Default is 0.

Responses

Status Code	Description	Samples
200	AssetUploadInfo containing contextId and uploadUrl
400	QppServiceException: unhandled server execption
401	MinorVersionNotSupportedException :This exception is thrown while trying to create asset's minor version when it is not allowed in the revision control settings of the collection(in which the asset is being checked-in) for the given content type.

initNewCheckinWithRelations

This request will checkin new asset with relations

Request

POST /api/v1/assetService/initNewCheckinWithRelations[?createMinorVersion]

Parameters

Name	Type	Value	Notes
createMinorVersion	integer		Variable createMinorVersion should refer to true or false for creating version for checkin
AssetWithRelations			Encapsulates information of asset relations including its metadata.

Responses

Status Code	Description	Samples
200	will return the upload info for the new asset
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

initNewCheckinWithRelationsAndInitialVersion

This request will checkin new asset with relations and specified asset version

Request

POST /api/v1/assetService/initNewCheckinWithRelationsAndInitialVersion[?createMinorVersion&initialMajorVersion&initialMinorVersion]

Parameters

Name	Type	Notes
createMinorVersion	boolean	Variable createMinorVersion should refer to true or false for creating version for checkin
AssetWithRelations		Encapsulates information of asset relations including its metadata.
initialMajorVersion	integer	Initial Major version. Default is 0.
initialMinorVersion	integer	Initial Minor version. Default is 0.

Responses

Status Code	Description	Samples
200	will return the upload info for the new asset
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

initRenditionUpload

Request will return asset redition upload info

Request

POST /api/v1/assetService/initRenditionUpload[?assetId&minorVersion&majorVersion&renditionType]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.
renditionType	integer	rendition type

Responses

Status Code	Description	Samples
200	Will return asset redition upload info
400	QppServiceException: Unhandled server exception.

promoteDraft

Promotes the last saved asset draft to a new asset version. It uses the saved draft copy of the content and creates a new asset version. After promoting the content to the new version, asset draft will be deleted and ASSET_VERSION_ADDED message will be published.

Request

POST /api/v1/assetService/promoteDraft[?createMinorVersion]

Parameters

Name	Type	Value	Notes
createMinorVersion	boolean		Variable createMinorVersion should refer to true or false for creating version for check in
Asset			Contains asset metadata in the form of array of attribute values..

Responses

Status Code	Description	Samples
200	will return the promteDraft asset
400	QppServiceException: unhandled server execption

revertToOlderVersion

This request will revert asset to older version

Request

POST /api/v1/assetService/revertToOlderVersion[?majorVersion]

Parameters

Name	Type	Value	Notes
majorVersion	integer		majorVersion should refer to the required Asset's major version. Provide null to fetch metadata of latest version

Responses

Status Code	Description	Samples
200	succefully reverted to older version and will return updated Asset
400	QppServiceException: unhandled server execption
401	AssetNotFoundException: If any of the parent asset or child asset - does not exist or lies in a collection that is not accessible to the logged in user. The specific reason for the exception can be determined by calling getExceptionCode(). Additional info will refer to the asset id that does not exist.

set AttributeValues for Asset

Sets the given attributes' values for the given asset. After the attribute values are set, message ASSET_CHANGED is published. The asset must be locked before setting attribute values and unlocked afterwards.

Request

POST /api/v1/assetService/setAttributeValues[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.

Responses

Status Code	Description	Samples
200	Will update the attribute values of an asset	Download
400	QppServiceException: Unhandled server exception.

setAttributeValuesForAssetVersion

Request will set attribute values for asset version

Request

POST /api/v1/assetService/setAttributeValuesForAssetVersion[?assetId&minorVersion&majorVersion&AttributeValue]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.
AttributeValue	integer	Represents the value of an attribute along with other metadata that is required to recognize the attribute value.

Responses

Status Code	Description	Samples
200	Will update the attribute values
400	QppServiceException: Unhandled server exception.
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

updateAllChildAssetsVersion

Updates child assets version to latest versions in all relations involving given asset id as parent asset id.

Request

POST /api/v1/assetService/updateAllChildAssetsVersion[?parentAssetId]

Parameters

Name	Type	Value	Notes
parentAssetId	integer		Variable assetId should refer to the QPP Server's parent Asset

Responses

Status Code	Description	Samples
200	successfully updated all versions
400	QppServiceException: unhandled server execption

updateAllChildAssetsVersionForRelationType

Updates child assets versions to latest versions in all those relations with the given asset id as parent asset id and any of the given relation type.

Request

POST /api/v1/assetService/updateAllChildAssetsVersionForRelationType[?parentAssetId]

Parameters

Name	Type	Value	Notes
parentAssetId	integer		Variable assetId should refer to the QPP Server's parent Asset.

Responses

Status Code	Description	Samples
200	successfully updated all versions
400	QppServiceException: unhandled server execption

updateAsset

Request will update the asset meta data

Request

POST /api/v1/assetService/updateAsset

Parameters

Name	Type	Value	Notes
Asset			Contains asset metadata in the form of array of attribute values.

Responses

Status Code	Description	Samples
200	asset updated successfully
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

updateChildAssetVersion

Updates the child asset version in all asset relations involving given parent and child asset id's,After successful update of child asset version in asset relation , message of object type and change type ASSET_RELATION_CHILD_VERSION_CHANGED is published for each asset relation updated.

Request

POST /api/v1/assetService/updateChildAssetVersion[?parentAssetId&childAssetId&childMajorVersion&childMinorVersion]

Parameters

Name	Type	Notes
parentAssetId	integer	Variable assetId should refer to the QPP Server's parent Asset
childAssetId	integer	Variable assetId should refer to the QPP Server's child Asset id
childMajorVersion	integer	childMajorVersion should refer to the required Asset's major version.
childMinorVersion	integer	childMinorVersion should refer to the required Asset's minor version.

Responses

Status Code	Description	Samples
200	successfully updated child asset versions	Download
400	QppServiceException: unhandled server execption

AssetServiceV3

abortCheckout

Request

POST /api/v3/assetService/abortCheckout[?assetId&branchId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.
branchId	integer		"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	return an asset with abort checkout
400	QppServiceException: unhandled server execption

cancelCheckin

Request will cancel the checkin for an asset

Request

POST /api/v3/assetService/cancelCheckin[?contextId]

Parameters

Name	Type	Value	Notes
contextId	string		Variable contextId should refer to the QPP Server's Asset upload context id.

Responses

Status Code	Description	Samples
200	succefully canceled
400	QppServiceException: Unhandled server exception.

cancelDraft

Request will cancel the draft for checkin asset

Request

POST /api/v3/assetService/cancelDraft[?contextId]

Parameters

Name	Type	Value	Notes
contextId	string		Variable contextId should refer to the QPP Server's Asset upload context id.

Responses

Status Code	Description	Samples
200	succefully canceled
400	QppServiceException: Unhandled server exception.

checkOut

Marks the asset with the given assetId

Request

POST /api/v3/assetService/checkOut[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.
AttributeValue			Represents the value of an attribute along with other metadata that is required to recognize the attribute value.

Responses

Status Code	Description	Samples
200	return an asset with checkout	Download
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

createAssetRelations

Creates a new relation between two assets, After successful creation of asset relation , message of object type and change type ASSET_RELATION_ADDED is published..

Request

POST /api/v3/assetService/createAssetRelations

Parameters

Name	Type	Value	Notes
AssetRelation			Encapsulates information of a relation between the two QPP assets. This include parent asset id, child asset id, child asset version

Responses

Status Code	Description	Samples
200	will return asset relation ids array
400	QppServiceException: unhandled server execption
401	InvalidAssetRelationException :This exception is thrown while creating an asset relation.

createAssetRelationsWithParentVersions

Request will create relation with parent version of asset

Request

POST /api/v3/assetService/createAssetRelationsWithParentVersions

Responses

Status Code	Description	Samples
200	will return relation ids array
400	QppServiceException: unhandled server execption
401	InvalidAssetRelationException :This exception is thrown while creating an asset relation.

createAssetVersion

This request will create version to an Asset

Request

POST /api/v3/assetService/createAssetVersion[?keepCheckedOut&createMinorVersion]

Parameters

Name	Type	Notes
keepCheckedOut	boolean	Variable keepCheckedOut should refer to either we want to checkout the asset default will be false
createMinorVersion	boolean	Variable createMinorVersion should refer to true or false for creating version for check in
Asset		Contains asset metadata in the form of array of attribute values..

Responses

Status Code	Description	Samples
200	created version successfully
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

deleteAsset

Deletes the asset with the given id and publishes ASSET_DELETED message. All associated asset relations would also get deleted on deletion of assset. The asset must be locked before deleting it.

Request

POST /api/v3/assetService/deleteAsset[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.

Responses

Status Code	Description	Samples
200	will delete the asset
401	AssetNotFoundException: If no asset corresponding to the given id exists or the asset lies in a collection that is not accessible to the logged in user.The specific reason for the exception can be determined by calling getExceptionCode()

deleteAssetRelations

Deletes asset relations with the given ids,After successful delete of asset relation , message of object type and change type ASSET_RELATION_DELETED is published for each asset relation deleted.

Request

POST /api/v3/assetService/deleteAssetRelations

Responses

Status Code	Description	Samples
200	delte the relation with respect to relation ids provide
400	QppServiceException: unhandled server execption

duplicateAsset

Duplicates the given asset and returns the Asset object of newly created asset.

Request

POST /api/v3/assetService/duplicateAsset[?assetId&createMinorVersion]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
createMinorVersion	boolean	Variable createMinorVersion should refer to creating version for duplicate asset.
DuplicateAssetInfo		Contains asset attribute values to be overridden and relations options to be used while duplicating asset.

Responses

Status Code	Description	Samples
200	return duplicate Asset
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

ApplicableContentPrivileges for Asset

Request will return the privillages

Request

GET /api/v3/assetService/getApplicableContentPrivileges[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.

Responses

Status Code	Description	Samples
200	return list of content privillages
400	QppServiceException: Unhandled server exception.

getAsset

GetAssetMetaData

Request

GET /api/v3/assetService/getAsset

Responses

Status Code	Description	Samples
200	Found the Asset data	Download
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user

getAssetDownloadInfo

Request will return asset download info

Request

GET /api/v3/assetService/getAssetDownloadInfo[?assetId&minorVersion&majorVersion]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	Will return asset download info
400	QppServiceException: Unhandled server exception.	Download

getAssetIdByPath

Request

GET /api/v3/assetService/getAssetIdByPath

Responses

Status Code	Description	Samples
200	successful operation

getAssetIdByPathAndName

Request will return asset id by path name

Request

GET /api/v3/assetService/getAssetIdByPathAndName[?collectionPath&assetName]

Parameters

Name	Type	Value	Notes
collectionPath	string		Variable collectionPath should refer to the QPP Server's Asset collection path.
assetName	string		Variable collectionPath should refer to the QPP Server's Assetname

Responses

Status Code	Description	Samples
200	return Asset id
400	QppServiceException: Unhandled server exception.

getAssetPublicUrl

GetAssetPublicUrl

Request

GET /api/v3/assetService/getAssetPublicUrl

Responses

Status Code	Description	Samples
200	Return the Asset public URL
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the asset does not exist or lie in a collection that is not accessible to the logged in user

getAssetRelations

This request will the list of relation of an asset

Request

GET /api/v3/assetService/getAssetRelations

Responses

Status Code	Description	Samples
200	Will return the list of asset relation
400	QppServiceException: Unhandled server exception.

getAssetRelationsWithParentVersions

This request will the list of relation of an parent asset version with relation ids

Request

GET /api/v3/assetService/getAssetRelationsWithParentVersions

Responses

Status Code	Description	Samples
200	Will return the list of asset relation
400	QppServiceException: Unhandled server exception.

getAssetRenditionDownloadInfo

Request will return list of asset redition download info

Request

GET /api/v3/assetService/getAssetRenditionDownloadInfo[?assetId&minorVersion&majorVersion&branchId&renditionType]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.
branchId	integer	"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.
renditionType	integer	rendition type

Responses

Status Code	Description	Samples
200	Will return asset redition download info
400	QppServiceException: Unhandled server exception.

getAssetRenditionPartDownloadInfo

Request will return asset redition download info

Request

GET /api/v3/assetService/getAssetRenditionPartDownloadInfo[?assetId&minorVersion&majorVersion&branchId&renditionType&layoutNumber&pageNumber]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.
branchId	integer	"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.
renditionType	integer	rendition type
layoutNumber	integer	layout number
pageNumber	integer	page number

Responses

Status Code	Description	Samples
200	Will return asset redition download info
400	QppServiceException: Unhandled server exception.

getAssetRenditionsInfo

Request

GET /api/v3/assetService/getAssetRenditionsInfo[?assetId&minorVersion&majorVersion&branchId&renditionType]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.
branchId	integer	"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.
renditionType	integer	By Specifying rendition type, emtadata of that redition will be return. Available redition are: PREVIEW,THUMBNAIL,ARTICLE_PAGE_PICTURE,TEXT"

Responses

Status Code	Description	Samples
200	Returns an assetReditionInfoList object containing an array of all available reditions of the same asset.
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getAssetStatus

This request will provide the status of an asset

Request

GET /api/v3/assetService/getAssetStatus[?contextId]

Parameters

Name	Type	Value	Notes
contextId	string		Variable contextId should refer to the QPP Server's Asset info contextId

Responses

Status Code	Description	Samples
200	will return the status of asset	Download
400	QppServiceException :Unhandled server exception.

getAssetVersion

GetAssetVersion

Request

GET /api/v3/assetService/getAssetVersion

Responses

Status Code	Description	Samples
200	Found the Asset data with Asset version	Download
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getAssetVersionNumbers

This request will return asset versions

Request

GET /api/v3/assetService/getAssetVersionNumbers[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's parent Asset.

Responses

Status Code	Description	Samples
200	Returns an list of asset versions	Download
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getAttributeValues

GetAttributeValue

Request

GET /api/v3/assetService/getAttributeValues

Responses

Status Code	Description	Samples
200	Found the Asset attribute values by id
400	QppServiceException: unhandled server execption	Download
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getAttributeValuesByName

GetAttributeByName

Request

GET /api/v3/assetService/getAttributeValuesByName[?assetId&branchId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.
branchId	integer		"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	Found the Asset attribute values by id
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getAttributeValuesForAssetVersion

GetAttributeByName

Request

GET /api/v3/assetService/getAttributeValuesForAssetVersion[?assetId&minorVersion&majorVersion&branchId]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.
branchId	integer	"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	Found the Asset attribute values by id
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getAttributeValuesForAssetVersions

Request

GET /api/v3/assetService/getAttributeValuesForAssetVersions[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.

Responses

Status Code	Description	Samples
200	return list of asset
400	QppServiceException: unhandled server execption

getChildAssetRelations

Request

GET /api/v3/assetService/getChildAssetRelations[?parentAssetId]

Parameters

Name	Type	Value	Notes
parentAssetId	integer		Variable assetId should refer to the QPP Server's parent Asset.

Responses

Status Code	Description	Samples
200	Returns an assetRelationInfoList between assets.
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getChildAssetRelationsOfType

Request

GET /api/v3/assetService/getChildAssetRelationsOfType[?parentAssetId]

Parameters

Name	Type	Value	Notes
parentAssetId	integer		Variable assetId should refer to the QPP Server's parent Asset.

Responses

Status Code	Description	Samples
200	Returns an childern's relation list of parent assets.
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getChildAssetRelationsVersion

Request

GET /api/v3/assetService/getChildAssetRelationsVersion[?parentAssetId&minorVersion&majorVersion&branchId]

Parameters

Name	Type	Notes
parentAssetId	integer	Variable assetId should refer to the QPP Server's parent Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.
branchId	integer	"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	Returns an childern's version list of parent assets.
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If the child asset of the relationship does not exist or lie in a collection that is not accessible to the logged in user.

getChildAssetRelationsVersionOfType

This request will the list of relation of an child asset version with type id

Request

GET /api/v3/assetService/getChildAssetRelationsVersionOfType[?minorVersion&majorVersion&branchId]

Parameters

Name	Type	Notes
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.
branchId	integer	"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	Will return the list of asset relation
400	QppServiceException: Unhandled server exception.

getCurrentVersionOnBranchTree

Request will return the Current Major Version Of Asset from Branch Tree

Request

GET /api/v3/assetService/getCurrentVersionOnBranchTree[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.

Responses

Status Code	Description	Samples
200	return lastest version of Asset from a branch
400	QppServiceException: Unhandled server exception.

getDraftAttributeValues

Request will return attribute draft values

Request

GET /api/v3/assetService/getDraftAttributeValues[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset id.

Responses

Status Code	Description	Samples
200	return draft attribute value
400	QppServiceException: Unhandled server exception.

getDraftDownloadInfo

Request will return draft asset download info

Request

GET /api/v3/assetService/getDraftDownloadInfo[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset id.

Responses

Status Code	Description	Samples
200	return asset download info
400	QppServiceException: unhandled server execption

getLastManualSavedAssetVersion

Request will return the last saved asset version

Request

GET /api/v3/assetService/getLastManualSavedAssetVersion[?assetId&branchId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.
branchId	integer		"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	returnasset version
400	QppServiceException: unhandled server execption

getLatestVersionOfBranch

Request will return the Latest Version Of Asset from given Branch

Request

GET /api/v3/assetService/getLatestVersionOfBranch[?assetId&branchId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.
branchId	integer		Provide 0 to fetch metadata of latest version of Origin Branch

Responses

Status Code	Description	Samples
200	return lastest version of Asset from a branch
400	QppServiceException: Unhandled server exception.

getParentAssetRelations

This request will the list of relation of an parent asset relation

Request

GET /api/v3/assetService/getParentAssetRelations[?childAssetId]

Parameters

Name	Type	Value	Notes
childAssetId	integer		Variable childAssetId should refer to the QPP Server's child asset which has raltion with parent.

Responses

Status Code	Description	Samples
200	Will return the list of asset relation
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If no asset corresponding to the given id exists or the asset lies in a collection that is not accessible to the logged in user.The specific reason for the exception can be determined by calling getExceptionCode()

getParentAssetRelationsOfType

This request will the list of relation of an parent asset with type

Request

GET /api/v3/assetService/getParentAssetRelationsOfType[?childAssetId]

Parameters

Name	Type	Value	Notes
childAssetId	integer		Variable assetId should refer to the QPP Server's child asset which has relation with parent asset.

Responses

Status Code	Description	Samples
200	Will return the list of asset relation
400	QppServiceException: Unhandled server exception.

getParentAssetRelationsVersion

This request will the list of relation of an parent asset relation version

Request

GET /api/v3/assetService/getParentAssetRelationsVersion[?childAssetId&minorVersion&majorVersion&branchId]

Parameters

Name	Type	Notes
childAssetId	integer	Variable childAssetId should refer to the QPP Server's child asset which has raltion with parent.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.
branchId	integer	"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	Will return the list of asset relation
400	QppServiceException: unhandled server execption
401	AssetNotFoundException:If no asset corresponding to the given id exists or the asset lies in a collection that is not accessible to the logged in user.The specific reason for the exception can be determined by calling getExceptionCode()

getParentAssetRelationsVersionOfType

This request will the list of relation of an parent asset version with type id

Request

GET /api/v3/assetService/getParentAssetRelationsVersionOfType[?childAssetId&minorVersion&majorVersion&branchId]

Parameters

Name	Type	Notes
childAssetId	integer	Variable assetId should refer to the QPP Server's child asset which has relation with parent asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.
branchId	integer	"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	Will return the list of asset relation
400	QppServiceException: Unhandled server exception.

getValidAssetIds

Request will return list valid asset ids

Request

GET /api/v3/assetService/getValidAssetIds

Responses

Status Code	Description	Samples
200	return duplicate Asset

getWorkflowAttributes

Request will return list of attribute

Request

GET /api/v3/assetService/getWorkflowAttributes

Responses

Status Code	Description	Samples
200	return list attributes
400	QppServiceException: Unhandled server exception.

initCheckin

Request will checkIn a local file, specified in variable "filePath", to QPP an asset.

Request

POST /api/v3/assetService/initCheckin[?createMinorVersion]

Parameters

Name	Type	Value	Notes
createMinorVersion	integer		Variable createMinorVersion should refer to true or false for creating version for checking.
Asset			Contains asset metadata in the form of array of attribute values..

Responses

Status Code	Description	Samples
200	checkin asset successfully	Download
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

initCheckinWithRelations

This request will checkin asset with relations

Request

POST /api/v3/assetService/initCheckinWithRelations[?createMinorVersion]

Parameters

Name	Type	Value	Notes
createMinorVersion	boolean		Variable createMinorVersion should refer to true or false for creating version for checkin
AssetWithRelations			Encapsulates information of asset relations including its metadata.

Responses

Status Code	Description	Samples
200	will return the upload info for the asset
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

initDraftUpload

Request will initialise draft upload

Request

POST /api/v3/assetService/initDraftUpload[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset id.

Responses

Status Code	Description	Samples
200	return asset upload info
400	QppServiceException: unhandled server execption

initGeometryUpdate

Request will return asset upload info

Request

POST /api/v3/assetService/initGeometryUpdate[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset id.

Responses

Status Code	Description	Samples
200	return asset upload info
400	QppServiceException: Unhandled server exception.

initNewCheckin

Request will checkIn a local file, specified in variable "filePath", to QPP as new asset.

Request

POST /api/v3/assetService/initNewCheckin[?createMinorVersion]

Parameters

Name	Type	Value	Notes
createMinorVersion	boolean		Variable createMinorVersion should refer to true or false for creating version for checking.
Asset			Contains asset metadata in the form of array of attribute values..

Responses

Status Code	Description	Samples
200	checkin asset successfully	Download
400	QppServiceException: unhandled server execption
401	MinorVersionNotSupportedException :This exception is thrown while trying to create asset's minor version when it is not allowed in the revision control settings of the collection(in which the asset is being checked-in) for the given content type.

initNewCheckinWithInitialVersion

Request will create a new context for asset checkin with the specified asset version.

Request

POST /api/v3/assetService/initNewCheckinWithInitialVersion[?createMinorVersion&initialMajorVersion&initialMinorVersion]

Parameters

Name	Type	Notes
createMinorVersion	boolean	Variable createMinorVersion should refer to true or false for creating version for checking.
Asset		Contains asset metadata in the form of array of attribute values..
initialMajorVersion	integer	Initial Major version. Default is 0.
initialMinorVersion	integer	Initial Minor version. Default is 0.

Responses

Status Code	Description	Samples
200	AssetUploadInfo containing contextId and uploadUrl
400	QppServiceException: unhandled server execption
401	MinorVersionNotSupportedException :This exception is thrown while trying to create asset's minor version when it is not allowed in the revision control settings of the collection(in which the asset is being checked-in) for the given content type.

initNewCheckinWithRelations

This request will checkin new asset with relations

Request

POST /api/v3/assetService/initNewCheckinWithRelations[?createMinorVersion]

Parameters

Name	Type	Value	Notes
createMinorVersion	integer		Variable createMinorVersion should refer to true or false for creating version for checkin
AssetWithRelations			Encapsulates information of asset relations including its metadata.

Responses

Status Code	Description	Samples
200	will return the upload info for the new asset
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

initNewCheckinWithRelationsAndInitialVersion

This request will checkin new asset with relations and specified asset version

Request

POST /api/v3/assetService/initNewCheckinWithRelationsAndInitialVersion[?createMinorVersion&initialMajorVersion&initialMinorVersion]

Parameters

Name	Type	Notes
createMinorVersion	boolean	Variable createMinorVersion should refer to true or false for creating version for checkin
AssetWithRelations		Encapsulates information of asset relations including its metadata.
initialMajorVersion	integer	Initial Major version. Default is 0.
initialMinorVersion	integer	Initial Minor version. Default is 0.

Responses

Status Code	Description	Samples
200	will return the upload info for the new asset
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

initRenditionUpload

Request will return asset redition upload info

Request

POST /api/v3/assetService/initRenditionUpload[?assetId&minorVersion&majorVersion&branchId&renditionType]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.
branchId	integer	"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.
renditionType	integer	rendition type

Responses

Status Code	Description	Samples
200	Will return asset redition upload info
400	QppServiceException: Unhandled server exception.

promoteDraft

Request

POST /api/v3/assetService/promoteDraft[?createMinorVersion]

Parameters

Name	Type	Value	Notes
createMinorVersion	boolean		Variable createMinorVersion should refer to true or false for creating version for check in
Asset			Contains asset metadata in the form of array of attribute values..

Responses

Status Code	Description	Samples
200	will return the promteDraft asset
400	QppServiceException: unhandled server execption

revertToOlderVersion

This request will revert asset to older version

Request

POST /api/v3/assetService/revertToOlderVersion[?majorVersion&branchId]

Parameters

Name	Type	Value	Notes
majorVersion	integer		majorVersion should refer to the required Asset's major version. Provide null to fetch metadata of latest version
branchId	integer		"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	succefully reverted to older version and will return updated Asset
400	QppServiceException: unhandled server execption
401	AssetNotFoundException: If any of the parent asset or child asset - does not exist or lies in a collection that is not accessible to the logged in user. The specific reason for the exception can be determined by calling getExceptionCode(). Additional info will refer to the asset id that does not exist.

set AttributeValues for Asset

Request

POST /api/v3/assetService/setAttributeValues[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.

Responses

Status Code	Description	Samples
200	Will update the attribute values of an asset	Download
400	QppServiceException: Unhandled server exception.

setAttributeValuesForAssetVersion

Request will set attribute values for asset version

Request

POST /api/v3/assetService/setAttributeValuesForAssetVersion[?assetId&minorVersion&majorVersion&AttributeValue&branchId]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
minorVersion	integer	"minorVersion" should refer to the required Asset's minor version. Provide 0 to fetch metadata of latest version.
majorVersion	integer	"majorVersion" should refer to the required Asset's major version. Provide null to fetch metadata of latest version.
AttributeValue	integer	Represents the value of an attribute along with other metadata that is required to recognize the attribute value.
branchId	integer	"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	Will update the attribute values
400	QppServiceException: Unhandled server exception.
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

updateAllChildAssetsVersion

Updates child assets version to latest versions in all relations involving given asset id as parent asset id.

Request

POST /api/v3/assetService/updateAllChildAssetsVersion[?parentAssetId&parentBranchId]

Parameters

Name	Type	Value	Notes
parentAssetId	integer		Variable assetId should refer to the QPP Server's parent Asset
parentBranchId	integer		"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	successfully updated all versions
400	QppServiceException: unhandled server execption

updateAllChildAssetsVersionForRelationType

Updates child assets versions to latest versions in all those relations with the given asset id as parent asset id and any of the given relation type.

Request

POST /api/v3/assetService/updateAllChildAssetsVersionForRelationType[?parentAssetId]

Parameters

Name	Type	Value	Notes
parentAssetId	integer		Variable assetId should refer to the QPP Server's parent Asset.

Responses

Status Code	Description	Samples
200	successfully updated all versions
400	QppServiceException: unhandled server execption

updateAsset

Request will update the asset meta data

Request

POST /api/v3/assetService/updateAsset

Parameters

Name	Type	Value	Notes
Asset			Contains asset metadata in the form of array of attribute values.

Responses

Status Code	Description	Samples
200	asset updated successfully
400	QppServiceException: unhandled server execption
401	InvalidAttributeValueException :This exception can be thrown while setting some attribute value.

updateChildAssetVersion

Request

POST /api/v3/assetService/updateChildAssetVersion[?parentAssetId&childAssetId&childMajorVersion&childMinorVersion&parentBranchId&childBranchId]

Parameters

Name	Type	Notes
parentAssetId	integer	Variable assetId should refer to the QPP Server's parent Asset
childAssetId	integer	Variable assetId should refer to the QPP Server's child Asset id
childMajorVersion	integer	childMajorVersion should refer to the required Asset's major version.
childMinorVersion	integer	childMinorVersion should refer to the required Asset's minor version.
parentBranchId	integer	"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.
childBranchId	integer	"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	successfully updated child asset versions	Download
400	QppServiceException: unhandled server execption

AttributeService

createAttribute

Creates a new attribute and returns its id and After successful creation of attribute message AttributeMessageConstants.AttributeChangeTypes#ATTRIBUTE_ADDED message is published.

Request

POST /api/v1/attributeService/createAttribute

Responses

Status Code	Description	Samples
200	Returns a attributeInfoList object containing a list of successfully created attribute
400	QppServiceException :Unhandled server exception.

deleteAttribute

This request will delete an attribute with the specified ID After successful deletion of attribute AttributeMessageConstants.AttributeChangeTypes#ATTRIBUTE_DELETED message is published.

Request

POST /api/v1/attributeService/deleteAttribute

Responses

Status Code	Description	Samples
200	will successfully delete an attribute
400	QppServiceException:Unhandled server exception.

duplicateAttribute

This request will duplicate attribute providing source and target

Request

POST /api/v1/attributeService/duplicateAttribute

Responses

Status Code	Description	Samples
200	This return duplicate attribute
400	QppServiceException:Unhandled server exception.

getAllAttributes

This request returns all existing attributes with their metadata of QPP Server.

Request

GET /api/v1/attributeService/getAllAttributes

Responses

Status Code	Description	Samples
200	This request returns all existing attributes with their metadata of QPP Server.
400	QppServiceException:Unhandled server exception.

getAttribute

This request returns an attribute with the specified ID

Request

GET /api/v1/attributeService/getAttribute

Responses

Status Code	Description	Samples
200	Returns an attributeInfoList object
400	QppServiceException:Unhandled server exception.

getAttributeByName

This request returns an attribute with the specified Name

Request

GET /api/v1/attributeService/getAttributeByName

Responses

Status Code	Description	Samples
200	Returns an attributeInfoList object
400	QppServiceException:Unhandled server exception.

getAttributes

This request returns all existing attributes with their metadata of QPP Server specific to ids.

Request

GET /api/v1/attributeService/getAttributes

Responses

Status Code	Description	Samples
200	This request returns all existing attributes with their metadata of QPP Server.
400	QppServiceException:Unhandled server exception.

getAttributesByName

This request returns all existing attributes with their metadata of QPP Server specific to names.

Request

GET /api/v1/attributeService/getAttributesByName

Responses

Status Code	Description	Samples
200	This request returns all existing attributes with their metadata of QPP Server.
400	QppServiceException:Unhandled server exception.

updateAttribute

This request is used to update the metadata of attribute.

Request

POST /api/v1/attributeService/updateAttribute

Responses

Status Code	Description	Samples
200	Returns an attributeInfoList object containing a list of successfully updated attribute.
400	QppServiceException:Unhandled server exception.

BlobProvidersManagementService

createBlobLocation

This request is used to create blob data Location of the object

Request

POST /api/v1/blob/manage/createBlobLocation

Responses

Status Code	Description	Samples
200	Returns blob Location object by blob provider id
400	BlobServiceException: bad request

deleteBlobLocation

This request is used to delete blob data Location of the object

Request

POST /api/v1/blob/manage/deleteBlobLocation

Responses

Status Code	Description	Samples
200	Returns deleted blob Location object by blobLocationId
400	BlobServiceException: bad request

getAllBlobLocationInfos

This request is used to retrieve all blob Location information

Request

GET /api/v1/blob/manage/getAllBlobLocationInfos

Responses

Status Code	Description	Samples
200	Returns blob Location information by blobLocationId
400	BlobServiceException: bad request

getAllBlobProviders

This request is used to retrieve blob data object by providers

Request

GET /api/v1/blob/manage/getAllBlobProviders

Responses

Status Code	Description	Samples
200	Returns blob info object
400	BlobServiceException: bad request

getBlobLocationInfos

This request is used to retrieve blob Location information

Request

GET /api/v1/blob/manage/getBlobLocationInfos

Responses

Status Code	Description	Samples
200	Returns blob Location information by blobLocationId
400	BlobServiceException: bad request

getStorageSize

This request is used to retrieve storage size of object

Request

GET /api/v1/blob/manage/getStorageSize

Responses

Status Code	Description	Samples
200	Returns storage size
400	BlobServiceException: bad request

synchronizeAllLocationStatuses

This request is used to retrieve list of synchronized status of the blob Location

Request

POST /api/v1/blob/manage/synchronizeAllLocationStatuses

Responses

Status Code	Description	Samples
200	Returns status List of the blob Location in synchronized by blobLocationId
400	BlobServiceException: bad request

synchronizeLocationStatus

This request is used to retrieve synchronized status of the blob Location

Request

POST /api/v1/blob/manage/synchronizeLocationStatus

Responses

Status Code	Description	Samples
200	Returns status of the blob Location by blobLocationId
400	BlobServiceException: bad request

updateBlobLocation

This request is used to update blob Location

Request

POST /api/v1/blob/manage/updateBlobLocation

Responses

Status Code	Description	Samples
200	Returns updated blob Location object by blobLocationId
400	BlobServiceException: bad request

BlobStorageRulesService

createStorageRule

This request is used to create strorage

Request

POST /api/v1/blob/storagerules/createStorageRule

Responses

Status Code	Description	Samples
200	Returns created storage object
400	BlobServiceException: bad request

createStorageRules

This request is used to create List of strorage rules

Request

POST /api/v1/blob/storagerules/createStorageRules

Responses

Status Code	Description	Samples
200	Returns array of created storage object
400	BlobServiceException: bad request

deleteStorageRule

This request is used to delete strorage rules object

Request

POST /api/v1/blob/storagerules/deleteStorageRule

Responses

Status Code	Description	Samples
200	Returns deleted storage rules by storageRuleId
400	BlobServiceException: bad request

getAllStorageRules

This request is used to retrieve all the strorage rules

Request

GET /api/v1/blob/storagerules/getAllStorageRules

Responses

Status Code	Description	Samples
200	Returns list of storage rules
400	BlobServiceException: bad request

getStorageRule

This request is used to retrieve the strorage rules

Request

GET /api/v1/blob/storagerules/getStorageRule

Responses

Status Code	Description	Samples
200	Returns storage rules by storageRuleId
400	BlobServiceException: bad request

getStorageRulesForBlobType

This request is used to retrieve blob type strorage rules object

Request

GET /api/v1/blob/storagerules/getStorageRulesForBlobType

Responses

Status Code	Description	Samples
200	Returns array blob type of storage rules by blobType
400	BlobServiceException: bad request

getStorageRulesForContentType

This request is used to retrieve content of the strorage rules

Request

GET /api/v1/blob/storagerules/getStorageRulesForContentType

Responses

Status Code	Description	Samples
200	Returns contentType storage rules by storageRuleId
400	BlobServiceException: bad request

updateStorageRule

This request is used to update strorage rules Object

Request

POST /api/v1/blob/storagerules/updateStorageRule

Responses

Status Code	Description	Samples
200	Returns updated storage rules
400	BlobServiceException: bad request

BlobStreamingService

uploadTransientBlob

This request is used to upload transient Blob and request header can be specified while uploading transient blob: * - blob.expiration.time: Time in seconds after which the transient blob is to be deleted. * - blob.resource.name: Name with which the transient blob is to be saved in blob location. * - blob.extract.zip: Boolean flag to specify whether to extract zip blob or not. * - blob.content.type: Content type of the blob.

Request

PUT /api/v1/blob/uploadTransientBlob

Parameters

Name	Type	Value	Notes
InputStreamResource			InputStream for resource.

Responses

Status Code	Description	Samples
200	Returns DownloadInfo object
400	BlobServiceException: bad request

upload

This request is used to upload file by inputstream

Request

PUT /api/v1/blob/{contextId}/{fileIdentifier}

Parameters

Name	Type	Notes
*fileIdentifier	string	Variable fileIdentifier is refer to type of file
*contextId	string	Variable contextId id refer to resource info
*InputStreamResource		InputStream for resource.

Responses

Status Code	Description	Samples
200	Returns array blob type of storage rules by blobType
400	BlobServiceException: bad request

download

This request is used to return the list of response entity object

Request

GET /api/v1/blob/{contextId}/{fileIdentifier}/**

Parameters

Name	Type	Value	Notes
*fileIdentifier	string		Variable fileIdentifier is refer to type of file
*contextId	string		Variable contextId is refer to id of blob

Responses

Status Code	Description	Samples
200	Returns the list of input stream
400	BlobServiceException: bad request

BranchingServiceV3

createBranch

This request will create branched version to an Asset

Request

POST /api/v3/branchingService/createBranch[?assetId&majorVersion&parentBranchId&branchName&isCurrent]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
majorVersion	integer	majorVersion should refer to the required Asset's major version. Provide null to fetch metadata of latest version
parentBranchId	integer	"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.
branchName	string	custom name of branch
isCurrent	boolean	Variable isCurrent should refer to true or false

Responses

Status Code	Description	Samples
200	branch created successfully
400	QppServiceException: unhandled server execption

deleteBranch

This request will delete a specific branch of an asset

Request

POST /api/v3/branchingService/deleteBranch[?assetId&branchId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.
branchId	integer		"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	branch deleted successfully
400	QppServiceException: unhandled server execption

getAllBranches

This request will get total branches created

Request

GET /api/v3/branchingService/getAllBranches

Responses

Status Code	Description	Samples
200	Branches fetched successfully.

getAllBranchesForAsset

This request will return branchInfo of all the branches of an asset.

Request

GET /api/v3/branchingService/getAllBranchesForAsset[?assetId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.

Responses

Status Code	Description	Samples
200	branchInfos returned successfully
400	QppServiceException: unhandled server execption

getAllSubBranches

This request will return sub branches of a branch.

Request

GET /api/v3/branchingService/getAllSubBranches[?assetId&branchId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.
branchId	integer		"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	sub branches returned successfully
400	QppServiceException: unhandled server execption

getBranch

This request will return branchInfo of requested branch.

Request

GET /api/v3/branchingService/getBranch[?assetId&branchId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.
branchId	integer		"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	branchInfo returned successfully
400	QppServiceException: unhandled server execption

getBranchByName

This request will return branchInfo of requested branch.

Request

GET /api/v3/branchingService/getBranchByName[?assetId&branchName]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.
branchName	string		"branchName" should refer to the required Asset's branch custom name.

Responses

Status Code	Description	Samples
200	branchInfo returned successfully
400	QppServiceException: unhandled server execption

hasSubBranches

This request will return true/false based on existence of sub branches of a branch.

Request

GET /api/v3/branchingService/hasSubBranches[?assetId&branchId]

Parameters

Name	Type	Value	Notes
assetId	integer		Variable assetId should refer to the QPP Server's Asset.
branchId	integer		"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	call successful
400	QppServiceException: unhandled server execption

renameBranch

This request will update custom name of a branch

Request

POST /api/v3/branchingService/renameBranch[?assetId&branchId&branchName]

Parameters

Name	Type	Notes
assetId	integer	Variable assetId should refer to the QPP Server's Asset.
branchId	integer	"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.
branchName	string	"branchName" should refer to the required Asset's branch custom name.

Responses

Status Code	Description	Samples
200	branchName updated successfully
400	QppServiceException: unhandled server execption

ChartingService

getChart

This request returns an Excel chart in image format

Request

POST /api/v1/chartingService/getChart

Responses

Status Code	Description	Samples
200	Returns an Excel chart in the image format.
400	QppServiceException:This exception is thrown in case of invalid output format or any error during generation of dynamic charts output.

getChartAsync

This request returns an Excel chart in image format as async

Request

POST /api/v1/chartingService/getChartAsync

Responses

Status Code	Description	Samples
200	Returns an Excel chart in the image format
400	QppServiceException:This exception is thrown in case of invalid output format or any error during generation of dynamic charts output.

getChartBasedOnStream

This request returns an Excel chart in the image format. Include the file in the request body or as file part.

Request

POST /api/v1/chartingService/getChartBasedOnStream

Responses

Status Code	Description	Samples
200	Returns an Excel chart in the image format
400	QppServiceException:This exception is thrown in case of invalid output format or any error during generation of dynamic charts output.

getChartBasedOnUri

This request returns an Excel chart in the image format.

Request

POST /api/v1/chartingService/getChartBasedOnUri

Responses

Status Code	Description	Samples
200	Returns an Excel chart in the image format
400	QppServiceException:This exception is thrown in case of invalid output format or any error during generation of dynamic charts output.

getChartBasedOnUriAsync

This request returns an Excel chart in the image format as async.

Request

POST /api/v1/chartingService/getChartBasedOnUriAsync

Responses

Status Code	Description	Samples
200	Returns an Excel chart in the image format
400	QppServiceException:This exception is thrown in case of invalid output format or any error during generation of dynamic charts output.

getChartingRequestStatusInfo

This request returns an status of Excel chart in the image format object.

Request

GET /api/v1/chartingService/getChartingRequestStatusInfo

Responses

Status Code	Description	Samples
200	Returns status an Excel chart in the image format
400	QppServiceException:This exception is thrown in case of invalid output format or any error during generation of dynamic charts output.

ClipboardService

convertAndGetFormattedDataDownloadInfo

This request is used to convert data and download data info

Request

POST /api/v1/clipboardService/convertAndGetFormattedDataDownloadInfo

Responses

Status Code	Description	Samples
200	Return ClipboardDataDownloadInfo object
400	QppServiceException :The cause is not initialized.

getAllClipboardChannelsMapping

This request retrieves all of the clipboard format to channel mappings.

Request

GET /api/v1/clipboardService/getAllClipboardChannelsMapping

Responses

Status Code	Description	Samples
200	Returns a clipboardChannelMappingInfoList object, containing a list of all clipboard format to channel mappings.
400	QppServiceException:The cause is not initialized.

getAllClipboardDataInfos

This request is used to get all the info and metadata of the clipboard data

Request

GET /api/v1/clipboardService/getAllClipboardDataInfos

Responses

Status Code	Description	Samples
200	Returns array of ClipboardDataInfo object
400	QppServiceException:The cause is not initialized.

getAllClipboardFormats

This request returns all the data formats supported for clipboard data

Request

GET /api/v1/clipboardService/getAllClipboardFormats

Responses

Status Code	Description	Samples
200	Returns a clipboardFormatInfoListobject containing an array of all the clipboard data formats. See the table in the “Request/Response parameter formats” chapter.
400	QppServiceException:The cause is not initialized.

getClipboardChannelsMapping

This request returns the cipboard format to channel mappings based on the content type.

Request

GET /api/v1/clipboardService/getClipboardChannelsMapping

Responses

Status Code	Description	Samples
200	Returns array ClipboardChannelMapping object
400	QppServiceException:The cause is not initialized.

getClipboardDataDownloadInfo

This request is used to get clipboard data download info by data id

Request

GET /api/v1/clipboardService/getClipboardDataDownloadInfo

Responses

Status Code	Description	Samples
200	Returns ClipboardDataDownloadInfo object
400	QppServiceException :The cause is not initialized.

getClipboardDataInfo

This request fetches information about the logged-in user’s clipboard data using the data Id.

Request

GET /api/v1/clipboardService/getClipboardDataInfo

Responses

Status Code	Description	Samples
200	Returns a clipboardDataInfo object in XML format, containing information about the clipboard data using the data Id.
400	QppServiceException :The cause is not initialized.

getClipboardDataStatus

This request is used to get clipboard data status

Request

GET /api/v1/clipboardService/getClipboardDataStatus

Responses

Status Code	Description	Samples
200	Returns ClipboardDataStatusInfo object
400	QppServiceException :The cause is not initialized.

getClipboardFormat

This request is used to get clipboard format

Request

GET /api/v1/clipboardService/getClipboardFormat

Responses

Status Code	Description	Samples
200	Returns ClipboardFormat object
400	QppServiceException:The cause is not initialized.

getFormattedDataDownloadInfo

This request id used to retrieve formatted data download info

Request

GET /api/v1/clipboardService/getFormattedDataDownloadInfo

Responses

Status Code	Description	Samples
200	Return ClipboardDataDownloadInfo object
400	QppServiceException :The cause is not initialized.

getLatestClipboardDataDownloadInfo

This request is used to get latest download info of the clipboard data

Request

GET /api/v1/clipboardService/getLatestClipboardDataDownloadInfo

Responses

Status Code	Description	Samples
200	Returns ClipboardDataDownloadInfo object
400	QppServiceException :The cause is not initialized.

getLatestClipboardDataInfo

This request fetches information about the latest data that was added to the loggedin user’s clipboard.

Request

GET /api/v1/clipboardService/getLatestClipboardDataInfo

Responses

Status Code	Description	Samples
200	Returns a clipboardDataInfo object in XML format, containing information about the latest data added to the users clipboard See the table in the Request/Response parameter formats chapter.
400	QppServiceException :The cause is not initialized.

getLatestFormattedDataDownloadInfo

This request is used to get latest formatted data download info

Request

GET /api/v1/clipboardService/getLatestFormattedDataDownloadInfo

Responses

Status Code	Description	Samples
200	Return ClipboardDataDownloadInfo object
400	QppServiceException :The cause is not initialized.

initClipboardDataFormatUpload

This request is used to upload data format for the clipboard data by id

Request

POST /api/v1/clipboardService/initClipboardDataFormatUpload

Responses

Status Code	Description	Samples
200	Rerturns ClipboardDataUploadInfo object
400	QppServiceException :The cause is not initialized.

initClipboardDataUpload

This request is used to upload clipboard data

Request

POST /api/v1/clipboardService/initClipboardDataUpload

Responses

Status Code	Description	Samples
200	Returns ClipboardDataUploadInfo object
400	QppServiceException :The cause is not initialized.

promoteClipboardDataToAsset

This request promotes the user’s clipboard data to Platform’s asset.

Request

POST /api/v1/clipboardService/promoteClipboardDataToAsset

Responses

Status Code	Description	Samples
200	Returns an assetInfo object, containing the metadata of the newly created asset. See the table in the “Request/Response parameter formats chapter
400	QppServiceException :The cause is not initialized.

promoteClipboardDataToAssetWithInitialVersion

This request promotes the user’s clipboard data to Platform’s asset with specfied asset version.

Request

POST /api/v1/clipboardService/promoteClipboardDataToAssetWithInitialVersion

Responses

Status Code	Description	Samples
200	Returns an assetInfo object, containing the metadata of the newly created asset. See the table in the “Request/Response parameter formats chapter
400	QppServiceException :The cause is not initialized.

CollectionService

createCollection

Creates new collection in the given parent collection and with the given metadata and After successful creation of collection, message of object type and change type COLLECTION_ADDED is published.

Request

POST /api/v1/collectionService/createCollection

Responses

Status Code	Description	Samples
200	Returns the collectionInfo object of the newly created collection.
400	QppServiceException: Unhandled server exception
401	InvalidCollectionException:If the given collection either does not exist or the logged on user has no access to this collection. Exact reason of the exception can be known by calling getExceptionCode() of the exception.
402	InvalidAttributeValueException: If any of the attribute values in supplied in the attributeValues array is not valid. The specific reason for the exception can be found by calling getExceptionCode() of the exception. Whereas, getAdditionalInfo() of the exception, tells you the id of the attribute causing exception

createJobjacket

This request creates new job jacket after parsing the content supplied and returns and object of the newly created Job Jacket. Stream the Job Jackets XML into the request body or send it as a file part.

Request

POST /api/v1/collectionService/createJobjacket

Parameters

Name	Type	Value	Notes
InputStreamResource			input stream resource to create jobJacket

Responses

Status Code	Description	Samples
200	Returns a jobJacketInfoList object that contains Job Jackets
400	QppServiceException: Unhandled server exception

deleteCollection

This request deletes the specified collection or collection template.

Request

POST /api/v1/collectionService/deleteCollection

Responses

Status Code	Description	Samples
200	will successfully delete the collection
400	QppServiceException: Unhandled server exception
401	CollectionInUseException: If collection being deleted is not empty i.e. either collection or some of its child collection contains assets in them

deleteJobJacket

This request deletes the jobjacket with the given id

Request

POST /api/v1/collectionService/deleteJobJacket

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution.
400	QppServiceException: Unhandled server exception

duplicateCollection

This request duplicates a given collection or collection template.

Request

POST /api/v1/collectionService/duplicateCollection

Responses

Status Code	Description	Samples
200	Returns the collectionInfo object of the duplicated collection.
400	QppServiceException: Unhandled server exception

duplicateCollectionWithAssets

Copies collection along with its child collections and assets to a new parent collection after collection hierarchy is created without assets and COLLECTION_ADDED messages are published for each collection created in the hierarchy

Request

POST /api/v1/collectionService/duplicateCollectionWithAssets

Responses

Status Code	Description	Samples
200	Returns the collectionInfo object of the duplicated collection.
400	QppServiceException: Unhandled server exception

duplicateCollectionWithAssetsAsync

This request duplicates a given collection or collection template.

Request

POST /api/v1/collectionService/duplicateCollectionWithAssetsAsync

Responses

Status Code	Description	Samples
200	Returns the collectionInfo object of the duplicated collection.
400	QppServiceException: Unhandled server exception

filterApplicableRoutingGroups

This request will returns list of collection groups filter basis on workflow id and status id

Request

GET /api/v1/collectionService/filterApplicableRoutingGroups

Responses

Status Code	Description	Samples
200	returns list of collection groups
400	QppServiceException: Unhandled server exception

filterApplicableRoutingUsers

This request will returns list of collection users filter basis on workflow id and status id

Request

GET /api/v1/collectionService/filterApplicableRoutingUsers

Responses

Status Code	Description	Samples
200	returns list of collection users
400	QppServiceException: Unhandled server exception

getAccessibleCollectionPath

This request returns all of the metadata associated with an entire collection

Request

GET /api/v1/collectionService/getAccessibleCollectionPath

Responses

Status Code	Description	Samples
200	Returns a list of collection info object
400	QppServiceException: Unhandled server exception
401	InvalidCollectionException:If the given collection either does not exist or the logged on user has no access to this collection. Exact reason of the exception can be known by calling getExceptionCode() of the exception.

getAccessibleImmediateChildCollections

This request returns all of the attrubutes associated with a specific collection

Request

GET /api/v1/collectionService/getAccessibleImmediateChildCollections

Responses

Status Code	Description	Samples
200	Returns a list of collectionInfo object with all its metadata and a list of its attributes.
400	QppServiceException:Unhandled server exception
401	InvalidCollectionException:If the given collection either does not exist or the logged on user has no access to this collection. Exact reason of the exception can be known by calling getExceptionCode() of the exception.

getAccessibleTopLevelCollections

This request returns all of the metadata associated with an entire collection

Request

GET /api/v1/collectionService/getAccessibleTopLevelCollections

Responses

Status Code	Description	Samples
200	Returns a list of collectionInfo object with all its metadata and a list of its attributes.
400	QppServiceException:Unhandled server exception

getAllAccessibleCollectionsIds

Request

GET /api/v1/collectionService/getAllAccessibleCollectionsIds

Responses

Status Code	Description	Samples
200	successful operation

getAllApplicableRoutingUsers

This request will returns list of All applicable routing users basis on workflow id and status id for the collection

Request

GET /api/v1/collectionService/getAllApplicableRoutingUsers

Responses

Status Code	Description	Samples
200	returns list of all applicable routing user
400	QppServiceException: Unhandled server exception

getAllJobJackets

This request returns all the metadata of Job Jackets available in the system.

Request

GET /api/v1/collectionService/getAllJobJackets

Responses

Status Code	Description	Samples
200	Returns a jobJacketInfoList object that contains a list of Job Jackets
400	QppServiceException: Unhandled server exception

getApplicableAttributeConstraints

This request returns attribute constraints applicable to the given status and collection for the logged in user. The user may have multiple userclasses, due to its membership in multiple groups which are mapped to the collection with different userclasses. Since attribute constraints are defined per userclass, multiple constraints in such cases are evaluated and the most permissive set of attribute constraints is returned.

Request

GET /api/v1/collectionService/getApplicableAttributeConstraints

Responses

Status Code	Description	Samples
200	Returns applicable AttributeConstraintsInfo objects
400	StatusNotFoundException: if the status with the given id does not exists.

getApplicablePrivileges

This request returns the privileges applicable for the logged in user for the given collection. These privileges are a union of the privileges of the following user clases:Userclass of the logged in user in the given collection, only if the user is mapped to the given collection.Userclasses of collection mapped groups of which the logged in user is a member

Request

GET /api/v1/collectionService/getApplicablePrivileges

Responses

Status Code	Description	Samples
200	Returns a applicablePrivilegesInfo object containing either application and content level privileges or both, depending upong the parameters.
400	InvalidCollectionException: If the collection Id supplied is invalid or not accessible to the logged on user.

getApplicablePrivilegesForContentType

Request

GET /api/v1/collectionService/getApplicablePrivilegesForContentType

Responses

Status Code	Description	Samples
200	Returns list of applicable status privillages
400	InvalidCollectionException: If the collection Id supplied is invalid or not accessible to the logged on user.

getApplicablePrivilegesForPrivIds

Request

GET /api/v1/collectionService/getApplicablePrivilegesForPrivIds

Responses

Status Code	Description	Samples
200	Returns list of applicable status privillages
400	InvalidCollectionException: If the collection Id supplied is invalid or not accessible to the logged on user.

getApplicableRoutingGroups

This request will returns list of applicable routing group basis on workflow id and status id for the collection

Request

GET /api/v1/collectionService/getApplicableRoutingGroups

Responses

Status Code	Description	Samples
200	returns list of collection group
400	QppServiceException: Unhandled server exception

getApplicableRoutingUsers

This request will returns applicable routing users basis on workflow id and status id for the collection

Request

GET /api/v1/collectionService/getApplicableRoutingUsers

Responses

Status Code	Description	Samples
200	returns list of collection user
400	QppServiceException: Unhandled server exception

getApplicableStatusPrivilegesForContentType

This request returns the applicable status transition for the given workflow, status and collection for the logged in user. If the status transition is overridden for the given userclass, then overridden will be considered

Request

GET /api/v1/collectionService/getApplicableStatusPrivilegesForContentType

Responses

Status Code	Description	Samples
200	Returns list of applicable status privillages
400	InvalidContentTypeException: If the content type with the given id does not exist.

getApplicableStatusPrivilegesForPrivIds

Request

GET /api/v1/collectionService/getApplicableStatusPrivilegesForPrivIds

Responses

Status Code	Description	Samples
200	Returns list of applicable status privillages
400	InvalidContentTypeException: If the content type with the given id does not exist.

getApplicableStatusTransition

Request

GET /api/v1/collectionService/getApplicableStatusTransition

Responses

Status Code	Description	Samples
200	Returns list of applicable status privillages
400	QppServiceException: Unhandled server exception.

getApplicableWorkflowInitialStatuses

Request

GET /api/v1/collectionService/getApplicableWorkflowInitialStatuses

Responses

Status Code	Description	Samples
200	Returns list of applicable status privillages
400	WorkflowNotFoundException: If workflow with the given id does not exist.

getApplicableWorkflows

This request returns the applicable statuses for the given workflow and collection

Request

GET /api/v1/collectionService/getApplicableWorkflows

Responses

Status Code	Description	Samples
200	Returns list of applicable workflows
400	InvalidContentTypeException: If parameter contentTypeIds contains some invalid content type id.

getCollection

This request returns the collection for the given id

Request

GET /api/v1/collectionService/getCollection

Responses

Status Code	Description	Samples
200	Returns the collectionInfo object of the collection.
400	QppServiceException: Unhandled server exception

getCollectionAllAttributeValues

This request returns all of the attrubutes associated with a specific collection

Request

GET /api/v1/collectionService/getCollectionAllAttributeValues

Responses

Status Code	Description	Samples
200	Returns a list of attribute values
400	QppServiceException:Unhandled server exception
401	InvalidCollectionException:If the given collection either does not exist or the logged on user has no access to this collection. Exact reason of the exception can be known by calling getExceptionCode() of the exception.

getCollectionAttributeValues

This request returns attrubutes associated with a specific collection

Request

GET /api/v1/collectionService/getCollectionAttributeValues

Responses

Status Code	Description	Samples
200	Returns a list of attribute values
400	QppServiceException:Unhandled server exception
401	InvalidCollectionException:If the given collection either does not exist or the logged on user has no access to this collection. Exact reason of the exception can be known by calling getExceptionCode() of the exception.

getCollectionDefaultJobJacket

This request returns the default job jacket set for a collection. Returns null if no job jacket is specified as default for this collection or the content of the job jacket is not found.

Request

GET /api/v1/collectionService/getCollectionDefaultJobJacket

Responses

Status Code	Description	Samples
200	Returns a jobJacketInfo object with its metadata
400	QppServiceException: Unhandled server exception

getCollectionDefaultTicket

This request returns the default Job Ticket for the collection.

Request

GET /api/v1/collectionService/getCollectionDefaultTicket

Responses

Status Code	Description	Samples
200	Returns the name of the default job ticket for a collection.
400	QppServiceException: Unhandled server exception

getCollectionGroups

This request returns an array of applicable routings groups for the given collection for the specified workflow and status. This will return all collection mapped groups whose userclass is the same as one of the status mapped userclasses.

Request

GET /api/v1/collectionService/getCollectionGroups

Responses

Status Code	Description	Samples
200	Returns a list of applicable routing GroupInfo objects for the given collection and status
400	QppServiceException: Unhandled server exception
401	InvalidCollectionException:If the given collection either does not exist or the logged on user has no access to this collection. Exact reason of the exception can be known by calling getExceptionCode() of the exception.

getCollectionInfo

This request returns all of the metadata associated with an entire collection.

Request

GET /api/v1/collectionService/getCollectionInfo

Responses

Status Code	Description	Samples
200	Returns a collectionInfo object with all its metadata and a list of its attributes.
400	QppServiceException:Unhandled server exception
401	InvalidCollectionException:If the given collection either does not exist or the logged on user has no access to this collection. Exact reason of the exception can be known by calling getExceptionCode() of the exception.

getCollectionInfoForCollectionPath

This request returns all of the metadata associated with an entire collection.

Request

GET /api/v1/collectionService/getCollectionInfoForCollectionPath

Responses

Status Code	Description	Samples
200	Returns a collectionInfo object with all its metadata and a list of its attributes.
400	QppServiceException:Unhandled server exception
401	InvalidCollectionException:If the given collection either does not exist or the logged on user has no access to this collection. Exact reason of the exception can be known by calling getExceptionCode() of the exception.

getCollectionJobJackets

This request returns all the metadata of Job Jackets available in the system.

Request

GET /api/v1/collectionService/getCollectionJobJackets

Responses

Status Code	Description	Samples
200	Returns a jobJacketInfoList object that contains a list of Job Jackets.
400	QppServiceException: Unhandled server exception

getCollectionUsers

Request

GET /api/v1/collectionService/getCollectionUsers

Responses

Status Code	Description	Samples
200	Returns a list of applicable routing GroupInfo objects for the given collection and status
400	QppServiceException: Unhandled server exception
401	InvalidCollectionException:If the given collection either does not exist or the logged on user has no access to this collection. Exact reason of the exception can be known by calling getExceptionCode() of the exception.

getCollectionWorkflows

This request returns all of the workflows for given collection

Request

GET /api/v1/collectionService/getCollectionWorkflows

Responses

Status Code	Description	Samples
200	Returns a list of workflow object with all its metadata and a list of its attributes.
400	InvalidCollectionException: If the collection Id supplied is invalid or not accessible to the logged on user.

getDuplicateCollectionStatus

This request return status of duplicate collection for the collection.

Request

GET /api/v1/collectionService/getDuplicateCollectionStatus

Responses

Status Code	Description	Samples
200	Returns the duplicate collectionInfo object of the duplicated collection.
400	QppServiceException: Unhandled server exception

getJobJacketCollections

This request returns job jacket collection ids array

Request

GET /api/v1/collectionService/getJobJacketCollections

Responses

Status Code	Description	Samples
200	Returns a list of job jacket collection ids.
400	QppServiceException: Unhandled server exception

getJobJacketContent

This request returns the actual content of a specified job jacket in xml format.

Request

GET /api/v1/collectionService/getJobJacketContent

Responses

Status Code	Description	Samples
200	Returns the actual content of a specified job jacket in XML format
400	QppServiceException: Unhandled server exception

getJobjacket

This request returns the specified job jacket.

Request

GET /api/v1/collectionService/getJobjacket

Responses

Status Code	Description	Samples
200	Returns a jobJacketInfoList object with its metadata.
400	QppServiceException: Unhandled server exception

getRevisionControlForContentType

This request returns revision for given collection

Request

GET /api/v1/collectionService/getRevisionControlForContentType

Responses

Status Code	Description	Samples
200	Returns a revision object with all its metadata and a list of its attributes.
400	InvalidCollectionException: If the collection Id supplied is invalid or not accessible to the logged on user.

getRevisionControls

This request returns revisions for given collection

Request

GET /api/v1/collectionService/getRevisionControls

Responses

Status Code	Description	Samples
200	Returns a list of revisions object with all its metadata and a list of its attributes.
400	InvalidCollectionException: If the collection Id supplied is invalid or not accessible to the logged on user.

getStatusRoutings

This request returns the status of routing for given collection

Request

GET /api/v1/collectionService/getStatusRoutings

Responses

Status Code	Description	Samples
200	Returns list of status routings
400	QppServiceException: Unhandled server exception

moveCollection

This request moves a collection or collection template from one level to another

Request

POST /api/v1/collectionService/moveCollection

Responses

Status Code	Description	Samples
200	Returns a collectionInfo object of the collection or the collection template with updated metadata.
400	QppServiceException: Unhandled server exception

parseJobJacketXml

This request parses the jobjacket xml and returns a JobJacket object containing the jobjacket name and ticket names.

Request

GET /api/v1/collectionService/parseJobJacketXml

Parameters

Name	Type	Value	Notes
InputStreamResource			Variable collectionId refer to id of the given collection

Responses

Status Code	Description	Samples
200	Returns a jobjacketinfo object in XML format.
400	QppServiceException: Unhandled server exception

setAttributeValues

Updates metadata of collection with the given collection Id and After successful updation of collection metadata, message of object type and change type COLLECTION_CHANGED is published.

Request

POST /api/v1/collectionService/setAttributeValues

Responses

Status Code	Description	Samples
200	Returns a collectionInfo object with all its metadata and a list of its attributes.
400	QppServiceException: Unhandled server exception
401	InvalidCollectionException:If the given collection either does not exist or the logged on user has no access to this collection. Exact reason of the exception can be known by calling getExceptionCode() of the exception.
402	InvalidAttributeValueException: If any of the attribute values in supplied in the attributeValues array is not valid. The specific reason for the exception can be found by calling getExceptionCode() of the exception. Whereas, getAdditionalInfo() of the exception, tells you the id of the attribute causing exception

setCollectionDefaultJobJacket

This request set the default job jacket set for a collection. Returns null if no job jacket is specified as default for this collection or the content of the job jacket is not found.

Request

POST /api/v1/collectionService/setCollectionDefaultJobJacket

Responses

Status Code	Description	Samples
200	Returns null if no job jacket is specified as default for this collection or the content of the job jacket is not found.
400	QppServiceException: Unhandled server exception

setCollectionGroups

Sets groups who would have access to the given collection. Also allows propagating groups to its sub-collections as well.After successful setting of collection groups, message of object type and change type COLLECTION_GROUPS_CHANGED is published.

Request

POST /api/v1/collectionService/setCollectionGroups

Responses

Status Code	Description	Samples
200	Returns a list of applicable routing GroupInfo objects for the given collection and status
400	QppServiceException: Unhandled server exception
401	InvalidCollectionException:If the given collection either does not exist or the logged on user has no access to this collection. Exact reason of the exception can be known by calling getExceptionCode() of the exception.

setCollectionJobjackets

Sets given JobJackets for a Collection.Existing job jackets of the collection will be replaced with new ones and After successful completion of operation CollectionMessageConstants.CollectionChangeTypes#COLLECTION_JOBJACKETS_CHANGED message is published.

Request

POST /api/v1/collectionService/setCollectionJobjackets

Responses

Status Code	Description	Samples
200	Returns null if no job jacket is specified as default for this collection or the content of the job jacket is not found.
400	QppServiceException: Unhandled server exception

setCollectionUsers

Sets users who would have access to the given collection,Admin user deletion from the collection is not allowed and After successful setting of collection users, message of object type and change type COLLECTION_USERS_CHANGED is published.

Request

POST /api/v1/collectionService/setCollectionUsers

Responses

Status Code	Description	Samples
200	will set collection users for the specific collection
400	QppServiceException: Unhandled server exception
401	InvalidCollectionException:If the given collection either does not exist or the logged on user has no access to this collection. Exact reason of the exception can be known by calling getExceptionCode() of the exception.

setCollectionWorkflows

Set list of all workflows applicable for a collection and its sub-collections. This overrides any existing set of workflows for this collection and After successful updation, message of OBJECT_TYPE and OBJECT_CHANGE_TYPE COLLECTION_WORKFLOWS_CHANGED is published.

Request

POST /api/v1/collectionService/setCollectionWorkflows

Responses

Status Code	Description	Samples
200	Returns a list of applicable routing GroupInfo objects for the given collection and status
400	QppServiceException: Unhandled server exception

setRevisionControls

Sets revision control settings for the given collection and After successful completion of operation COLLECTION_REVISION_CONTROLS_CHANGED message is published.

Request

POST /api/v1/collectionService/setRevisionControls

Responses

Status Code	Description	Samples
200	set the revisions
400	QppServiceException: Unhandled server exception

setStatusRoutings

Sets the status routings of the given workflow for the given collection and After successfully performing the operation, message of OBJECT_TYPE COLLECTION_ROUTINGS_CHANGED is published.

Request

POST /api/v1/collectionService/setStatusRoutings

Responses

Status Code	Description	Samples
200	set the status routings
400	QppServiceException: Unhandled server exception

updateJobJacket

Updates the given jobjacket.

Request

POST /api/v1/collectionService/updateJobJacket

Parameters

Name	Type	Value	Notes
InputStreamResource			input stream resource

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution.
400	IOException:Note that the detail message associated with is not automatically incorporated into this exception's detail message.

ContentStructureService

addAttributeToContentTypes

This request is used to update the attribute mapping of content types and their children with the specified map of attributes.

Request

POST /api/v1/contentStructureService/addAttributeToContentTypes

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution
400	QppServiceException: Unhandled server exception

createContentType

This request is used to create one or more content types and its child content types according to the parent content type ID.

Request

POST /api/v1/contentStructureService/createContentType

Responses

Status Code	Description	Samples
200	Returns a contenTypeInfoList object containing containing the successfully created content types.
400	QppServiceException: Unhandled server exception

deleteContentType

This request is used to delete the specified content type

Request

POST /api/v1/contentStructureService/deleteContentType

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution
400	QppServiceException: Unhandled server exception

detectContentType

This request detects the content type of a provided asset.

Request

POST /api/v1/contentStructureService/detectContentType

Parameters

Name	Type	Value	Notes
resource			stream resource for the asset

Responses

Status Code	Description	Samples
200	Returns content
400	QppServiceException: Unhandled server exception

duplicateContentType

This request creates a duplicate of content.

Request

POST /api/v1/contentStructureService/duplicateContentType

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution
400	QppServiceException: Unhandled server exception

getAllChildContentTypesInfo

Request

GET /api/v1/contentStructureService/getAllChildContentTypesInfo

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution
400	QppServiceException: Unhandled server exception

getAllContentTypes

This request returns complete information of all content types in the system in a hierarchical structure

Request

GET /api/v1/contentStructureService/getAllContentTypes

Responses

Status Code	Description	Samples
200	Returns a contenTypeInfoList object containing an array of content types (contentTypeInfo).
400	QppServiceException: Unhandled server exception

getAttributeContentTypesMapping

This request is used retrieve content type attriute mapping of an attribute by id

Request

GET /api/v1/contentStructureService/getAttributeContentTypesMapping

Responses

Status Code	Description	Samples
200	Returns array of mapping content type attribute
400	QppServiceException: Unhandled server exception

getChildContentTypesInfo

THis request is used to retrieve child content info by parent conent type by id

Request

GET /api/v1/contentStructureService/getChildContentTypesInfo

Responses

Status Code	Description	Samples
200	Return array of content type info
400	QppServiceException: Unhandled server exception

getContentIdentifier

This request is used to get the identifier for content

Request

POST /api/v1/contentStructureService/getContentIdentifier

Parameters

Name	Type	Value	Notes
resource			The stream resource for the asset

Responses

Status Code	Description	Samples
200	Returns content identifier object with all its metadata
400	QppServiceException: Unhandled server exception

getContentType

This request returns complete information on the specified content type. This will also include the child content types.

Request

GET /api/v1/contentStructureService/getContentType

Responses

Status Code	Description	Samples
200	Returns a contentTypeInfoList object containing information on the specified content type inclusive of its children .
400	QppServiceException: Unhandled server exception

getContentTypeAttributes

This request returns an attribute with the specified ID

Request

GET /api/v1/contentStructureService/getContentTypeAttributes

Responses

Status Code	Description	Samples
200	Returns list of attribute
400	QppServiceException: Unhandled server exception

getContentTypeAttributesMapping

This request returns an attribute with the specified ID or Name.

Request

GET /api/v1/contentStructureService/getContentTypeAttributesMapping

Responses

Status Code	Description	Samples
200	Returns list of ContentTypeAttributeMapping object
400	QppServiceException: Unhandled server exception

getContentTypeHierarchy

This request is used to get hierarchy of content type

Request

GET /api/v1/contentStructureService/getContentTypeHierarchy

Responses

Status Code	Description	Samples
200	Returns array of contentTypeInfo object
400	QppServiceException: Unhandled server exception

getContentTypeIconDownloadInfo

This request is used retrieve ContentTypeIconDownloadInfo for the content type by id

Request

GET /api/v1/contentStructureService/getContentTypeIconDownloadInfo

Responses

Status Code	Description	Samples
200	Returns ContentTypeIconDownloadInfo object
400	QppServiceException: Unhandled server exception

getContentTypeIconStatus

This request is used to retrieve status info contenttype icon

Request

GET /api/v1/contentStructureService/getContentTypeIconStatus

Responses

Status Code	Description	Samples
200	Returns ContentTypeIconStatusInfo object
400	QppServiceException: Unhandled server exception

getContentTypeInfo

This request returns complete information on the specified content type. This will also include the child content types

Request

GET /api/v1/contentStructureService/getContentTypeInfo

Responses

Status Code	Description	Samples
200
400	QppServiceException: Unhandled server exception

getContentTypesInfoByHierarchy

This request is used to retirve content type info by Hierarchy

Request

GET /api/v1/contentStructureService/getContentTypesInfoByHierarchy

Responses

Status Code	Description	Samples
200	Returns ContentTypeInfo object
400	QppServiceException: Unhandled server exception

getContentTypesInfoByName

This request is used to retirve content type info by conetenttype name

Request

GET /api/v1/contentStructureService/getContentTypesInfoByName

Responses

Status Code	Description	Samples
200	Returns array of ContentTypeInfo
400	QppServiceException: Unhandled server exception

getParentContentTypeInfo

This request is used to content type info of parent by id

Request

GET /api/v1/contentStructureService/getParentContentTypeInfo

Responses

Status Code	Description	Samples
200	Returns ContentTypeInfo object
400	QppServiceException: Unhandled server exception

getRootContentType

This request is used to get root content type

Request

GET /api/v1/contentStructureService/getRootContentType

Responses

Status Code	Description	Samples
200	Returns ContentType object
400	QppServiceException: Unhandled server exception

initContentTypeIconUpload

This request is used upload content type icon

Request

POST /api/v1/contentStructureService/initContentTypeIconUpload

Responses

Status Code	Description	Samples
200	Returns ContentTypeIconUploadInfo object
400	QppServiceException: Unhandled server exception

isValidAncestor

This request is used to check content type is having valid ancestor by id

Request

GET /api/v1/contentStructureService/isValidAncestor

Responses

Status Code	Description	Samples
200	Returns either true or false
400	QppServiceException: Unhandled server exception

removeAttributeFromContentTypes

This request is used to remove the attribute mapping of content types and their children with the specified map of attributes.

Request

POST /api/v1/contentStructureService/removeAttributeFromContentTypes

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution
400	QppServiceException: Unhandled server exception

renameContentType

This request is used to rename content types and its child content types according to the parent content type ID.

Request

POST /api/v1/contentStructureService/renameContentType

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

setAttributeContentTypes

This request is used to update the attribute mapping of content types and their children with the specified map of attributes.

Request

POST /api/v1/contentStructureService/setAttributeContentTypes

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution
400	QppServiceException: Unhandled server exception

setContentTypeAttributes

This request is used to update the content types and their children.

Request

POST /api/v1/contentStructureService/setContentTypeAttributes

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution.
400	QppServiceException: Unhandled server exception

EventService

getAllEvents

This request is used to retrieve all the events

Request

GET /api/v1/eventService/getAllEvents

Responses

Status Code	Description	Samples
200	Returns string
400	QppServiceException: Unhandled server exception

getViewUrl

This request is used to retrieve url to view event

Request

GET /api/v1/eventService/getViewUrl

Responses

Status Code	Description	Samples
200	Returns string url
400	QppServiceException: Unhandled server exception

publishCustomEvent

This request is used to publish custom event

Request

POST /api/v1/eventService/publishCustomEvent

Responses

Status Code	Description	Samples
200	Returns string
400	QppServiceException: Unhandled server exception

FormService

createForm

Creates a new form with the given details and returns its ID.and After successful creation of form FormMessageConstants.FormChangeTypes#FORM_ADDED message is published.

Request

POST /api/v1/formService/createForm

Responses

Status Code	Description	Samples
200	Returns a formInfoList object containing a list of successfully created forms.A status of 200 is returned in response to a successful request execution.
400	QppServiceException: Unhandled server exception

deleteForm

Deletes a form with given ID and After successful deletion of form FormMessageConstants.FormChangeTypes#FORM_DELETED message is published.

Request

POST /api/v1/formService/deleteForm

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution.
400	QppServiceException: Unhandled server exception

getContentTypeForm

This request is used to return content type form by contentType id

Request

GET /api/v1/formService/getContentTypeForm

Responses

Status Code	Description	Samples
200	Returns a Form object
400	QppServiceException: Unhandled server exception

getForm

This request is used to get forms saved in the system

Request

GET /api/v1/formService/getForm

Responses

Status Code	Description	Samples
200	Returns a formInfoList object containing a list of all the forms.
400	QppServiceException: Unhandled server exception

getWorkflowForms

This request returns all the metadata from form of a specified workflow

Request

GET /api/v1/formService/getWorkflowForms

Responses

Status Code	Description	Samples
200	Returns list of Form object
400	QppServiceException: Unhandled server exception

updateFormContent

Updates the form content data and After successful updation of form FormMessageConstants.FormChangeTypes#FORM_CHANGED message is published.

Request

POST /api/v1/formService/updateFormContent

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

IndexingService

generateIndexesOfAllCollections

This request asynchronously initiates indexes for all Platform Server collections.

Request

POST /api/v1/indexingService/generateIndexesOfAllCollections

Responses

Status Code	Description	Samples
200	Retruns text for indexes
400	QppServiceException: Unhandled server exception

generateRenditions

This request returns all information about an asset’s reditions

Request

POST /api/v1/indexingService/generateRenditions

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

generateTextIndexesOfAllAssets

This request asynchronously initiates text indexes for all Platform Server assets including asset attributes and content.

Request

POST /api/v1/indexingService/generateTextIndexesOfAllAssets

Responses

Status Code	Description	Samples
200	Retruns text for indexes
400	QppServiceException: Unhandled server exception

generateTextIndexesOfAssetIds

This request asynchronously initiates text indexes for all Platform Server assets,including asset attributes and content.

Request

POST /api/v1/indexingService/generateTextIndexesOfAssetIds

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution, along with the following message: The text indexes generation process has been initiated successfully
400	QppServiceException: Unhandled server exception

generateTextIndexesOfQueryAssets

This request initiates text indexes for all Platform Server by query

Request

POST /api/v1/indexingService/generateTextIndexesOfQueryAssets

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

generateTextRenditionOfAllAssets

This request initiates text reditions for all Platform Server assets

Request

POST /api/v1/indexingService/generateTextRenditionOfAllAssets

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

generateTextRenditionOfAssetIds

This request initiates text reditions for all Platform Server assets by ids

Request

POST /api/v1/indexingService/generateTextRenditionOfAssetIds

Responses

Status Code	Description	Samples
200
400	QppServiceException: Unhandled server exception

generateTextRenditionOfQueryAssets

This request initiates text reditions for all Platform Server assets by query

Request

POST /api/v1/indexingService/generateTextRenditionOfQueryAssets

Responses

Status Code	Description	Samples
200
400	QppServiceException: Unhandled server exception

getRenditionTypeId

This request returns all information about an asset’s reditions

Request

GET /api/v1/indexingService/getRenditionTypeId

Responses

Status Code	Description	Samples
200	Returns success wiht id
400	QppServiceException: Unhandled server exception

IndexingServiceV3

generateIndexesOfAllCollections

This request asynchronously initiates indexes for all Platform Server collections.

Request

POST /api/v3/indexingService/generateIndexesOfAllCollections

Responses

Status Code	Description	Samples
200	Retruns text for indexes
400	QppServiceException: Unhandled server exception

generateRenditions

This request returns all information about an asset’s reditions

Request

POST /api/v3/indexingService/generateRenditions[?branchId]

Parameters

Name	Type	Value	Notes
branchId	integer		"branchId" should refer to the required Asset's branchId. Provide 0 to fetch metadata of latest version.

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

generateTextIndexesOfAllAssets

This request asynchronously initiates text indexes for all Platform Server assets including asset attributes and content.

Request

POST /api/v3/indexingService/generateTextIndexesOfAllAssets

Responses

Status Code	Description	Samples
200	Retruns text for indexes
400	QppServiceException: Unhandled server exception

generateTextIndexesOfAssetIds

This request asynchronously initiates text indexes for all Platform Server assets,including asset attributes and content.

Request

POST /api/v3/indexingService/generateTextIndexesOfAssetIds

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution, along with the following message: The text indexes generation process has been initiated successfully
400	QppServiceException: Unhandled server exception

generateTextIndexesOfQueryAssets

This request initiates text indexes for all Platform Server by query

Request

POST /api/v3/indexingService/generateTextIndexesOfQueryAssets

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

generateTextRenditionOfAllAssets

This request initiates text reditions for all Platform Server assets

Request

POST /api/v3/indexingService/generateTextRenditionOfAllAssets

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

generateTextRenditionOfAssetIds

This request initiates text reditions for all Platform Server assets by ids

Request

POST /api/v3/indexingService/generateTextRenditionOfAssetIds

Responses

Status Code	Description	Samples
200
400	QppServiceException: Unhandled server exception

generateTextRenditionOfQueryAssets

This request initiates text reditions for all Platform Server assets by query

Request

POST /api/v3/indexingService/generateTextRenditionOfQueryAssets

Responses

Status Code	Description	Samples
200
400	QppServiceException: Unhandled server exception

getRenditionTypeId

This request returns all information about an asset’s reditions

Request

GET /api/v3/indexingService/getRenditionTypeId

Responses

Status Code	Description	Samples
200	Returns success wiht id
400	QppServiceException: Unhandled server exception

LicenseProvisioningService

assignLicence

This request is used to assign licence to user by id and type of licence

Request

POST /api/v1/licenseProvisioningService/assignLicence

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Thrown when the specified user does not exist

getAllLicenses

This request is used to return all the licenses available for the product.

Request

GET /api/v1/licenseProvisioningService/getAllLicenses

Responses

Status Code	Description	Samples
200	Returns all the licences
400	QppServiceException: Thrown when license not found for the specified product

getUserLicenseInfo

This request used to retrieve user licence info specific to id

Request

GET /api/v1/licenseProvisioningService/getUserLicenseInfo

Responses

Status Code	Description	Samples
200	Returns user licence info object
400	QppServiceException: Thrown when the specified user does not exist

groupsToBeRemoved

This request is used to return the list of all the groups a user needs to be removed before updating its license.

Request

GET /api/v1/licenseProvisioningService/groupsToBeRemoved

Responses

Status Code	Description	Samples
200	Returns user licence info object
400	QppServiceException: Thrown when the specified user does not exist

revokeLicense

This request used to revoke licence of user by id

Request

POST /api/v1/licenseProvisioningService/revokeLicense

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Thrown when the specified user does not exist

validateLicenseType

This request is used to validate the license type, returns true or false

Request

GET /api/v1/licenseProvisioningService/validateLicenseType

Responses

Status Code	Description	Samples
200	Returns true or false
400	QppServiceException: Thrown when license not found

validateUserLicence

This request is used to validate user Licence and returns userLicence info

Request

POST /api/v1/licenseProvisioningService/validateUserLicence

Responses

Status Code	Description	Samples
200	Returns user licence info object
400	QppServiceException: Thrown when the specified user does not exist

OfficeService

getExcelDataObject

This request is used to retrieve excelsheet data object

Request

POST /api/v1/officeService/getExcelDataObject

Responses

Status Code	Description	Samples
200	Returns array of OfficeOutputDownloadInfo
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelDataObjectAsync

This request is used to retrieve excelsheet data object asynchronously

Request

POST /api/v1/officeService/getExcelDataObjectAsync

Responses

Status Code	Description	Samples
200	Returns string of data object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelDataObjectBasedOnStream

This request is used to retrieve excelsheet data object by stream

Request

POST /api/v1/officeService/getExcelDataObjectBasedOnStream

Responses

Status Code	Description	Samples
200	Returns OfficeDocumentUploadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelDataObjectBasedOnURI

This request is used to retrieve excelsheet data object by uri

Request

POST /api/v1/officeService/getExcelDataObjectBasedOnURI

Responses

Status Code	Description	Samples
200	Returns array of OfficeOutputDownloadInfo
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelDataObjectBasedOnURIAsync

This request is used to retrieve excelsheet data object by uri asynchronously

Request

POST /api/v1/officeService/getExcelDataObjectBasedOnURIAsync

Responses

Status Code	Description	Samples
200	Returns string as data object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelWorksheets

This request returns all worksheets defined in an Excel document.

Request

GET /api/v1/officeService/getExcelWorksheets

Responses

Status Code	Description	Samples
200	Returns all worksheets or required worksheets defined in an Excel document. Each worksheet encapsulates its metadata (such as worksheet index and name.) Each worksheet also provides information about tables, named ranges and charts defined in the worksheet
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelWorksheetsBasedOnStream

This request is used to retrieve office document upload info based on stream

Request

POST /api/v1/officeService/getExcelWorksheetsBasedOnStream

Responses

Status Code	Description	Samples
200	Returns OfficeDocumentUploadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelWorksheetsBasedOnURI

This request returns all worksheets defined in an Excel document.

Request

GET /api/v1/officeService/getExcelWorksheetsBasedOnURI

Responses

Status Code	Description	Samples
200	Returns all worksheets or required worksheets defined in an Excel document. Each worksheet encapsulates its metadata (such as worksheet index and name.) Each worksheet also provides information about tables, named ranges and charts defined in the worksheet
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelWorksheetsStatusInfo

This request is used to retrieve excel worksheet status by context id

Request

GET /api/v1/officeService/getExcelWorksheetsStatusInfo

Responses

Status Code	Description	Samples
200	Variable contextId should refer to the QPP Server's context
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getOfficeOutputStatusInfo

This request is used to retrieve office output status info by contextId

Request

GET /api/v1/officeService/getOfficeOutputStatusInfo

Responses

Status Code	Description	Samples
200	Returns OfficeOutputStatusInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointDataObject

This request is used to retrieve powerpoint data object

Request

POST /api/v1/officeService/getPowerPointDataObject

Responses

Status Code	Description	Samples
200	Returns array of OfficeOutputDownloadInfo
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointDataObjectAsync

This request is used to retrieve powerpoint data object async

Request

POST /api/v1/officeService/getPowerPointDataObjectAsync

Responses

Status Code	Description	Samples
200	Returns data objectfor powerpoint
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointDataObjectBasedOnStream

This request is used to retrieve powerpoint data object by stream

Request

POST /api/v1/officeService/getPowerPointDataObjectBasedOnStream

Responses

Status Code	Description	Samples
200	Returns OfficeDocumentUploadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointDataObjectBasedOnURI

This request is used to retrieve powerpoint data object by uri

Request

POST /api/v1/officeService/getPowerPointDataObjectBasedOnURI

Responses

Status Code	Description	Samples
200	Returns array of OfficeOutputDownloadInfo
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointDataObjectBasedOnURIAsync

This request is used to retrieve powerpoint data object by uri async

Request

POST /api/v1/officeService/getPowerPointDataObjectBasedOnURIAsync

Responses

Status Code	Description	Samples
200	Returns data object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointSlides

This request returns all slides defined within a PowerPoint document. To retrieve specific slides, specify a valid slide index in the slideIndexes parameter

Request

GET /api/v1/officeService/getPowerPointSlides

Responses

Status Code	Description	Samples
200	Returns a PowerPointSlidesInfoList object that contains index numbers and slide IDs of all slides for a given PowerPoint asset
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointSlidesBasedOnStream

This request returns all slides defined within a PowerPoint document. To retrieve specific slides, specify a valid index of a slide in the slideIndexes parameter. Includethe file in the request body or as a file part

Request

POST /api/v1/officeService/getPowerPointSlidesBasedOnStream

Responses

Status Code	Description	Samples
200	Returns OfficeDocumentUploadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointSlidesBasedOnURI

This request returns all slides defined within a PowerPoint document. To retrieve specific slides, specify a valid slide id in the slideIndexes parameter

Request

GET /api/v1/officeService/getPowerPointSlidesBasedOnURI

Responses

Status Code	Description	Samples
200	Returns a PowerPointSlidesInfoList object that contains index numbers and slide IDs for all slides of a given PowerPoint asset.
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointSlidesStatusInfo

This request is used to retrieve powerpoint slides status info by contextId

Request

GET /api/v1/officeService/getPowerPointSlidesStatusInfo

Responses

Status Code	Description	Samples
200	Returns a PowerPointSlideInfoList object that contains index numbers and slide IDs for all slides of a given PowerPoint asset
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioDataObject

This request is used to retrieve vision data object

Request

POST /api/v1/officeService/getVisioDataObject

Responses

Status Code	Description	Samples
200	Returns array OfficeOutputDownloadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioDataObjectAsync

This request is used to retrieve vision data object async

Request

POST /api/v1/officeService/getVisioDataObjectAsync

Responses

Status Code	Description	Samples
200	Returns string of data object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioDataObjectBasedOnStream

This request is used to retrieve vision data object by stream

Request

POST /api/v1/officeService/getVisioDataObjectBasedOnStream

Responses

Status Code	Description	Samples
200	Returns OfficeDocumentUploadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioDataObjectBasedOnURI

This request is used to retrieve vision data object by uri

Request

POST /api/v1/officeService/getVisioDataObjectBasedOnURI

Responses

Status Code	Description	Samples
200	Returns array of OfficeOutputDownloadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioDataObjectBasedOnURIAsync

This request is used to retrieve vision data object by uri async

Request

POST /api/v1/officeService/getVisioDataObjectBasedOnURIAsync

Responses

Status Code	Description	Samples
200	Returns string of data object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioPages

This request returns all pages defined within a Visio document. To retrieve specific pages, specify a valid page name in the pages parameter

Request

GET /api/v1/officeService/getVisioPages

Responses

Status Code	Description	Samples
200	Returns a VisioPageInfoList object that contains index number and page name of all pages of a given Visio asset.
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioPagesBasedOnStream

This request returns all pages defined within a Visio document. To retrieve specific pages, specify a valid page name in the pages parameter. Include the file in the request body or as a file part.

Request

POST /api/v1/officeService/getVisioPagesBasedOnStream

Responses

Status Code	Description	Samples
200	Returns a OfficeDocumentUploadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioPagesBasedOnURI

This request returns all pages defined within a Visio document. To retrieve specific pages, specify a valid page name in the pages parameter.

Request

GET /api/v1/officeService/getVisioPagesBasedOnURI

Responses

Status Code	Description	Samples
200	Returns a VisioPageInfoList object that contains index number and page name of all pages of a given Visio asset.
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioPagesStatusInfo

This request is used to retrieve pages status info by contextId

Request

GET /api/v1/officeService/getVisioPagesStatusInfo

Responses

Status Code	Description	Samples
200	Returns VisioPagesStatusInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

OfficeServiceV3

getExcelDataObject

This request is used to retrieve excelsheet data object

Request

POST /api/v3/officeService/getExcelDataObject

Responses

Status Code	Description	Samples
200	Returns array of OfficeOutputDownloadInfo
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelDataObjectAsync

This request is used to retrieve excelsheet data object asynchronously

Request

POST /api/v3/officeService/getExcelDataObjectAsync

Responses

Status Code	Description	Samples
200	Returns string of data object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelDataObjectBasedOnStream

This request is used to retrieve excelsheet data object by stream

Request

POST /api/v3/officeService/getExcelDataObjectBasedOnStream

Responses

Status Code	Description	Samples
200	Returns OfficeDocumentUploadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelDataObjectBasedOnURI

This request is used to retrieve excelsheet data object by uri

Request

POST /api/v3/officeService/getExcelDataObjectBasedOnURI

Responses

Status Code	Description	Samples
200	Returns array of OfficeOutputDownloadInfo
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelDataObjectBasedOnURIAsync

This request is used to retrieve excelsheet data object by uri asynchronously

Request

POST /api/v3/officeService/getExcelDataObjectBasedOnURIAsync

Responses

Status Code	Description	Samples
200	Returns string as data object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelWorksheets

This request returns all worksheets defined in an Excel document.

Request

GET /api/v3/officeService/getExcelWorksheets

Responses

Status Code	Description	Samples
200	Returns all worksheets or required worksheets defined in an Excel document. Each worksheet encapsulates its metadata (such as worksheet index and name.) Each worksheet also provides information about tables, named ranges and charts defined in the worksheet
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelWorksheetsBasedOnStream

This request is used to retrieve office document upload info based on stream

Request

POST /api/v3/officeService/getExcelWorksheetsBasedOnStream

Responses

Status Code	Description	Samples
200	Returns OfficeDocumentUploadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelWorksheetsBasedOnURI

This request returns all worksheets defined in an Excel document.

Request

GET /api/v3/officeService/getExcelWorksheetsBasedOnURI

Responses

Status Code	Description	Samples
200	Returns all worksheets or required worksheets defined in an Excel document. Each worksheet encapsulates its metadata (such as worksheet index and name.) Each worksheet also provides information about tables, named ranges and charts defined in the worksheet
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getExcelWorksheetsStatusInfo

This request is used to retrieve excel worksheet status by context id

Request

GET /api/v3/officeService/getExcelWorksheetsStatusInfo

Responses

Status Code	Description	Samples
200	Variable contextId should refer to the QPP Server's context
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getOfficeOutputStatusInfo

This request is used to retrieve office output status info by contextId

Request

GET /api/v3/officeService/getOfficeOutputStatusInfo

Responses

Status Code	Description	Samples
200	Returns OfficeOutputStatusInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointDataObject

This request is used to retrieve powerpoint data object

Request

POST /api/v3/officeService/getPowerPointDataObject

Responses

Status Code	Description	Samples
200	Returns array of OfficeOutputDownloadInfo
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointDataObjectAsync

This request is used to retrieve powerpoint data object async

Request

POST /api/v3/officeService/getPowerPointDataObjectAsync

Responses

Status Code	Description	Samples
200	Returns data objectfor powerpoint
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointDataObjectBasedOnStream

This request is used to retrieve powerpoint data object by stream

Request

POST /api/v3/officeService/getPowerPointDataObjectBasedOnStream

Responses

Status Code	Description	Samples
200	Returns OfficeDocumentUploadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointDataObjectBasedOnURI

This request is used to retrieve powerpoint data object by uri

Request

POST /api/v3/officeService/getPowerPointDataObjectBasedOnURI

Responses

Status Code	Description	Samples
200	Returns array of OfficeOutputDownloadInfo
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointDataObjectBasedOnURIAsync

This request is used to retrieve powerpoint data object by uri async

Request

POST /api/v3/officeService/getPowerPointDataObjectBasedOnURIAsync

Responses

Status Code	Description	Samples
200	Returns data object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointSlides

This request returns all slides defined within a PowerPoint document. To retrieve specific slides, specify a valid slide index in the slideIndexes parameter

Request

GET /api/v3/officeService/getPowerPointSlides

Responses

Status Code	Description	Samples
200	Returns a PowerPointSlidesInfoList object that contains index numbers and slide IDs of all slides for a given PowerPoint asset
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointSlidesBasedOnStream

Request

POST /api/v3/officeService/getPowerPointSlidesBasedOnStream

Responses

Status Code	Description	Samples
200	Returns OfficeDocumentUploadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointSlidesBasedOnURI

This request returns all slides defined within a PowerPoint document. To retrieve specific slides, specify a valid slide id in the slideIndexes parameter

Request

GET /api/v3/officeService/getPowerPointSlidesBasedOnURI

Responses

Status Code	Description	Samples
200	Returns a PowerPointSlidesInfoList object that contains index numbers and slide IDs for all slides of a given PowerPoint asset.
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getPowerPointSlidesStatusInfo

This request is used to retrieve powerpoint slides status info by contextId

Request

GET /api/v3/officeService/getPowerPointSlidesStatusInfo

Responses

Status Code	Description	Samples
200	Returns a PowerPointSlideInfoList object that contains index numbers and slide IDs for all slides of a given PowerPoint asset
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioDataObject

This request is used to retrieve vision data object

Request

POST /api/v3/officeService/getVisioDataObject

Responses

Status Code	Description	Samples
200	Returns array OfficeOutputDownloadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioDataObjectAsync

This request is used to retrieve vision data object async

Request

POST /api/v3/officeService/getVisioDataObjectAsync

Responses

Status Code	Description	Samples
200	Returns string of data object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioDataObjectBasedOnStream

This request is used to retrieve vision data object by stream

Request

POST /api/v3/officeService/getVisioDataObjectBasedOnStream

Responses

Status Code	Description	Samples
200	Returns OfficeDocumentUploadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioDataObjectBasedOnURI

This request is used to retrieve vision data object by uri

Request

POST /api/v3/officeService/getVisioDataObjectBasedOnURI

Responses

Status Code	Description	Samples
200	Returns array of OfficeOutputDownloadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioDataObjectBasedOnURIAsync

This request is used to retrieve vision data object by uri async

Request

POST /api/v3/officeService/getVisioDataObjectBasedOnURIAsync

Responses

Status Code	Description	Samples
200	Returns string of data object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioPages

This request returns all pages defined within a Visio document. To retrieve specific pages, specify a valid page name in the pages parameter

Request

GET /api/v3/officeService/getVisioPages

Responses

Status Code	Description	Samples
200	Returns a VisioPageInfoList object that contains index number and page name of all pages of a given Visio asset.
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioPagesBasedOnStream

This request returns all pages defined within a Visio document. To retrieve specific pages, specify a valid page name in the pages parameter. Include the file in the request body or as a file part.

Request

POST /api/v3/officeService/getVisioPagesBasedOnStream

Responses

Status Code	Description	Samples
200	Returns a OfficeDocumentUploadInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioPagesBasedOnURI

This request returns all pages defined within a Visio document. To retrieve specific pages, specify a valid page name in the pages parameter.

Request

GET /api/v3/officeService/getVisioPagesBasedOnURI

Responses

Status Code	Description	Samples
200	Returns a VisioPageInfoList object that contains index number and page name of all pages of a given Visio asset.
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

getVisioPagesStatusInfo

This request is used to retrieve pages status info by contextId

Request

GET /api/v3/officeService/getVisioPagesStatusInfo

Responses

Status Code	Description	Samples
200	Returns VisioPagesStatusInfo object
400	QppServiceException: This exception is thrown while inserting/updating attribute values for an asset.

PreferenceService

createPreference

This request is used to create a single or multiple preferences at one time.

Request

POST /api/v1/preferenceService/createPreference

Responses

Status Code	Description	Samples
200	Returns a preferenceInfoList object containing a list of successfully created preferences
400	QppServiceException: Unhandled server exception

deletePreference

This request is used to delete the specified preference.

Request

POST /api/v1/preferenceService/deletePreference

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution.
400	QppServiceException: Unhandled server exception

getAllPreferences

This request returns all of the existing preference definitions

Request

GET /api/v1/preferenceService/getAllPreferences

Responses

Status Code	Description	Samples
200	Returns a preferenceInfoList object containing metadata of all existing preferences with its possible values
400	QppServiceException: Unhandled server exception

getDefaultPreferenceValues

This request is used to get preference values for default preference

Request

GET /api/v1/preferenceService/getDefaultPreferenceValues

Responses

Status Code	Description	Samples
200	Returns list of prefrence values
400	QppServiceException: Unhandled server exception

getFavorites

This request returns all of the favorites items of the logged-on user

Request

GET /api/v1/preferenceService/getFavorites

Responses

Status Code	Description	Samples
200	Returns a favoriteItemList object containing metadata of all of the favorites items for the logged-in user.
400	QppServiceException: Unhandled server exception

getPreference

This request returns the metadata of a specified preference.

Request

GET /api/v1/preferenceService/getPreference

Responses

Status Code	Description	Samples
200	Returns a preferenceInfoList object containing the metadata of the specified preference.
400	QppServiceException: Unhandled server exception

getPreferenceByName

This request is used to get the prefrence by Name

Request

GET /api/v1/preferenceService/getPreferenceByName

Responses

Status Code	Description	Samples
200	Returns the prefernce specific to name
400	QppServiceException: Unhandled server exception

getUserPreferenceValues

This request is used to get preference values for a given preference corresponding to the logged-in user

Request

GET /api/v1/preferenceService/getUserPreferenceValues

Responses

Status Code	Description	Samples
200	Returns list of PrefrenceValues corresponding to ids
400	QppServiceException: Unhandled server exception

renamePreference

This request used to rename prefrence

Request

POST /api/v1/preferenceService/renamePreference

Responses

Status Code	Description	Samples
200	Retuens success
400	QppServiceException: Unhandled server exception

resetAllUsersPreferenceValues

This request is used to reset all the prefrences for user

Request

POST /api/v1/preferenceService/resetAllUsersPreferenceValues

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

setDefaultPreferenceValues

This request used to set default prefrence name

Request

POST /api/v1/preferenceService/setDefaultPreferenceValues

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

setFavorites

This request sets the favorites items for the logged-in user.

Request

POST /api/v1/preferenceService/setFavorites

Responses

Status Code	Description	Samples
200	Returns a favoriteItemList object containing the metadata of favorite items successfully set for logged-in user.
400	QppServiceException: Unhandled server exception

setPreferenceValues

Sets the Preference Values provided in the array, values corresponding to preference ids for a user or system .If the PreferenceValue being updated is a System preference then PreferenceMessageConstants.PreferenceChangeTypes#SYSTEM_PREFERENCE_CHANGED message is published.

Request

POST /api/v1/preferenceService/setPreferenceValues

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

updatePreference

This request is used to update the metadata of a specified single or multiple preferences

Request

POST /api/v1/preferenceService/updatePreference

Responses

Status Code	Description	Samples
200	Returns a preferenceInfoList object containing a list of all the successfully updated preferences.
400	QppServiceException: Unhandled server exception

PrivilegeService

createPrivilegeDefinition

This request is used to create privilleges definition

Request

POST /api/v1/privilegeService/createPrivilegeDefinition

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution.
400	QppServiceException: Unhandled server exception

createPrivilegeGroupDefinition

This request creates new privilege group along with its subgroups and privileges in the specified hierarchy

Request

POST /api/v1/privilegeService/createPrivilegeGroupDefinition

Responses

Status Code	Description	Samples
200	Returns a privilegeGroupDefinitionList object containing the metadata of the successfuy created privilege groups.
400	QppServiceException: Unhandled server exception

deletePrivilegeDefinition

This request deletes the specified privilege Id

Request

POST /api/v1/privilegeService/deletePrivilegeDefinition

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution.
400	QppServiceException: Unhandled server exception

deletePrivilegeGroupDefinition

This request deletes the given privilege group

Request

POST /api/v1/privilegeService/deletePrivilegeGroupDefinition

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution
400	QppServiceException: Unhandled server exception

getAllApplicationPrivilegeDefs

This request returns enabled applicable application privileges for the logged in user Applicable privileges are a union of all the privileges granted to him as a user as well as to groups of which the user is a member

Request

GET /api/v1/privilegeService/getAllApplicationPrivilegeDefs

Responses

Status Code	Description	Samples
200	Returns PrivilegeGroupDefinition object
400	QppServiceException: Unhandled server exception

getAllPrivilegeDefForLicenseType

This request returns a privilege(s) definition based on a specific license.

Request

GET /api/v1/privilegeService/getAllPrivilegeDefForLicenseType

Responses

Status Code	Description	Samples
200	Returns specific privilege(s) for a specific license.
400	QppServiceException: Unhandled server exception

getAllPrivilegeDefs

This request returns all existing privilege group definitions.

Request

GET /api/v1/privilegeService/getAllPrivilegeDefs

Responses

Status Code	Description	Samples
200	Returns all existing privilege group definitions. Each privilege group contains its information along with its privileges and sub-privilege group definitions.
400	QppServiceException: Unhandled server exception

getAllPrivilegeGroupDefs

This request returns all existing privilege group definitions.

Request

GET /api/v1/privilegeService/getAllPrivilegeGroupDefs

Responses

Status Code	Description	Samples
200	Returns all existing privilege group definitions. Each privilege group contains its information along with its privileges and sub-privilege group definitions
400	QppServiceException: Unhandled server exception

getContentPrivilegeDefs

This request is used to get the content privileges defs by contentType id

Request

GET /api/v1/privilegeService/getContentPrivilegeDefs

Responses

Status Code	Description	Samples
200	Returns PrivilegeGroupDefinition object
400	QppServiceException: Unhandled server exception

getPrivilegeContentTypes

This request returns enabled privileges of the given content type applicable for the logged in user. Applicable privileges are a union of all the privileges granted to him as a user as well as to groups of which the user is a member

Request

GET /api/v1/privilegeService/getPrivilegeContentTypes

Responses

Status Code	Description	Samples
200	Returns the contentPrivList object containing all of the applicable content privileges
400	QppServiceException: Unhandled server exception

getPrivilegeDefs

This request returns a specific privilege(s) in system with given id or name

Request

GET /api/v1/privilegeService/getPrivilegeDefs

Responses

Status Code	Description	Samples
200	Returns specific privilege(s) in system with given ID or name. If privilege name is specified and there exists multiple privileges in different privilege groups, with the given name, list of all such privileges will be returned.
400	QppServiceException: Unhandled server exception

getPrivilegeGroupDefs

This request returns all existing privilege group definitions.

Request

GET /api/v1/privilegeService/getPrivilegeGroupDefs

Responses

Status Code	Description	Samples
200	Returns information for the specified privilege group based on its id or name specified
400	QppServiceException: Unhandled server exception

setContentTypesForPrivilegeDef

This request is used to set the content types for the previleges defs

Request

POST /api/v1/privilegeService/setContentTypesForPrivilegeDef

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution.
400	QppServiceException: Unhandled server exception

setPrivilegeGroupName

This request is used to set the group name for the privilleges

Request

POST /api/v1/privilegeService/setPrivilegeGroupName

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution.
400	QppServiceException: Unhandled server exception

setPrivilegeName

This request is used to set the name for the privileges

Request

POST /api/v1/privilegeService/setPrivilegeName

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution.
400	QppServiceException: Unhandled server exception

validateApplicationPrivileges

This request is used to validate the application privileges.

Request

GET /api/v1/privilegeService/validateApplicationPrivileges

Responses

Status Code	Description	Samples
200	A status 200 is returned in the response to a successful request execution.
400	QppServiceException: Unhandled server exception

PublishingService

convertToDatadoc

This request will convert the asset to datadoc

Request

POST /api/v1/publishingService/convertToDatadoc

Responses

Status Code	Description	Samples
200	convert to datadoc
400	QppServiceException: Unhandled server exception

createDatadoc

This request creates a datadoc by executing the given datadoc channel and checks it in to the platform with the given metadata

Request

POST /api/v1/publishingService/createDatadoc

Responses

Status Code	Description	Samples
200	Returns the metadata of newly created Datadoc asset
400	QppServiceException: Unhandled server exception

deleteContentTypeChannelMappings

This request delete content type channel with mapping

Request

POST /api/v1/publishingService/deleteContentTypeChannelMappings

Responses

Status Code	Description	Samples
200	delete content type channel mapping
400	QppServiceException: Unhandled server exception

deleteContentTypesForChannel

This request delete channel for content types mapping

Request

POST /api/v1/publishingService/deleteContentTypesForChannel

Responses

Status Code	Description	Samples
200	delete content types for a channel mapping
400	QppServiceException: Unhandled server exception

deliverAsset

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v1/publishingService/deliverAsset

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

deliverAssetAsync

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v1/publishingService/deliverAssetAsync

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

deliverAssetVersion

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v1/publishingService/deliverAssetVersion

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

deliverAssetVersionAsync

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v1/publishingService/deliverAssetVersionAsync

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

deliverBasedOnStream

This request will publish a non-platform resource. Takes input in the form of a file stream

Request

POST /api/v1/publishingService/deliverBasedOnStream

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format
400	QppServiceException: Unhandled server exception	Download

deliverBasedOnURI

Publish a non-Platform resource. Takes input in the form of URI.

Request

POST /api/v1/publishingService/deliverBasedOnURI

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format.
400	QppServiceException: Unhandled server exception	Download

deliverBasedOnURIAsync

Publish a non-Platform resource. Takes input in the form of URI.

Request

POST /api/v1/publishingService/deliverBasedOnURIAsync

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format.
400	QppServiceException: Unhandled server exception	Download

detachDatadocFromSource

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.

Request

POST /api/v1/publishingService/detachDatadocFromSource

Responses

Status Code	Description	Samples
200	Returns the metadata of newly created asset.
400	QppServiceException: Unhandled server exception

executeDatadocChannel

This request returns the all avilable metadata of publishing channels for given content type. Null will be returned in case the channel doesn’t exist for the given content type

Request

POST /api/v1/publishingService/executeDatadocChannel

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object
400	QppServiceException: Unhandled server exception

getAllDatadocChannels

This request returns all channels of type ‘datadoc’ that exist in the system.

Request

GET /api/v1/publishingService/getAllDatadocChannels

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object containing the metadata of channels of type datadoc
400	QppServiceException: Unhandled server exception

getAllDeliveryChannels

This request returns the metadata of all existing Publishing Channels with their parameters.

Request

GET /api/v1/publishingService/getAllDeliveryChannels

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object containing an array of all existing publishing channels.
400	QppServiceException: Unhandled server exception

getAllPublishingChannels

This request returns the metadata of all existing Publishing Channels with their parameters

Request

GET /api/v1/publishingService/getAllPublishingChannels

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object containing an array of all existing publishing channels
400	QppServiceException: Unhandled server exception

getChannel

This request returns the metadata of publishing channels for given channel id. Null will be returned in case the channel doesn’t exist for the given channel id

Request

GET /api/v1/publishingService/getChannel

Responses

Status Code	Description	Samples
200	Returns a publishingChannel object
400	QppServiceException: Unhandled server exception

getChannelTransform

This request converts PublishingChannel object to corresponding publishing framework's Channel object.

Request

GET /api/v1/publishingService/getChannelTransform

Responses

Status Code	Description	Samples
200	Returns a publishing framework's Channel object
400	QppServiceException: Unhandled server exception

getChannelWithAllParameters

This request returns the metadata of publishing channels with all its parameters for given channel id. Null will be returned in case the channel doesn’t exist for the given channel id

Request

GET /api/v1/publishingService/getChannelWithAllParameters

Responses

Status Code	Description	Samples
200	Returns a publishingChannel object
400	QppServiceException: Unhandled server exception

getContentTypeChannelMappings

This request returns the list of content type channel with mapping

Request

GET /api/v1/publishingService/getContentTypeChannelMappings

Responses

Status Code	Description	Samples
200	Returns list of content type channel with mapping
400	QppServiceException: Unhandled server exception

getContentTypesForChannel

This request returns the list of content types for a specific channel.

Request

GET /api/v1/publishingService/getContentTypesForChannel

Responses

Status Code	Description	Samples
200	Returns list of content types for a specific channel.
400	QppServiceException: Unhandled server exception

getDatadocAssets

This request returns the metadata of the datadoc assets which had been created by executing the given channel and parameters.

Request

GET /api/v1/publishingService/getDatadocAssets

Responses

Status Code	Description	Samples
200	Returns the metadata of the Datadoc asset created through the supplied datadoc channel.
400	QppServiceException: Unhandled server exception

getDatadocChannels

This request returns the all avilable metadata of publishing channels for given content type. Null will be returned in case the channel doesn’t exist for the given content type

Request

GET /api/v1/publishingService/getDatadocChannels

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object
400	QppServiceException: Unhandled server exception

getDeliveryChannels

This request returns the metadata of all existing Publishing Channels with their parameters.

Request

GET /api/v1/publishingService/getDeliveryChannels

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object containing an array of all existing publishing channels.
400	QppServiceException: Unhandled server exception

getPublishingChannel

This request converts publishing framework's Channel object to corresponding PublishingChannel object.

Request

GET /api/v1/publishingService/getPublishingChannel

Responses

Status Code	Description	Samples
200	Returns a publishingChannel object
400	QppServiceException: Unhandled server exception

getPublishingChannels

This request returns the all avilable metadata of publishing channels for given content type. Null will be returned in case the channel doesn’t exist for the given content type

Request

GET /api/v1/publishingService/getPublishingChannels

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object
400	QppServiceException: Unhandled server exception

getPublishingStatus

This request returns the all avilable metadata of publishing channels and its status

Request

GET /api/v1/publishingService/getPublishingStatus

Responses

Status Code	Description	Samples
200	Returns a publishing status
400	QppServiceException: Unhandled server exception

getQXPSVersion

Request

GET /api/v1/publishingService/getQXPSVersion

Responses

Status Code	Description	Samples
200	successful operation

publishAndDeliver

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v1/publishingService/publishAndDeliver

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object
400	QppServiceException: Unhandled server exception

publishAndDeliverAssetVersion

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v1/publishingService/publishAndDeliverAssetVersion

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

publishAndDeliverAssetVersionAsync

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v1/publishingService/publishAndDeliverAssetVersionAsync

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

publishAndDeliverAsync

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v1/publishingService/publishAndDeliverAsync

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object
400	QppServiceException: Unhandled server exception

publishAndDeliverBasedOnStream

This request will publish a non-platform resource. Takes input in the form of a file stream

Request

POST /api/v1/publishingService/publishAndDeliverBasedOnStream

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format
400	QppServiceException: Unhandled server exception	Download

publishAndDeliverBasedOnURI

Publish a non-Platform resource. Takes input in the form of URI.

Request

POST /api/v1/publishingService/publishAndDeliverBasedOnURI

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format.
400	QppServiceException: Unhandled server exception	Download

publishAndDeliverBasedOnURIAsync

Publish a non-Platform resource. Takes input in the form of URI.

Request

POST /api/v1/publishingService/publishAndDeliverBasedOnURIAsync

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object
400	QppServiceException: Unhandled server exception

publishAsset

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v1/publishingService/publishAsset

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

publishAssetAsync

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v1/publishingService/publishAssetAsync

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

publishAssetVersion

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v1/publishingService/publishAssetVersion

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

publishAssetVersionAsync

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v1/publishingService/publishAssetVersionAsync

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

publishBasedOnStream

This request will publish a non-platform resource. Takes input in the form of a file stream

Request

POST /api/v1/publishingService/publishBasedOnStream

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format
400	QppServiceException: Unhandled server exception	Download

publishBasedOnURI

Publish a non-Platform resource. Takes input in the form of URI.

Request

POST /api/v1/publishingService/publishBasedOnURI

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format.
400	QppServiceException: Unhandled server exception

publishBasedOnURIAsync

Publish a non-Platform resource. Takes input in the form of URI.

Request

POST /api/v1/publishingService/publishBasedOnURIAsync

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format.
400	QppServiceException: Unhandled server exception

setChannelWithContentTypeMappings

This request set channel with contentTypes mapping

Request

POST /api/v1/publishingService/setChannelWithContentTypeMappings

Responses

Status Code	Description	Samples
200	update channel with content types mapping
400	QppServiceException: Unhandled server exception

setContentTypeChannelMappings

This request set content type channel with mapping

Request

POST /api/v1/publishingService/setContentTypeChannelMappings

Responses

Status Code	Description	Samples
200	update content type channel mapping
400	QppServiceException: Unhandled server exception

setPreviewChannels

This request set preview content channel

Request

POST /api/v1/publishingService/setPreviewChannels

Responses

Status Code	Description	Samples
200	set preview for channel
400	QppServiceException: Unhandled server exception

updateDatadoc

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.

Request

POST /api/v1/publishingService/updateDatadoc

Responses

Status Code	Description	Samples
200	Returns the metadata of the successfully updated Datadoc asset
400	QppServiceException: Unhandled server exception

updateDatadocChannelAndParameters

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.

Request

POST /api/v1/publishingService/updateDatadocChannelAndParameters

Responses

Status Code	Description	Samples
200	Returns the metadata of the successfully updated Datadoc asset
400	QppServiceException: Unhandled server exception

PublishingServiceV3

convertToDatadoc

This request will convert the asset to datadoc

Request

POST /api/v3/publishingService/convertToDatadoc

Responses

Status Code	Description	Samples
200	convert to datadoc
400	QppServiceException: Unhandled server exception

createDatadoc

This request creates a datadoc by executing the given datadoc channel and checks it in to the platform with the given metadata

Request

POST /api/v3/publishingService/createDatadoc

Responses

Status Code	Description	Samples
200	Returns the metadata of newly created Datadoc asset
400	QppServiceException: Unhandled server exception

deleteContentTypeChannelMappings

This request delete content type channel with mapping

Request

POST /api/v3/publishingService/deleteContentTypeChannelMappings

Responses

Status Code	Description	Samples
200	delete content type channel mapping
400	QppServiceException: Unhandled server exception

deleteContentTypesForChannel

This request delete channel for content types mapping

Request

POST /api/v3/publishingService/deleteContentTypesForChannel

Responses

Status Code	Description	Samples
200	delete content types for a channel mapping
400	QppServiceException: Unhandled server exception

deliverAsset

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v3/publishingService/deliverAsset

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

deliverAssetAsync

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v3/publishingService/deliverAssetAsync

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

deliverAssetVersion

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v3/publishingService/deliverAssetVersion

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

deliverAssetVersionAsync

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v3/publishingService/deliverAssetVersionAsync

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

deliverBasedOnStream

This request will publish a non-platform resource. Takes input in the form of a file stream

Request

POST /api/v3/publishingService/deliverBasedOnStream

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format
400	QppServiceException: Unhandled server exception

deliverBasedOnURI

Publish a non-Platform resource. Takes input in the form of URI.

Request

POST /api/v3/publishingService/deliverBasedOnURI

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format.
400	QppServiceException: Unhandled server exception

deliverBasedOnURIAsync

Publish a non-Platform resource. Takes input in the form of URI.

Request

POST /api/v3/publishingService/deliverBasedOnURIAsync

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format.
400	QppServiceException: Unhandled server exception

detachDatadocFromSource

Request

POST /api/v3/publishingService/detachDatadocFromSource

Responses

Status Code	Description	Samples
200	Returns the metadata of newly created asset.
400	QppServiceException: Unhandled server exception

executeDatadocChannel

This request returns the all avilable metadata of publishing channels for given content type. Null will be returned in case the channel doesn’t exist for the given content type

Request

POST /api/v3/publishingService/executeDatadocChannel

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object	Download
400	QppServiceException: Unhandled server exception

getAllDatadocChannels

This request returns all channels of type ‘datadoc’ that exist in the system.

Request

GET /api/v3/publishingService/getAllDatadocChannels

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object containing the metadata of channels of type datadoc
400	QppServiceException: Unhandled server exception

getAllDeliveryChannels

This request returns the metadata of all existing Publishing Channels with their parameters.

Request

GET /api/v3/publishingService/getAllDeliveryChannels

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object containing an array of all existing publishing channels.
400	QppServiceException: Unhandled server exception

getAllPublishingChannels

This request returns the metadata of all existing Publishing Channels with their parameters

Request

GET /api/v3/publishingService/getAllPublishingChannels

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object containing an array of all existing publishing channels
400	QppServiceException: Unhandled server exception

getChannel

This request returns the metadata of publishing channels for given channel id. Null will be returned in case the channel doesn’t exist for the given channel id

Request

GET /api/v3/publishingService/getChannel

Responses

Status Code	Description	Samples
200	Returns a publishingChannel object
400	QppServiceException: Unhandled server exception

getChannelTransform

This request converts PublishingChannel object to corresponding publishing framework's Channel object.

Request

GET /api/v3/publishingService/getChannelTransform

Responses

Status Code	Description	Samples
200	Returns a publishing framework's Channel object
400	QppServiceException: Unhandled server exception

getChannelWithAllParameters

This request returns the metadata of publishing channels with all its parameters for given channel id. Null will be returned in case the channel doesn’t exist for the given channel id

Request

GET /api/v3/publishingService/getChannelWithAllParameters

Responses

Status Code	Description	Samples
200	Returns a publishingChannel object
400	QppServiceException: Unhandled server exception

getContentTypeChannelMappings

This request returns the list of content type channel with mapping

Request

GET /api/v3/publishingService/getContentTypeChannelMappings

Responses

Status Code	Description	Samples
200	Returns list of content type channel with mapping
400	QppServiceException: Unhandled server exception

getContentTypesForChannel

This request returns the list of content types for a specific channel.

Request

GET /api/v3/publishingService/getContentTypesForChannel

Responses

Status Code	Description	Samples
200	Returns list of content types for a specific channel.
400	QppServiceException: Unhandled server exception

getDatadocAssets

This request returns the metadata of the datadoc assets which had been created by executing the given channel and parameters.

Request

GET /api/v3/publishingService/getDatadocAssets

Responses

Status Code	Description	Samples
200	Returns the metadata of the Datadoc asset created through the supplied datadoc channel.
400	QppServiceException: Unhandled server exception

getDatadocChannels

This request returns the all avilable metadata of publishing channels for given content type. Null will be returned in case the channel doesn’t exist for the given content type

Request

GET /api/v3/publishingService/getDatadocChannels

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object
400	QppServiceException: Unhandled server exception

getDeliveryChannels

This request returns the metadata of all existing Publishing Channels with their parameters.

Request

GET /api/v3/publishingService/getDeliveryChannels

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object containing an array of all existing publishing channels.
400	QppServiceException: Unhandled server exception

getPublishingChannel

This request converts publishing framework's Channel object to corresponding PublishingChannel object.

Request

GET /api/v3/publishingService/getPublishingChannel

Responses

Status Code	Description	Samples
200	Returns a publishingChannel object
400	QppServiceException: Unhandled server exception

getPublishingChannels

This request returns the all avilable metadata of publishing channels for given content type. Null will be returned in case the channel doesn’t exist for the given content type

Request

GET /api/v3/publishingService/getPublishingChannels

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object
400	QppServiceException: Unhandled server exception

getPublishingStatus

This request returns the all avilable metadata of publishing channels and its status

Request

GET /api/v3/publishingService/getPublishingStatus

Responses

Status Code	Description	Samples
200	Returns a publishing status
400	QppServiceException: Unhandled server exception

getQXPSVersion

Request

GET /api/v3/publishingService/getQXPSVersion

Responses

Status Code	Description	Samples
200	successful operation

publishAndDeliver

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v3/publishingService/publishAndDeliver

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object
400	QppServiceException: Unhandled server exception

publishAndDeliverAssetVersion

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v3/publishingService/publishAndDeliverAssetVersion

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

publishAndDeliverAssetVersionAsync

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v3/publishingService/publishAndDeliverAssetVersionAsync

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

publishAndDeliverAsync

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v3/publishingService/publishAndDeliverAsync

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object
400	QppServiceException: Unhandled server exception

publishAndDeliverBasedOnStream

This request will publish a non-platform resource. Takes input in the form of a file stream

Request

POST /api/v3/publishingService/publishAndDeliverBasedOnStream

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format
400	QppServiceException: Unhandled server exception

publishAndDeliverBasedOnURI

Publish a non-Platform resource. Takes input in the form of URI.

Request

POST /api/v3/publishingService/publishAndDeliverBasedOnURI

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format.
400	QppServiceException: Unhandled server exception

publishAndDeliverBasedOnURIAsync

Publish a non-Platform resource. Takes input in the form of URI.

Request

POST /api/v3/publishingService/publishAndDeliverBasedOnURIAsync

Responses

Status Code	Description	Samples
200	Returns a publishingChannelList object
400	QppServiceException: Unhandled server exception

publishAsset

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v3/publishingService/publishAsset

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

publishAssetAsync

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v3/publishingService/publishAssetAsync

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

publishAssetVersion

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v3/publishingService/publishAssetVersion

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

publishAssetVersionAsync

This request returns the stream after publishing an asset into a specified format using the publishing channel.

Request

POST /api/v3/publishingService/publishAssetVersionAsync

Responses

Status Code	Description	Samples
200	Returns the filestream after publishing an asset into required format.
400	QppServiceException: Unhandled server exception	Download

publishBasedOnStream

This request will publish a non-platform resource. Takes input in the form of a file stream

Request

POST /api/v3/publishingService/publishBasedOnStream

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format
400	QppServiceException: Unhandled server exception	Download

publishBasedOnURI

Publish a non-Platform resource. Takes input in the form of URI.

Request

POST /api/v3/publishingService/publishBasedOnURI

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format.
400	QppServiceException: Unhandled server exception	Download

publishBasedOnURIAsync

Publish a non-Platform resource. Takes input in the form of URI.

Request

POST /api/v3/publishingService/publishBasedOnURIAsync

Responses

Status Code	Description	Samples
200	Returns the filestream of output after publishing an asset to the required format.
400	QppServiceException: Unhandled server exception	Download

setChannelWithContentTypeMappings

This request set channel with contentTypes mapping

Request

POST /api/v3/publishingService/setChannelWithContentTypeMappings

Responses

Status Code	Description	Samples
200	update channel with content types mapping
400	QppServiceException: Unhandled server exception

setContentTypeChannelMappings

This request set content type channel with mapping

Request

POST /api/v3/publishingService/setContentTypeChannelMappings

Responses

Status Code	Description	Samples
200	update content type channel mapping
400	QppServiceException: Unhandled server exception

setPreviewChannels

This request set preview content channel

Request

POST /api/v3/publishingService/setPreviewChannels

Responses

Status Code	Description	Samples
200	set preview for channel
400	QppServiceException: Unhandled server exception

updateDatadoc

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.

Request

POST /api/v3/publishingService/updateDatadoc

Responses

Status Code	Description	Samples
200	Returns the metadata of the successfully updated Datadoc asset
400	QppServiceException: Unhandled server exception

updateDatadocChannelAndParameters

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.

Request

POST /api/v3/publishingService/updateDatadocChannelAndParameters

Responses

Status Code	Description	Samples
200	Returns the metadata of the successfully updated Datadoc asset
400	QppServiceException: Unhandled server exception

QueryService

closeQueryResult

This request will close query result for query specific to result id

Request

POST /api/v1/queryService/closeQueryResult

Responses

Status Code	Description	Samples
200	will close the query result
400	QppServiceException: Unhandled server exception

closeWatchQuerySession

This request will close watch query session specific to session

Request

POST /api/v1/queryService/closeWatchQuerySession

Responses

Status Code	Description	Samples
200
400	QppServiceException: Unhandled server exception

countQueryResult

This request will return the count for query result

Request

GET /api/v1/queryService/countQueryResult

Responses

Status Code	Description	Samples
200	return the count of result
400	QppServiceException: Unhandled server exception

countQueryResultForConditions

This request will return the count for query result specific to conditions

Request

GET /api/v1/queryService/countQueryResultForConditions

Responses

Status Code	Description	Samples
200	return the count of result
400	QppServiceException: Unhandled server exception

countQueryResultWithoutAcl

This request will return the count for query result

Request

GET /api/v1/queryService/countQueryResultWithoutAcl

Responses

Status Code	Description	Samples
200	return the count of result
400	QppServiceException: Unhandled server exception

createQuery

This request will create a query with definition and details of a query

Request

POST /api/v1/queryService/createQuery

Responses

Status Code	Description	Samples
200	will create query and return with id
400	QppServiceException: Unhandled server exception

createWatchQuerySession

This request will create a watch query with timeout session

Request

POST /api/v1/queryService/createWatchQuerySession

Responses

Status Code	Description	Samples
200	will create watch query with session
400	QppServiceException: Unhandled server exception

deleteQuery

This request will delte query specific to query id

Request

POST /api/v1/queryService/deleteQuery

Responses

Status Code	Description	Samples
200	will delete query
400	QppServiceException: Unhandled server exception

duplicateQuery

This request will create duplicate query from specific query

Request

POST /api/v1/queryService/duplicateQuery

Responses

Status Code	Description	Samples
200	will create duplicate query
400	QppServiceException: Unhandled server exception

exportSearchResults

This request will export the search result for query specific to id, date, queryDisplay and locale

Request

POST /api/v1/queryService/exportSearchResults

Responses

Status Code	Description	Samples
200	will export the results for search query
400	QppServiceException: Unhandled server exception

exportSearchResultsForConditions

This request will export the search result for query specific to id, date, queryDisplay and locale for queryDefinition conditions

Request

POST /api/v1/queryService/exportSearchResultsForConditions

Responses

Status Code	Description	Samples
200	will export the results for search query for conditions
400	QppServiceException: Unhandled server exception

getAllQueries

This request will return all the query with there definition

Request

GET /api/v1/queryService/getAllQueries

Responses

Status Code	Description	Samples
200	list of all Queries wirh thir definition object
400	QppServiceException: Unhandled server exception

getCollectionDisplay

This request will return collection display for specific collection

Request

GET /api/v1/queryService/getCollectionDisplay

Responses

Status Code	Description	Samples
200	Will return collectionDispaly object
400	QppServiceException: Unhandled server exception

getExportSearchResultsStatus

This request will return status info for export search results specific to contextId

Request

GET /api/v1/queryService/getExportSearchResultsStatus

Responses

Status Code	Description	Samples
200	Will return object of ExportResultsStatusInfo
400	QppServiceException: Unhandled server exception

getNextQueryResult

This request will return the list of query next result

Request

GET /api/v1/queryService/getNextQueryResult

Responses

Status Code	Description	Samples
200	will return the list of query result object with its metadata
400	QppServiceException: Unhandled server exception

getPaginatedQueryResults

This request return paginated Query Element and details of a Query stored in the system specific to id

Request

POST /api/v1/queryService/getPaginatedQueryResults

Responses

Status Code	Description	Samples
200	will return list of queryresultelement object for query
400	QppServiceException: Unhandled server exception

getPaginatedQueryResultsForConditions

This request return paginated Query Element and details of a Query stored in the system specific to conditions

Request

POST /api/v1/queryService/getPaginatedQueryResultsForConditions

Responses

Status Code	Description	Samples
200	will return list of queryresultelement object for query
400	QppServiceException: Unhandled server exception

getPaginatedQueryResultsForResultId

This request will return paginated queryResultElement object specific to resultId

Request

POST /api/v1/queryService/getPaginatedQueryResultsForResultId

Responses

Status Code	Description	Samples
200	will return list of queryresultelement object for query
400	QppServiceException: Unhandled server exception

getPaginatedQueryResultsWithFilters

This request return paginated Query Element and details of a Query stored in the system with specific filter in query

Request

POST /api/v1/queryService/getPaginatedQueryResultsWithFilters

Responses

Status Code	Description	Samples
200	will return list of queryresultelement object for query
400	QppServiceException: Unhandled server exception

getQueryDefinition

This request will return object of queryDefinition specific to query id

Request

GET /api/v1/queryService/getQueryDefinition

Responses

Status Code	Description	Samples
200
400	QppServiceException: Unhandled server exception

getQueryDisplay

This request will return query display object for specific query id

Request

GET /api/v1/queryService/getQueryDisplay

Responses

Status Code	Description	Samples
200	Will return query display object
400	QppServiceException: Unhandled server exception

getQueryResult

This request return Query Element and details of a Query stored in the system specific to id

Request

GET /api/v1/queryService/getQueryResult

Responses

Status Code	Description	Samples
200
400	QppServiceException: Unhandled server exception

getQueryResultElement

This request will return paginated queryResultElement object specific to resultId and element id

Request

GET /api/v1/queryService/getQueryResultElement

Responses

Status Code	Description	Samples
200	will return list of queryresultelement object for query
400	QppServiceException: Unhandled server exception

getQueryResultForConditions

This request return Query Element and details of a Query stored in the system specific to conditions

Request

POST /api/v1/queryService/getQueryResultForConditions

Responses

Status Code	Description	Samples
200	Returns a list of elements for query result
400	QppServiceException: Unhandled server exception

getQueryResultWithFilters

This request return Query Element and details of a Query stored in the system with specific filter in query

Request

GET /api/v1/queryService/getQueryResultWithFilters

Responses

Status Code	Description	Samples
200
400	QppServiceException: Unhandled server exception

getSharedQueryTrustees

This request shares any specified query to any user or group.

Request

GET /api/v1/queryService/getSharedQueryTrustees

Responses

Status Code	Description	Samples
200	Will return array of ids
400	QppServiceException: Unhandled server exception

getUserQueries

This request will return list of nameId query specific to user id

Request

GET /api/v1/queryService/getUserQueries

Responses

Status Code	Description	Samples
200	will return NameId list of object specific to user
400	QppServiceException: Unhandled server exception

keepAliveWatchQuerySession

This request set the watch query to keep alive for particular session

Request

POST /api/v1/queryService/keepAliveWatchQuerySession

Responses

Status Code	Description	Samples
200	will set the watch query session to alive
400	QppServiceException: Unhandled server exception

openWatchQueryResults

This request will return results for watch query specific to id , session , change types

Request

POST /api/v1/queryService/openWatchQueryResults

Responses

Status Code	Description	Samples
200	will returns the results for watch query
400	QppServiceException: Unhandled server exception

openWatchQueryResultsForConditions

This request will return results for watch query specific to id , session , change types for conditions

Request

POST /api/v1/queryService/openWatchQueryResultsForConditions

Responses

Status Code	Description	Samples
200	will returns the results for watch query for conditions
400	QppServiceException: Unhandled server exception

openWatchQueryResultsWithFilters

This request will return results for watch query specific to id , session , change types with filters

Request

POST /api/v1/queryService/openWatchQueryResultsWithFilters

Responses

Status Code	Description	Samples
200	will returns the results for watch query with filters
400	QppServiceException: Unhandled server exception

reassignQuery

This request will reassign the query to new specific user or group

Request

POST /api/v1/queryService/reassignQuery

Responses

Status Code	Description	Samples
200	will assign suuceefully new owner to query
400	QppServiceException: Unhandled server exception

removeSharedQuery

This request will remove the shared query specific to qury and any user or group

Request

POST /api/v1/queryService/removeSharedQuery

Responses

Status Code	Description	Samples
200	will remove shared query
400	QppServiceException: Unhandled server exception

setAllCollectionDisplay

Thid request will set collection display for all collection

Request

POST /api/v1/queryService/setAllCollectionDisplay

Responses

Status Code	Description	Samples
200
400	QppServiceException: Unhandled server exception

setCollectionDisplay

This request will set collection display for content of collection

Request

POST /api/v1/queryService/setCollectionDisplay

Responses

Status Code	Description	Samples
200	will set successfully collection display
400	QppServiceException: Unhandled server exception

setQueryDisplay

This request will set the query display specific to query id

Request

POST /api/v1/queryService/setQueryDisplay

Responses

Status Code	Description	Samples
200	will set query display for query
400	QppServiceException: Unhandled server exception

shareQuery

This request will share query with specific to trustee

Request

POST /api/v1/queryService/shareQuery

Responses

Status Code	Description	Samples
200	will share query between user or group
400	QppServiceException: Unhandled server exception

updateQuery

This request will update a query with updated query definition

Request

POST /api/v1/queryService/updateQuery

Responses

Status Code	Description	Samples
200	will update query successfully
400	QppServiceException: Unhandled server exception

RelationService

createRelationType

Creates a new relation type with the defined name, checkOutManadatory boolean flag and array of relationTypeAttributeMappings and After successful creation of relation type, message of object type RelationMessageConstants.MESSAGE_OBJECT_TYPE_RELATION_TYPE and change type RelationMessageConstants.RelationTypeChangeTypes#RELATION_TYPE_ADDED is published.

Request

POST /api/v1/relationService/createRelationType

Responses

Status Code	Description	Samples
200	Returns a relationTypeInfoList object containing a list of successfully created relation types
400	QppServiceException: Unhandled server exception

deleteRelationType

Deletes a relation type with the given id from the system.Only user defined relation types can be deleted and After successful deletion of a relation type, message of object type RelationMessageConstants.MESSAGE_OBJECT_TYPE_RELATION_TYPE and change type RelationMessageConstants.RelationTypeChangeTypes#RELATION_TYPE_DELETED is published.

Request

POST /api/v1/relationService/deleteRelationType

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution.
400	QppServiceException: Unhandled server exception

getAllRelationTypes

This request returns all the relation types with their attributes.

Request

GET /api/v1/relationService/getAllRelationTypes

Responses

Status Code	Description	Samples
200	Returns a relationTypeInfoList object containing an array of all relation types that exist on the QPP Server
400	QppServiceException: Unhandled server exception

getRelationType

This request is used to get the metadata of a specified relation type.

Request

GET /api/v1/relationService/getRelationType

Responses

Status Code	Description	Samples
200	Returns a relationTypeInfoList object containing the metadata of the specified relation type
400	QppServiceException: Unhandled server exception

getRelationTypeAttributes

Request

GET /api/v1/relationService/getRelationTypeAttributes

Responses

Status Code	Description	Samples
200	Returns list of mapping for relation type attribute
400	QppServiceException: Unhandled server exception

renameRelationType

Updates the name of the relation type. Only user defined relation types are allowed for name update and After successful renaming of the relation type, message of object type RelationMessageConstants.MESSAGE_OBJECT_TYPE_RELATION_TYPE and change type RelationMessageConstants.RelationTypeChangeTypes#RELATION_TYPE_CHANGED is published.

Request

POST /api/v1/relationService/renameRelationType

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

setRelationTypeAttributes

Sets the RelationType to Attributes mappings for the relation type with the given id and After successful update of the relationTypeAttributeMappings, message of object type RelationMessageConstants.MESSAGE_OBJECT_TYPE_RELATION_TYPE and change type RelationMessageConstants.RelationTypeChangeTypes#RELATION_ATTRIBUTE_MAPPINGS_CHANGED is published.

Request

POST /api/v1/relationService/setRelationTypeAttributes

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

RuntimeConfigurationService

getServerTime

This request is used to get server time .

Request

GET /api/v1/runtimeConfigurationService/getServerTime

Responses

Status Code	Description	Samples
200	Returns server time as a string
400	bad request

SchedulerService

createSchedule

This request is used to Creates an execution schedule

Request

POST /api/v1/schedulerService/createSchedule

Responses

Status Code	Description	Samples
200	retrun the created shedule of an object
400	QppServiceException: Unhandled server exception.

deleteSchedule

This request is used to delete execution schedule

Request

POST /api/v1/schedulerService/deleteSchedule

Responses

Status Code	Description	Samples
200	retrun the deleted shedule of an object
400	QppServiceException: Unhandled server exception.

getAllSchedules

This request is used to retrieve all the execution schedule

Request

GET /api/v1/schedulerService/getAllSchedules

Responses

Status Code	Description	Samples
200	retrun the array list of shedule
400	QppServiceException: Unhandled server exception.

getSchedule

This request is used to retrieve the execution schedule

Request

GET /api/v1/schedulerService/getSchedule

Responses

Status Code	Description	Samples
200	retrun the data of shedule object
400	QppServiceException: Unhandled server exception.

updateSchedule

This request is used to update execution schedule

Request

POST /api/v1/schedulerService/updateSchedule

Responses

Status Code	Description	Samples
200	retrun the updated shedule of an object
400	QppServiceException: Unhandled server exception.

ScriptService

createScript

this request to create a script

Request

POST /api/v1/scriptService/createScript

Responses

Status Code	Description	Samples
200	retrun the created script
400	QppServiceException: Unhandled server exception.

deleteScript

This request is used to delete script.

Request

POST /api/v1/scriptService/deleteScript

Responses

Status Code	Description	Samples
200	returned deleted script object
400	QppServiceException: Unhandled server exception.

executeScript

This request is used to Executes an existing script

Request

POST /api/v1/scriptService/executeScript

Responses

Status Code	Description	Samples
200	retrun the Executed an existing script
400	QppServiceException: Unhandled server exception.

executeScriptWithParameters

Executes a given script method with the given parameter list

Request

POST /api/v1/scriptService/executeScriptWithParameters

Responses

Status Code	Description	Samples
200	retrun the script
400	QppServiceException: Unhandled server exception.

getAllScripts

this request to Gets all stored scripts.

Request

GET /api/v1/scriptService/getAllScripts

Responses

Status Code	Description	Samples
200	retrun the list of strored script
400	QppServiceException: Unhandled server exception.

getScheduleIdbyScriptId

Gets the scheduleId associated with the given scriptId.

Request

GET /api/v1/scriptService/getScheduleIdbyScriptId

Responses

Status Code	Description	Samples
200	Returns -1 if no schedule is associated with the script.
400	QppServiceException: Unhandled server exception.

getScript

this request to Gets all stored scripts.

Request

GET /api/v1/scriptService/getScript

Responses

Status Code	Description	Samples
200	The returned script object also contains the script object
400	QppServiceException: Unhandled server exception.

getScriptByName

This request is used to Gets a stored script

Request

GET /api/v1/scriptService/getScriptByName

Responses

Status Code	Description	Samples
200	returned script object also contains the script object
400	QppServiceException: Unhandled server exception.

getScriptExecutionDetails

This request is used to Gets the execution details of an existing script.

Request

GET /api/v1/scriptService/getScriptExecutionDetails

Responses

Status Code	Description	Samples
200	returned execution details of an existing script script object
400	QppServiceException: Unhandled server exception.

getScriptIdByScheduleId

Gets the scriptId associated with the given scheduleId.

Request

GET /api/v1/scriptService/getScriptIdByScheduleId

Responses

Status Code	Description	Samples
200	Returns -1 if no script is associated with the job Id.
400	QppServiceException: Unhandled server exception.

getScriptsByEventChangeType

this request is used to registered with eventType and the change type specified

Request

GET /api/v1/scriptService/getScriptsByEventChangeType

Responses

Status Code	Description	Samples
200	Returns an array of Script Ids which are registered with eventType and the change type specified.
400	QppServiceException: Unhandled server exception.

getSupportedEvents

Gets all the supported events that could be attached to embedded scripts.

Request

GET /api/v1/scriptService/getSupportedEvents

Responses

Status Code	Description	Samples
200	returned Array of supported events
400	QppServiceException: Unhandled server exception.

getSupportedLanguages

Gets all the registered script languages in the form of a ScriptLanguage

Request

GET /api/v1/scriptService/getSupportedLanguages

Responses

Status Code	Description	Samples
200	Returns an empty array if there are no supported languages..
400	QppServiceException: Unhandled server exception.

updateScriptContent

Updates the content of an existing script.

Request

POST /api/v1/scriptService/updateScriptContent

Responses

Status Code	Description	Samples
200	returned updated supported events
400	QppServiceException: Unhandled server exception.

updateScriptExecutionDetails

Updates the execution details of an existing script.

Request

POST /api/v1/scriptService/updateScriptExecutionDetails

Responses

Status Code	Description	Samples
200	returned execution details of an existing script
400	QppServiceException: Unhandled server exception.

updateScriptName

Updates the name of an existing script.

Request

POST /api/v1/scriptService/updateScriptName

Responses

Status Code	Description	Samples
200	returned Updated the name of an existing script object
400	QppServiceException: Unhandled server exception.

SessionService

authenticateUser

This request is used to authenticate user by name and password

Request

POST /api/v1/sessionService/authenticateUser

Responses

Status Code	Description	Samples
200	Returns user info object
400	QppServiceException: Unhandled server exception

validateTrustedUser

This request is used to validate trusted user by token

Request

POST /api/v1/sessionService/validateTrustedUser

Responses

Status Code	Description	Samples
200	Return user info object
400	QppServiceException: Unhandled server exception

TrusteeService

addUserToGroups

This request will add the user to multiple groups at a time specific to user ids with groupIds

Request

POST /api/v1/trusteeService/addUserToGroups

Responses

Status Code	Description	Samples
200	Returns success with user added to grops
400	QppServiceException: Unhandled server exception

createGroup

This request is used to create a single group at one time.

Request

POST /api/v1/trusteeService/createGroup

Responses

Status Code	Description	Samples
200	Returns a groupInfoList object containing its metadata and memberlist.
400	QppServiceException: Unhandled server exception

createUser

This request is used to create users. The new user will be created without password, client needs to set the password for the user separately

Request

POST /api/v1/trusteeService/createUser

Responses

Status Code	Description	Samples
200	Returns id of a newly created user.
400	QppServiceException: Unhandled server exception

deleteTrustee

This request will delete the trustee fspecific to trusteeId

Request

POST /api/v1/trusteeService/deleteTrustee

Responses

Status Code	Description	Samples
200	Returns success and delete the trustee
400	QppServiceException: Unhandled server exception

duplicateGroup

This request will create duplicate group and returns id for the group

Request

POST /api/v1/trusteeService/duplicateGroup

Responses

Status Code	Description	Samples
200	Returns success with group id
400	QppServiceException: Unhandled server exception

duplicateUser

This request will create duplicate user and returns id for the user

Request

POST /api/v1/trusteeService/duplicateUser

Responses

Status Code	Description	Samples
200	Returns success with id
400	QppServiceException: Unhandled server exception

exportCustomisations

This request returns download info for export customisation for migration

Request

GET /api/v1/trusteeService/exportCustomisations

Responses

Status Code	Description	Samples
200	Returns downloadInfo for migration export customisation
400	QppServiceException: Unhandled server exception

getAllApplicableApplicationPrivileges

This request returns all the applicable application privileges.

Request

GET /api/v1/trusteeService/getAllApplicableApplicationPrivileges

Responses

Status Code	Description	Samples
200	Returns list of all the Privileges
400	QppServiceException: Unhandled server exception

getAllApplicableContentPrivileges

This request returns all the privileges applicable for the specific contentTypeId

Request

GET /api/v1/trusteeService/getAllApplicableContentPrivileges

Responses

Status Code	Description	Samples
200	Returns list of all the Privileges
400	QppServiceException: Unhandled server exception

getAllAuthorUsers

This request is used to fetch all users with role of Author

Request

GET /api/v1/trusteeService/getAllAuthorUsers

Responses

Status Code	Description	Samples
200	Returns user object role with author
400	QppServiceException: Unhandled server exception

getAllGroups

This request returns all groups including its members.

Request

GET /api/v1/trusteeService/getAllGroups

Responses

Status Code	Description	Samples
200	Returns a groupInfoList object containing an array of groups that exist on the QPP server. See the table in the “Request/Response parameter formats” chapter.
400	QppServiceException: Unhandled server exception

getAllTrustees

This request returns all the trustee with metadata of a specified trustee

Request

GET /api/v1/trusteeService/getAllTrustees

Responses

Status Code	Description	Samples
200	Returns list of Trustee object
400	QppServiceException: Unhandled server exception

getAllUsers

This request is used to fetch all users.

Request

GET /api/v1/trusteeService/getAllUsers

Responses

Status Code	Description	Samples
200	Returns an userInfoList object containing metadata of users in the form of an array.
400	QppServiceException: Unhandled server exception

getApplicableApplicationPrivileges

This request returns enabled applicable application privileges for the logged in user. Applicable privileges are a union of all the privileges granted to him as a user as well as to groups of which the user is a member.

Request

GET /api/v1/trusteeService/getApplicableApplicationPrivileges

Responses

Status Code	Description	Samples
200	Returns the applicationPrivList containing all of the applicable applicaton privileges
400	QppServiceException: Unhandled server exception

getApplicableApplicationPrivilegesForGroup

This request returns enabled privileges of the application applicable for the group

Request

GET /api/v1/trusteeService/getApplicableApplicationPrivilegesForGroup

Responses

Status Code	Description	Samples
200	Returns the PrivList containing all of the applicable privileges
400	QppServiceException: Unhandled server exception

getApplicableContentPrivileges

Request

GET /api/v1/trusteeService/getApplicableContentPrivileges

Responses

Status Code	Description	Samples
200	Returns the contentPrivList containing all of the applicable content privileges.
400	QppServiceException: Unhandled server exception

getApplicableContentPrivilegesForGroup

This request returns enabled privileges of the given content type applicable for the group

Request

GET /api/v1/trusteeService/getApplicableContentPrivilegesForGroup

Responses

Status Code	Description	Samples
200	Returns the contentPrivList containing all of the applicable content privileges
400	QppServiceException: Unhandled server exception

getGroup

This request returns all the metadata of specified group.

Request

GET /api/v1/trusteeService/getGroup

Responses

Status Code	Description	Samples
200	Returns a groupInfoList object in XML format of specified group. See the table in the “Request/Response parameter formats” chapter.
400	QppServiceException: Unhandled server exception

getGroupByName

This request will return a group specific to group name

Request

GET /api/v1/trusteeService/getGroupByName

Responses

Status Code	Description	Samples
200	Returns a Gruop object specific to groupName
400	QppServiceException: Unhandled server exception

getGroupMembers

This request will return list of users and all their metadata speicific to groupId

Request

GET /api/v1/trusteeService/getGroupMembers

Responses

Status Code	Description	Samples
200	Returns list of user for group
400	QppServiceException: Unhandled server exception

getGroups

This request returns list with all the metadata of group specific to groupIds.

Request

GET /api/v1/trusteeService/getGroups

Responses

Status Code	Description	Samples
200	Returns list of group object with all the metadata
400	QppServiceException: Unhandled server exception

getGroupsByUserClass

This request will return all the groups for a specified role

Request

GET /api/v1/trusteeService/getGroupsByUserClass

Responses

Status Code	Description	Samples
200	Returns array of groups with all the metadata for a specified role.
400	QppServiceException: Unhandled server exception

getOnlineUsers

This request will returns the list of online users on QPP server platform

Request

GET /api/v1/trusteeService/getOnlineUsers

Responses

Status Code	Description	Samples
200	Returns list of online users and their status
400	QppServiceException: Unhandled server exception

getTrustee

This request returns all the metadata of a specified trustee.

Request

GET /api/v1/trusteeService/getTrustee

Responses

Status Code	Description	Samples
200	Returns a trusteeInfo object in XML format of specified user or group.
400	QppServiceException: Unhandled server exception

getTrusteeById

This request returns all the metadata of a specified trustee.

Request

GET /api/v1/trusteeService/getTrusteeById

Responses

Status Code	Description	Samples
200	Returns a trusteeInfo object in XML format of specified user or group.
400	QppServiceException: Unhandled server exception

getTrusteeByName

This request will returnall the metadata of trustee spefcific to name of the trustee

Request

GET /api/v1/trusteeService/getTrusteeByName

Responses

Status Code	Description	Samples
200	Returns a trustee will all the metadata
400	QppServiceException: Unhandled server exception

getTrusteesByUserClass

This request will return all the members (users/groups) for a specified role

Request

GET /api/v1/trusteeService/getTrusteesByUserClass

Responses

Status Code	Description	Samples
200	Returns array of users/groups with all the metadata for a specified role.
400	QppServiceException: Unhandled server exception

getUser

This request is used to fet the metadata of a specified user.

Request

GET /api/v1/trusteeService/getUser

Responses

Status Code	Description	Samples
200	Returns an userInfoList object with its metadata.
400	QppServiceException: Unhandled server exception

getUserAvatarDownloadInfo

This request will return user avatar download info

Request

GET /api/v1/trusteeService/getUserAvatarDownloadInfo

Responses

Status Code	Description	Samples
200	Returns user avatar download info
400	QppServiceException: Unhandled server exception

getUserAvatarStatus

This request will return user avtar status

Request

GET /api/v1/trusteeService/getUserAvatarStatus

Responses

Status Code	Description	Samples
200	Returns user avatar status info
400	QppServiceException: Unhandled server exception

getUserByName

This request will return user metadata specific to userName

Request

GET /api/v1/trusteeService/getUserByName

Responses

Status Code	Description	Samples
200
400	QppServiceException: Unhandled server exception

getUserGroups

This request returns all groups to which the given user belongs.

Request

GET /api/v1/trusteeService/getUserGroups

Responses

Status Code	Description	Samples
200	Returns a groupInfoList object containing a list of groups of which the given user is a member.
400	QppServiceException: Unhandled server exception

getUserId

This request will return userId specific with the userName

Request

GET /api/v1/trusteeService/getUserId

Responses

Status Code	Description	Samples
200	Returns a userId specific to userName
400	QppServiceException: Unhandled server exception

getUserInactivityTime

This request will return user inactivity time on QPP server platform

Request

GET /api/v1/trusteeService/getUserInactivityTime

Responses

Status Code	Description	Samples
200	Returns the time for user inActivity
400	QppServiceException: Unhandled server exception

getUsers

This request will return list of user objects specific to userIds

Request

GET /api/v1/trusteeService/getUsers

Responses

Status Code	Description	Samples
200	Reyurns a list of users with all the metadata
400	QppServiceException: Unhandled server exception

getUsersAcceptableForRole

This request will return all the users that can be assigned to a group with a specific role.

Request

GET /api/v1/trusteeService/getUsersAcceptableForRole

Responses

Status Code	Description	Samples
200	Returns array of users with all the metadata for a specified role.
400	QppServiceException: Unhandled server exception

getUsersByUserClass

This request will return all the users for a specified role

Request

GET /api/v1/trusteeService/getUsersByUserClass

Responses

Status Code	Description	Samples
200	Returns array of users with all the metadata for a specified role.
400	QppServiceException: Unhandled server exception

getUsersOnlineStatus

This request will return online status of the users specific to userIds

Request

GET /api/v1/trusteeService/getUsersOnlineStatus

Responses

Status Code	Description	Samples
200	Returns the list of user online status
400	QppServiceException: Unhandled server exception

importCustomisations

This request returns will import custmosiation for migration

Request

POST /api/v1/trusteeService/importCustomisations

Responses

Status Code	Description	Samples
200	Returns success for importing customisation
400	QppServiceException: Unhandled server exception

initUserAvatarUpload

This request will upload the user avatar and returns upload info specific to userId

Request

POST /api/v1/trusteeService/initUserAvatarUpload

Responses

Status Code	Description	Samples
200	Returns user avatar upload info
400	QppServiceException: Unhandled server exception

isGroupMember

This request will return either true or false that a user is member of group specific to userId and GroupId

Request

GET /api/v1/trusteeService/isGroupMember

Responses

Status Code	Description	Samples
200	Returns either true or false
400	QppServiceException: Unhandled server exception

keepAlive

This request keeps the current session alive.

Request

GET /api/v1/trusteeService/keepAlive

Responses

Status Code	Description	Samples
200	Returns success with setting session keep alive
400	QppServiceException: Unhandled server exception

reassignTrustee

This request will reassign trusteeid with old trusteeId

Request

POST /api/v1/trusteeService/reassignTrustee

Responses

Status Code	Description	Samples
200	Returns success with newTrusteeId
400	QppServiceException: Unhandled server exception

removeUserFromGroups

This request will remove the user to multiple groups at a time specific to user ids with groupIds

Request

POST /api/v1/trusteeService/removeUserFromGroups

Responses

Status Code	Description	Samples
200	Returns success with user removed from grops
400	QppServiceException: Unhandled server exception

setUserPassword

This request will set password for user spefic to userId

Request

POST /api/v1/trusteeService/setUserPassword

Responses

Status Code	Description	Samples
200	will set the the password for user
400	QppServiceException: Unhandled server exception

updateGroup

This request is used to update an group on QPP server platform.

Request

POST /api/v1/trusteeService/updateGroup

Responses

Status Code	Description	Samples
200	Request will update the group with updated details
400	QppServiceException: Unhandled server exception

updateRoleForUser

This request updates the role of a user.

Request

POST /api/v1/trusteeService/updateRoleForUser

Responses

Status Code	Description	Samples
200	Returns list of string
400	QppServiceException: Unhandled server exception

updateUser

Updates a user. Upon successful updating of the user, UserMessageConstants.UserChangeTypes#USER_CHANGED message is published.

Request

POST /api/v1/trusteeService/updateUser

Responses

Status Code	Description	Samples
200	will update the details for user
400	QppServiceException: Unhandled server exception

validRolesForUser

This request returns the list of all the roles to which a user can update to.

Request

GET /api/v1/trusteeService/validRolesForUser

Responses

Status Code	Description	Samples
200	Returns list of string
400	QppServiceException: Unhandled server exception

UserClassService

createUserClass

Creates a user role with the given userclass object that contains userclass name, content based privileges and application based privilege id's information. UserClassMessageConstants.UserClassChangeTypes#USERCLASS_ADDED message is published.

Request

POST /api/v1/userClassService/createUserClass

Responses

Status Code	Description	Samples
200	Returns id
400	QppServiceException: Unhandled server exception

deleteStatusPrivileges

This request is used to delete status privileges by status id

Request

POST /api/v1/userClassService/deleteStatusPrivileges

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

deleteUserClass

This request is used to delete the user Class by id

Request

POST /api/v1/userClassService/deleteUserClass

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

deleteUserClassStatusPrivileges

This request is used to delete user class status privileges

Request

POST /api/v1/userClassService/deleteUserClassStatusPrivileges

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

duplicateUserClass

This request is used to create duplicate userClass

Request

POST /api/v1/userClassService/duplicateUserClass

Responses

Status Code	Description	Samples
200	Return duplicate id
400	QppServiceException: Unhandled server exception

getAllEnabledApplicationPrivileges

This request used to retrieve all enabled application privileges by userClassId

Request

GET /api/v1/userClassService/getAllEnabledApplicationPrivileges

Responses

Status Code	Description	Samples
200	Returns array of enabled application privileges
400	QppServiceException: Unhandled server exception

getAllEnabledContentPrivileges

This request used to retrieve all enabled content privileges by userClassId

Request

GET /api/v1/userClassService/getAllEnabledContentPrivileges

Responses

Status Code	Description	Samples
200	Returns array of enabled content privileges
400	QppServiceException: Unhandled server exception

getAllUserClasses

This request returns all the userclasses with its metadata

Request

GET /api/v1/userClassService/getAllUserClasses

Responses

Status Code	Description	Samples
200	Returns list of userClasses for all users
400	QppServiceException: Unhandled server exception

getAllUserClassesForLicenseType

This request returns the userclasses with its metadata by license type

Request

GET /api/v1/userClassService/getAllUserClassesForLicenseType

Responses

Status Code	Description	Samples
200	Returns userClass object
400	QppServiceException: Unhandled server exception

getOverriddenStatusAttributeConstraints

This request is used to get overridden status for attribute constraints

Request

GET /api/v1/userClassService/getOverriddenStatusAttributeConstraints

Responses

Status Code	Description	Samples
200	Returns array of StatusAttributeConstraint object
400	QppServiceException: Unhandled server exception

getOverriddenStatusTransition

This request used get the overridden status transition

Request

GET /api/v1/userClassService/getOverriddenStatusTransition

Responses

Status Code	Description	Samples
200	Returns statusTransition object
400	QppServiceException: Unhandled server exception

getOverriddenUserClassesForWorkflow

This request used to retrieve overriden user classes for workflow

Request

GET /api/v1/userClassService/getOverriddenUserClassesForWorkflow

Responses

Status Code	Description	Samples
200	Returns array od ids
400	QppServiceException: Unhandled server exception

getOverriddenWorkflowAttributeConstraints

This request is used to get workflow overridden for attribute constraints

Request

GET /api/v1/userClassService/getOverriddenWorkflowAttributeConstraints

Responses

Status Code	Description	Samples
200	Returns array of StatusAttributeConstraint object
400	QppServiceException: Unhandled server exception

getOverriddenWorkflowStatusTransitions

This request used to retrieve all the overridden workflow statusTransition

Request

GET /api/v1/userClassService/getOverriddenWorkflowStatusTransitions

Responses

Status Code	Description	Samples
200	Returns list of statusTransition
400	QppServiceException: Unhandled server exception

getStatusPrivileges

This request is used to get status Priviliges by id

Request

GET /api/v1/userClassService/getStatusPrivileges

Responses

Status Code	Description	Samples
200	Returns ContentTypeOverriddenPrivileges object
400	QppServiceException: Unhandled server exception

getStatusPrivilegesForContentType

This request is used to get status Priviliges for content type by id

Request

GET /api/v1/userClassService/getStatusPrivilegesForContentType

Responses

Status Code	Description	Samples
200	Returns ContentTypeOverriddenPrivileges object
400	QppServiceException: Unhandled server exception

getUserClass

This request returns the userclasse with its metadata by userClass id

Request

GET /api/v1/userClassService/getUserClass

Responses

Status Code	Description	Samples
200	Returns userClass object
400	QppServiceException: Unhandled server exception

getUserClassInfo

This request returns the userclasse with its metadata by userClass id

Request

GET /api/v1/userClassService/getUserClassInfo

Responses

Status Code	Description	Samples
200	Returns userClass object with metaData
400	QppServiceException: Unhandled server exception

getUserClassName

This request used to return userClass name by id

Request

GET /api/v1/userClassService/getUserClassName

Responses

Status Code	Description	Samples
200	Returns string as userClass name
400	QppServiceException: Unhandled server exception

getUserClassStatusPrivileges

Ths request is used to retreive userClass status privileges

Request

GET /api/v1/userClassService/getUserClassStatusPrivileges

Responses

Status Code	Description	Samples
200	Returns array of ContentTypeOverriddenPrivileges object
400	QppServiceException: Unhandled server exception

getUserClassStatusPrivilegesForContentType

Request

GET /api/v1/userClassService/getUserClassStatusPrivilegesForContentType

Responses

Status Code	Description	Samples
200	successful operation

isStatusPrivilegesOverridden

This request is used to check status privilleges overridden either true or false

Request

GET /api/v1/userClassService/isStatusPrivilegesOverridden

Responses

Status Code	Description	Samples
200	Returns either true or false
400	QppServiceException: Unhandled server exception

isStatusPrivilegesOverriddenForUserClass

This request is used to check overridden status privileges for user class

Request

GET /api/v1/userClassService/isStatusPrivilegesOverriddenForUserClass

Responses

Status Code	Description	Samples
200	Return either true or false
400	QppServiceException: Unhandled server exception

isUserClassInUse

This request used to check if userClass is in use returns true or false

Request

GET /api/v1/userClassService/isUserClassInUse

Responses

Status Code	Description	Samples
200	Returns true or false
400	QppServiceException: Unhandled server exception

reassignUserClass

Update all references of a user role to use another role. Before deleting a role, all references to it must be reassigned to a new role After role reassignments, message UserClassMessageConstants.UserClassChangeTypes#USERCLASS_REASSIGNED is published.

Request

POST /api/v1/userClassService/reassignUserClass

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

setApplicationPrivileges

This request used to set application priviliges specific to userClass by id

Request

POST /api/v1/userClassService/setApplicationPrivileges

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

setContentPrivileges

Sets the contentTypePrivileges for the given user class and After the content privileges have been set UserClassMessageConstants.UserClassChangeTypes#USERCLASS_CHANGED message is published.

Request

POST /api/v1/userClassService/setContentPrivileges

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

setLicenseOfUserClass

This request updates the license of the role

Request

POST /api/v1/userClassService/setLicenseOfUserClass

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

setOverriddenStatusAttributeConstraints

This request is used to set status overridden for attribute constraints

Request

POST /api/v1/userClassService/setOverriddenStatusAttributeConstraints

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

setOverriddenWorkflowStatusTransitions

This request is used to set the overridden workflow status transition for userclass by workflow id and status transition

Request

POST /api/v1/userClassService/setOverriddenWorkflowStatusTransitions

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

setStatusPrivileges

Set privileges for a user role as applicable over assets belonging to the specified status and After updating the privileges for the userclass, message UserClassMessageConstants.UserClassChangeTypes#USERCLASS_STATUS_PRIVILEGES_CHANGED is published.

Request

POST /api/v1/userClassService/setStatusPrivileges

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

setUserClass

Updates the specified userclass,its name, content type and application based privileges for the specified user class id and After update of name and privileges UserClassMessageConstants.UserClassChangeTypes#USERCLASS_CHANGED message is published.

Request

POST /api/v1/userClassService/setUserClass

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

setUserClassName

Updates the name of the specified user class. Allows only user defined userclass name to be updated. After the name of the user class has been updated, UserClassMessageConstants.UserClassChangeTypes#USERCLASS_CHANGED message is published.

Request

POST /api/v1/userClassService/setUserClassName

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

setUserClassStatusPrivileges

This request is used to set userClass status priviliges

Request

POST /api/v1/userClassService/setUserClassStatusPrivileges

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unhandled server exception

validLicensesForRoleUpdation

This request returns the list of all the licenses to which a role can be updated.

Request

GET /api/v1/userClassService/validLicensesForRoleUpdation

Responses

Status Code	Description	Samples
200	Returns list of licenses.
400	QppServiceException: Unhandled server exception

WorkflowService

addWorkflowStatus

Add a new Status to a Workflow and After successful appending of status WorkflowMessageConstants.WorkflowChangeTypes#STATUS_ADDED message is published.The message also contain property WorkflowMessageConstants.WorkflowMessagePropertyNames#STATUS_ID whose value is set to the ID of status added.

Request

POST /api/v1/workflowService/addWorkflowStatus

Responses

Status Code	Description	Samples
200	Returns success and returns id for the same
400	QppServiceException: Unexpected exception while processing request.

createWorkflow

Creates a workflow defined by its name and a set of Statuses. By default the workflow is not assigned to any collection and After successful creation of workflow WorkflowMessageConstants.WorkflowChangeTypes#WORKFLOW_ADDED message is published.

Request

POST /api/v1/workflowService/createWorkflow

Responses

Status Code	Description	Samples
200	Returns a workflowInfoList object containing containing the successfully created workflows
400	QppServiceException: Unexpected exception while processing request.

deleteWorkflow

This request is used to delete the specified workflow

Request

POST /api/v1/workflowService/deleteWorkflow

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution
400	QppServiceException: Unexpected exception while processing request.

deleteWorkflowStatus

This request will delete the status and its metadata by id

Request

POST /api/v1/workflowService/deleteWorkflowStatus

Responses

Status Code	Description	Samples
200	Returns success and delete the status specific to id
400	QppServiceException: Unexpected exception while processing request.

duplicateWorkflow

Duplicates the given workflow with the new name and After successful duplication of workflow messsage WORKFLOW_ADDED is published.

Request

POST /api/v1/workflowService/duplicateWorkflow

Responses

Status Code	Description	Samples
200	Returns workflow and its metadata for duplicate workflow
400	QppServiceException: Unexpected exception while processing request.

getAllUserRedliningColors

This request will return the red line for all the users

Request

GET /api/v1/workflowService/getAllUserRedliningColors

Responses

Status Code	Description	Samples
200	returns array of UserRedliningColor
400	QppServiceException: Unexpected exception while processing request.

getAllWorkflows

This request returns list of all the metadata of a specified workflow

Request

GET /api/v1/workflowService/getAllWorkflows

Responses

Status Code	Description	Samples
200	Returns list of Workflow object with all the metadata
400	QppServiceException: Unexpected exception while processing request.

getCheckinRuleEvaluationEnabledStatuses

This request will returns checkIn rule by enablestatus for given workflow

Request

GET /api/v1/workflowService/getCheckinRuleEvaluationEnabledStatuses

Responses

Status Code	Description	Samples
200	Returns success
400	QppServiceException: Unexpected exception while processing request.

getContentTypeWorkflows

This request returns the content type for given workflow by id

Request

GET /api/v1/workflowService/getContentTypeWorkflows

Responses

Status Code	Description	Samples
200
400	QppServiceException: Unexpected exception while processing request.

getPrintRuleEvaluationEnabledStatuses

This request will returns PrintRuleEvaluation of status for given workflow by is

Request

GET /api/v1/workflowService/getPrintRuleEvaluationEnabledStatuses

Responses

Status Code	Description	Samples
200	Returns Print Rule Evaluation EnabledStatuses with ids
400	QppServiceException: Unexpected exception while processing request.

getRedliningEnabledStatuses

This request will return red line enable status specific to workflow by id

Request

GET /api/v1/workflowService/getRedliningEnabledStatuses

Responses

Status Code	Description	Samples
200	Returns the status array
400	QppServiceException: Unexpected exception while processing request.

getStatus

This request returns status specified of a workflow by id

Request

GET /api/v1/workflowService/getStatus

Responses

Status Code	Description	Samples
200	Returns Status object
400	QppServiceException: Unexpected exception while processing request.

getStatusAttributeConstraints

This request returns StatusAttributeConstraint of status for given workflow by id

Request

GET /api/v1/workflowService/getStatusAttributeConstraints

Responses

Status Code	Description	Samples
200	Returns StatusAttributeConstraint object with all its metadata
400	QppServiceException: Unexpected exception while processing request.

getStatusByName

This request returns status specified of a workflow by name

Request

GET /api/v1/workflowService/getStatusByName

Responses

Status Code	Description	Samples
200	Returns Status object
400	QppServiceException: Unexpected exception while processing request.

getStatusRoutingUserclasses

This request will return status routing user class for given workflow and status by id

Request

GET /api/v1/workflowService/getStatusRoutingUserclasses

Responses

Status Code	Description	Samples
200	Returns StatusRoutingUserClasses object with all its metadata
400	QppServiceException: Unexpected exception while processing request.

getStatusTransition

This request returns the status transitions set for the given workflow. If the statusId parameter is specified, then status transitions for a particular status\r\n are returned. If the roleIdOrName parameter is specified, then the overridden transitions for the given role for particular workflow will be returned. Otherwise the default status transitions are returned

Request

GET /api/v1/workflowService/getStatusTransition

Responses

Status Code	Description	Samples
200	Returns an statusTransitionInfoList object containing a list of StatusTransitions set for the given workflow or workflow status for specified role.
400	QppServiceException: Unexpected exception while processing request.

getUserRedliningColor

This request will return red line status specific to user by id

Request

GET /api/v1/workflowService/getUserRedliningColor

Responses

Status Code	Description	Samples
200	Returns object of UserRedliningColor
400	QppServiceException: Unexpected exception while processing request.

getWorkflow

This request returns all the metadata of a specified workflow by id

Request

GET /api/v1/workflowService/getWorkflow

Responses

Status Code	Description	Samples
200	Returns a workflowInfoList object with the metadata of a specified workflow XML format.
400	QppServiceException: Unexpected exception while processing request.

getWorkflowAttributeConstraints

This request returns StatusAttributeConstraint for given workflow by id

Request

GET /api/v1/workflowService/getWorkflowAttributeConstraints

Responses

Status Code	Description	Samples
200	Returns StatusAttributeConstraint with all its metadata
400	QppServiceException: Unexpected exception while processing request.

getWorkflowByName

This request returns all the metadata of a specified workflow by name

Request

GET /api/v1/workflowService/getWorkflowByName

Responses

Status Code	Description	Samples
200	Returns Workflow object with all the metadata
400	QppServiceException: Unexpected exception while processing request.

getWorkflowContentTypes

This request will return contentTypes for given workflow id

Request

GET /api/v1/workflowService/getWorkflowContentTypes

Responses

Status Code	Description	Samples
200	Returns ids for workflow content type
400	QppServiceException: Unexpected exception while processing request.

getWorkflowIconDownloadInfo

This request will return Workflow Icon Download Info for given workflow

Request

GET /api/v1/workflowService/getWorkflowIconDownloadInfo

Responses

Status Code	Description	Samples
200	Returns WorkflowIconDownloadInfo object
400	QppServiceException: Unexpected exception while processing request.

getWorkflowIconStatus

This request will returns Workflow Icon Status Info by its context id after upload

Request

GET /api/v1/workflowService/getWorkflowIconStatus

Responses

Status Code	Description	Samples
200
400	QppServiceException: Unexpected exception while processing request.

getWorkflowInitialStatuses

This request will returns initial status and all its metadata

Request

GET /api/v1/workflowService/getWorkflowInitialStatuses

Responses

Status Code	Description	Samples
200	Returns list od status and its metadata
400	QppServiceException: Unexpected exception while processing request.

getWorkflowStatusRoutingUserclasses

This request will return workflow status routing user class for given workflow and status by id

Request

GET /api/v1/workflowService/getWorkflowStatusRoutingUserclasses

Responses

Status Code	Description	Samples
200	Returns list of StatusRoutingUserClasses object with all its metadata
400	QppServiceException: Unexpected exception while processing request.

initWorkflowIconUpload

This request will upload the icon for workflow

Request

POST /api/v1/workflowService/initWorkflowIconUpload

Responses

Status Code	Description	Samples
200	Returns WorkflowIconUploadInfo object
400	QppServiceException: Unexpected exception while processing request.

reassignAndDeleteStatus

This request will reassign status to status for given workflow and delete the status of reassigned one

Request

POST /api/v1/workflowService/reassignAndDeleteStatus

Responses

Status Code	Description	Samples
200	Returns success and reassigned status id and delete the other one
400	QppServiceException: Unexpected exception while processing request.

reassignStatus

This request will reassign status to status for given workflow

Request

POST /api/v1/workflowService/reassignStatus

Responses

Status Code	Description	Samples
200	Returns success and reassign status
400	QppServiceException: Unexpected exception while processing request.

renameWorkflow

Rename existing workflow and After renaming of workflow WorkflowMessageConstants.WorkflowChangeTypes#WORKFLOW_CHANGED message is published.

Request

POST /api/v1/workflowService/renameWorkflow

Responses

Status Code	Description	Samples
200	Returns success and rename workflow
400	QppServiceException: Unexpected exception while processing request.

setCheckInRuleEvaluation

This request will set checkIn rule by enableCheckIn of status for given workflow for multiple status ids

Request

POST /api/v1/workflowService/setCheckInRuleEvaluation

Responses

Status Code	Description	Samples
200	Returns success and set the rule for checkIn
400	QppServiceException: Unexpected exception while processing request.

setPrintRuleEvaluation

This request will set PrintRuleEvaluation by enablePrint of status for given workflow specific to status ids

Request

POST /api/v1/workflowService/setPrintRuleEvaluation

Responses

Status Code	Description	Samples
200
400	QppServiceException: Unexpected exception while processing request.

setStatusAttributeConstraints

This request will set the status attribute constraint for given workflow by id

Request

POST /api/v1/workflowService/setStatusAttributeConstraints

Responses

Status Code	Description	Samples
200	Returns success and set the StatusAttributeConstraints
400	QppServiceException: Unexpected exception while processing request.

setStatusRedlining

Enables redlining for given statuses of the workflow. Before enabling, existing redlining settings of all the statuses of the given workflow would be deleted. On successful updation WorkflowMessageConstants.WorkflowChangeTypes#REDLINING_CHANGED message is published.

Request

POST /api/v1/workflowService/setStatusRedlining

Responses

Status Code	Description	Samples
200	Returns success and set the status redline for status of workflow
400	QppServiceException: Unexpected exception while processing request.

setStatusRoutingUserclasses

This request will set status routing user class for given workflow by id

Request

POST /api/v1/workflowService/setStatusRoutingUserclasses

Responses

Status Code	Description	Samples
200	Returns success and set the sStatusRoutingUserClasses for given workflow
400	QppServiceException: Unexpected exception while processing request.

setStatusTransitions

This request will set the StatusTransitions for status of given workflow by id

Request

POST /api/v1/workflowService/setStatusTransitions

Responses

Status Code	Description	Samples
200	Returns success and set the status transition
400	QppServiceException: Unexpected exception while processing request.

setUserRedliningColor

This request will Defines the DTO for user color

Request

POST /api/v1/workflowService/setUserRedliningColor

Responses

Status Code	Description	Samples
200	Returns success and set UserRedliningColor
400	QppServiceException: Unexpected exception while processing request.

setWorkflowContentTypes

Set content types for which a Workflow will be applicable. Assets can be assigned the Workflow and any of its Status if they belong to any of the content type associated with the Workflow and After successful UPDATION WorkflowMessageConstants.WorkflowChangeTypes#WORKFLOW_CHANGED message is published.

Request

POST /api/v1/workflowService/setWorkflowContentTypes

Responses

Status Code	Description	Samples
200	Returns success on setting workflow content type
400	QppServiceException: Unexpected exception while processing request.

setWorkflowStatuses

Set given array of statuses for a workflow. The statuses with id greater than zero will be updated and After successful setting of workflow statuses messages WorkflowMessageConstants.WorkflowChangeTypes#STATUS_ADDED,

Request

POST /api/v1/workflowService/setWorkflowStatuses

Responses

Status Code	Description	Samples
200	Returns success and set the workflow status
400	QppServiceException: Unexpected exception while processing request.

updateCheckInRuleEvaluation

This request will update checkIn rule by enableCheckIn of status for given workflow

Request

POST /api/v1/workflowService/updateCheckInRuleEvaluation

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution
400	QppServiceException: Unexpected exception while processing request.

updateConstrainedStatusTransition

this request will update constrainedStatusTransition of status of workflow specific to id

Request

POST /api/v1/workflowService/updateConstrainedStatusTransition

Responses

Status Code	Description	Samples
200	Returns success on update
400	QppServiceException: Unexpected exception while processing request.

updatePrintRuleEvaluation

This request will update PrintRuleEvaluation by enablePrint of status for given workflow

Request

POST /api/v1/workflowService/updatePrintRuleEvaluation

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution
400	QppServiceException: Unexpected exception while processing request.

updateStatusRedlining

This request will update statusRedlining of status for given workflow by status id

Request

POST /api/v1/workflowService/updateStatusRedlining

Responses

Status Code	Description	Samples
200	A status of 200 is returned in response to a successful request execution
400	QppServiceException: Unexpected exception while processing request.

updateWorkflowStatuses

Modify details of a Workflow Statuses. Only statuses of the single workflow would be allowed at a time and After successful update of statuses WorkflowMessageConstants.WorkflowChangeTypes#STATUS_CHANGED message is published.

Request

POST /api/v1/workflowService/updateWorkflowStatuses

Responses

Status Code	Description	Samples
200	Returns success on update
400	QppServiceException: Unexpected exception while processing request.