APIs, SDKs, and Services > Administration API > Other Server Admin APIs
  

Other Server Admin APIs

Catalog API

The elements described in the following table are contained within an <wsdl:portType name="IAeCatalogManagement">
Operation Name
Operation
Description
deleteItem
<wsdl:operation name="deleteCatalog">
<wsdl:input message="tns:deleteCatalog" />
<wsdl:output message="tns:deleteCatalogResponse" />
<wsdl:fault
message="tns:AdminAPIFault"
name="AdminAPIFault" />
</wsdl:operation>
Deletes an item in a catalog.
getItem
<wsdl:operation name="getItem">
<wsdl:input message="tns:GetItem" />
<wsdl:output message="tns:GetItemResponse" />
<wsdl:fault message="tns:AdminAPIFault"
name="AdminAPIFault" />
</wsdl:operation>
Retrieves an intem within a catalog.
insertItem
<wsdl:operation name="insertItem">
<wsdl:input message="tns:InsertItem" />
<wsdl:output message="tns:InsertItemResponse" />
<wsdl:fault message="tns:AdminAPIFault"
name="AdminAPIFault" />
</wsdl:operation>
Inserts an item into a catalog.
searchCatalog
<wsdl:operation name="searchCatalog">
<wsdl:input message="tns:SearchCatalog" />
<wsdl:output message="tns:SearchCatalogResponse" />
<wsdl:fault message="tns:AdminAPIFault"
name="AdminAPIFault" />
</wsdl:operation>
Searches a catalog for an item.
updateItem
<wsdl:operation name="updateItem">
<wsdl:input message="tns:UpdateItem" />
<wsdl:output message="tns:UpdateItemResponse" />
<wsdl:fault message="tns:AdminAPIFault"
name="AdminAPIFault" />
</wsdl:operation>
Updates an item in a catalog.

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.

Process Monitoring API

The elements described in the following table are contained within an <wsdl:portType name="IAeProcessManagement"> element.
Operation Name
Operation
Description
getAlarmList
<wsdl:operation name="getAlarmList">
<wsdl:input message="tns:GetAlarmList" />
<wsdl:output message="tns:GetAlarmListResponse" />
<wsdl:fault message="tns:ApiFault" name="apiFault" />
</wsdl:operation>
Returns a list of the process's alarms.
getApiVersion
<wsdl:operation name="getApiVersion">
<wsdl:input message="tns:GetApiVersion" />
<wsdl:output message="tns:GetApiVersionResponse" />
<wsdl:fault message="tns:ApiFault" name="apiFault" />
</wsdl:operation>
Returns the process's API version.
getMessageReceiveList
<wsdl:operation name="getMessageReceiverList">
<wsdl:input message="tns:GetMessageReceiverList" />
<wsdl:output message="tns:GetMessageReceiverListResponse" />
<wsdl:fault message="tns:ApiFault" name="apiFault" />
</wsdl:operation>
Returns a list of received messages.
getProcessList
<wsdl:operation name="getProcessList">
<wsdl:input message="tns:GetProcessList" />
<wsdl:output message="tns:GetProcessListResponse" />
<wsdl:fault message="tns:ApiFault" name="apiFault" />
</wsdl:operation>
Returns a list of processes.
getProcessLog
<wsdl:operation name="getProcessLog">
<wsdl:input message="tns:GetProcessLog" />
<wsdl:output message="tns:GetProcessLogResponse" />
<wsdl:fault message="tns:ApiFault" name="apiFault" />
</wsdl:operation>
Returns the process log.
getProcessState
<wsdl:operation name="getProcessState">
<wsdl:input message="tns:GetProcessState" />
<wsdl:output message="tns:GetProcessStateResponse" />
<wsdl:fault message="tns:ApiFault" name="apiFault" />
</wsdl:operation>
Returns the process state.

Scheduler API

The Scheduler API lets you capture the following information:
The elements described in the following table are contained within an <wsdl:portType name="IAeScheduleManagement"> element.
Operation Name
Operation
Description
createDatabaseMaintenanceSchedule
<wsdl:operation name="createDatabaseMaintenanceSchedule">
<wsdl:input message="tns:createDatabaseMaintenanceSchedule" />
<wsdl:output message="tns:createDatabaseMaintenanceScheduleeResponse" />
<wsdl:fault message="tns:AdminAPIFault"
name="AdminAPIFault" />
</wsdl:operation>
Creates a maintenance schedule for a database.
createSchedule
<wsdl:operation name="createSchedule">
<wsdl:input message="tns:CreateSchedule" />
<wsdl:output message="tns:CreateScheduleResponse" />
<wsdl:fault message="tns:AdminAPIFault"
name="AdminAPIFault" />
</wsdl:operation>
Creates a schedule.
deleteSchedule
<wsdl:operation name="deleteSchedule">
<wsdl:input message="tns:DeleteSchedule" />
<wsdl:output message="tns:DeleteScheduleResponse" />
<wsdl:fault message="tns:AdminAPIFault"
name="AdminAPIFault" />
</wsdl:operation>
Deletes a schedule.
editSchedule
<wsdl:operation name="editSchedule">
<wsdl:input message="tns:EditSchedule" />
<wsdl:output message="tns:EditScheduleResponse" />
<wsdl:fault message="tns:AdminAPIFault"
name="AdminAPIFault" />
</wsdl:operation>
Changes items within a schedule.
getAllSchedules
<wsdl:operation name="getAllSchedules">
<wsdl:input message="tns:GetAllSchedules" />
<wsdl:output message="tns:GetAllSchedulesResponse" />
</wsdl:operation>
Returns information on all schedules.
getDatabaseMaintenanceSchedule
<wsdl:operation name="getDatabaseMaintenanceSchedule">
<wsdl:input message="tns:getDatabaseMaintenanceSchedule" />
<wsdl:output message="tns:getDatabaseMaintenanceScheduleResponse" />
</wsdl:operation>
Returns information on the maintenance schedule for your databases.
runDatabaseMaintenance
<wsdl:operation name="runDatabaseMaintenance">
<wsdl:input message="tns:runDatabaseMaintenance" />
<wsdl:output message="tns:runDatabaseMaintenanceResponse" />
<wsdl:fault message="tns:AdminAPIFault"
name="AdminAPIFault" />
</wsdl:operation>
Initiates the maintenance for a database.
runNow
<wsdl:operation name="runNow">
<wsdl:input message="tns:RunNow" />
<wsdl:output message="tns:RunNowResponse" />
<wsdl:fault message="tns:AdminAPIFault"
name="AdminAPIFault" />
</wsdl:operation>
Tells a scheduled item that it should run now instead of at its scheduled time.
setScheduleStatus
<wsdl:operation name="setScheduleStatus">
<wsdl:input message="tns:SetScheduleStatus" />
<wsdl:output message="tns:SetScheduleStatusResponse" />
<wsdl:fault message="tns:AdminAPIFault"
name="AdminAPIFault" />
</wsdl:operation>
Sets the status for a schedule.

URN Mapping API

Within Process Server, you can use system mapping and user-defined mappings for a URN. For information on URN mappings, look for URN Mappings elsewhere in this help.
The elements described in the following table are contained within an <wsdl:portType name="IAeURNManagement">
Operation Name
Operation
Description
deleteURN
<wsdl:operation name="deleteURN">
<wsdl:input message="tns:DeleteURN" />
<wsdl:output message="tns:DeleteURNResponse" />
</wsdl:operation>
Deletes a URN.
getAllURNDefinitions
<wsdl:operation name="getAllUrnDefinitions">
<wsdl:input message="tns:GetAllUrnDefinitions" />
<wsdl:output
message="tns:GetAllUrnDefinitionsResponse" />
</wsdl:operation>
Returns information on all URN definitions.
getUrnDefinitions
<wsdl:operation name="getUrnDefinitions">
<wsdl:input message="tns:getUrnDefinitions" />
<wsdl:output
message="tns:getUrnDefinitionsResponse" />
</wsdl:operation>
Returns information on one URN.
upsertURN
<wsdl:operation name="upsertURN">
<wsdl:input message="tns:UpsertURN" />
<wsdl:output message="tns:UpsertURNResponse" />
</wsdl:operation>
Upserts (inserts; switches to update if already exists) a URN.