HomeGuidesAPI ReferenceAnnouncements
HomeGuidesAPI ReferenceChangelogDeveloper Q&A
HomeGuidesAPI ReferenceAnnouncementsLog In
API Reference
  1. Enterprise 9 SOAP API
  2. What's New in 9.12

Changed Entities

ProcedureTemplate Entity

Element Added
Summary
OperationalRisks
BackoutPlan
<xs:complexType name="ProcedureTemplate" mixed="false">
		<xs:complexContent>
			<xs:extension base="RemovableCorrigoEntity">
				<xs:sequence>
					<xs:element name="DisplayAs" type="xs:string" minOccurs="0"/>
					<xs:element name="AllowMarkAll" type="xs:boolean"/>
					<xs:element name="AllowNotApplicable" type="xs:boolean"/>
					<xs:element name="BaseId" type="xs:int"/>
					<xs:element name="Steps" type="ArrayOfProcedureTemplateStep" minOccurs="0"/>
					<xs:element name="Summary" type="xs:string" minOccurs="0"/>
					<xs:element name="OperationalRisks" type="xs:string" minOccurs="0"/>
					<xs:element name="BackoutPlan" type="xs:string" minOccurs="0"/>
					<xs:element name="ProcedureCategories" type="ArrayOfLinkProcedureCategoryAndTemplate" minOccurs="0"/>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>

ProcedureTemplateStep Entity

Element Added
ConditionType
ParentStepId
ConditionCustomField
ConditionAttribute
YIdx
ZIdx
<xs:complexType name="ProcedureTemplateStep" mixed="false">
	<xs:complexContent>
		<xs:extension base="RemovableCorrigoEntity">
			<xs:sequence>
				<xs:element name="ProcedureTemplateId" type="xs:int"/>
				<xs:element name="Index" type="xs:int"/>
				<xs:element name="Description" type="xs:string" minOccurs="0"/>
				<xs:element name="TypeId" type="ProcedureStepType"/>
				<xs:element name="IsRequired" type="xs:boolean"/>
				<xs:element name="FieldDescriptor" type="CustomFieldDescriptor" minOccurs="0"/>
				<xs:element name="AttrDescriptor" type="AttributeDescriptor" minOccurs="0"/>
				<xs:element name="Instructions" type="xs:string" minOccurs="0"/>
				<xs:element name="ConditionType" type="ProcedureStepConditionType" nillable="true"/>
				<xs:element name="ParentStepId" type="xs:int"/>
				<xs:element name="ConditionCustomField" type="CustomFieldOption" minOccurs="0"/>
				<xs:element name="ConditionAttribute" type="AttributeOption" minOccurs="0"/>
				<xs:element name="YIdx" type="xs:int"/>
				<xs:element name="ZIdx" type="xs:int"/>
			</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>

WoProcedure Entity

Element Added
Summary
OperationalRisks
BackoutPlan
<xs:complexType name="WoProcedure" mixed="false">
		<xs:complexContent>
			<xs:extension base="RemovableCorrigoEntity">
				<xs:sequence>
					<xs:element name="WorkOrderId" type="xs:int"/>
					<xs:element name="ProcedureTemplate" type="ProcedureTemplate" minOccurs="0"/>
					<xs:element name="Asset" type="Location" minOccurs="0"/>
					<xs:element name="DisplayAs" type="xs:string" minOccurs="0"/>
					<xs:element name="TypeId" type="ProcedureType"/>
					<xs:element name="AllowMarkAll" type="xs:boolean"/>
					<xs:element name="AllowNotApplicable" type="xs:boolean"/>
					<xs:element name="IsNotApplicable" type="xs:boolean"/>
					<xs:element name="Flag" type="ProcedureFlagReason" minOccurs="0"/>
					<xs:element name="StatusId" type="ProcedureStatus"/>
					<xs:element name="Index" type="xs:int"/>
					<xs:element name="Steps" type="ArrayOfWoProcedureStep" minOccurs="0"/>
					<xs:element name="Summary" type="xs:string" minOccurs="0"/>
					<xs:element name="OperationalRisks" type="xs:string" minOccurs="0"/>
					<xs:element name="BackoutPlan" type="xs:string" minOccurs="0"/>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>

WoProcedureStep Entity

Element Added
CompletedActor
DtCompleted
DataValueId
IsVisible
ConditionType
ParentStepId
ConditionValueId
StepNumber
<xs:complexType name="WoProcedureStep" mixed="false">
		<xs:complexContent>
			<xs:extension base="RemovableCorrigoEntity">
				<xs:sequence>
					<xs:element name="WorkOrderId" type="xs:int"/>
					<xs:element name="Index" type="xs:int"/>
					<xs:element name="Comment" type="xs:string" minOccurs="0"/>
					<xs:element name="Description" type="xs:string" minOccurs="0"/>
					<xs:element name="StatusId" type="ProcedureStatus"/>
					<xs:element name="WoProcedureId" type="xs:int"/>
					<xs:element name="ProcedureTemplateStep" type="ProcedureTemplateStep" minOccurs="0"/>
					<xs:element name="TypeId" type="ProcedureStepType"/>
					<xs:element name="IsWon" type="xs:boolean"/>
					<xs:element name="IsRequired" type="xs:boolean"/>
					<xs:element name="FieldDescriptor" type="CustomFieldDescriptor" minOccurs="0"/>
					<xs:element name="AttrDescriptor" type="AttributeDescriptor" minOccurs="0"/>
					<xs:element name="DataTypeId" type="CfType"/>
					<xs:element name="DataValue" type="xs:string" minOccurs="0"/>
					<xs:element name="DataLabel" type="xs:string" minOccurs="0"/>
					<xs:element name="Flag" type="ProcedureFlagReason" minOccurs="0"/>
					<xs:element name="IsNotApplicable" type="xs:boolean"/>
					<xs:element name="MoneyId" type="CurrencyType"/>
					<xs:element name="ActionsRequired" type="xs:int"/>
					<xs:element name="ActionsTaken" type="xs:int"/>
					<xs:element name="CompletedActor" type="Actor" minOccurs="0"/>
					<xs:element name="DtCompleted" type="xs:dateTime" nillable="true"/>
					<xs:element name="DataValueId" type="xs:int" nillable="true"/>
					<xs:element name="IsVisible" type="xs:boolean"/>
					<xs:element name="ConditionType" type="ProcedureStepConditionType"/>
					<xs:element name="ParentStepId" type="xs:int"/>
					<xs:element name="ConditionValueId" type="xs:int" nillable="true"/>
					<xs:element name="StepNumber" type="xs:string" minOccurs="0"/>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>

WorkOrder Entity

Element Added
WoSecondarySchedules
<xs:complexType name="WorkOrder" mixed="false">
		<xs:complexContent>
			<xs:extension base="CorrigoEntityWithOptimisticLock">
				<xs:sequence>
					<xs:element name="Number" type="xs:string" minOccurs="0"/>
					<xs:element name="TypeCategory" type="WOType"/>
					<xs:element name="WorkOrderCost" type="WorkOrderCost" minOccurs="0"/>
					<xs:element name="Priority" type="WoPriority" minOccurs="0"/>
					<xs:element name="StatusId" type="WorkOrderStatus"/>
					<xs:element name="RequestorContact" type="Contact" minOccurs="0"/>
					<xs:element name="Access" type="PTEType"/>
					<xs:element name="MainAsset" type="Location" minOccurs="0"/>
					<xs:element name="ShortLocation" type="xs:string" minOccurs="0"/>
					<xs:element name="TaskRefinement" type="xs:string" minOccurs="0"/>
					<xs:element name="WorkZone" type="WorkZone" minOccurs="0"/>
					<xs:element name="Employee" type="Employee" minOccurs="0"/>
					<xs:element name="Duration" type="xs:int"/>
					<xs:element name="VendorNte" type="MoneyValue" minOccurs="0"/>
					<xs:element name="Specialty" type="Specialty" minOccurs="0"/>
					<xs:element name="PoNumber" type="xs:string" minOccurs="0"/>
					<xs:element name="SubType" type="WorkOrderType" minOccurs="0"/>
					<xs:element name="RepairCode" type="RepairCode" minOccurs="0"/>
					<xs:element name="Customer" type="Customer" minOccurs="0"/>
					<xs:element name="ContactName" type="xs:string" minOccurs="0"/>
					<xs:element name="WonId" type="xs:int"/>
					<xs:element name="IsWarranty" type="xs:boolean"/>
					<xs:element name="Flag" type="WoActionReasonLookup" minOccurs="0"/>
					<xs:element name="FlagId" type="xs:int"/>
					<xs:element name="TimeZone" type="xs:int"/>
					<xs:element name="CurrencyTypeId" type="CurrencyType"/>
					<xs:element name="LastActionDate" type="xs:dateTime"/>
					<xs:element name="DtCreated" type="xs:dateTime"/>
					<xs:element name="DtScheduledStart" type="xs:dateTime" nillable="true"/>
					<xs:element name="DtDue" type="xs:dateTime" nillable="true"/>
					<xs:element name="DtAcknowledgeBy" type="xs:dateTime" nillable="true"/>
					<xs:element name="AcknowledgeByUtc" type="xs:dateTime" nillable="true"/>
					<xs:element name="LastActionDateUtc" type="xs:dateTime"/>
					<xs:element name="CreatedDateUtc" type="xs:dateTime"/>
					<xs:element name="ScheduledStartUtc" type="xs:dateTime" nillable="true"/>
					<xs:element name="DueDateUtc" type="xs:dateTime" nillable="true"/>
					<xs:element name="DtOnSiteBy" type="xs:dateTime" nillable="true"/>
					<xs:element name="DtUtcOnSiteBy" type="xs:dateTime" nillable="true"/>
					<xs:element name="LastAction" type="WoLastAction" minOccurs="0"/>
					<xs:element name="Address" type="Address2" minOccurs="0"/>
					<xs:element name="Items" type="ArrayOfWoItem" minOccurs="0"/>
					<xs:element name="EquipmentWorkedOn" type="ArrayOfWoEquipment" minOccurs="0"/>
					<xs:element name="Notes" type="ArrayOfWoNote" minOccurs="0"/>
					<xs:element name="CompletionNote" type="WoNote" minOccurs="0"/>
					<xs:element name="ContactAddress" type="ContactInfo" minOccurs="0"/>
					<xs:element name="Assignments" type="ArrayOfWoAssignment" minOccurs="0"/>
					<xs:element name="Procedures" type="ArrayOfWoProcedure" minOccurs="0"/>
					<xs:element name="Documents" type="ArrayOfDocument" minOccurs="0"/>
					<xs:element name="CustomFields" type="ArrayOfCustomField2" minOccurs="0"/>
					<xs:element name="Verifications" type="ArrayOfWoVerification" minOccurs="0"/>
					<xs:element name="Quote" type="WoQuote" minOccurs="0"/>
					<xs:element name="CheckInOuts" type="ArrayOfWoOnSite" minOccurs="0"/>
					<xs:element name="ActionLogRecords" type="ArrayOfWoActionLog" minOccurs="0"/>
					<xs:element name="Estimate" type="WoEstimate" minOccurs="0"/>
					<xs:element name="Owner" type="Employee" minOccurs="0"/>
					<xs:element name="InductionAndSafetyStatusID" type="IsmStatus"/>
					<xs:element name="Flags" type="ArrayOfWoFlag" minOccurs="0"/>
					<xs:element name="WoSecondarySchedules" type="ArrayOfWoSchedule" minOccurs="0"/>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>

Updated about 1 year ago

Did this page help you?

Updated about 1 year ago

Did this page help you?