V3_MiddlewareAccess_GetByXml (Get)

Summary

Get data by submitting an XML request that specifies a stored procedure.

Parameters

Name	Description	Data Type
xmlRequest	Required. The XML string contents. See Specifying MES Stored Procedures in a MiddlewareAccess XML Endpoint for a description of the XML string contents.	string

Request Headers

Name	Description
trans_id	Used to supply the ID of the transaction if the call is taking part in a transaction.
max_rows	Used to supply the maximum number of rows that will be returned by the get.

200 Response

The response body is of type object.

The endpoint returns a JSON array that represents the data in the dataset that is returned by the MES middleware.

Remarks

This endpoint retrieves data by submitting an XML request to the MES middleware to call a stored procedure.

The following Get methods (in the XML, message types) are supported:

GetAll
GetByKey
GetSpecific

For information about datetime and decimal separator requirements when passed in strings, see the overview topic "Datetime and Decimal Format Requirements."

Example

General Format

The following examples show the general format for how to specify none, one, or more parameters.

A stored procedure that takes no parameters:
fullyqualifiedhostname/mesmw/api/v3/MiddlewareAccess/xml?xmlRequest=<request><object>table_name</object><cmd>commandname</cmd><msgtype>messagetype</msgtype></request>

A stored procedure that takes one parameter:
fullyqualifiedhostname/mesmw/api/v3/MiddlewareAccess/xml?xmlRequest=<request><object>table_name</object><cmd>commandname</cmd><msgtype>messagetype</msgtype><param_1>value</param_1></request>

A stored procedure that takes two parameters:
fullyqualifiedhostname/mesmw/api/v3/MiddlewareAccess/xml?xmlRequest=<request><object>table_name</object><cmd>commandname</cmd><msgtype>messagetype</msgtype><param_1>value</param_1><param_2>value</param_2></request>

Specific Example

To get utilization reasons using reas_cd and reas_desc as filters:
fullyqualifiedhostname/mesmw/api/v3/MiddlewareAccess/xml?xmlRequest=<request><object>util_reas</object><cmd>getall</cmd><msgtype>getall</msgtype><reas_cd>1</reas_cd><reas_desc>Running</reas_desc></request>

Response body:
[{"reas_cd":1,"reas_desc":"Running","reas_grp_id":0,"reas_grp_desc":"Example Util. Reason Group","state_cd":1,"state_desc":"RUNNING","color":65280,
"runtime":true,"downtime":false,"setuptime":false,"teardowntime":false,"fixedtime":false,"vartime":true,"failure":false,"def_lab_cd":null,"lab_desc":null,
"display_seq":2,"priority":1,"max_duration":null,"new_reas_cd":null,"standard_time":null,"min_time":null,"max_time":null,"ent_enabled":true,
"category1":null,"category2":null,"category3":null,"category4":null,"spare1":null,"spare2":null,"spare3":null,"spare4":null,
"last_edit_comment":null,"last_edit_by":"DomainAAA\\Userzzz","last_edit_at":"2020-04-23T14:25:11Z"}]

MES Web API V3