BatchRestAPI

This collection contains the list of REST commands for the Batch Rest API.

The Batch REST API only supports https.

Basic Authentication is required. The username and password will be authenticated on the Batch REST Service computer to be a valid Windows user account. The username is also required to belong to the Windows Group specified in the batch_config_rest_service.json file. This group name can be changed in the config file and you must create the Windows group and add your users to the Windows Group. This extra level of checking can be turned off in the batch_config_rest_service.json file. Note that you must restart the Batch REST API service for the config file changes to take effect.

The Basic Authentication username is sent to the Batch Server for various batch commands (batch commands, step commands, phase commands, binding, setting parameter values, acknowledging prompts, etc), and this is what is logged by the Batch Server into the batch event journal file. We recommend that you use a different Basic Authentication Credential for each user so that the batch event journal file will have a proper record of who the user was performing each batch command.

The root URL for all REST calls is https://localhost:4867/BatchRestAPI/

The URL is case-sensitive.

You can use the URL https://localhost:4867/BatchRestAPI/about to test your server connection. It returns the product name and version. It is useful for performing a connection test to the Batch REST API without making a call to VBIS and the Batch Server.

The BatchRestAPI will make API calls to the GE Proficy Batch VBIS.exe application. If an API call fails due to an error from the Batch System, VBIS returns an error code and the information is returned in the response. Additional details will be logged in the batch_rest_service.log The VBIS.log on the Batch Server computer will also contain more detailed error messages. Note that for some VBIS API calls (PUT calls), VBIS will send the request to the Batch Server and return success without knowing if the Batch Server was successful with the request. For these cases, we return the success status and the detail message "The command was sent to the batch server".

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

AlarmAPI

AreaModelAPI

BatchAPI

BindingPromptsAPI

BreakpointAPI

ESignatureAPI

ElectronicWorkInstructionAPI

Misc

OperatorPromptsAPI

PhaseControlAPI

RecipeAPI

RecipeElementsAndStepControlAPI

RecipeManagementAPI

AlarmAPI

Up 
get /alarms
Alarms (alarms)
Get the list of alarms stored in the Batch Execution Server.

Return type

array[alarm]

Example data

Content-Type: application/json
[ {
  "ArbitrationSet" : "1",
  "BatchID" : " ",
  "FailMsg" : "CONFIG ERROR - Ordinal not defined in PHASE_FAILURES enumeration set - unable to locate failure description: 1",
  "Mode" : " ",
  "Owner" : " ",
  "PhaseID" : "12",
  "PhaseMsg" : "0",
  "PhaseName" : "ADD_INGS1",
  "PhaseState" : "IDLE",
  "UnitID" : "0",
  "UnitName" : "MIX1",
  "ValidUnitList" : "MIX1"
}, {
  "ArbitrationSet" : "1",
  "BatchID" : " ",
  "FailMsg" : "CONFIG ERROR - Ordinal not defined in PHASE_FAILURES enumeration set - unable to locate failure description: 1",
  "Mode" : " ",
  "Owner" : " ",
  "PhaseID" : "12",
  "PhaseMsg" : "0",
  "PhaseName" : "ADD_INGS1",
  "PhaseState" : "IDLE",
  "UnitID" : "0",
  "UnitName" : "MIX1",
  "ValidUnitList" : "MIX1"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

AreaModelAPI

Up 
get /areamodelheader
AreaModel Header (areaModelHeader)
Get the Areamodel header data.

Return type

AreamodelHeader

Example data

Content-Type: application/json
{
  "AreaAuditPerformedByComment" : "Added Control Module",
  "AreaAuditPerformedByName" : "Batchexecutive",
  "AreaAuditPerformedByTime" : "2020-07-21 11:50:00",
  "AreaAuditPerformedByUserID" : "Batchexecutive",
  "AreaAuditVerifiedByComment" : "",
  "AreaAuditVerifiedByName" : "",
  "AreaAuditVerifiedByTime" : "",
  "AreaAuditVerifiedByUserID" : "",
  "AreaAuditVersion" : "21",
  "Name" : "AREA1",
  "Revision" : "AREA1"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

AreamodelHeader
Up 
get /connections
Connections (connections)
Get the list of connections from the Areamodel.

Return type

array[Connection]

Example data

Content-Type: application/json
[ {
  "Destination" : "HDR_BASE",
  "DestinationType" : 1,
  "EquipmentID" : 34,
  "Label" : "",
  "MaxOwners" : 1,
  "Name" : "CONNECTION1",
  "NeededEquipment" : [ ],
  "Source" : "WATER",
  "SourceType" : 0
}, {
  "Destination" : "HDR_BASE",
  "DestinationType" : 1,
  "EquipmentID" : 34,
  "Label" : "",
  "MaxOwners" : 1,
  "Name" : "CONNECTION1",
  "NeededEquipment" : [ ],
  "Source" : "WATER",
  "SourceType" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
get /controlmodules
Control Modules (controlModules)
Get the list of control modules from the Areamodel.

Return type

array[ControlModule]

Example data

Content-Type: application/json
[ {
  "ClassName" : "RESOURCE_CLS1",
  "EquipmentID" : 56,
  "MaxOwners" : 1,
  "Name" : "RESOURCE1",
  "NeededEquipment" : [ ]
}, {
  "ClassName" : "RESOURCE_CLS1",
  "EquipmentID" : 56,
  "MaxOwners" : 1,
  "Name" : "RESOURCE1",
  "NeededEquipment" : [ ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
get /dataservers
Data Servers (dataServers)
Get the list of data servers from the Areamodel.

Return type

array[DataServer]

Example data

Content-Type: application/json
[ {
  "Application" : "",
  "BadValue" : "",
  "DefaultServerFlag" : true,
  "Name" : "SPS",
  "Topic" : "",
  "Type" : 3,
  "Watchdog" : ""
}, {
  "Application" : "",
  "BadValue" : "",
  "DefaultServerFlag" : true,
  "Name" : "SPS",
  "Topic" : "",
  "Type" : 3,
  "Watchdog" : ""
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
get /enumerationsets
Enumeration Sets (enumerationSets)
Get the list of enumeration sets from the Areamodel.

Return type

array[EnumerationSet]

Example data

Content-Type: application/json
[ {
  "Enumerations" : [ {
    "Name" : "WINTERGREEN",
    "Ordinal" : 0
  }, {
    "Name" : "SPEARMINT",
    "Ordinal" : 1
  }, {
    "Name" : "PEPPERMINT",
    "Ordinal" : 2
  }, {
    "Name" : "BUBBLEGUM",
    "Ordinal" : 3
  } ],
  "Name" : "FLAVORS"
}, {
  "Enumerations" : [ {
    "Name" : "WINTERGREEN",
    "Ordinal" : 0
  }, {
    "Name" : "SPEARMINT",
    "Ordinal" : 1
  }, {
    "Name" : "PEPPERMINT",
    "Ordinal" : 2
  }, {
    "Name" : "BUBBLEGUM",
    "Ordinal" : 3
  } ],
  "Name" : "FLAVORS"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
get /manifolds
Manifolds (manifolds)
Get the list of manifolds from the Areamodel.

Return type

array[manifold1]

Example data

Content-Type: application/json
[ {
  "EquipmentID" : 32,
  "IconFilename" : "",
  "MaxOwners" : 1,
  "Name" : "HDR_FLAVOR",
  "NeededEquipment" : [ ]
}, {
  "EquipmentID" : 32,
  "IconFilename" : "",
  "MaxOwners" : 1,
  "Name" : "HDR_FLAVOR",
  "NeededEquipment" : [ ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
get /phases
Phases (phases)
Get the list of phases from the Areamodel.

Return type

array[Phase]

Example data

Content-Type: application/json
[ {
  "ClassName" : "COOL",
  "CommandTagName" : "COOL1_VC",
  "EquipmentID" : 15,
  "FailureTagName" : "COOL1_F",
  "MaxOwners" : 1,
  "Name" : "COOL1",
  "NeededEquipment" : [ ],
  "OwnerTagName" : "COOL1_W",
  "ParameterTags" : [ {
    "ClassName" : "PARMTR01",
    "DataType" : 1,
    "ItemName" : "COOL1P01",
    "Name" : "NODE.COOL1P01.F_CV",
    "TagType" : 3
  } ],
  "Parameters" : [ {
    "EngineeringUnits" : "ENG. UNITS",
    "Enumerations" : [ ],
    "HighLimit" : "ENG. UNITS",
    "ID" : 1,
    "LowLimit" : "ENG. UNITS",
    "Name" : "TEMP_TO_COOL",
    "Scalable" : false,
    "Type" : 1,
    "Value" : "ENG. UNITS"
  } ],
  "PauseTagName" : "COOL1_P",
  "PausedTagName" : "COOL1_PD",
  "PhaseReports" : [ {
    "EngineeringUnits" : "ENG. UNITS",
    "ID" : 1,
    "Name" : "COOL_TEMP",
    "Type" : 1
  } ],
  "ReportTags" : [ {
    "ClassName" : "REPORT01",
    "DataType" : 1,
    "ItemName" : "COOL1R01",
    "Name" : "NODE.COOL1R01.F_CV",
    "TagType" : 3
  } ],
  "RequestTagName" : "COOL1_RQ",
  "RequestTags" : [ ],
  "SingleStepTagName" : "COOL1_SS",
  "StatusTagName" : "COOL1_ST",
  "StepIndexTagName" : "COOL1_SI",
  "UnitIDTagName" : "COOL1_UN",
  "Units" : [ "MIX1" ]
}, {
  "ClassName" : "COOL",
  "CommandTagName" : "COOL1_VC",
  "EquipmentID" : 15,
  "FailureTagName" : "COOL1_F",
  "MaxOwners" : 1,
  "Name" : "COOL1",
  "NeededEquipment" : [ ],
  "OwnerTagName" : "COOL1_W",
  "ParameterTags" : [ {
    "ClassName" : "PARMTR01",
    "DataType" : 1,
    "ItemName" : "COOL1P01",
    "Name" : "NODE.COOL1P01.F_CV",
    "TagType" : 3
  } ],
  "Parameters" : [ {
    "EngineeringUnits" : "ENG. UNITS",
    "Enumerations" : [ ],
    "HighLimit" : "ENG. UNITS",
    "ID" : 1,
    "LowLimit" : "ENG. UNITS",
    "Name" : "TEMP_TO_COOL",
    "Scalable" : false,
    "Type" : 1,
    "Value" : "ENG. UNITS"
  } ],
  "PauseTagName" : "COOL1_P",
  "PausedTagName" : "COOL1_PD",
  "PhaseReports" : [ {
    "EngineeringUnits" : "ENG. UNITS",
    "ID" : 1,
    "Name" : "COOL_TEMP",
    "Type" : 1
  } ],
  "ReportTags" : [ {
    "ClassName" : "REPORT01",
    "DataType" : 1,
    "ItemName" : "COOL1R01",
    "Name" : "NODE.COOL1R01.F_CV",
    "TagType" : 3
  } ],
  "RequestTagName" : "COOL1_RQ",
  "RequestTags" : [ ],
  "SingleStepTagName" : "COOL1_SS",
  "StatusTagName" : "COOL1_ST",
  "StepIndexTagName" : "COOL1_SI",
  "UnitIDTagName" : "COOL1_UN",
  "Units" : [ "MIX1" ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
get /processcells
Process Cells (Area Model Tree) (processCells(AreaModelTree))
Gets the process cells from the area model. This will return the hierarchical areamodel tree containing the process cells, and within each process cell, it will contain the list of units, the list of connections, and the list of manifolds. Each unit will contain a list of phases. You can set the optional query parameter getphases to false to not return the list of phases. The default value is true.

Query parameters

getphases (required)
Query Parameter —

Return type

array[ProcessCellsWithoutPhase]

Example data

Content-Type: application/json
[ {
  "Connections" : [ {
    "Destination" : "HDR_BASE",
    "DestinationType" : 1,
    "EquipmentID" : 34,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION1",
    "NeededEquipment" : [ ],
    "Source" : "WATER",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_BASE",
    "DestinationType" : 1,
    "EquipmentID" : 36,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION3",
    "NeededEquipment" : [ ],
    "Source" : "FLUORIDE",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_BASE",
    "DestinationType" : 1,
    "EquipmentID" : 38,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION5",
    "NeededEquipment" : [ ],
    "Source" : "GUM",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_BASE",
    "DestinationType" : 1,
    "EquipmentID" : 35,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION2",
    "NeededEquipment" : [ ],
    "Source" : "BAKINGSODA",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_BASE",
    "DestinationType" : 1,
    "EquipmentID" : 37,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION4",
    "NeededEquipment" : [ ],
    "Source" : "PH_ADDITIVE",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_FLAVOR",
    "DestinationType" : 1,
    "EquipmentID" : 44,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION11",
    "NeededEquipment" : [ ],
    "Source" : "FLAVORING",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_FLAVOR",
    "DestinationType" : 1,
    "EquipmentID" : 42,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION9",
    "NeededEquipment" : [ ],
    "Source" : "WHITENER",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_REACT",
    "DestinationType" : 1,
    "EquipmentID" : 45,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION10",
    "NeededEquipment" : [ ],
    "Source" : "MIX1",
    "SourceType" : 0
  }, {
    "Destination" : "REACTPLAIN",
    "DestinationType" : 0,
    "EquipmentID" : 49,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION15",
    "NeededEquipment" : [ ],
    "Source" : "MIX1",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_REACT",
    "DestinationType" : 1,
    "EquipmentID" : 46,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION12",
    "NeededEquipment" : [ ],
    "Source" : "MIX2",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_REACT",
    "DestinationType" : 1,
    "EquipmentID" : 47,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION13",
    "NeededEquipment" : [ ],
    "Source" : "MIX3",
    "SourceType" : 0
  }, {
    "Destination" : "MIX3",
    "DestinationType" : 0,
    "EquipmentID" : 51,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION17",
    "NeededEquipment" : [ ],
    "Source" : "HDR_FLAVOR",
    "SourceType" : 1
  }, {
    "Destination" : "MIX2",
    "DestinationType" : 0,
    "EquipmentID" : 41,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION8",
    "NeededEquipment" : [ ],
    "Source" : "HDR_FLAVOR",
    "SourceType" : 1
  }, {
    "Destination" : "MIX1",
    "DestinationType" : 0,
    "EquipmentID" : 39,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION6",
    "NeededEquipment" : [ ],
    "Source" : "HDR_BASE",
    "SourceType" : 1
  }, {
    "Destination" : "MIX2",
    "DestinationType" : 0,
    "EquipmentID" : 40,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION7",
    "NeededEquipment" : [ ],
    "Source" : "HDR_BASE",
    "SourceType" : 1
  }, {
    "Destination" : "MIX3",
    "DestinationType" : 0,
    "EquipmentID" : 50,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION16",
    "NeededEquipment" : [ ],
    "Source" : "HDR_BASE",
    "SourceType" : 1
  }, {
    "Destination" : "REACTFLAVOR",
    "DestinationType" : 0,
    "EquipmentID" : 48,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION14",
    "NeededEquipment" : [ ],
    "Source" : "HDR_REACT",
    "SourceType" : 1
  } ],
  "EquipmentID" : 1,
  "HMIPicture" : "",
  "Manifolds" : [ {
    "EquipmentID" : 32,
    "IconFilename" : "",
    "MaxOwners" : 1,
    "Name" : "HDR_FLAVOR",
    "NeededEquipment" : [ ]
  }, {
    "EquipmentID" : 33,
    "IconFilename" : "",
    "MaxOwners" : 1,
    "Name" : "HDR_BASE",
    "NeededEquipment" : [ ]
  }, {
    "EquipmentID" : 43,
    "IconFilename" : "",
    "MaxOwners" : 1,
    "Name" : "HDR_REACT",
    "NeededEquipment" : [ ]
  } ],
  "MaxOwners" : 1,
  "Name" : "TOOTHPASTE",
  "Units" : [ {
    "Capacity" : 0,
    "ClassName" : "WATER",
    "DefaultPriority" : 0,
    "EquipmentID" : 5,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "WATER",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "NONE"
  }, {
    "Capacity" : 0,
    "ClassName" : "FLUORIDE",
    "DefaultPriority" : 0,
    "EquipmentID" : 6,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "FLUORIDE",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "NONE"
  }, {
    "Capacity" : 0,
    "ClassName" : "GUM",
    "DefaultPriority" : 0,
    "EquipmentID" : 10,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "GUM",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "NONE"
  }, {
    "Capacity" : 0,
    "ClassName" : "BAKINGSODA",
    "DefaultPriority" : 0,
    "EquipmentID" : 8,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "BAKINGSODA",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "NONE"
  }, {
    "Capacity" : 0,
    "ClassName" : "PH_ADDITIVE",
    "DefaultPriority" : 0,
    "EquipmentID" : 7,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "PH_ADDITIVE",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "NONE"
  }, {
    "Capacity" : 0,
    "ClassName" : "FLAVORING",
    "DefaultPriority" : 0,
    "EquipmentID" : 9,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "FLAVORING",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "NONE"
  }, {
    "Capacity" : 0,
    "ClassName" : "WHITENER",
    "DefaultPriority" : 0,
    "EquipmentID" : 30,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "WHITENER",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "NONE"
  }, {
    "Capacity" : 1000,
    "ClassName" : "MIX1",
    "DefaultPriority" : 0,
    "EquipmentID" : 2,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "MIX1",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ {
      "ClassName" : "LEVEL",
      "DataType" : 2,
      "ItemName" : "LEVEL1",
      "Name" : "LEVEL1",
      "TagType" : 3
    } ],
    "UOM" : "LITERS"
  }, {
    "Capacity" : 2000,
    "ClassName" : "MIX2",
    "DefaultPriority" : 0,
    "EquipmentID" : 3,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "MIX2",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ {
      "ClassName" : "LEVEL",
      "DataType" : 2,
      "ItemName" : "LEVEL2",
      "Name" : "LEVEL2",
      "TagType" : 3
    } ],
    "UOM" : "LITERS"
  }, {
    "Capacity" : 500,
    "ClassName" : "MIX3",
    "DefaultPriority" : 0,
    "EquipmentID" : 11,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "MIX3",
    "NeededEquipment" : [ "TOOTHPASTE", "REACTFLAVOR", "COOL3", "CONNECTION13", "HDR_REACT" ],
    "ReadyFlag" : true,
    "Tags" : [ {
      "ClassName" : "LEVEL",
      "DataType" : 2,
      "ItemName" : "LEVEL3",
      "Name" : "LEVEL3",
      "TagType" : 3
    } ],
    "UOM" : "LITERS"
  }, {
    "Capacity" : 1000,
    "ClassName" : "REACTPLAIN",
    "DefaultPriority" : 1,
    "EquipmentID" : 29,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "REACTPLAIN",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "LITERS"
  }, {
    "Capacity" : 2000,
    "ClassName" : "REACTFLAVOR",
    "DefaultPriority" : 2,
    "EquipmentID" : 4,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "REACTFLAVOR",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "LITERS"
  } ]
}, {
  "Connections" : [ {
    "Destination" : "HDR_BASE",
    "DestinationType" : 1,
    "EquipmentID" : 34,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION1",
    "NeededEquipment" : [ ],
    "Source" : "WATER",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_BASE",
    "DestinationType" : 1,
    "EquipmentID" : 36,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION3",
    "NeededEquipment" : [ ],
    "Source" : "FLUORIDE",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_BASE",
    "DestinationType" : 1,
    "EquipmentID" : 38,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION5",
    "NeededEquipment" : [ ],
    "Source" : "GUM",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_BASE",
    "DestinationType" : 1,
    "EquipmentID" : 35,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION2",
    "NeededEquipment" : [ ],
    "Source" : "BAKINGSODA",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_BASE",
    "DestinationType" : 1,
    "EquipmentID" : 37,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION4",
    "NeededEquipment" : [ ],
    "Source" : "PH_ADDITIVE",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_FLAVOR",
    "DestinationType" : 1,
    "EquipmentID" : 44,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION11",
    "NeededEquipment" : [ ],
    "Source" : "FLAVORING",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_FLAVOR",
    "DestinationType" : 1,
    "EquipmentID" : 42,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION9",
    "NeededEquipment" : [ ],
    "Source" : "WHITENER",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_REACT",
    "DestinationType" : 1,
    "EquipmentID" : 45,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION10",
    "NeededEquipment" : [ ],
    "Source" : "MIX1",
    "SourceType" : 0
  }, {
    "Destination" : "REACTPLAIN",
    "DestinationType" : 0,
    "EquipmentID" : 49,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION15",
    "NeededEquipment" : [ ],
    "Source" : "MIX1",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_REACT",
    "DestinationType" : 1,
    "EquipmentID" : 46,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION12",
    "NeededEquipment" : [ ],
    "Source" : "MIX2",
    "SourceType" : 0
  }, {
    "Destination" : "HDR_REACT",
    "DestinationType" : 1,
    "EquipmentID" : 47,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION13",
    "NeededEquipment" : [ ],
    "Source" : "MIX3",
    "SourceType" : 0
  }, {
    "Destination" : "MIX3",
    "DestinationType" : 0,
    "EquipmentID" : 51,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION17",
    "NeededEquipment" : [ ],
    "Source" : "HDR_FLAVOR",
    "SourceType" : 1
  }, {
    "Destination" : "MIX2",
    "DestinationType" : 0,
    "EquipmentID" : 41,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION8",
    "NeededEquipment" : [ ],
    "Source" : "HDR_FLAVOR",
    "SourceType" : 1
  }, {
    "Destination" : "MIX1",
    "DestinationType" : 0,
    "EquipmentID" : 39,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION6",
    "NeededEquipment" : [ ],
    "Source" : "HDR_BASE",
    "SourceType" : 1
  }, {
    "Destination" : "MIX2",
    "DestinationType" : 0,
    "EquipmentID" : 40,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION7",
    "NeededEquipment" : [ ],
    "Source" : "HDR_BASE",
    "SourceType" : 1
  }, {
    "Destination" : "MIX3",
    "DestinationType" : 0,
    "EquipmentID" : 50,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION16",
    "NeededEquipment" : [ ],
    "Source" : "HDR_BASE",
    "SourceType" : 1
  }, {
    "Destination" : "REACTFLAVOR",
    "DestinationType" : 0,
    "EquipmentID" : 48,
    "Label" : "",
    "MaxOwners" : 1,
    "Name" : "CONNECTION14",
    "NeededEquipment" : [ ],
    "Source" : "HDR_REACT",
    "SourceType" : 1
  } ],
  "EquipmentID" : 1,
  "HMIPicture" : "",
  "Manifolds" : [ {
    "EquipmentID" : 32,
    "IconFilename" : "",
    "MaxOwners" : 1,
    "Name" : "HDR_FLAVOR",
    "NeededEquipment" : [ ]
  }, {
    "EquipmentID" : 33,
    "IconFilename" : "",
    "MaxOwners" : 1,
    "Name" : "HDR_BASE",
    "NeededEquipment" : [ ]
  }, {
    "EquipmentID" : 43,
    "IconFilename" : "",
    "MaxOwners" : 1,
    "Name" : "HDR_REACT",
    "NeededEquipment" : [ ]
  } ],
  "MaxOwners" : 1,
  "Name" : "TOOTHPASTE",
  "Units" : [ {
    "Capacity" : 0,
    "ClassName" : "WATER",
    "DefaultPriority" : 0,
    "EquipmentID" : 5,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "WATER",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "NONE"
  }, {
    "Capacity" : 0,
    "ClassName" : "FLUORIDE",
    "DefaultPriority" : 0,
    "EquipmentID" : 6,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "FLUORIDE",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "NONE"
  }, {
    "Capacity" : 0,
    "ClassName" : "GUM",
    "DefaultPriority" : 0,
    "EquipmentID" : 10,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "GUM",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "NONE"
  }, {
    "Capacity" : 0,
    "ClassName" : "BAKINGSODA",
    "DefaultPriority" : 0,
    "EquipmentID" : 8,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "BAKINGSODA",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "NONE"
  }, {
    "Capacity" : 0,
    "ClassName" : "PH_ADDITIVE",
    "DefaultPriority" : 0,
    "EquipmentID" : 7,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "PH_ADDITIVE",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "NONE"
  }, {
    "Capacity" : 0,
    "ClassName" : "FLAVORING",
    "DefaultPriority" : 0,
    "EquipmentID" : 9,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "FLAVORING",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "NONE"
  }, {
    "Capacity" : 0,
    "ClassName" : "WHITENER",
    "DefaultPriority" : 0,
    "EquipmentID" : 30,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "WHITENER",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "NONE"
  }, {
    "Capacity" : 1000,
    "ClassName" : "MIX1",
    "DefaultPriority" : 0,
    "EquipmentID" : 2,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "MIX1",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ {
      "ClassName" : "LEVEL",
      "DataType" : 2,
      "ItemName" : "LEVEL1",
      "Name" : "LEVEL1",
      "TagType" : 3
    } ],
    "UOM" : "LITERS"
  }, {
    "Capacity" : 2000,
    "ClassName" : "MIX2",
    "DefaultPriority" : 0,
    "EquipmentID" : 3,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "MIX2",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ {
      "ClassName" : "LEVEL",
      "DataType" : 2,
      "ItemName" : "LEVEL2",
      "Name" : "LEVEL2",
      "TagType" : 3
    } ],
    "UOM" : "LITERS"
  }, {
    "Capacity" : 500,
    "ClassName" : "MIX3",
    "DefaultPriority" : 0,
    "EquipmentID" : 11,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "MIX3",
    "NeededEquipment" : [ "TOOTHPASTE", "REACTFLAVOR", "COOL3", "CONNECTION13", "HDR_REACT" ],
    "ReadyFlag" : true,
    "Tags" : [ {
      "ClassName" : "LEVEL",
      "DataType" : 2,
      "ItemName" : "LEVEL3",
      "Name" : "LEVEL3",
      "TagType" : 3
    } ],
    "UOM" : "LITERS"
  }, {
    "Capacity" : 1000,
    "ClassName" : "REACTPLAIN",
    "DefaultPriority" : 1,
    "EquipmentID" : 29,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "REACTPLAIN",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "LITERS"
  }, {
    "Capacity" : 2000,
    "ClassName" : "REACTFLAVOR",
    "DefaultPriority" : 2,
    "EquipmentID" : 4,
    "HMIPicture" : "",
    "MaxOwners" : 1,
    "Name" : "REACTFLAVOR",
    "NeededEquipment" : [ ],
    "ReadyFlag" : true,
    "Tags" : [ ],
    "UOM" : "LITERS"
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
get /tags
Tags (tags)
Get the list of tags from the Areamodel.

Return type

array[Tag2]

Example data

Content-Type: application/json
[ {
  "ClassName" : "COMMAND",
  "DataType" : 2,
  "ItemName" : "ADD_INGS1_VC",
  "Name" : "ADD_INGS1_VC",
  "TagType" : 3
}, {
  "ClassName" : "COMMAND",
  "DataType" : 2,
  "ItemName" : "ADD_INGS1_VC",
  "Name" : "ADD_INGS1_VC",
  "TagType" : 3
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
get /units
Units (units)
Get the list of units from the areamodel. It will also retrieve the list of phases for each unit. You can use the optional "getphases=false" query parameter to not include the phases list.

Return type

array[UnitsWithoutPhase]

Example data

Content-Type: application/json
[ {
  "Capacity" : 1000,
  "ClassName" : "MIX1",
  "DefaultPriority" : 0,
  "EquipmentID" : 2,
  "HMIPicture" : "",
  "MaxOwners" : 1,
  "Name" : "MIX1",
  "NeededEquipment" : [ ],
  "ReadyFlag" : true,
  "Tags" : [ {
    "ClassName" : "LEVEL",
    "DataType" : 2,
    "ItemName" : "LEVEL1",
    "Name" : "LEVEL1",
    "TagType" : 3
  } ],
  "UOM" : "LITERS"
}, {
  "Capacity" : 1000,
  "ClassName" : "MIX1",
  "DefaultPriority" : 0,
  "EquipmentID" : 2,
  "HMIPicture" : "",
  "MaxOwners" : 1,
  "Name" : "MIX1",
  "NeededEquipment" : [ ],
  "ReadyFlag" : true,
  "Tags" : [ {
    "ClassName" : "LEVEL",
    "DataType" : 2,
    "ItemName" : "LEVEL1",
    "Name" : "LEVEL1",
    "TagType" : 3
  } ],
  "UOM" : "LITERS"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

BatchAPI

Up 
post /addbatch
Add Batch (addBatch)

Create a new batch.

The unitbindings is optional and is used in place of the default unit bindings. Specify the unit bindings as tab-delimited string pairs: unit class/unit instance. For example, BASE:1\tMIX1\tADDITIVE:1\tMIX2\tFINAL:1\tREACTFLAVOR.

NOTE: You must specify all unit bindings in this tab-delimited string.

The parametervalues is optional and is used in place of the default parameter values. Specify the parameter bindings as tab-delimited string pairs: parameter name/value. For example, BAKINGSODA_AMT\t50\tFLAVOR\tSPEARMINT\tFLAVOR_AMT\t22\tFLUORIDE_AMT\t11\tGUM_AMT\t27\tPH_AMT\t55\tWATER_AMT\t78\tWHITENER_AMT\t12

NOTE: You must specify all parameter bindings in this tab-delimited string.

NOTE: The \t is used for the tab character, not %09 since this is passed in the JSON Body.

The call will return the batch serial number generated by the Batch Execution Server.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AddBatchRequest (required)
Body Parameter —
example: { "recipeid" : "MAKE_TOOTHPASTE", "recipeversion" : 1, "batchid" : "batch07122020", "batchscale" : 1, "unitbindings" : "BASE:1\tMIX1\tADDITIVE:1\tMIX2\tFINAL:1\tREACTFLAVOR", "parametervalues" : "BAKINGSODA_AMT\t50\tFLAVOR\tSPEARMINT\tFLAVOR_AMT\t22\tFLUORIDE_AMT\t11\tGUM_AMT\t27\tPH_AMT\t55\tWATER_AMT\t78\tWHITENER_AMT\t12" }

Return type

addbatch

Example data

Content-Type: application/json
{
  "batchserialnumber" : 122,
  "detail" : "Batch Added"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

addbatch
Up 
post /addbatchevent
Add Batch Event (addBatchEvent)
Add a user event to the batch. The batchid is required and is either * to match all batches or a specific batchid. The other fields are optional and allow you to put a data value for that field of the event record. The event record is written to the event journal file as specified by the batchid.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AddBatchEventRequest (required)
Body Parameter —
example: { "batchid" : "batch07122020", "value" : "100", "description" : "TEST adding event", "engineeringunit" : "EU", "phasename" : "PHASENAME", "unitname" : "UNITNAME", "processcell" : "PROCESSCELL" }

Return type

addbatchevent

Example data

Content-Type: application/json
{
  "detail" : "Batch Add Event Was Executed."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

addbatchevent
Up 
get /batchstate
Batch State (batchState)
Returns the current batch state for the specified batch. The batchstate return value can be one of the following:

Query parameters

batchserialnumber (required)
Query Parameter — format: int32

Return type

BatchState

Example data

Content-Type: application/json
{
  "BatchState" : "READY",
  "BatchStateValue" : 130
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

BatchState
Up 
get /batches
Batches (batches)
Get the list of batches stored in the Batch Execution Server.

Return type

array[batch]

Example data

Content-Type: application/json
[ {
  "BatchBound" : "1",
  "BatchDescription" : "TOOTHPASTE WITH BAKING SODA BASE",
  "BatchID" : "BATCH07122020",
  "BatchMode" : "O-AUTO",
  "BatchSerialNumber" : "122",
  "BatchState" : "READY",
  "CommandMask" : "18944",
  "DefaultBind" : "1",
  "ElapsedTime" : "00:00:00",
  "Failures" : " ",
  "OperatorBindParameters" : "1",
  "OperatorBindUnits" : "1",
  "OperatorInteraction" : "1",
  "ParametersRequired" : "0",
  "ParametersSupplied" : "0",
  "PhaseList" : "",
  "ProcessCellList" : "TOOTHPASTE,PROCESS_CELL1",
  "RecipeAuditVersion" : "17",
  "RecipeName" : "MAKE_TOOTHPASTE",
  "RecipeVersion" : "1.0",
  "Scale" : "1",
  "StartTime" : " ",
  "Type" : "1",
  "UnitList" : "MIX1,MIX2,REACTFLAVOR",
  "UnitsRequired" : "0",
  "UnitsSupplied" : "0"
}, {
  "BatchBound" : "1",
  "BatchDescription" : "TOOTHPASTE WITH BAKING SODA BASE",
  "BatchID" : "BATCH07122020",
  "BatchMode" : "O-AUTO",
  "BatchSerialNumber" : "122",
  "BatchState" : "READY",
  "CommandMask" : "18944",
  "DefaultBind" : "1",
  "ElapsedTime" : "00:00:00",
  "Failures" : " ",
  "OperatorBindParameters" : "1",
  "OperatorBindUnits" : "1",
  "OperatorInteraction" : "1",
  "ParametersRequired" : "0",
  "ParametersSupplied" : "0",
  "PhaseList" : "",
  "ProcessCellList" : "TOOTHPASTE,PROCESS_CELL1",
  "RecipeAuditVersion" : "17",
  "RecipeName" : "MAKE_TOOTHPASTE",
  "RecipeVersion" : "1.0",
  "Scale" : "1",
  "StartTime" : " ",
  "Type" : "1",
  "UnitList" : "MIX1,MIX2,REACTFLAVOR",
  "UnitsRequired" : "0",
  "UnitsSupplied" : "0"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
put /bindbatch
Bind Batch Parameter Values and Unit Bindings (bindBatchParameterValuesandUnitBindings)

Binds units and parameters to the specified batch. The batch must be in the Ready state (130).

Specify the parameter bindings as tab-delimited string pairs for all parameters. If you want to use default values then this value can be empty.

Specify the unit bindings as tab-delimited string pairs for all units. If you want to use default values then this value can be empty.

Note that \t must be used for the tab character, not %09 since this is passed in the JSON Body.

For example with unit bindings: BASE:1\tMIX1\tADDITIVE:1\tMIX2\tFINAL:1\tREACTFLAVOR

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body BindBatchParameterValuesandUnitBindingsRequest (required)
Body Parameter —
example: { "batchserialnumber" : 154, "unitbindings" : "BASE:1\tMIX1\tADDITIVE:1\tMIX2\tFINAL:1\tREACTFLAVOR", "parametervalues" : "BAKINGSODA_AMT\t50\tFLAVOR\tSPEARMINT\tFLAVOR_AMT\t22\tFLUORIDE_AMT\t11\tGUM_AMT\t27\tPH_AMT\t55\tWATER_AMT\t78\tWHITENER_AMT\t12" }

Return type

BindBatchParameterValuesandUnitBindings

Example data

Content-Type: application/json
{
  "detail" : "Bind Command sent to the Batch Server."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

BindBatchParameterValuesandUnitBindings
Up 
get /parameters
Parameters (parameters)

Gets the list of parameters for the specified procedure.

procedureid is the tab delimited procedure path starting with the batch serial number and followed by the optional recipe unit procedure, optional recipe operation, optional recipe phase. Examples: 123 123\tBASE:1 123\tBASE:1\tMAKE_BASE:1 123\tBASE:1\tMAKE_BASE:1\tADD_INGS:1

%09 can be used in place of \t to represent the tab character. Example: 168%09BASE:1%09MAKE_BASE:1

Query parameters

procedureid (required)
Query Parameter — format: int32

Return type

array[Parametersexampleshowingparametersfromthephasestep.]

Example data

Content-Type: application/json
[ {
  "EngineeringUnits" : "ENG. UNITS",
  "Enumerations" : [ ],
  "HighLimit" : "100.000000",
  "ID" : 0,
  "LowLimit" : "0.000000",
  "Name" : "TEMP_TO_COOL",
  "Scalable" : false,
  "Type" : 1,
  "Value" : "0.000000"
}, {
  "EngineeringUnits" : "ENG. UNITS",
  "Enumerations" : [ ],
  "HighLimit" : "100.000000",
  "ID" : 0,
  "LowLimit" : "0.000000",
  "Name" : "TEMP_TO_COOL",
  "Scalable" : false,
  "Type" : 1,
  "Value" : "0.000000"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
delete /batches
Remove Batch (removeBatch)
Remove the batch.

Query parameters

batchserialnumber (required)
Query Parameter — format: int32

Return type

DeleteBatch

Example data

Content-Type: application/json
{
  "detail" : "Batch Command Executed."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

DeleteBatch
Up 
get /reportparameters
Report Parameters (reportParameters)

Gets the list of report parameters for the specified procedureid.

procedureid is the tab delimited procedure path starting with the batch serial number and followed by the optional recipe unit procedure, optional recipe operation, optional recipe phase. Examples: 123 123\tBASE:1 123\tBASE:1\tMAKE_BASE:1 123\tBASE:1\tMAKE_BASE:1\tADD_INGS:1 123\tBASE:1\tMAKE_BASE:1\tADD_INGS:1\tCOOL:1

%09 can be used in place of \t to represent the tab character. Example: 168%09BASE:1%09MAKE_BASE:1%09ADD_INGS:1%09COOL:1

Query parameters

procedureid (required)
Query Parameter —

Return type

array[ReportParameter]

Example data

Content-Type: application/json
[ {
  "EngineeringUnits" : "ENG. UNITS",
  "Enumerations" : [ ],
  "HighLimit" : "ENG. UNITS",
  "ID" : 0,
  "LowLimit" : "ENG. UNITS",
  "Name" : "COOL_TEMP",
  "Scalable" : false,
  "Type" : 0,
  "Value" : " "
}, {
  "EngineeringUnits" : "ENG. UNITS",
  "Enumerations" : [ ],
  "HighLimit" : "ENG. UNITS",
  "ID" : 0,
  "LowLimit" : "ENG. UNITS",
  "Name" : "COOL_TEMP",
  "Scalable" : false,
  "Type" : 0,
  "Value" : " "
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
put /batches
Run Batch Command (runBatchCommand)

Send a batch command to the batch server. The batchcommand can be: start, stop, hold, restart, abort, clearfailures, manual, auto.

Note that the "remove" batch command is handled in the REST DELETE command.

Note that the batch must be in the proper state in order for the batchcommand to succeed.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RunBatchCommandRequest (required)
Body Parameter —
example: { "batchserialnumber" : 139, "batchcommand" : "restart" }

Return type

batchcommandGood

Example data

Content-Type: application/json
{
  "detail" : "Batch Command Executed."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

batchcommandGood

400

Bad Request PhaseCommandsAndBatchCommands1
Up 
put /setunittag
Set Unit Tag (setUnitTag)

Sets the value of the specified unit tag class name.

Note that the unit tag class name is used to specify the unit tag.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SetUnitTagRequest (required)
Body Parameter —
example: { "unitname" : "MIX1", "unittagclassname" : "LEVEL", "value" : "20" }

Return type

SetUnitTag

Example data

Content-Type: application/json
{
  "detail" : "Set Unit Tag command sent to the Batch Server."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

SetUnitTag
Up 
get /unittags
Unit Tags (unitTags)

Gets the list of unit tags for the given procedureid.

procedureid is the tab delimited procedure path starting with the batch serial number and followed by the optional recipe unit procedure, optional recipe operation, optional recipe phase. Examples: 123 123\tBASE:1 123\tBASE:1\tMAKE_BASE:1 123\tBASE:1\tMAKE_BASE:1\tADD_INGS:1

%09 can be used in place of \t to represent the tab character. Example: 168%09BASE:1%09MAKE_BASE:1

Query parameters

unitname (required)
Query Parameter —

Return type

array[GetUnitTag]

Example data

Content-Type: application/json
[ {
  "Class" : "LEVEL",
  "Name" : "LEVEL1",
  "Type" : 2,
  "Value" : "20"
}, {
  "Class" : "LEVEL",
  "Name" : "LEVEL1",
  "Type" : 2,
  "Value" : "20"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

BindingPromptsAPI

Up 
put /ackbindingprompt
Acknowledge Binding Prompt (acknowledgeBindingPrompt)
Acknowledge the specified binding prompt with the specified promptvalue containing the unit to bind to.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AcknowledgeBindingPromptRequest (required)
Body Parameter —
example: { "eventid" : 1, "promptvalue" : "MIX1" }

Return type

ackbindingprompt

Example data

Content-Type: application/json
{
  "detail" : "Acknowedge Binding Prompt Executed"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

ackbindingprompt
Up 
get /bindingprompts
Binding Prompts (bindingPrompts)
Get the list of binding prompts.

Return type

array[bindingprompt]

Example data

Content-Type: application/json
[ {
  "Area" : "AREA1",
  "BatchID" : "BATCH07122020B",
  "BatchSerialNumber" : "123",
  "BindingUnits" : [ "MIX1" ],
  "DefaultUnit" : "MIX1",
  "Description" : "Unit Binding: Active Binding Prompt Sent",
  "EngineeringUnits" : " ",
  "Event" : "Active Binding",
  "EventID" : "1",
  "Phase" : "",
  "ProcessCell" : " ",
  "Recipe" : "123:MAKE_TOOTHPASTE\\BASE:1-1",
  "StepName" : "BASE:1",
  "Time" : "7/12/2020 22:28:52",
  "Unit" : " ",
  "UnitClass" : "MIXER",
  "Value" : "MIXER"
}, {
  "Area" : "AREA1",
  "BatchID" : "BATCH07122020B",
  "BatchSerialNumber" : "123",
  "BindingUnits" : [ "MIX1" ],
  "DefaultUnit" : "MIX1",
  "Description" : "Unit Binding: Active Binding Prompt Sent",
  "EngineeringUnits" : " ",
  "Event" : "Active Binding",
  "EventID" : "1",
  "Phase" : "",
  "ProcessCell" : " ",
  "Recipe" : "123:MAKE_TOOTHPASTE\\BASE:1-1",
  "StepName" : "BASE:1",
  "Time" : "7/12/2020 22:28:52",
  "Unit" : " ",
  "UnitClass" : "MIXER",
  "Value" : "MIXER"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

BreakpointAPI

Up 
put /ackbreakpointprompt
Acknowledge Breakpoint Prompt (acknowledgeBreakpointPrompt)
Acknowedge the specified breakpointpromptid. See the GET breakpointprompts response JSON output to find the ID value to use for breakpointpromptid.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AcknowledgeBreakpointPromptRequest (required)
Body Parameter —
example: { "breakpointpromptid" : 1 }

Return type

ackbreakpointprompt

Example data

Content-Type: application/json
{
  "detail" : "Acknowledge Breakpoint Prompt Executed."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

ackbreakpointprompt
Up 
get /breakpointprompts
Breakpoint Prompts (breakpointPrompts)
Get the list of breakpoint prompts.

Return type

array[breakpointprompt]

Example data

Content-Type: application/json
[ {
  "BatchID" : "BATCH07122020",
  "BatchSerialNumber" : "122",
  "BreakpointID" : "1",
  "Expression" : "FINAL:1.STATE = COMPLETE ",
  "ID" : "1",
  "Recipe" : "122:MAKE_TOOTHPASTE",
  "TransitionID" : "45"
}, {
  "BatchID" : "BATCH07122020",
  "BatchSerialNumber" : "122",
  "BreakpointID" : "1",
  "Expression" : "FINAL:1.STATE = COMPLETE ",
  "ID" : "1",
  "Recipe" : "122:MAKE_TOOTHPASTE",
  "TransitionID" : "45"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
get /breakpoints
Breakpoints (breakpoints)
Get the list of breakpoints.

Return type

array[breakpoint]

Example data

Content-Type: application/json
[ {
  "BatchID" : "BATCH07122020",
  "BatchSerialNumber" : "122",
  "Expression" : "FINAL:1.STATE = COMPLETE ",
  "ID" : "1",
  "Recipe" : "122:MAKE_TOOTHPASTE",
  "TransitionID" : "45"
}, {
  "BatchID" : "BATCH07122020",
  "BatchSerialNumber" : "122",
  "Expression" : "FINAL:1.STATE = COMPLETE ",
  "ID" : "1",
  "Recipe" : "122:MAKE_TOOTHPASTE",
  "TransitionID" : "45"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
put /clearbreakpoint
Clear Breakpoint (clearBreakpoint)
Remove the breakpoint from the specified transition.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ClearBreakpointRequest (required)
Body Parameter —
example: { "breakpointid" : 2 }

Return type

clearbreakpoint

Example data

Content-Type: application/json
{
  "detail" : "Clear Breakpoint Command was sent to the Batch Server."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

clearbreakpoint
Up 
put /setbreakpoint
Set Breakpoint (setBreakpoint)
set a breakpoint in the specified batch and transition id.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SetBreakpointRequest (required)
Body Parameter —
example: { "batchserialnumber" : 122, "transitionid" : 45 }

Return type

setbreakpoint

Example data

Content-Type: application/json
{
  "detail" : "Set Breakpoint Command was sent to the Batch Server."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

setbreakpoint

ESignatureAPI

Up 
post /addsecurityevent
Add Security Event (addSecurityEvent)

Add a security event record to the batch event file specified by the batchid.

Signaturetype can be:

60 This is for performed. The 3 performedby and 3 verifiedby parameters are NOT required.

61 This is for performedby. The 3 performedby parameters are required.

62 This is for performedby/verifiedby. The 3 performedby and 3 verifiedby parameters are required.

Note that this method can be used by the BatchRestAPI programmer to record an E-Signature event to the batch event journal file. The programmer would typically call the Authenticate User BatchRestAPI method, perform a batch command, and then call this BatchRestAPI method to log the event.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AddSecurityEventRequest (required)
Body Parameter —
example: { "signaturetype" : 62, "command" : "Start Batch", "computername" : "MyComputer", "batchserialnumber" : 128, "batchid" : "BATCH_ID_BIND2", "performedbyname" : "operator1", "performedbygroup" : "operators", "performedbytimestamp" : "2020-07-12 18:00:00", "verifiedbyname" : "supervisor1", "verifiedbygroup" : "supervisors", "verifiedbytimestamp" : "2020-07-12 18:02:00" }

Responses

200

Up 
post /authenticateuser
Authenticate User (authenticateUser)

Authenticate that the username and password are valid, and that the username is a member of the securitygroup. The password must be base64 encoded.

The authentication is performed on the Batch Server computer and the username must be a Windows user on the Batch Server computer and a member of the specified Windows User Group on the Batch Server computer.

This method can be used by the BatchRestAPI programmer to implement e-signature type authentication prior to the progammer calling any batch/step/phase/prompts commands that they want to secure with authentication and with e-signatures. If the call is successful, then the programmer can proceed and call the batch/step/phase/prompt command REST API (for example: Start Batch) to be executed, and then call the Add Security Event REST API method to record the e-signature data record to the batch event journal file.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AuthenticateUserRequest (required)
Body Parameter —
example: { "username" : "batchuser", "password" : "QmF0Y2gxMjM0==", "securitygroup" : "operators" }

Return type

authenticateuser

Example data

Content-Type: application/json
{
  "FullName" : "BatchUser",
  "ResolvedPrincipal" : "AB082RQ2E\\BatchUser",
  "detail" : "User is successfully authenticated."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

authenticateuser

400

Bad Request PhaseCommandsAndBatchCommands1

ElectronicWorkInstructionAPI

Up 
put /ackewiprompt
Acknowledge EWI Prompt (acknowledgeEWIPrompt)
Acknowledge the EWI prompt.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AcknowledgeEWIPromptRequest (required)
Body Parameter —
example: { "eventid" : 2, "promptvalue" : "SUCCESS" }

Return type

ackewiprompt

Example data

Content-Type: application/json
{
  "detail" : "EWI Prompt acknowledgement was sent to the Batch Server."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

ackewiprompt
Up 
post /addewievent
Add EWI Event (addEWIEvent)

Add an EWI Event to the batch journal. This method lets you record the same EWI events to the batch journal file as is done by the EWI ActiveX Control. The processcell, unitname, and phasename are optional.

Please see the batch event journal file for examples of the XML values that are recorded when a user performs and completes different types of work instructions using the EWI ActiveX Control.

the ewieventype can be one of the following constants: EWI_INSTRUCTION = 10, EWI_DATAENTRY = 11, EWI_SIGNING = 12, EWI_DEVIATION = 13, EWI_COMMENTS = 14, EWI_IMMUTABLE = 15, EWI_EIB = 16, EIB_SIGNING = 17, EIB_DEVIATION = 18, EIB_COMMENTS = 19, LOGICSTEP_DEVIATION = 20, LOGICSTEP_COMMENTS = 21, LOGICSTEP_EXPRESSION = 22

The event subtype can be one of the following constants: EWI_EDITBOX = 30, EWI_CHECKBOX = 31, EWI_RADIOBUTTON = 32, EWI_DATETIME = 33, EWI_DONE = 34, EWI_DONEBY = 35, EWI_CHECKBY = 36, EIB_HEADER = 37, EIB_ACQUIRE = 38, EIB_RELEASE = 39, EWI_EMPTY = 40, EWI_SKIP = 41, EWI_REEXECUTE = 42, EWI_REEXECUTE_CANCEL = 43, LOGICSTEP_SKIP = 44

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AddEWIEventRequest (required)
Body Parameter —
example: { "batchid" : "batch0727", "ewieventtype" : 11, "ewieventsubtype" : 31, "value" : "<EWIDATAENTRY><EIBID>PACKAGE_SIMPLE.XML.1:1</EIBID><EIBVERSION>1</EIBVERSION><PHASEPROCID>PACK:1</PHASEPROCID><EWISTEPID>2</EWISTEPID><STEPOCCURRENCE>1</STEPOCCURRENCE><EWICHECKBOX><LABEL>Check Here</LABEL><BOOL_VALUE>FALSE</BOOL_VALUE></EWICHECKBOX></EWIDATAENTRY>", "phasename" : "Phase2", "unitname" : "Unit2", "processcell" : "ProcessCell2" }

Return type

AddEWIEvent

Example data

Content-Type: application/json
{
  "detail" : "Add EWI Event was sent to the batch server."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

AddEWIEvent
Up 
get /ewiprompts
EWI Prompts (eWIPrompts)
Get the EWI prompts stored in the Batch Execution Server.

Return type

array[ewiprompt]

Example data

Content-Type: application/json
[ {
  "AreaModel" : "AREA1",
  "BatchID" : "BATCH_ID4",
  "BatchSerialNumber" : "152",
  "EventID" : "3",
  "FileName" : "PACKAGE_SIMPLE.XML",
  "FileVersion" : "1",
  "Phase" : "PACK1",
  "ProcessCell" : "PACKAGE_PROCESS",
  "Recipe" : "152:PACKAGE_SIMPLE\\PACK:1-1",
  "Time" : "7/23/2020 15:01:18",
  "Unit" : "MIX1"
}, {
  "AreaModel" : "AREA1",
  "BatchID" : "BATCH_ID4",
  "BatchSerialNumber" : "152",
  "EventID" : "3",
  "FileName" : "PACKAGE_SIMPLE.XML",
  "FileVersion" : "1",
  "Phase" : "PACK1",
  "ProcessCell" : "PACKAGE_PROCESS",
  "Recipe" : "152:PACKAGE_SIMPLE\\PACK:1-1",
  "Time" : "7/23/2020 15:01:18",
  "Unit" : "MIX1"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Misc

Up 
get /about
About (about)
Displays the product name and version. Useful for performing a connection test to the Batch REST API without making a call to the Batch Server (VBIS).

Return type

about

Example data

Content-Type: application/json
{
  "Name" : "BatchRestAPI version 1.0"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

about

OperatorPromptsAPI

Up 
put /ackoperatorprompt
Acknowledge Operator Prompt (acknowledgeOperatorPrompt)
Acknowledge the specified operator prompt with the specified promptvalue.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AcknowledgeOperatorPromptRequest (required)
Body Parameter —
example: { "eventid" : 1, "promptvalue" : "100" }

Return type

ackoperatorprompt

Example data

Content-Type: application/json
{
  "detail" : "Acknowedge Operator Prompt Executed"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

ackoperatorprompt
Up 
get /operatorprompts
Operator Prompts (operatorPrompts)
Get the list of operator prompts.

Return type

array[operatorprompt]

Example data

Content-Type: application/json
[ {
  "Area" : "AREA1",
  "BatchID" : "BATCH07122020",
  "Default" : "0",
  "EU" : "RPM",
  "EquipmentDescription" : "SPEED",
  "EventID" : "1",
  "EventType" : "Prompt",
  "High" : "100",
  "Low" : "0",
  "Phase" : "AGITATE4",
  "ProcCell" : "TOOTHPASTE",
  "Recipe" : "122:MAKE_TOOTHPASTE\\FINAL:1\\MAKE_FNL:1\\AGITATE:1-1",
  "RespType" : "1",
  "Time" : "7/12/2020 22:08:14",
  "Unit" : "REACTFLAVOR",
  "Value" : "0"
}, {
  "Area" : "AREA1",
  "BatchID" : "BATCH07122020",
  "Default" : "0",
  "EU" : "RPM",
  "EquipmentDescription" : "SPEED",
  "EventID" : "1",
  "EventType" : "Prompt",
  "High" : "100",
  "Low" : "0",
  "Phase" : "AGITATE4",
  "ProcCell" : "TOOTHPASTE",
  "Recipe" : "122:MAKE_TOOTHPASTE\\FINAL:1\\MAKE_FNL:1\\AGITATE:1-1",
  "RespType" : "1",
  "Time" : "7/12/2020 22:08:14",
  "Unit" : "REACTFLAVOR",
  "Value" : "0"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PhaseControlAPI

Up 
put /acquirephase
Acquire Phase (acquirePhase)
Acquire the specified phase. Note that you must acquire a phase before you can execute a phase command on that phase.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AcquirePhaseRequest (required)
Body Parameter —
example: { "phaseid" : 12 }

Return type

acquirephase

Example data

Content-Type: application/json
{
  "detail" : "Acquire phase was sent to the batch server."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

acquirephase
Up 
put /phasecommand
Phase Commands (phaseCommands)

Sends a phase command to the batch server for the specified phaseid. Phase command can be: start, hold, restart, abort, stop, reset, pause, resume, clearfailures, singlestep.

Note that the singlestep command toggles the current value of singlestep.

It will fail to send the command to the batch server if the phaseid does not exist or if the phase is not in the correct state. You need to acquire the phase prior to sending a phase command.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body PhaseCommandsRequest (required)
Body Parameter —
example: { "phaseid" : 12, "unitname" : "MIX1", "batchid" : "BATCH_ID1", "phasecommand" : "START" }

Return type

PhaseCommands

Example data

Content-Type: application/json
{
  "detail" : "The phase command was sent to the batch server."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PhaseCommands

400

Bad Request PhaseCommandsAndBatchCommands1
Up 
get /phases2
Phases2 (phases2)
Returns the Phases2 data which comes from VBIS PhaseControl. This is similar to the AreaModel Phases data but it includes more runtime information.

Return type

array[Phases2]

Example data

Content-Type: application/json
[ {
  "ArbMask" : "1",
  "BatchID" : " ",
  "ClassName" : "COOL",
  "CmdMask" : "0",
  "CommandTagName" : "COOL1_VC",
  "CurrentUnit" : "MIX1",
  "EquipmentID" : 15,
  "Failure" : "",
  "FailureTagName" : "COOL1_F",
  "MaxOwners" : 1,
  "Mode" : " ",
  "Msg" : "",
  "Name" : "COOL1",
  "NeededEquipment" : [ ],
  "Owner" : " ",
  "OwnerTagName" : "COOL1_W",
  "ParameterTags" : [ {
    "ClassName" : "PARMTR01",
    "DataType" : 1,
    "ItemName" : "COOL1P01",
    "Name" : "NODE.COOL1P01.F_CV",
    "TagType" : 3
  } ],
  "Parameters" : [ {
    "EngineeringUnits" : "ENG. UNITS",
    "Enumerations" : [ ],
    "HighLimit" : "ENG. UNITS",
    "ID" : 1,
    "LowLimit" : "ENG. UNITS",
    "Name" : "TEMP_TO_COOL",
    "Scalable" : false,
    "Type" : 1,
    "Value" : "ENG. UNITS"
  } ],
  "Pause" : "",
  "PauseTagName" : "COOL1_P",
  "PausedTagName" : "COOL1_PD",
  "PhaseReports" : [ {
    "EngineeringUnits" : "ENG. UNITS",
    "ID" : 1,
    "Name" : "COOL_TEMP",
    "Type" : 1
  } ],
  "ReportTags" : [ {
    "ClassName" : "REPORT01",
    "DataType" : 1,
    "ItemName" : "COOL1R01",
    "Name" : "NODE.COOL1R01.F_CV",
    "TagType" : 3
  } ],
  "RequestTagName" : "COOL1_RQ",
  "RequestTags" : [ ],
  "SingleStepTagName" : "COOL1_SS",
  "State" : "IDLE",
  "StatusTagName" : "COOL1_ST",
  "Step" : 0,
  "StepIndexTagName" : "COOL1_SI",
  "UnitID" : 0,
  "UnitIDTagName" : "COOL1_UN",
  "Units" : [ "MIX1" ],
  "ValidUnits" : [ ]
}, {
  "ArbMask" : "1",
  "BatchID" : " ",
  "ClassName" : "COOL",
  "CmdMask" : "0",
  "CommandTagName" : "COOL1_VC",
  "CurrentUnit" : "MIX1",
  "EquipmentID" : 15,
  "Failure" : "",
  "FailureTagName" : "COOL1_F",
  "MaxOwners" : 1,
  "Mode" : " ",
  "Msg" : "",
  "Name" : "COOL1",
  "NeededEquipment" : [ ],
  "Owner" : " ",
  "OwnerTagName" : "COOL1_W",
  "ParameterTags" : [ {
    "ClassName" : "PARMTR01",
    "DataType" : 1,
    "ItemName" : "COOL1P01",
    "Name" : "NODE.COOL1P01.F_CV",
    "TagType" : 3
  } ],
  "Parameters" : [ {
    "EngineeringUnits" : "ENG. UNITS",
    "Enumerations" : [ ],
    "HighLimit" : "ENG. UNITS",
    "ID" : 1,
    "LowLimit" : "ENG. UNITS",
    "Name" : "TEMP_TO_COOL",
    "Scalable" : false,
    "Type" : 1,
    "Value" : "ENG. UNITS"
  } ],
  "Pause" : "",
  "PauseTagName" : "COOL1_P",
  "PausedTagName" : "COOL1_PD",
  "PhaseReports" : [ {
    "EngineeringUnits" : "ENG. UNITS",
    "ID" : 1,
    "Name" : "COOL_TEMP",
    "Type" : 1
  } ],
  "ReportTags" : [ {
    "ClassName" : "REPORT01",
    "DataType" : 1,
    "ItemName" : "COOL1R01",
    "Name" : "NODE.COOL1R01.F_CV",
    "TagType" : 3
  } ],
  "RequestTagName" : "COOL1_RQ",
  "RequestTags" : [ ],
  "SingleStepTagName" : "COOL1_SS",
  "State" : "IDLE",
  "StatusTagName" : "COOL1_ST",
  "Step" : 0,
  "StepIndexTagName" : "COOL1_SI",
  "UnitID" : 0,
  "UnitIDTagName" : "COOL1_UN",
  "Units" : [ "MIX1" ],
  "ValidUnits" : [ ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
put /releasephase
Release Phase (releasePhase)
Release the specified phase.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ReleasePhaseRequest (required)
Body Parameter —
example: { "phaseid" : 12 }

Return type

ReleasePhase

Example data

Content-Type: application/json
{
  "detail" : "Release phase was sent to the batch server."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

ReleasePhase

RecipeAPI

Up 
get /recipeparameters
Recipe Parameters (recipeParameters)
Get the list of equipment phase parameters for the specified recipe. The recipe version should always be 1.

Query parameters

recipeid (required)
Query Parameter —
recipeversion (required)
Query Parameter — format: int32

Return type

array[recipeparameter]

Example data

Content-Type: application/json
[ {
  "EngineeringUnits" : "LBS",
  "Enumerations" : [ ],
  "HighLimit" : "100",
  "ID" : 0,
  "LowLimit" : "0",
  "Name" : "BAKINGSODA_AMT",
  "Scalable" : true,
  "Type" : 1,
  "Value" : "50"
}, {
  "EngineeringUnits" : "LBS",
  "Enumerations" : [ ],
  "HighLimit" : "100",
  "ID" : 0,
  "LowLimit" : "0",
  "Name" : "BAKINGSODA_AMT",
  "Scalable" : true,
  "Type" : 1,
  "Value" : "50"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
get /recipeunits
Recipe Units (recipeUnits)
Get the recipe units for the specified recipe. The recipe version should always be 1.

Query parameters

recipeid (required)
Query Parameter —
recipeversion (required)
Query Parameter — format: int32

Return type

array[recipeunit]

Example data

Content-Type: application/json
[ {
  "DefaultUnitName" : "MIX1",
  "StepName" : "BASE:1",
  "UnitList" : [ "MIX1", "MIX2", "MIX3" ]
}, {
  "DefaultUnitName" : "MIX1",
  "StepName" : "BASE:1",
  "UnitList" : [ "MIX1", "MIX2", "MIX3" ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
get /recipes
Recipes (recipes)
Get the list of recipes stored in the Batch Execution Server.

Return type

array[recipe]

Example data

Content-Type: application/json
[ {
  "Author" : "PROCESS ENGINEER",
  "ProductID" : "21039438",
  "RecipeAuditVersion" : "18",
  "RecipeDescription" : "TPST",
  "RecipeFilename" : "FINAL.UPC",
  "RecipeID" : "FINAL",
  "RecipeProductName" : "TPST",
  "RecipeReleased" : "0",
  "RecipeStorageType" : "FILE",
  "RecipeType" : "UNIT PROCEDURE",
  "RecipeVersion" : "1.0",
  "TimeStamp" : "15:33:55 THURSDAY, JULY 2, 2020"
}, {
  "Author" : "PROCESS ENGINEER",
  "ProductID" : "21039438",
  "RecipeAuditVersion" : "18",
  "RecipeDescription" : "TPST",
  "RecipeFilename" : "FINAL.UPC",
  "RecipeID" : "FINAL",
  "RecipeProductName" : "TPST",
  "RecipeReleased" : "0",
  "RecipeStorageType" : "FILE",
  "RecipeType" : "UNIT PROCEDURE",
  "RecipeVersion" : "1.0",
  "TimeStamp" : "15:33:55 THURSDAY, JULY 2, 2020"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

RecipeElementsAndStepControlAPI

Up 
put /ackstepbindingprompt
Acknowledge Step Binding Prompt (acknowledgeStepBindingPrompt)
Acknowledge the specified binding prompt with the specified unit.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AcknowledgeStepBindingPromptRequest (required)
Body Parameter —
example: { "batchserialnumber" : 123, "stepname" : "FINAL:1", "eventid" : 2, "unit" : "REACTFLAVOR" }

Return type

ackstepbindingprompt

Example data

Content-Type: application/json
{
  "detail" : "Step Acknowledge binding was sent to the Batch Server."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

ackstepbindingprompt
Up 
get /activerecipesteplistitems
Active Recipe Step List Items (activeRecipeStepListItems)

Gets a filtered collection of Recipe Step List Items. The collection is filtered by the state of the recipe step as indicated by the parameter activeStepMask.

The activeStepMask value for the desired active state(s) in the recipe step collection:

1 – Running or Restarting

2 – Held or Holding

4 – Stopped or Stopping

8 – Aborted or Aborting

The values may be masked in a binary fashion to retrieve a collection containing more than one state.

3 – Held/Holding or Running/Restarting

5 – Stopped/Stopping or Running/Restarting

6 – Stopped/Stopping or Held/Holding

7 – Stopped/Stopping or Held/Holding or Running/Restarting

9 – Aborted/Aborting or Running/Restarting

10 – Aborted/Aborting or Held/Holding

11 – Aborted/Aborting or Held/Holding or Running/Restarting

12 – Aborted/Aborting or Stopped/Stopping

13 – Aborted/Aborting or Stopped/Stopping or Running/Restarting

14 – Aborted/Aborting or Stopped/Stopping or Held/Holding

15 – Aborted/Aborting or Stopped/Stopping or Held/Holding or Running/Restarting

Query parameters

batchserialnumber (required)
Query Parameter — format: int32
activestepmask (required)
Query Parameter — format: int32

Return type

array[activerecipesteplistitem]

Example data

Content-Type: application/json
[ {
  "CommandMask" : 0,
  "ElementID" : 48,
  "Failure" : " ",
  "FullStepIdentification" : "",
  "KeyParameterName" : " ",
  "KeyParameterValueEU" : " ",
  "Message" : " ",
  "Mode" : "P-AUTO",
  "Owner" : "BATCH",
  "OwnerID" : -27,
  "OwnerName" : "153:MAKE_TOOTHPASTE\\BASE:1\\MAKE_BASE:1",
  "RequestRegister" : 1000,
  "S88Type" : 4,
  "ScheduledUnitName" : " ",
  "State" : "RUNNING",
  "StepIndex" : 0,
  "StepName" : "ADD_INGS:1",
  "UnitName" : "MIX1"
}, {
  "CommandMask" : 0,
  "ElementID" : 48,
  "Failure" : " ",
  "FullStepIdentification" : "",
  "KeyParameterName" : " ",
  "KeyParameterValueEU" : " ",
  "Message" : " ",
  "Mode" : "P-AUTO",
  "Owner" : "BATCH",
  "OwnerID" : -27,
  "OwnerName" : "153:MAKE_TOOTHPASTE\\BASE:1\\MAKE_BASE:1",
  "RequestRegister" : 1000,
  "S88Type" : 4,
  "ScheduledUnitName" : " ",
  "State" : "RUNNING",
  "StepIndex" : 0,
  "StepName" : "ADD_INGS:1",
  "UnitName" : "MIX1"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
put /steprebind
Rebind (rebind)
Rebind the specified recipe step with the specified unit.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RebindRequest (required)
Body Parameter —
example: { "batchserialnumber" : 124, "stepname" : "BASE:1", "unit" : "MIX1" }

Return type

steprebind

Example data

Content-Type: application/json
{
  "detail" : "Step rebinding was sent to the Batch Server."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

steprebind
Up 
get /recipeelements
Recipe Elements (recipeElements)

Get the recipe elements for the specified procedure id.

procedureid is the tab delimited procedure path starting with the batch serial number and followed by the optional recipe unit procedure, optional recipe operation. Examples: 123 123\tBASE:1 123\tBASE:1\tMAKE_BASE:1

%09 can be used in place of \t to represent the tab character. Example: 168%09BASE:1%09MAKE_BASE:1

Query parameters

procedureid (required)
Query Parameter — format: int32

Return type

RecipeElements

Example data

Content-Type: application/json
{
  "Abstract" : "FF",
  "Author" : "PROCESS ENGINEER",
  "Description" : "TOOTHPASTE WITH BAKING SODA BASE",
  "Font" : {
    "ClipPrecision" : 2,
    "Escapement" : 0,
    "FontName" : "COURIER NEW",
    "Height" : -110,
    "Italic" : 0,
    "Orientation" : 0,
    "OutPrecision" : 3,
    "PitchAndFamily" : 49,
    "Quality" : 1,
    "StrikeOut" : 0,
    "Underline" : 0,
    "Weight" : 400
  },
  "Identifier" : "MAKE_TOOTHPASTE",
  "ProductCode" : "1002568790",
  "RecipeLinks" : [ {
    "AnchorID" : 19,
    "EndingNodes" : [ 21 ],
    "StartingNodes" : [ 19 ],
    "Type" : "Link"
  }, {
    "AnchorID" : 21,
    "EndingNodes" : [ 23, 33 ],
    "StartingNodes" : [ 21 ],
    "Type" : "AndDivergence"
  }, {
    "AnchorID" : 23,
    "EndingNodes" : [ 27 ],
    "StartingNodes" : [ 23 ],
    "Type" : "EquipmentLink"
  }, {
    "AnchorID" : 33,
    "EndingNodes" : [ 27 ],
    "StartingNodes" : [ 33 ],
    "Type" : "EquipmentLink"
  }, {
    "AnchorID" : 25,
    "EndingNodes" : [ 25 ],
    "StartingNodes" : [ 23, 33 ],
    "Type" : "AndConvergence"
  }, {
    "AnchorID" : 25,
    "EndingNodes" : [ 27 ],
    "StartingNodes" : [ 25 ],
    "Type" : "Link"
  }, {
    "AnchorID" : 27,
    "EndingNodes" : [ 29 ],
    "StartingNodes" : [ 27 ],
    "Type" : "Link"
  }, {
    "AnchorID" : 29,
    "EndingNodes" : [ 31 ],
    "StartingNodes" : [ 29 ],
    "Type" : "Link"
  } ],
  "RecipeStepInitial" : {
    "Fail" : "",
    "ID" : 19,
    "State" : "",
    "Xpos" : 2550,
    "Ypos" : 150
  },
  "RecipeStepParent" : {
    "ActUnit" : "",
    "BindType" : 156451404,
    "CmdMask" : 1296129860,
    "Control" : "UNKNOWN_STATE",
    "ID" : 18,
    "Index" : 154143024,
    "KeyParamValue" : "",
    "Mode" : "UNKNOWN_STATE",
    "Name" : "",
    "RecipeParameters" : [ {
      "Default" : "50",
      "EngineeringUnits" : "GAL",
      "Enumerations" : [ ],
      "High" : "100",
      "Low" : "0",
      "Name" : "FLUORIDE_AMT",
      "ResponseType" : 1,
      "Scope" : 1,
      "Value" : "50"
    }, {
      "Default" : "50",
      "EngineeringUnits" : "LBS",
      "Enumerations" : [ ],
      "High" : "100",
      "Low" : "0",
      "Name" : "GUM_AMT",
      "ResponseType" : 1,
      "Scope" : 1,
      "Value" : "50"
    }, {
      "Default" : "50",
      "EngineeringUnits" : "LBS",
      "Enumerations" : [ ],
      "High" : "100",
      "Low" : "0",
      "Name" : "BAKINGSODA_AMT",
      "ResponseType" : 1,
      "Scope" : 1,
      "Value" : "50"
    }, {
      "Default" : "50",
      "EngineeringUnits" : "LBS",
      "Enumerations" : [ ],
      "High" : "100",
      "Low" : "0",
      "Name" : "PH_AMT",
      "ResponseType" : 1,
      "Scope" : 1,
      "Value" : "50"
    }, {
      "Default" : "50",
      "EngineeringUnits" : "GAL",
      "Enumerations" : [ ],
      "High" : "100",
      "Low" : "0",
      "Name" : "WATER_AMT",
      "ResponseType" : 1,
      "Scope" : 1,
      "Value" : "50"
    }, {
      "Default" : "50",
      "EngineeringUnits" : "GAL",
      "Enumerations" : [ ],
      "High" : "100",
      "Low" : "0",
      "Name" : "FLAVOR_AMT",
      "ResponseType" : 1,
      "Scope" : 1,
      "Value" : "50"
    }, {
      "Default" : "WINTERGREEN",
      "EngineeringUnits" : "FLAVORS",
      "Enumerations" : [ {
        "Name" : "WINTERGREEN",
        "Ordinal" : 0
      }, {
        "Name" : "SPEARMINT",
        "Ordinal" : 1
      }, {
        "Name" : "PEPPERMINT",
        "Ordinal" : 2
      }, {
        "Name" : "BUBBLEGUM",
        "Ordinal" : 3
      } ],
      "High" : " ",
      "Low" : " ",
      "Name" : "FLAVOR",
      "ResponseType" : 5,
      "Scope" : 1,
      "Value" : "WINTERGREEN"
    }, {
      "Default" : "50",
      "EngineeringUnits" : "GAL",
      "Enumerations" : [ ],
      "High" : "100",
      "Low" : "0",
      "Name" : "WHITENER_AMT",
      "ResponseType" : 1,
      "Scope" : 1,
      "Value" : "0.12"
    } ],
    "RecipePath" : "MAKE_TOO.BPC",
    "RecipeReports" : [ ],
    "State" : "",
    "UnitClass" : "",
    "UnitName" : "",
    "X2Pos" : 805908528,
    "XPos" : 30853576,
    "Y2Pos" : 154154249,
    "YPos" : 26673344
  },
  "RecipeStepTerminal" : {
    "ID" : 31,
    "State" : "",
    "Xpos" : 2550,
    "Ypos" : 3900
  },
  "RecipeStepTransitions" : [ {
    "Acquiring" : false,
    "Condition" : "TRUE",
    "Fail" : "",
    "ID" : 21,
    "State" : "IDLE",
    "XPos" : 2700,
    "YPos" : 750
  }, {
    "Acquiring" : false,
    "Condition" : "ADDITIVE:1.STATE = COMPLETE AND BASE:1.STATE = COMPLETE ",
    "Fail" : "",
    "ID" : 25,
    "State" : "IDLE",
    "XPos" : 2700,
    "YPos" : 2100
  }, {
    "Acquiring" : false,
    "Condition" : "FINAL:1.STATE = COMPLETE ",
    "Fail" : "",
    "ID" : 29,
    "State" : "IDLE",
    "XPos" : 2700,
    "YPos" : 3300
  } ],
  "RecipeSteps" : [ {
    "ActUnit" : " ",
    "BindType" : 1,
    "CmdMask" : 0,
    "Control" : " ",
    "ID" : 23,
    "Index" : 0,
    "KeyParamValue" : "",
    "Mode" : " ",
    "Name" : "BASE:1",
    "RecipeParameters" : [ {
      "Default" : "50",
      "EngineeringUnits" : "LBS",
      "Enumerations" : [ ],
      "High" : "100",
      "Low" : "0",
      "Name" : "GUM_AMT",
      "ResponseType" : 1,
      "Scope" : 3,
      "Value" : "0.27"
    }, {
      "Default" : "50",
      "EngineeringUnits" : "LBS",
      "Enumerations" : [ ],
      "High" : "100",
      "Low" : "0",
      "Name" : "PH_AMT",
      "ResponseType" : 1,
      "Scope" : 3,
      "Value" : "0.55"
    }, {
      "Default" : "50",
      "EngineeringUnits" : "GAL",
      "Enumerations" : [ ],
      "High" : "100",
      "Low" : "0",
      "Name" : "WATER_AMT",
      "ResponseType" : 1,
      "Scope" : 3,
      "Value" : "0.78"
    }, {
      "Default" : "50",
      "EngineeringUnits" : "LBS",
      "Enumerations" : [ ],
      "High" : "100",
      "Low" : "0",
      "Name" : "BKSD_AMT",
      "ResponseType" : 1,
      "Scope" : 3,
      "Value" : "0.5"
    }, {
      "Default" : "50",
      "EngineeringUnits" : "GAL",
      "Enumerations" : [ ],
      "High" : "100",
      "Low" : "0",
      "Name" : "FLRD_AMT",
      "ResponseType" : 1,
      "Scope" : 3,
      "Value" : "0.11"
    } ],
    "RecipePath" : "BASE.UPC",
    "RecipeReports" : [ ],
    "State" : "",
    "UnitClass" : "MIXER",
    "UnitName" : "MIX1",
    "X2Pos" : 1784,
    "XPos" : 1200,
    "Y2Pos" : 1629,
    "YPos" : 150
  }, {
    "ActUnit" : " ",
    "BindType" : 1,
    "CmdMask" : 0,
    "Control" : " ",
    "ID" : 33,
    "Index" : 0,
    "KeyParamValue" : "",
    "Mode" : " ",
    "Name" : "ADDITIVE:1",
    "RecipeParameters" : [ {
      "Default" : "50",
      "EngineeringUnits" : " ",
      "Enumerations" : [ ],
      "High" : "100",
      "Low" : "0",
      "Name" : "FLAVOR_AMT",
      "ResponseType" : 1,
      "Scope" : 3,
      "Value" : "0.22"
    }, {
      "Default" : "WINTERGREEN",
      "EngineeringUnits" : "FLAVORS",
      "Enumerations" : [ {
        "Name" : "WINTERGREEN",
        "Ordinal" : 0
      }, {
        "Name" : "SPEARMINT",
        "Ordinal" : 1
      }, {
        "Name" : "PEPPERMINT",
        "Ordinal" : 2
      }, {
        "Name" : "BUBBLEGUM",
        "Ordinal" : 3
      } ],
      "High" : " ",
      "Low" : " ",
      "Name" : "FLAVOR",
      "ResponseType" : 5,
      "Scope" : 3,
      "Value" : "SPEARMINT"
    }, {
      "Default" : "50",
      "EngineeringUnits" : " ",
      "Enumerations" : [ ],
      "High" : "100",
      "Low" : "0",
      "Name" : "WHITENER_AMT",
      "ResponseType" : 1,
      "Scope" : 3,
      "Value" : "0.12"
    } ],
    "RecipePath" : "ADDITIVE.UPC",
    "RecipeReports" : [ ],
    "State" : "",
    "UnitClass" : "MIXER",
    "UnitName" : "MIX2",
    "X2Pos" : 5772,
    "XPos" : 1200,
    "Y2Pos" : 1656,
    "YPos" : 4050
  }, {
    "ActUnit" : " ",
    "BindType" : 1,
    "CmdMask" : 0,
    "Control" : " ",
    "ID" : 27,
    "Index" : 0,
    "KeyParamValue" : "",
    "Mode" : " ",
    "Name" : "FINAL:1",
    "RecipeParameters" : [ ],
    "RecipePath" : "FINAL.UPC",
    "RecipeReports" : [ ],
    "State" : "",
    "UnitClass" : "REACTOR",
    "UnitName" : "REACTFLAVOR",
    "X2Pos" : 3617,
    "XPos" : 2550,
    "Y2Pos" : 2978,
    "YPos" : 1950
  } ],
  "Unit" : "900000\t900000",
  "VersionDate" : "13:02:52 WEDNESDAY, JULY 29, 2020",
  "VersionNum" : "1.0 "
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

RecipeElements
Up 
get /recipelinks
Recipe Links (recipeLinks)

Get the recipe links for the specified procedure id.

procedureid is the tab delimited procedure path starting with the batch serial number and followed by the optional recipe unit procedure, optional recipe operation. Examples: 123 123\tBASE:1 123\tBASE:1\tMAKE_BASE:1

%09 can be used in place of \t to represent the tab character. Example: 168%09BASE:1%09MAKE_BASE:1

Query parameters

procedureid (required)
Query Parameter — format: int32

Return type

array[RecipeLink]

Example data

Content-Type: application/json
[ {
  "AnchorID" : 19,
  "EndingNodes" : [ 21 ],
  "StartingNodes" : [ 19 ],
  "Type" : "Link"
}, {
  "AnchorID" : 21,
  "EndingNodes" : [ 23, 33 ],
  "StartingNodes" : [ 21 ],
  "Type" : "AndDivergence"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
get /recipesteplistitems
Recipe Step List Items (recipeStepListItems)
Get the recipe step list items for the specified batch.

Query parameters

batchserialnumber (required)
Query Parameter — format: int32

Return type

array[recipesteplistitem]

Example data

Content-Type: application/json
[ {
  "CommandMask" : 18944,
  "ElementID" : 34,
  "Failure" : " ",
  "FullStepIdentification" : "",
  "KeyParameterName" : " ",
  "KeyParameterValueEU" : " ",
  "Message" : " ",
  "Mode" : "O-AUTO",
  "Owner" : "BATCH",
  "OwnerID" : 0,
  "OwnerName" : " ",
  "RequestRegister" : 0,
  "S88Type" : 1,
  "ScheduledUnitName" : " ",
  "State" : "READY",
  "StepIndex" : 0,
  "StepName" : "BATCH07122020",
  "UnitName" : " "
}, {
  "CommandMask" : 18944,
  "ElementID" : 34,
  "Failure" : " ",
  "FullStepIdentification" : "",
  "KeyParameterName" : " ",
  "KeyParameterValueEU" : " ",
  "Message" : " ",
  "Mode" : "O-AUTO",
  "Owner" : "BATCH",
  "OwnerID" : 0,
  "OwnerName" : " ",
  "RequestRegister" : 0,
  "S88Type" : 1,
  "ScheduledUnitName" : " ",
  "State" : "READY",
  "StepIndex" : 0,
  "StepName" : "BATCH07122020",
  "UnitName" : " "
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
get /recipesteptransitions
Recipe Step Transitions (recipeStepTransitions)

Get the recipe step transitions for the specified procedure id.

procedureid is the tab delimited procedure path starting with the batch serial number and followed by the optional recipe unit procedure, optional recipe operation. Examples: 123 123\tBASE:1 123\tBASE:1\tMAKE_BASE:1

%09 can be used in place of \t to represent the tab character. Example: 168%09BASE:1%09MAKE_BASE:1

Query parameters

procedureid (required)
Query Parameter — format: int32

Return type

array[RecipeStepTransition1]

Example data

Content-Type: application/json
[ {
  "Acquiring" : false,
  "Condition" : "TRUE",
  "Fail" : "",
  "ID" : 21,
  "State" : "",
  "XPos" : 2700,
  "YPos" : 750
}, {
  "Acquiring" : false,
  "Condition" : "TRUE",
  "Fail" : "",
  "ID" : 21,
  "State" : "",
  "XPos" : 2700,
  "YPos" : 750
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
get /recipesteps
Recipe Steps (recipeSteps)

Get the recipesteps for the specified procedure id.

procedureid is the tab delimited procedure path starting with the batch serial number and followed by the optional recipe unit procedure, optional recipe operation. Examples: 123 123\tBASE:1 123\tBASE:1\tMAKE_BASE:1

%09 can be used in place of \t to represent the tab character. Example: 168%09BASE:1%09MAKE_BASE:1

Query parameters

procedureid (required)
Query Parameter — format: int32

Return type

array[RecipeStep1]

Example data

Content-Type: application/json
[ {
  "ActUnit" : " ",
  "BindType" : 1,
  "CmdMask" : 134217736,
  "Control" : "UNKNOWN_STATE",
  "ID" : 23,
  "Index" : 604582449,
  "KeyParamValue" : "",
  "Mode" : "UNKNOWN_STATE",
  "Name" : "BASE:1",
  "RecipeParameters" : [ {
    "Default" : "50",
    "EngineeringUnits" : "LBS",
    "Enumerations" : [ ],
    "High" : "100",
    "Low" : "0",
    "Name" : "GUM_AMT",
    "ResponseType" : 1,
    "Scope" : 3,
    "Value" : "50"
  }, {
    "Default" : "50",
    "EngineeringUnits" : "LBS",
    "Enumerations" : [ ],
    "High" : "100",
    "Low" : "0",
    "Name" : "PH_AMT",
    "ResponseType" : 1,
    "Scope" : 3,
    "Value" : "50"
  }, {
    "Default" : "50",
    "EngineeringUnits" : "GAL",
    "Enumerations" : [ ],
    "High" : "100",
    "Low" : "0",
    "Name" : "WATER_AMT",
    "ResponseType" : 1,
    "Scope" : 3,
    "Value" : "50"
  }, {
    "Default" : "50",
    "EngineeringUnits" : "LBS",
    "Enumerations" : [ ],
    "High" : "100",
    "Low" : "0",
    "Name" : "BKSD_AMT",
    "ResponseType" : 1,
    "Scope" : 3,
    "Value" : "50"
  }, {
    "Default" : "50",
    "EngineeringUnits" : "GAL",
    "Enumerations" : [ ],
    "High" : "100",
    "Low" : "0",
    "Name" : "FLRD_AMT",
    "ResponseType" : 1,
    "Scope" : 3,
    "Value" : "50"
  } ],
  "RecipePath" : "BASE.UPC",
  "RecipeReports" : [ ],
  "State" : "",
  "UnitClass" : "MIXER",
  "UnitName" : "MIX1",
  "X2Pos" : 1784,
  "XPos" : 1200,
  "Y2Pos" : 1629,
  "YPos" : 150
}, {
  "ActUnit" : " ",
  "BindType" : 1,
  "CmdMask" : 134217736,
  "Control" : "UNKNOWN_STATE",
  "ID" : 23,
  "Index" : 604582449,
  "KeyParamValue" : "",
  "Mode" : "UNKNOWN_STATE",
  "Name" : "BASE:1",
  "RecipeParameters" : [ {
    "Default" : "50",
    "EngineeringUnits" : "LBS",
    "Enumerations" : [ ],
    "High" : "100",
    "Low" : "0",
    "Name" : "GUM_AMT",
    "ResponseType" : 1,
    "Scope" : 3,
    "Value" : "50"
  }, {
    "Default" : "50",
    "EngineeringUnits" : "LBS",
    "Enumerations" : [ ],
    "High" : "100",
    "Low" : "0",
    "Name" : "PH_AMT",
    "ResponseType" : 1,
    "Scope" : 3,
    "Value" : "50"
  }, {
    "Default" : "50",
    "EngineeringUnits" : "GAL",
    "Enumerations" : [ ],
    "High" : "100",
    "Low" : "0",
    "Name" : "WATER_AMT",
    "ResponseType" : 1,
    "Scope" : 3,
    "Value" : "50"
  }, {
    "Default" : "50",
    "EngineeringUnits" : "LBS",
    "Enumerations" : [ ],
    "High" : "100",
    "Low" : "0",
    "Name" : "BKSD_AMT",
    "ResponseType" : 1,
    "Scope" : 3,
    "Value" : "50"
  }, {
    "Default" : "50",
    "EngineeringUnits" : "GAL",
    "Enumerations" : [ ],
    "High" : "100",
    "Low" : "0",
    "Name" : "FLRD_AMT",
    "ResponseType" : 1,
    "Scope" : 3,
    "Value" : "50"
  } ],
  "RecipePath" : "BASE.UPC",
  "RecipeReports" : [ ],
  "State" : "",
  "UnitClass" : "MIXER",
  "UnitName" : "MIX1",
  "X2Pos" : 1784,
  "XPos" : 1200,
  "Y2Pos" : 1629,
  "YPos" : 150
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
get /recipetransitionexpression
Recipe Transition Expression (recipeTransitionExpression)

Get the recipe transition expression for the specified procedure id and transition id.

procedureid is the tab delimited procedure path starting with the batch serial number and followed by the optional recipe unit procedure, optional recipe operation. Examples: 123 123\tBASE:1 123\tBASE:1\tMAKE_BASE:1

%09 can be used in place of \t to represent the tab character. Example: 168%09BASE:1%09MAKE_BASE:1

Query parameters

procedureid (required)
Query Parameter — format: int32
transitionid (required)
Query Parameter — format: int32

Return type

array[recipetransitionexpression]

Example data

Content-Type: application/json
[ {
  "Color" : 255,
  "Left" : "ADDITIVE:1.STATE",
  "LeftValue" : "RUNNING",
  "Oper" : "= ",
  "Right" : "COMPLETE",
  "RightValue" : "COMPLETE"
}, {
  "Color" : 255,
  "Left" : "ADDITIVE:1.STATE",
  "LeftValue" : "RUNNING",
  "Oper" : "= ",
  "Right" : "COMPLETE",
  "RightValue" : "COMPLETE"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Up 
put /steps
Run Step Command (runStepCommand)

run the step command for the specified procedure id. The Step command can be: startstep, holdstep, restartstep, abortstep, stopstep, manualstep, autostep, clearfailures.

procedureid is the tab delimited procedure path starting with the batch serial number and followed by the optional recipe unit procedure, optional recipe operation. Examples: 123 123\tBASE:1 123\tBASE:1\tMAKE_BASE:1

Note that \t must be used for the tab character, not %09 since this is passed in the JSON Body.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RunStepCommandRequest (required)
Body Parameter —
example: { "stepcommand" : "startstep", "procedureid" : "122" }

Return type

stepcommands

Example data

Content-Type: application/json
{
  "detail" : "Step Command was sent to the Batch Server."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

stepcommands
Up 
put /setrecipeparametervalue
Set Recipe Parameter Value (setRecipeParameterValue)

Set a parameter value at the specified recipe step. The step parameter can be at the procedureid level or in the optionally provided stepname level.

procedureid is the tab delimited procedure path starting with the batch serial number and followed by the optional recipe unit procedure, optional recipe operation. Examples: 123 123\tBASE:1 123\tBASE:1\tMAKE_BASE:1

Note that \t must be used for the tab character, not %09 since this is passed in the JSON Body.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SetRecipeParameterValueRequest (required)
Body Parameter —
example: { "procedureid" : "165\tFINAL:1\tMAKE_FNL:1", "stepname" : "AGITATE:1", "parametername" : "TIME", "parametervalue" : "55" }

Return type

setrecipeparametervalue

Example data

Content-Type: application/json
{
  "detail" : "Recipe parameter value was sent to the Batch Server."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

setrecipeparametervalue

RecipeManagementAPI

Up 
post /addrecipe
Add Recipe (addRecipe)

Reads the recipe header information from the database for the given recipe ID and recipe version and adds it to the end of the recipe.dir file. This is useful for creating recipes outside of the Recipe Editor (for example, to copy an existing recipe and change the recipe ID or parameters within the recipe database).

Note that the specified recipe must be stored in the relational database, meaning the recipe file type must be set to SQL in the Batch Execution WorkSpace project.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AddRecipeRequest (required)
Body Parameter —
example: { "recipeid" : "make_toothpaste2", "recipeversion" : 1 }

Return type

AddRecipe

Example data

Content-Type: application/json
{
  "detail" : "Add Recipe was successful."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

AddRecipe
Up 
get /globalformulationheader
Get Global Formulation Header (getGlobalFormulationHeader)

Get the global formulation header for the specified recipe. Recipe version should always be 1.

Note that the specified recipe must be stored in the relational database, meaning the recipe file type must be set to SQL in the Batch Execution WorkSpace project.

Note that VBIS will return the message "VBIS Failed to Find Recipe Specified" even in the case of a bad SQL connection.

Query parameters

recipeid (required)
Query Parameter —
recipeversion (required)
Query Parameter — format: int32

Return type

GetGlobalFormulationHeader

Example data

Content-Type: application/json
{
  "FormulationAuthor" : "Joe",
  "FormulationBatchSize" : "0.0",
  "FormulationDescription" : "",
  "FormulationName" : "GLOBAL_PARAMETERS",
  "FormulationProductCode" : "",
  "FormulationStatus" : 0,
  "FormulationType" : 1,
  "FormulationValid" : true,
  "FormulationVersion" : 1,
  "FormulationVersionDateLocal" : "22:50:28 Sunday, July 26, 2020",
  "FormulationVersionDateUTC" : "2:50:28 Monday, July 27, 2020",
  "MasterRecipeAuditVersion" : 0,
  "RecipeID" : "MAKE_TOOTHPASTE",
  "RecipeVersion" : "1"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

GetGlobalFormulationHeader
Up 
get /productformulationheader
Get Product Formulation Header (getProductFormulationHeader)

Get the product formulation header for the specified formulation name.

Note that the The specified formulation must be stored in the relational database, meaning the formulation file type must be set to SQL in the Batch Execution WorkSpace project.

Note that VBIS will return the message "VBIS Failed to Find Recipe Specified" even in the case of a bad SQL connection.

Query parameters

formulationname (required)
Query Parameter —

Return type

GetProductFormulationHeader

Example data

Content-Type: application/json
{
  "FormulationAuthor" : "Joe",
  "FormulationBatchSize" : "0.0",
  "FormulationDescription" : "My first formula for toothpaste",
  "FormulationName" : "FORMULA1",
  "FormulationProductCode" : "12345",
  "FormulationStatus" : 1,
  "FormulationType" : 0,
  "FormulationValid" : true,
  "FormulationVersion" : 2,
  "FormulationVersionDateLocal" : "22:55:14 Sunday, July 26, 2020",
  "FormulationVersionDateUTC" : "2:55:14 Monday, July 27, 2020",
  "MasterRecipeAuditVersion" : 29,
  "RecipeID" : "MAKE_TOOTHPASTE",
  "RecipeVersion" : "1"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

GetProductFormulationHeader
Up 
get /recipeheader
Get Recipe Header (getRecipeHeader)

Get the recipe header information for the specified recipe. Recipe version should always be 1.

Note that the specified recipe must be stored in the relational database, meaning the recipe file type must be set to SQL in the Batch Execution WorkSpace project.

Note that VBIS will return the message "VBIS Failed to Find Recipe Specified" even in the case of a bad SQL connection.

Query parameters

recipeid (required)
Query Parameter —
recipeversion (required)
Query Parameter — format: int32

Return type

GetRecipeHeader

Example data

Content-Type: application/json
{
  "Abstract" : "ff",
  "ApprovedBy" : "KShay",
  "AreaModelFilename" : "C:\\PROGRAM FILES (X86)\\PROFICY\\PROFICY BATCH EXECUTION\\PROJECTS\\DEMO\\RECIPES\\DEMO.CFG",
  "AreaModelValidatedAgainst" : "11:28:53 Friday, July 24, 2020",
  "Author" : "Process Engineer",
  "BatchRunLength" : "1",
  "BatchSizeDefault" : "1000.",
  "BatchSizeMaximum" : "2000.",
  "BatchSizeMinimum" : "200.",
  "BatchSizeUnits" : "LITERS",
  "DefaultUnit" : "",
  "Description" : "Toothpaste with baking soda base",
  "Equipment" : 0,
  "Graphics" : true,
  "HeaderVersionNumber" : 0,
  "Name" : "",
  "OperatorChangeBindCreate" : true,
  "OperatorChangeBindExecute" : true,
  "ProductCode" : "1002568790",
  "ProductName" : "Bakingsoda Toothpaste",
  "RecipeAuditPerformedByComment" : "",
  "RecipeAuditPerformedByName" : "",
  "RecipeAuditPerformedByTime" : "",
  "RecipeAuditPerformedByUserID" : "",
  "RecipeAuditVerifiedByComment" : "",
  "RecipeAuditVerifiedByName" : "",
  "RecipeAuditVerifiedByTime" : "",
  "RecipeAuditVerifiedByUserID" : "",
  "RecipeAuditVersion" : "32",
  "RecipeID" : "MAKE_TOOTHPASTE",
  "RecipeType" : 0,
  "ReleasedToProduction" : true,
  "ScaleCapacity" : 1,
  "StorageType" : 1,
  "UnitBindMethod" : 1,
  "UnitCapacity" : 0,
  "UnitOfMeasure" : "NONE",
  "ValidationTime" : "11:52:56 Tuesday, July 28, 2020",
  "VersionDate" : "15:52:57 Tuesday, July 28, 2020",
  "VersionNumber" : "1.0 "
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

GetRecipeHeader
Up 
put /rebuildrecipedir
Rebuild recipe.dir (rebuildrecipe.dir)

Reads the recipe header information from the SQL database for all recipes and rewrites the recipe.dir file. This is useful if the recipe.dir file gets corrupted or lost.

The recipes must be stored in the relational database, meaning the recipe file type must be set to SQL in the Batch Execution WorkSpace project.

Return type

Rebuildrecipe.dir

Example data

Content-Type: application/json
{
  "detail" : "Rebuild recipe.dir file was successful."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Rebuildrecipe.dir
Up 
put /resetcontrol
Reset Control (resetControl)

Resets the control recipe and step parameter values to the master recipe and step parameter values.

Note that the specified recipe must be stored in the relational database, meaning the recipe file type must be set to SQL in the Batch Execution WorkSpace project.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ResetControlRequest (required)
Body Parameter —
example: { "recipeid" : "make_toothpaste", "recipeversion" : 1 }

Return type

ResetControl

Example data

Content-Type: application/json
{
  "detail" : "Reset Control was successful."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

ResetControl
Up 
put /updatemasterrecipe
Update Master Recipe (updateMasterRecipe)

Updates the master recipe and step parameter values to the control recipe and step parameter values.

Note that the specified recipes must be stored in the relational database, meaning the recipe file type must be set to SQL in the Batch Execution WorkSpace project.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body UpdateMasterRecipeRequest (required)
Body Parameter —
example: { "recipeid" : "make_toothpaste", "recipeversion" : 1 }

Return type

UpdateMasterRecipe

Example data

Content-Type: application/json
{
  "detail" : "Update Master Recipe was successful."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

UpdateMasterRecipe
Up 
get /verifyrecipe
Verify Recipe (verifyRecipe)

Verify the specified recipe. The recipe version should always be 1.

Note that the specified recipe must be stored in the relational database, meaning the recipe file type must be set to SQL in the Batch Execution WorkSpace project.

Note that VBIS will return the message "VBIS Failed to Find Recipe Specified" even in the case of a bad SQL connection.

Query parameters

recipeid (required)
Query Parameter —
recipeversion (required)
Query Parameter — format: int32

Return type

VerifyRecipe

Example data

Content-Type: application/json
{
  "detail" : "Verify Recipe was successful."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VerifyRecipe

Models

[ Jump to Methods ]

Table of Contents

  1. AcknowledgeBindingPromptRequest - AcknowledgeBindingPromptRequest
  2. AcknowledgeBreakpointPromptRequest - AcknowledgeBreakpointPromptRequest
  3. AcknowledgeEWIPromptRequest - AcknowledgeEWIPromptRequest
  4. AcknowledgeOperatorPromptRequest - AcknowledgeOperatorPromptRequest
  5. AcknowledgeStepBindingPromptRequest - AcknowledgeStepBindingPromptRequest
  6. AcquirePhaseRequest - AcquirePhaseRequest
  7. AddBatchEventRequest - AddBatchEventRequest
  8. AddBatchRequest - AddBatchRequest
  9. AddEWIEvent - AddEWIEvent
  10. AddEWIEventRequest - AddEWIEventRequest
  11. AddRecipe - AddRecipe
  12. AddRecipeRequest - AddRecipeRequest
  13. AddSecurityEventRequest - AddSecurityEventRequest
  14. AreamodelHeader - AreamodelHeader
  15. AuthenticateUserRequest - AuthenticateUserRequest
  16. BatchState - BatchState
  17. BindBatchParameterValuesandUnitBindings - BindBatchParameterValuesandUnitBindings
  18. BindBatchParameterValuesandUnitBindingsRequest - BindBatchParameterValuesandUnitBindingsRequest
  19. ClearBreakpointRequest - ClearBreakpointRequest
  20. Connection - Connection
  21. ControlModule - ControlModule
  22. DataServer - DataServer
  23. DeleteBatch - DeleteBatch
  24. Enumeration - Enumeration
  25. Enumeration1 - Enumeration1
  26. EnumerationSet - EnumerationSet
  27. Font - Font
  28. GetGlobalFormulationHeader - GetGlobalFormulationHeader
  29. GetProductFormulationHeader - GetProductFormulationHeader
  30. GetRecipeHeader - GetRecipeHeader
  31. GetUnitTag - GetUnitTag
  32. Manifold - Manifold
  33. Parameter - Parameter
  34. ParameterTag - ParameterTag
  35. Parametersexampleshowingparametersfromthephasestep. - Parametersexampleshowingparametersfromthephasestep.
  36. Phase - Phase
  37. PhaseCommands - PhaseCommands
  38. PhaseCommandsAndBatchCommands1 - PhaseCommandsAndBatchCommands1
  39. PhaseCommandsRequest - PhaseCommandsRequest
  40. PhaseReport - PhaseReport
  41. Phases2 - Phases2
  42. ProcessCellsWithoutPhase - ProcessCellsWithoutPhase
  43. RebindRequest - RebindRequest
  44. Rebuildrecipe.dir - Rebuildrecipe.dir
  45. RecipeElements - RecipeElements
  46. RecipeLink - RecipeLink
  47. RecipeParameter1 - RecipeParameter1
  48. RecipeParameter2 - RecipeParameter2
  49. RecipeStep - RecipeStep
  50. RecipeStep1 - RecipeStep1
  51. RecipeStepInitial - RecipeStepInitial
  52. RecipeStepParent - RecipeStepParent
  53. RecipeStepTerminal - RecipeStepTerminal
  54. RecipeStepTransition - RecipeStepTransition
  55. RecipeStepTransition1 - RecipeStepTransition1
  56. ReleasePhase - ReleasePhase
  57. ReleasePhaseRequest - ReleasePhaseRequest
  58. ReportParameter - ReportParameter
  59. ReportTag - ReportTag
  60. ResetControl - ResetControl
  61. ResetControlRequest - ResetControlRequest
  62. RunBatchCommandRequest - RunBatchCommandRequest
  63. RunStepCommandRequest - RunStepCommandRequest
  64. SetBreakpointRequest - SetBreakpointRequest
  65. SetRecipeParameterValueRequest - SetRecipeParameterValueRequest
  66. SetUnitTag - SetUnitTag
  67. SetUnitTagRequest - SetUnitTagRequest
  68. Tag - Tag
  69. Tag2 - Tag2
  70. Unit - Unit
  71. UnitsWithoutPhase - UnitsWithoutPhase
  72. UpdateMasterRecipe - UpdateMasterRecipe
  73. UpdateMasterRecipeRequest - UpdateMasterRecipeRequest
  74. VerifyRecipe - VerifyRecipe
  75. about - about
  76. ackbindingprompt - ackbindingprompt
  77. ackbreakpointprompt - ackbreakpointprompt
  78. ackewiprompt - ackewiprompt
  79. ackoperatorprompt - ackoperatorprompt
  80. ackstepbindingprompt - ackstepbindingprompt
  81. acquirephase - acquirephase
  82. activerecipesteplistitem - activerecipesteplistitem
  83. addbatch - addbatch
  84. addbatchevent - addbatchevent
  85. alarm - alarm
  86. authenticateuser - authenticateuser
  87. batch - batch
  88. batchcommandGood - batchcommandGood
  89. bindingprompt - bindingprompt
  90. breakpoint - breakpoint
  91. breakpointprompt - breakpointprompt
  92. clearbreakpoint - clearbreakpoint
  93. ewiprompt - ewiprompt
  94. manifold1 - manifold1
  95. operatorprompt - operatorprompt
  96. recipe - recipe
  97. recipeparameter - recipeparameter
  98. recipesteplistitem - recipesteplistitem
  99. recipetransitionexpression - recipetransitionexpression
  100. recipeunit - recipeunit
  101. setbreakpoint - setbreakpoint
  102. setrecipeparametervalue - setrecipeparametervalue
  103. stepcommands - stepcommands
  104. steprebind - steprebind

AcknowledgeBindingPromptRequest - AcknowledgeBindingPromptRequest Up

eventid
Integer format: int32
promptvalue
String

AcknowledgeBreakpointPromptRequest - AcknowledgeBreakpointPromptRequest Up

breakpointpromptid
Integer format: int32

AcknowledgeEWIPromptRequest - AcknowledgeEWIPromptRequest Up

eventid
Integer format: int32
promptvalue
String

AcknowledgeOperatorPromptRequest - AcknowledgeOperatorPromptRequest Up

eventid
Integer format: int32
promptvalue
String

AcknowledgeStepBindingPromptRequest - AcknowledgeStepBindingPromptRequest Up

batchserialnumber
Integer format: int32
stepname
String
eventid
Integer format: int32
unit
String

AcquirePhaseRequest - AcquirePhaseRequest Up

phaseid
Integer format: int32

AddBatchEventRequest - AddBatchEventRequest Up

batchid
String
value
String
description
String
engineeringunit
String
phasename
String
unitname
String
processcell
String

AddBatchRequest - AddBatchRequest Up

recipeid
String
recipeversion
Integer format: int32
batchid
String
batchscale
BigDecimal
unitbindings
String
parametervalues
String

AddEWIEvent - AddEWIEvent Up

detail
String

AddEWIEventRequest - AddEWIEventRequest Up

batchid
String
ewieventtype
Integer format: int32
ewieventsubtype
Integer format: int32
value
String
phasename
String
unitname
String
processcell
String

AddRecipe - AddRecipe Up

detail
String

AddRecipeRequest - AddRecipeRequest Up

recipeid
String
recipeversion
Integer format: int32

AddSecurityEventRequest - AddSecurityEventRequest Up

signaturetype
Integer format: int32
command
String
computername
String
batchserialnumber
Integer format: int32
batchid
String
performedbyname
String
performedbygroup
String
performedbytimestamp
String
verifiedbyname
String
verifiedbygroup
String
verifiedbytimestamp
String

AreamodelHeader - AreamodelHeader Up

AreaAuditPerformedByComment
String
AreaAuditPerformedByName
String
AreaAuditPerformedByTime
String
AreaAuditPerformedByUserID
String
AreaAuditVerifiedByComment
String
AreaAuditVerifiedByName
String
AreaAuditVerifiedByTime
String
AreaAuditVerifiedByUserID
String
AreaAuditVersion
String
Name
String
Revision
String

AuthenticateUserRequest - AuthenticateUserRequest Up

username
String
password
String
securitygroup
String

BatchState - BatchState Up

BatchState
String
BatchStateValue
Integer format: int32

BindBatchParameterValuesandUnitBindings - BindBatchParameterValuesandUnitBindings Up

detail
String

BindBatchParameterValuesandUnitBindingsRequest - BindBatchParameterValuesandUnitBindingsRequest Up

batchserialnumber
Integer format: int32
unitbindings
String
parametervalues
String

ClearBreakpointRequest - ClearBreakpointRequest Up

breakpointid
Integer format: int32

Connection - Connection Up

Destination
String
DestinationType
Integer format: int32
EquipmentID
Integer format: int32
Label
String
MaxOwners
Integer format: int32
Name
String
NeededEquipment
array[String]
Source
String
SourceType
Integer format: int32

ControlModule - ControlModule Up

ClassName
String
EquipmentID
Integer format: int32
MaxOwners
Integer format: int32
Name
String
NeededEquipment
array[String]

DataServer - DataServer Up

Application
String
BadValue
String
DefaultServerFlag
Boolean
Name
String
Topic
String
Type
Integer format: int32
Watchdog
String

DeleteBatch - DeleteBatch Up

detail
String

Enumeration - Enumeration Up

Name (optional)
String
Ordinal (optional)
Integer format: int32

Enumeration1 - Enumeration1 Up

Name
String
Ordinal
Integer format: int32

EnumerationSet - EnumerationSet Up

Enumerations
array[Enumeration1]
Name
String

Font - Font Up

ClipPrecision
Integer format: int32
Escapement
Integer format: int32
FontName
String
Height
Integer format: int32
Italic
Integer format: int32
Orientation
Integer format: int32
OutPrecision
Integer format: int32
PitchAndFamily
Integer format: int32
Quality
Integer format: int32
StrikeOut
Integer format: int32
Underline
Integer format: int32
Weight
Integer format: int32

GetGlobalFormulationHeader - GetGlobalFormulationHeader Up

FormulationAuthor
String
FormulationBatchSize
String
FormulationDescription
String
FormulationName
String
FormulationProductCode
String
FormulationStatus
Integer format: int32
FormulationType
Integer format: int32
FormulationValid
Boolean
FormulationVersion
Integer format: int32
FormulationVersionDateLocal
String
FormulationVersionDateUTC
String
MasterRecipeAuditVersion
Integer format: int32
RecipeID
String
RecipeVersion
String

GetProductFormulationHeader - GetProductFormulationHeader Up

FormulationAuthor
String
FormulationBatchSize
String
FormulationDescription
String
FormulationName
String
FormulationProductCode
String
FormulationStatus
Integer format: int32
FormulationType
Integer format: int32
FormulationValid
Boolean
FormulationVersion
Integer format: int32
FormulationVersionDateLocal
String
FormulationVersionDateUTC
String
MasterRecipeAuditVersion
Integer format: int32
RecipeID
String
RecipeVersion
String

GetRecipeHeader - GetRecipeHeader Up

Abstract
String
ApprovedBy
String
AreaModelFilename
String
AreaModelValidatedAgainst
String
Author
String
BatchRunLength
String
BatchSizeDefault
String
BatchSizeMaximum
String
BatchSizeMinimum
String
BatchSizeUnits
String
DefaultUnit
String
Description
String
Equipment
Integer format: int32
Graphics
Boolean
HeaderVersionNumber
Integer format: int32
Name
String
OperatorChangeBindCreate
Boolean
OperatorChangeBindExecute
Boolean
ProductCode
String
ProductName
String
RecipeAuditPerformedByComment
String
RecipeAuditPerformedByName
String
RecipeAuditPerformedByTime
String
RecipeAuditPerformedByUserID
String
RecipeAuditVerifiedByComment
String
RecipeAuditVerifiedByName
String
RecipeAuditVerifiedByTime
String
RecipeAuditVerifiedByUserID
String
RecipeAuditVersion
String
RecipeID
String
RecipeType
Integer format: int32
ReleasedToProduction
Boolean
ScaleCapacity
Integer format: int32
StorageType
Integer format: int32
UnitBindMethod
Integer format: int32
UnitCapacity
Integer format: int32
UnitOfMeasure
String
ValidationTime
String
VersionDate
String
VersionNumber
String

GetUnitTag - GetUnitTag Up

Class
String
Name
String
Type
Integer format: int32
Value
String

Manifold - Manifold Up

EquipmentID (optional)
Integer format: int32
IconFilename (optional)
String
MaxOwners (optional)
Integer format: int32
Name (optional)
String
NeededEquipment (optional)
array[String]

Parameter - Parameter Up

EngineeringUnits (optional)
String
Enumerations (optional)
array[Enumeration]
HighLimit (optional)
String
ID (optional)
Integer format: int32
LowLimit (optional)
String
Name (optional)
String
Scalable (optional)
Boolean
Type (optional)
Integer format: int32
Value (optional)
String

ParameterTag - ParameterTag Up

ClassName (optional)
String
DataType (optional)
Integer format: int32
ItemName (optional)
String
Name (optional)
String
TagType (optional)
Integer format: int32

Parametersexampleshowingparametersfromthephasestep. - Parametersexampleshowingparametersfromthephasestep. Up

EngineeringUnits
String
Enumerations
array[String]
HighLimit
String
ID
Integer format: int32
LowLimit
String
Name
String
Scalable
Boolean
Type
Integer format: int32
Value
String

Phase - Phase Up

ClassName
String
CommandTagName
String
EquipmentID
Integer format: int32
FailureTagName
String
MaxOwners
Integer format: int32
Name
String
NeededEquipment
array[String]
OwnerTagName
String
ParameterTags
array[ParameterTag]
Parameters
array[Parameter]
PauseTagName
String
PausedTagName
String
PhaseReports
array[PhaseReport]
ReportTags
array[ReportTag]
RequestTagName
String
RequestTags
array[String]
SingleStepTagName
String
StatusTagName
String
StepIndexTagName
String
UnitIDTagName
String
Units
array[String]

PhaseCommands - PhaseCommands Up

detail
String

PhaseCommandsAndBatchCommands1 - PhaseCommandsAndBatchCommands1 Up

detail
String
error_code
Integer format: int32
status
String
title
String
type
String

PhaseCommandsRequest - PhaseCommandsRequest Up

phaseid
Integer format: int32
unitname
String
batchid
String
phasecommand
String

PhaseReport - PhaseReport Up

EngineeringUnits (optional)
String
ID (optional)
Integer format: int32
Name (optional)
String
Type (optional)
Integer format: int32

Phases2 - Phases2 Up

ArbMask
String
BatchID
String
ClassName
String
CmdMask
String
CommandTagName
String
CurrentUnit
String
EquipmentID
Integer format: int32
Failure
String
FailureTagName
String
MaxOwners
Integer format: int32
Mode
String
Msg
String
Name
String
NeededEquipment
array[String]
Owner
String
OwnerTagName
String
ParameterTags
array[ParameterTag]
Parameters
array[Parameter]
Pause
String
PauseTagName
String
PausedTagName
String
PhaseReports
array[PhaseReport]
ReportTags
array[ReportTag]
RequestTagName
String
RequestTags
array[String]
SingleStepTagName
String
State
String
StatusTagName
String
Step
Integer format: int32
StepIndexTagName
String
UnitID
Integer format: int32
UnitIDTagName
String
Units
array[String]
ValidUnits
array[String]

ProcessCellsWithoutPhase - ProcessCellsWithoutPhase Up

Connections
array[Connection]
EquipmentID
Integer format: int32
HMIPicture
String
Manifolds
array[Manifold]
MaxOwners
Integer format: int32
Name
String
Units
array[Unit]

RebindRequest - RebindRequest Up

batchserialnumber
Integer format: int32
stepname
String
unit
String

Rebuildrecipe.dir - Rebuildrecipe.dir Up

detail
String

RecipeElements - RecipeElements Up

Abstract
String
Author
String
Description
String
Font
Font
Identifier
String
ProductCode
String
RecipeLinks
array[RecipeLink]
RecipeStepInitial
RecipeStepInitial
RecipeStepParent
RecipeStepParent
RecipeStepTerminal
RecipeStepTerminal
RecipeStepTransitions
array[RecipeStepTransition]
RecipeSteps
array[RecipeStep]
Unit
String
VersionDate
String
VersionNum
String

RecipeLink - RecipeLink Up

AnchorID
Integer format: int32
EndingNodes
array[Integer] format: int32
StartingNodes
array[Integer] format: int32
Type
String
Type
String

RecipeParameter1 - RecipeParameter1 Up

Default
String
EngineeringUnits
String
Enumerations
array[Enumeration]
High
String
Low
String
Name
String
ResponseType
Integer format: int32
Scope
Integer format: int32
Value
String

RecipeParameter2 - RecipeParameter2 Up

Default (optional)
String
EngineeringUnits (optional)
String
Enumerations (optional)
array[Enumeration]
High (optional)
String
Low (optional)
String
Name (optional)
String
ResponseType (optional)
Integer format: int32
Scope (optional)
Integer format: int32
Value (optional)
String

RecipeStep - RecipeStep Up

ActUnit
String
BindType
Integer format: int32
CmdMask
Integer format: int32
Control
String
ID
Integer format: int32
Index
Integer format: int32
KeyParamValue
String
Mode
String
Name
String
RecipeParameters
array[RecipeParameter2]
RecipePath
String
RecipeReports
array[String]
State
String
UnitClass
String
UnitName
String
X2Pos
Integer format: int32
XPos
Integer format: int32
Y2Pos
Integer format: int32
YPos
Integer format: int32

RecipeStep1 - RecipeStep1 Up

ActUnit
String
BindType
Integer format: int32
CmdMask
Integer format: int32
Control
String
ID
Integer format: int32
Index
Integer format: int32
KeyParamValue
String
Mode
String
Name
String
RecipeParameters
array[RecipeParameter2]
RecipePath
String
RecipeReports
array[String]
State
String
UnitClass
String
UnitName
String
X2Pos
Integer format: int32
XPos
Integer format: int32
Y2Pos
Integer format: int32
YPos
Integer format: int32

RecipeStepInitial - RecipeStepInitial Up

Fail
String
ID
Integer format: int32
State
String
Xpos
Integer format: int32
Ypos
Integer format: int32

RecipeStepParent - RecipeStepParent Up

ActUnit
String
BindType
Integer format: int32
CmdMask
Integer format: int32
Control
String
ID
Integer format: int32
Index
Integer format: int32
KeyParamValue
String
Mode
String
Name
String
RecipeParameters
array[RecipeParameter1]
RecipePath
String
RecipeReports
array[String]
State
String
UnitClass
String
UnitName
String
X2Pos
Integer format: int32
XPos
Integer format: int32
Y2Pos
Integer format: int32
YPos
Integer format: int32

RecipeStepTerminal - RecipeStepTerminal Up

ID
Integer format: int32
State
String
Xpos
Integer format: int32
Ypos
Integer format: int32

RecipeStepTransition - RecipeStepTransition Up

Acquiring
Boolean
Condition
String
Fail
String
ID
Integer format: int32
State
String
XPos
Integer format: int32
YPos
Integer format: int32

RecipeStepTransition1 - RecipeStepTransition1 Up

Acquiring
Boolean
Condition
String
Fail
String
ID
Integer format: int32
State
String
XPos
Integer format: int32
YPos
Integer format: int32

ReleasePhase - ReleasePhase Up

detail
String

ReleasePhaseRequest - ReleasePhaseRequest Up

phaseid
Integer format: int32

ReportParameter - ReportParameter Up

EngineeringUnits
String
Enumerations
array[String]
HighLimit
String
ID
Integer format: int32
LowLimit
String
Name
String
Scalable
Boolean
Type
Integer format: int32
Value
String

ReportTag - ReportTag Up

ClassName (optional)
String
DataType (optional)
Integer format: int32
ItemName (optional)
String
Name (optional)
String
TagType (optional)
Integer format: int32

ResetControl - ResetControl Up

detail
String

ResetControlRequest - ResetControlRequest Up

recipeid
String
recipeversion
Integer format: int32

RunBatchCommandRequest - RunBatchCommandRequest Up

batchserialnumber
Integer format: int32
batchcommand
String

RunStepCommandRequest - RunStepCommandRequest Up

stepcommand
String
procedureid
String

SetBreakpointRequest - SetBreakpointRequest Up

batchserialnumber
Integer format: int32
transitionid
Integer format: int32

SetRecipeParameterValueRequest - SetRecipeParameterValueRequest Up

procedureid
String
stepname
String
parametername
String
parametervalue
String

SetUnitTag - SetUnitTag Up

detail
String

SetUnitTagRequest - SetUnitTagRequest Up

unitname
String
unittagclassname
String
value
String

Tag - Tag Up

ClassName (optional)
String
DataType (optional)
Integer format: int32
ItemName (optional)
String
Name (optional)
String
TagType (optional)
Integer format: int32

Tag2 - Tag2 Up

ClassName
String
DataType
Integer format: int32
ItemName
String
Name
String
TagType
Integer format: int32

Unit - Unit Up

Capacity
Integer format: int32
ClassName
String
DefaultPriority
Integer format: int32
EquipmentID
Integer format: int32
HMIPicture
String
MaxOwners
Integer format: int32
Name
String
NeededEquipment
array[String]
ReadyFlag
Boolean
Tags
array[Tag]
UOM
String

UnitsWithoutPhase - UnitsWithoutPhase Up

Capacity
Integer format: int32
ClassName
String
DefaultPriority
Integer format: int32
EquipmentID
Integer format: int32
HMIPicture
String
MaxOwners
Integer format: int32
Name
String
NeededEquipment
array[String]
ReadyFlag
Boolean
Tags
array[Tag]
UOM
String

UpdateMasterRecipe - UpdateMasterRecipe Up

detail
String

UpdateMasterRecipeRequest - UpdateMasterRecipeRequest Up

recipeid
String
recipeversion
Integer format: int32

VerifyRecipe - VerifyRecipe Up

detail
String

about - about Up

Name
String

ackbindingprompt - ackbindingprompt Up

detail
String

ackbreakpointprompt - ackbreakpointprompt Up

detail
String

ackewiprompt - ackewiprompt Up

detail
String

ackoperatorprompt - ackoperatorprompt Up

detail
String

ackstepbindingprompt - ackstepbindingprompt Up

detail
String

acquirephase - acquirephase Up

detail
String

activerecipesteplistitem - activerecipesteplistitem Up

CommandMask
Integer format: int32
ElementID
Integer format: int32
Failure
String
FullStepIdentification
String
KeyParameterName
String
KeyParameterValueEU
String
Message
String
Mode
String
Owner
String
OwnerID
Integer format: int32
OwnerName
String
RequestRegister
Integer format: int32
S88Type
Integer format: int32
ScheduledUnitName
String
State
String
StepIndex
Integer format: int32
StepName
String
UnitName
String

addbatch - addbatch Up

batchserialnumber
Integer format: int32
detail
String

addbatchevent - addbatchevent Up

detail
String

alarm - alarm Up

ArbitrationSet
String
BatchID
String
FailMsg
String
Mode
String
Owner
String
PhaseID
String
PhaseMsg
String
PhaseName
String
PhaseState
String
UnitID
String
UnitName
String
ValidUnitList
String

authenticateuser - authenticateuser Up

FullName
String
ResolvedPrincipal
String
detail
String

batch - batch Up

BatchBound
String
BatchDescription
String
BatchID
String
BatchMode
String
BatchSerialNumber
String
BatchState
String
CommandMask
String
DefaultBind
String
ElapsedTime
String
Failures
String
OperatorBindParameters
String
OperatorBindUnits
String
OperatorInteraction
String
ParametersRequired
String
ParametersSupplied
String
PhaseList
String
ProcessCellList
String
RecipeAuditVersion
String
RecipeName
String
RecipeVersion
String
Scale
String
StartTime
String
Type
String
UnitList
String
UnitsRequired
String
UnitsSupplied
String

batchcommandGood - batchcommandGood Up

detail
String

bindingprompt - bindingprompt Up

Area
String
BatchID
String
BatchSerialNumber
String
BindingUnits
array[String]
DefaultUnit
String
Description
String
EngineeringUnits
String
Event
String
EventID
String
Phase
String
ProcessCell
String
Recipe
String
StepName
String
Time
String
Unit
String
UnitClass
String
Value
String

breakpoint - breakpoint Up

BatchID
String
BatchSerialNumber
String
Expression
String
ID
String
Recipe
String
TransitionID
String

breakpointprompt - breakpointprompt Up

BatchID
String
BatchSerialNumber
String
BreakpointID
String
Expression
String
ID
String
Recipe
String
TransitionID
String

clearbreakpoint - clearbreakpoint Up

detail
String

ewiprompt - ewiprompt Up

AreaModel
String
BatchID
String
BatchSerialNumber
String
EventID
String
FileName
String
FileVersion
String
Phase
String
ProcessCell
String
Recipe
String
Time
String
Unit
String

manifold1 - manifold1 Up

EquipmentID
Integer format: int32
IconFilename
String
MaxOwners
Integer format: int32
Name
String
NeededEquipment
array[String]

operatorprompt - operatorprompt Up

Area
String
BatchID
String
Default
String
EU
String
EquipmentDescription
String
EventID
String
EventType
String
High
String
Low
String
Phase
String
ProcCell
String
Recipe
String
RespType
String
Time
String
Unit
String
Value
String

recipe - recipe Up

Author
String
ProductID
String
RecipeAuditVersion
String
RecipeDescription
String
RecipeFilename
String
RecipeID
String
RecipeProductName
String
RecipeReleased
String
RecipeStorageType
String
RecipeType
String
RecipeVersion
String
TimeStamp
String

recipeparameter - recipeparameter Up

EngineeringUnits
String
Enumerations
array[Enumeration]
HighLimit
String
ID
Integer format: int32
LowLimit
String
Name
String
Scalable
Boolean
Type
Integer format: int32
Value
String

recipesteplistitem - recipesteplistitem Up

CommandMask
Integer format: int32
ElementID
Integer format: int32
Failure
String
FullStepIdentification
String
KeyParameterName
String
KeyParameterValueEU
String
Message
String
Mode
String
Owner
String
OwnerID
Integer format: int32
OwnerName
String
RequestRegister
Integer format: int32
S88Type
Integer format: int32
ScheduledUnitName
String
State
String
StepIndex
Integer format: int32
StepName
String
UnitName
String

recipetransitionexpression - recipetransitionexpression Up

Color
Integer format: int32
Left
String
LeftValue
String
Oper
String
Right
String
RightValue
String

recipeunit - recipeunit Up

DefaultUnitName
String
StepName
String
UnitList
array[String]

setbreakpoint - setbreakpoint Up

detail
String

setrecipeparametervalue - setrecipeparametervalue Up

detail
String

stepcommands - stepcommands Up

detail
String

steprebind - steprebind Up

detail
String