Definitions

This section covers the following definitions:

• CostingInput
• CostingResult
• PartCostingResult
• ServiceConfiguration
• ServiceStatus
• Shutdown
• ShutdownConfigs
• Workflow
• WorkflowActionResult
• WorkflowJob
• WorkflowJobSummary

CostingInput

Name	Schema
annualVolume	integer (int32)
batchSize	integer (int32)
machiningMode	string
materialName	string
processGroupName	string
productionLife	number (double)
targetCost	number (double)
targetMass	number (double)
vpeName	string

CostingResult

Name	Schema
annualManufacturingCarbon	number (double)
capitalInvestment	number (double)
cycleTime	number (double)
dfmRisk	string
dfmScore	integer (int32)
finishMass	number (double)
fullyBurdenedCost	number (double)
laborTime	number (double)
logisticsCarbon	number (double)
materialCarbon	number (double)
materialCost	number (double)
processCarbon	number (double)
roughMass	number (double)
routingName	string
totalCarbon	number (double)
totalCost	number (double)
utilization	number (double)

PartCostingResult

Name	Schema
cidPartNumber	string
cicStatus	string
errorMessage	string
cidPartLink	string
apwScenarioLink	string
partId	string
partNumber	string
partName	string
revisionNumber	string
checkInUser	string
description	string
scenarioName	string
costingResult	string
partType	string
input	See CostingInput
result	See CostingResult

ServiceConfiguration

Name	Schema
cicHostUrl (optional)	string
csrfTokenTimeoutSeconds (optional)	integer (int32)
fscUrl (optional)	string
hostname (optional)	string
maxPartsToReturn (optional)	integer (int32)
plmType (optional)	enum (FILE_SYSTEM, MOCK, TEAMCENTER, WINDCHILL)
reconnectionInterval (optional)	integer (int32)
rootFolderPath (optional)	string
scanRate (optional)	integer (int32)

ServiceStatus

Name	Description	Schema
cicConnection Status (optional)		string
jobCount (optional)		integer (int32)
plmConnectionStatus (optional)		string
serviceStatus (optional)		string
serviceTime (optional)	Example : "yyyy-MM-dd’T’HH:mm’Z'	string

Shutdown

Name	Schema
shutdownCode (optional)	string

ShutdownConfigs

Name	Description	Schema
shutdownMode (optional)	currently there is only one shutdown mode supported: completeAndTerminate Example : "completeAndTerminate"	string

Workflow

Name	Schema
description (optional)	string
id (optional)	string
locked (optional)	boolean
name (optional)	string
partSelectionType (optional)	enum (Spreadsheet, REST API request, Query definition)

WorkflowActionResult

Name	Description	Schema
jobId (optional)		string
startedAt (optional)	Example : "yyyy-MM-dd’T’HH:mm’Z'"	string

WorkflowJob

Name	Schema
completedAt (optional)	string (date-time)
componentsFailed (optional)	integer (int32)
componentsProcessed (optional)	integer (int32)
componentsTotal (optional)	integer (int32)
errorMessage (optional)	string
identity (optional)	string
outputFolder (optional)	string
startedAt (optional)	string (date-time)
status (optional)	string

WorkflowJobSummary

Name	Schema
identity (optional)	string
outputFolder (optional)	string
status (optional)	string