Job Order Management Thing Shape Services
The following services are found on the job order management Thing Shape (PTC.SCA.SCO.JobOrderManagementThingShape):
Creation Services
 |
When creating any object that is part of the Operator Advisor data model, the UID value is automatically generated by the system. Any value you enter in the UID field is ignored.
|
CreateJobOrderMaterialRequirementLinks—Creates one or more job order material requirement links using the information added to the JobOrderMaterialRequirementLinks input parameter table. Returns the list of job order material requirement links that were created, along with their UIDs.
• Input parameters: JobOrderMaterialRequirementLinks (INFOTABLE)
• Output: result (INFOTABLE)
CreateJobOrderMaterialRequirements—Creates one or more job order material requirements using the information added to the JobOrderMaterialRequirements input parameter table. Returns the list of job order material requirements that were created, along with their UIDs.
• Input parameters: JobOrderMaterialRequirements (INFOTABLE)
• Output: result (INFOTABLE)
CreateJobOrderPersonnelRequirements—Creates one or more job order personnel requirements using the information added to the JobOrderPersonnelRequirements input parameter table. Returns the list of job order personnel requirements that were created, along with their UIDs.
• Input parameters: JobOrderPersonnelRequirements (INFOTABLE)
• Output: result (INFOTABLE)
CreateJobOrderProcessingResourceRequirements—Creates one or more job order processing resource requirements using the information added to the JobOrderProcessingResourceRequirements input parameter table. Returns the list of job order processing resource requirements that were created, along with their UIDs.
• Input parameters: JobOrderProcessingResourceRequirements (INFOTABLE)
• Output: result (INFOTABLE)
CreateJobOrders—Creates one or more job orders using the information added to the JobOrders input parameter table. Returns the list of job orders that were created, along with their UIDs.
• Input parameters: JobOrders (INFOTABLE)
• Output: result (INFOTABLE)
CreateJobOrderWorkDefinitionLinks—Creates one or more job-order-to-work-definition links using the information added to the JobOrders input parameter table. Returns the list of job-order-to-work-definition links that were created, along with their UIDs.
• Input parameters: JobOrderWorkDefinitionLinks (INFOTABLE)
• Output: result (INFOTABLE)
Deletion Services
DeleteJobOrder—Deletes the job order with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
DeleteJobOrderMaterialRequirement—Deletes the job order material requirement with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
DeleteJobOrderMaterialRequirementLink—Deletes the job order material requirement link with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
DeleteJobOrderPersonnelRequirement—Deletes the job order personnel requirement with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
DeleteJobOrderProcessingResourceRequirement—Deletes the job order processing resource requirement with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
DeleteJobOrderWorkDefinitionLink—Deletes the job-order-to-work-definition link with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
Read Services
GetJobOrder—Retrieves the individual job order with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
GetJobOrderMaterialRequirement—Retrieves the individual job order material requirement with the specified UID.
• Input parameters: UID (STRING)
• Output: result (INFOTABLE)
GetJobOrderMaterialRequirementLinks—Retrieves a list of all job order material requirement links with the specified parent UID.
• Input parameters: ParentUID (STRING)
• Output: result (INFOTABLE)
GetJobOrderMaterialRequirements—Retrieves a list of all job order material requirements with the specified job order UID.
• Input parameters: JobOrderUID (STRING)
• Output: result (INFOTABLE)
GetJobOrderPersonnelRequirements—Retrieves a list of all job order personnel requirements associated with the specified job order UID.
• Input parameters: JobOrderUID (STRING)
• Output: result (INFOTABLE)
GetJobOrderProcessingResourceRequirements—Retrieves a list of all job order processing resource requirements associated with the specified job order UID.
• Input parameters: JobOrderUID (STRING)
• Output: result (INFOTABLE)
GetJobOrders—Retrieves a list of all job orders in the database, including their UIDs. A filter can be applied with an offset and a limit to narrow the list of returned results.
• Input parameters:
◦ filter (JSON)
◦ offset (INTEGER)
◦ limit (INTEGER)
• Output: result (INFOTABLE)
GetJobOrderWorkDefinitionLinks—Retrieves a list of all job-order-to-work-definition links with the specified job order UID.
• Input parameters: JobOrderUID (STRING)
• Output: result (INFOTABLE)
GetJobOrderWorkDefinitions—Retrieves a list of work definitions that are linked to the specified job order UID.
• Input parameters: JobOrderUID (STRING)
• Output: result (INFOTABLE)
Update Services
UpdateJobOrderMaterialRequirementLinks—Updates one or more job order material requirement links by UID, using the information added to the JobOrderMaterialRequirementLinks input parameter table. Returns the list of job order material requirement links that were updated.
• Input parameters: JobOrderMaterialRequirementLinks (INFOTABLE)
• Output: result (INFOTABLE)
UpdateJobOrderMaterialRequirements—Updates one or more job order material requirements by UID, using the information added to the JobOrderMaterialRequirementLinks input parameter table. Returns the list of job order material requirements that were updated.
• Input parameters: JobOrderMaterialRequirements (INFOTABLE)
• Output: result (INFOTABLE)
UpdateJobOrderPersonnelRequirements—Updates one or more job order personnel requirements by UID, using the information added to the JobOrderPersonnelRequirements input parameter table. Returns the list of job order material personnel requirements that were updated.
• Input parameters: JobOrderPersonnelRequirements (INFOTABLE)
• Output: result (INFOTABLE)
UpdateJobOrderProcessingResourceRequirements—Updates one or more job order processing resource requirements by UID, using the information added to the JobOrderProcessingResourceRequirements input parameter table. Returns the list of job order processing resource requirements that were updated.
• Input parameters: JobOrderProcessingResourceRequirements (INFOTABLE)
• Output: result (INFOTABLE)
UpdateJobOrders—Updates one or more job orders by UID, using the information added to the JobOrders input parameter table. Returns the list of job orders that were updated.
• Input parameters: JobOrders (INFOTABLE)
• Output: result (INFOTABLE)
UpdateJobOrderWorkDefinitionLinks—Updates one or more job-order-to-work-definition links by UID, using the information added to the JobOrderWorkDefinitionLinks input parameter table. Returns the list of job orders that were updated.
• Input parameters: JobOrderWorkDefinitionLinks (INFOTABLE)
• Output: result (INFOTABLE)
Miscellaneous and Utility Services
GetJobOrderDBInfo—Retrieves the database table information related to job orders, such as database table column names. Used internally by other services. Not intended for standalone use.
• Input parameters: No inputs
• Output: result (JSON)
GetJobOrderRelatedObjects—Retrieves a list of all objects of the specified Data Shape related to the job order with the specified UID. Used internally by other services. Not intended for standalone use.
• Input parameters:
◦ dataShapeName (STRING)
◦ JobOrderUID (STRING)
• Output: result (INFOTABLE)