Skip to main content
Version: 2.2.0

newProgrammedMaintenance

This method allows adding:

  • Data from a programmed maintenance

To insert each of these items, it is necessary to follow the standard documented below.

Java class
Requestweb\wwwroot\ws\java\maintenance\NewProgrammedMaintenanceRequestType.java
Returnweb\wwwroot\ws\java\maintenance\NewProgrammedMaintenanceResponseType.java

Request:

ID #RequiredDescription
IDACTIVITYActivity ID # (Generated automatically if not entered)
IDMODELACTIVITYXStandard activity ID #
IDASSETXAsset ID #
Note: For multiple assets, insert the identifiers separated by ';'.
(E.g.: ASSET1;ASSET2)
ACTIVITYSTEPActivity step:
1 - Planning;
2 - Execution.
Note: Considering 1 by default
STARTDATEPLANPlanned start date. The expected format is YYYY-MM-DD (Year-Month-Day).
STARTTIMEPLANPlanned start time.
FINISHDATEPLANPlanned end date. The expected format is YYYY-MM-DD (Year-Month-Day).
FINISHTIMEPLANPlanned end time.
STARTDATEExecution start date. The expected format is YYYY-MM-DD (Year-Month-Day).
STARTTIMEExecution start time
REALPERCENTAGEActual percentage (%)
IDSERVICECENTERService center ID #
IDTECHNICIANRESPONSIBLETechnician ID #
ATTRIBUTESExample:
identifier_of_attribute1=value_of_attribute1;
identifier_of_attribute2=value_of_attribute2;
identifier_of_attribute3=value_of_attribute3.

Example with a multivalued attribute:
identifier_of_attribute1=value1_of_attribute1, value2_of_attribute1, value3_of_attibute1
Note: For attributes with a numeric value, the decimal place separator must be "." (dot).
For date fields, the value must have the “Y-M-D” (Year-Month-Day) format.
IDEVALMETHODX⁵Evaluation method ID #
DSEVALCRITX⁶For quantitative method:
▪ For list of values:
[id criterion 1]=[id result1];
[id criterion 2]=[id result2]
▪ For indeterminate value:
[id criterion 1]=[value 1];
[id criterion 2]=[value 2]
▪ Mix:
[id criterion 1]=[id result1];
[id criterion 2]=[value 2]
▪ For simple listing method:
[id result]
IDPROCESSASSOCPlace the ID # of the process instance that you want to associate with the created activity. Only for workflow.
FGAUTOMATIONProcess automation type:
1 - Workflow.
info
  • X¹ - Required if the “Activity step” field is 1.
  • X² - Required if the “Activity step” step is 2.
  • X¹ - Required if the ID # has not been entered in the standard activity.
  • X⁴ - Required if the standard activity has a required attribute.
  • X⁵ - Required if the DSEVALCRIT field is filled out.
  • X⁶ - Required if the IDEVALMETHOD field is filled out.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:maintenance">
<soapenv:Header/>
<soapenv:Body>
<urn:newProgrammedMaintenance>
<!--You may enter the following 18 items in any order-->
<urn:ActivityID>?</urn:ActivityID>
<urn:ModelActivityID>?</urn:ModelActivityID>
<urn:AssetID>?</urn:AssetID>
<urn:ActivityStep>?</urn:ActivityStep>
<urn:StartPlanDate>?</urn:StartPlanDate>
<urn:StartPlanTime>?</urn:StartPlanTime>
<urn:FinishPlanDate>?</urn:FinishPlanDate>
<urn:FinishPlanTime>?</urn:FinishPlanTime>
<urn:StartDate>?</urn:StartDate>
<urn:StartTime>?</urn:StartTime>
<urn:RealPercentage>?</urn:RealPercentage>
<urn:ServiceCenterID>?</urn:ServiceCenterID>
<urn:TechnicianResponsibleID>?</urn:TechnicianResponsibleID>
<urn:Attributes>?</urn:Attributes>
<urn:EvalMethodID>?</urn:EvalMethodID>
<urn:EvalCriteria>?</urn:EvalCriteria>
<urn:IdProcessAssoc>?</urn:IdProcessAssoc>
<urn:FgAutomation>?</urn:FgAutomation>
</urn:newProgrammedMaintenance>
</soapenv:Body>
</soapenv:Envelope>

Return:

ID #Description
returnSUCCESS: Activity ID # created
FAILURE: Returns a message regarding the error that occurred