eQuipAPI

<back to all web services

GetJobPlanTemplate

Get Job Plan Details In PM Template

The following routes are available for this service:
GET/PMTemplate/JobPlan/{JobPlanID}Get Job Plan Details In PM Template
GetJobPlanTemplate Parameters:
NameParameterData TypeRequiredDescription
UserIDpathstringYesUser Internal ID of User
WorkOrderTemplateIdpathstringYesWorkOrderTemplate Id of job plan
JobPlanIDpathstringYesJobplan Id of job plan
DtoJobPlanDetails Parameters:
NameParameterData TypeRequiredDescription
ResponseJobPlanDetailsbodyJobPlanTemplateNo
JobPlanTemplate Parameters:
NameParameterData TypeRequiredDescription
UuidbodyGuidNo
TaskNumberbodyintNo
TaskSequenceNumberbodyintNo
TaskDescriptionbodystringNo
TaskStatusbodystringNo
TaskLeadbodystringNo
TaskWorkGroupbodystringNo
CreatedBybodystringNo
CreatedDatebodyDateTime?No
UpdatedBybodystringNo
UpdatedDatebodyDateTime?No
WorkOrderTemplateIdbodystringNo
WorkOrderTemplateDetailIDbodystringNo
TriggeredOnMeterReadingbodystringNo
TriggeredOnSchedulebodyboolNo
TaskTemplateIDbodystringNo
TaskNamebodystringNo
TaskTypebodyintNo
TriggerEveryHrbodyintNo
TriggerEveryMinbodyintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetJobPlanTemplate HTTP/1.1 
Host: equipstage2.e-isg.com 
Content-Type: application/xml
Content-Length: length

<GetJobPlanTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <JobPlanID>String</JobPlanID>
  <UserID>String</UserID>
  <WorkOrderTemplateId>String</WorkOrderTemplateId>
</GetJobPlanTemplate>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DtoJobPlanDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <ResponseJobPlanDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/eQuip.Domain.MaintenanceManagement">
    <d2p1:CreatedBy>String</d2p1:CreatedBy>
    <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
    <d2p1:TaskDescription>String</d2p1:TaskDescription>
    <d2p1:TaskLead>String</d2p1:TaskLead>
    <d2p1:TaskName>String</d2p1:TaskName>
    <d2p1:TaskNumber>0</d2p1:TaskNumber>
    <d2p1:TaskSequenceNumber>0</d2p1:TaskSequenceNumber>
    <d2p1:TaskStatus>String</d2p1:TaskStatus>
    <d2p1:TaskTemplateID>String</d2p1:TaskTemplateID>
    <d2p1:TaskType>0</d2p1:TaskType>
    <d2p1:TaskWorkGroup>String</d2p1:TaskWorkGroup>
    <d2p1:TriggerEveryHr>0</d2p1:TriggerEveryHr>
    <d2p1:TriggerEveryMin>0</d2p1:TriggerEveryMin>
    <d2p1:TriggeredOnMeterReading>String</d2p1:TriggeredOnMeterReading>
    <d2p1:TriggeredOnSchedule>false</d2p1:TriggeredOnSchedule>
    <d2p1:UpdatedBy>String</d2p1:UpdatedBy>
    <d2p1:UpdatedDate>0001-01-01T00:00:00</d2p1:UpdatedDate>
    <d2p1:Uuid>00000000-0000-0000-0000-000000000000</d2p1:Uuid>
    <d2p1:WorkOrderTemplateDetailID>String</d2p1:WorkOrderTemplateDetailID>
    <d2p1:WorkOrderTemplateId>String</d2p1:WorkOrderTemplateId>
  </ResponseJobPlanDetails>
</DtoJobPlanDetails>