Deployment REST API

From alfrescowiki

Jump to: navigation, search
AVM Deprecation Warning: The AVM is no longer being actively developed by Alfresco Engineering and Enterprise support subscriptions for the AVM are no longer being offered to new customers. New projects requiring Web Content Management features may want to consider leveraging a CMIS-based solution such as Web Quick Start instead.

This page describes a possible design for the deployment rest api.

Please note NOT IMPLEMENTED

Contents

WCM Deployment

wcm/webproject/deploymentTargets

Represents a collection of deployment targets

add a deployment target

POST /alfresco/service/api/wcm/webproject/{webProjectRef}/deploymentTargets
=> WCMTarget

list all deployment targets

GET /alfresco/service/api/wcm/webproject/{projectref}/deploymentTargets
=> WCMTarget[]
     <type name="wca:deploymentserver">
           <property name="wca:deploytype">
           <property name="wca:deployservertype">
           <property name="wca:deployserverhost">       
           <property name="wca:deployserverport">
           <property name="wca:deployservername">
           <property name="wca:deployservergroup">
           <property name="wca: deployserveradaptername">
           <property name="wca:deployserverusername">
           <property name="wca:deployserverpassword">
           <property name="wca:deployserverurl">
           <property name="wca:deploysourcepath">
           <property name="wca:deployexcludes">
           <property name="wca:deployserverallocatedto">
           <property name="wca:deployonapproval">

update a deployment target properties

PUT /alfresco/service/api/wcm/webproject/{webProjectRef}/deploymentTargets/{targetRef}
=> WCMTarget

delete a deployment target

DELETE /alfresco/service/api/wcm/webproject/{webProjectRef}/deploymentTargets/{targetRef}
=> WCMTarget

list deployment target properties

GET /alfresco/service/api/wcm/webproject/{projectref}/deploymentTarget
=> WCMTarget[]

Do a deployment - will need to return some sort of action handle to be able to identify the action in the action queue and find its current status.

POST /alfresco/service/api/wcm/webproject/{webProjectRef}/deploymentTargets
=> WCMDeploymentActionHandle

wcm/webproject/deploymentTarget/deploymentReports

list all deployment reports

GET /alfresco/service/api/wcm/webproject/{projectref}/deploymentTargets/{targetRef}/deploymentReports
=> WCMDeploymentReport[]

wcm/webproject/deploymentTarget/deploymentReport

GET /alfresco/service/api/wcm/webproject/{projectref}/deploymentTargets/{targetRef}/deploymentReport/{ReportID}
=> WCMDeploymentReport
</pre<

<pre>
GET /alfresco/service/api/wcm/webproject/{projectref}/deploymentTargets/{targetRef}/deploymentReports
=> WCMDeploymentReport[]
Personal tools
Download and go
© 2012 Alfresco Software, Inc. All Rights Reserved. Legal | Privacy | Accessibility