Table of Contents

Search

  1. Preface
  2. Overview, Downloading, and Installing
  3. Administration API
  4. Identity Service API
  5. Screenflow Programming and SDK
  6. ActiveVOS WSHT API
  7. Embedding Request Forms in Standalone Web Pages
  8. XML-JSON for Process Central

7. APIs, SDKs, and Services

7. APIs, SDKs, and Services

Contribution API

Contribution API

The elements described in the following table are contained within an
<wsdl:portType name="IAeContributionManagement">
Operation Name
Operation
Description
deleteContribution
<wsdl:operation name="deleteContribution"> <wsdl:input message="tns:DeleteContribution"/> <wsdl:output message="tns:DeleteContributionResponse"/> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Deletes a contribution.
deletePlan
<wsdl:operation name="deletePlan"> <wsdl:input message="tns:DeletePlan" /> <wsdl:output message="tns:DeletePlanResponse" /> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Deletes a plan.
getContributionDetail
<wsdl:operation name="getContributionDetail"> <wsdl:input message="tns:GetContributionDetail" /> <wsdl:output message="tns:GetContributionDetailResponse" /> </wsdl:operation>
Obtains information about a contribution.
getDeployedProcessDetail
<wsdl:operation name="getDeployedProcessDetail"> <wsdl:input message="tns:getDeployedProcessDetail" /> <wsdl:output message="tns:getDeployedProcessDetailResponse" /> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Retrieves information about a deployed process
getDeploymentLog
<wsdl:operation name="getDeploymentLog"> <wsdl:input message="tns:GetDeploymentLog" /> <wsdl:output message="tns:GetDeploymentLogResponse" /> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Retrieves a contribution's deployment log.
getDeployedProcessVersionDetail
<wsdl:operation name="getDeployedProcessVersionDetail"> <wsdl:input message="tns:getDeployedProcessVersionDetail" /> <wsdl:output message="tns:getDeployedProcessVersionDetailResponse" /> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Retrieves information about a version of a deployed process
purgeOffline
<wsdl:operation name="purgeOffline"> <wsdl:input message="tns:PurgeOffline" /> <wsdl:output message="tns:PurgeOfflineResponse" /> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Tells Process Server to purge the contribution when the application is offline.
searchContribution
<wsdl:operation name="searchContributions"> <wsdl:input message="tns:SearchContributions" /> <wsdl:output message="tns:SearchContributionsResponse" /> </wsdl:operation>
Looks for a contribution.
searchDeployedProcesses
<wsdl:operation name="searchDeployedProcessses"> <wsdl:input message="tns:searchDeployedProcessses" /> <wsdl:output message="tns:searchDeployedProcesssesResponse" /> </wsdl:operation>
Looks for a deployed process.
searchDeployedServices
<wsdl:operation name="searchDeployedServices"> <wsdl:input message="tns:searchDeployedServices" /> <wsdl:output message="tns:searchsearchDeployedServicesResponse" /> </wsdl:operation>
Looks for a service definition
searchIndexedProperties
<wsdl:operation name="searchIndexedProperties"> <wsdl:input message="tns:searchIndexedProperties" /> <wsdl:output message="tns:searchIndexedPropertiesResponse" /> </wsdl:operation>
Looks for an indexed property.
searchPartnerDefinitions
<wsdl:operation name="searchPartnerDefinitions"> <wsdl:input message="tns:searchIndexedProperties" /> <wsdl:output message="tns:searchsearchIndexedPropertiesResponse" /> </wsdl:operation>
Looks for a partner definition.
searchTaskProperties
<wsdl:operation name="searchTaskProperties"> <wsdl:input message="tns:searchTaskProperties" /> <wsdl:output message="tns:searchTaskPropertiesResponse" /> </wsdl:operation>
setContributionOnline
<wsdl:operation name="setContributionOnline"> <wsdl:input message="tns:SetContributionOnline" /> <wsdl:output message="tns:SetContributionOnlineResponse" /> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Places a contribution online.
setPlanOnline
<wsdl:operation name="setPlanOnline"> <wsdl:input message="tns:SetPlanOnline" /> <wsdl:output message="tns:SetPlanOnlineResponse" /> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Places a plan online.
takeContributionDetail
<wsdl:operation name="takeContributionOffline"> <wsdl:input message="tns:TakeContributionOffline" /> <wsdl:output message="tns:TakeContributionOfflineResponse" /> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Obtains contribution details.
takePlanOffline
<wsdl:operation name="takePlanOffline"> <wsdl:input message="tns:TakePlanOffline"/> <wsdl:output message="tns:TakePlanOfflineResponse"/> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Places the plan offline.
takePlansOffline
<wsdl:operation name="takePlasOffline"> <wsdl:input message="tns:TakePlansOffline"/> <wsdl:output message="tns:TakePlansOfflineResponse"/> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Places all plans offline.
updatePlan
<wsdl:operation name="updatePlan"> <wsdl:input message="tns:updatePlan"/> <wsdl:output message="tns:updatePlanResponse"/> <wsdl:fault message="tns:AdminAPIFault" name="AdminAPIFault" /> </wsdl:operation>
Updates a plan.