Guides and Articles

Use this documentation when building your Tekla EPM apps

Code example: Retrieve a list of jobs from Tekla EPM

Updated: 23 May 2019

This guide explains the Tekla EPM Open API command GetProductionControlJobs.

Tekla EPM Go job overview
Production control job information in Tekla EPM Go.

GetProductionControlJobs command

 

Command    Required parameter    Optional parameters
GetProductionControlJobs    None    GroupName :string 
       GroupName2:string
       JobNumber :string

Request format

The request can be formed like this:

<FabSuiteXMLRequest>
  <GetProductionControlJobs/>
</FabSuiteXMLRequest>

Or like this:

<FabSuiteXMLRequest>
  <GetProductionControlJobs>
  </GetProductionControlJobs>
</FabSuiteXMLRequest>

Using optional parameters

Below is an example with one optional parameter. You can add multiple optional parameters if needed. The example will retrieve all jobs in the “Structural” job group:

<FabSuiteXMLRequest>
  <GetProductionControlJobs>
    <GroupName>Structural</GroupName>
  </GetProductionControlJobs>
</FabSuiteXMLRequest>

Using the JobNumber tag will retrieve one job – with the matching JobNumber. Here in an example response:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<FabSuiteXMLResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <GetProductionControlJobs>
    <Successful>1</Successful>
    <ProductionControlJob>
      <ProductionControlID>1397</ProductionControlID>
      <JobNumber>7.3 Basic Training</JobNumber>
      <JobDescription>7.3 Basic Training</JobDescription>
      <JobLocation/>
      <GroupName/>
      <GroupName2/>
    </ProductionControlJob>
    <ProductionControlJob>
      <ProductionControlID>1394</ProductionControlID>
      <JobNumber>7.3 Basic Training EA</JobNumber>
      <JobDescription>7.3 Basic Training EA</JobDescription>
      <JobLocation/>
      <GroupName/>
      <GroupName2/>
    </ProductionControlJob>
    <ProductionControlJob>
      <ProductionControlID>781</ProductionControlID>
      <JobNumber>901097-001 10/15/13</JobNumber>
      <JobDescription>DISNEY C15</JobDescription>
      <JobLocation/>
      <GroupName>Old Orders</GroupName>
      <GroupName2/>
    </ProductionControlJob>
  </GetProductionControlJobs>
  <JobGroups>
      <GroupName> </GroupName>
      <GroupName>Old Orders </GroupName>
   </JobGroups>
</FabSuiteXMLResponse>

Descriptions for all fields

 

Field    Parent Description
GetProductionControlJobs    FabSuiteXMLResponse Command that this is responding to
     
Successful    GetProductionControlJobs    Boolean: 1 if command was successful
ProductionControlJob    GetProductionControlJobs A single production control job. There may be several of these.
     
ProductionControlID    ProductionControlJob Integer: Unique numeric ID of job
JobNumber    ProductionControlJob String: Unique Name of job
JobDescription    ProductionControlJob String: Job Description
JobLocation    ProductionControlJob String: Job Location
GroupName    ProductionControlJob String: Job Group
GroupName2    ProductionControlJob String: Job Group 2
     
JobGroups    FabSuiteXMLResponse XML tag that contains all job groups represented in this response
     
GroupName    JobGroups String: A single Job Group represented. Multiple is allowed.
GroupName2    JobGroups String: A single Job Group2 represented. Multiple is allowed.