Common Parameters

There are some special parameters that can be passed either in the header of the call or as a parameter in the URL.

trans_id

The transaction ID to be used with the call. If a trans_id is provided and the transaction referenced no longer exists, the call will fail.

The trans_id parameter can be included in the call's header (using the format trans_id:transIdString) or as an input parameter in the URL (using the format trans_id=transIdString). If the trans_id parameter is included both in header and in the URL, the header takes precedence over the value in the URL. In that case, only the transaction ID supplied in the header is considered.

trans_id In header example

User-Agent: Fiddler
Content-Type: application/json; charset=utf-8
Host: fullyqualifiedhostname
Content-Length: 466
trans_id: c1bec0bd-ce03-4b2c-89e2-8573f11c6d5a

trans_id in URL example

https://fullyqualifiedhostname/mesmw/api/v3/entity?trans_id=c1bec0bd-ce03-4b2c-89e2-8573f11c6d5a

tz_id

The time zone identifier. In general, all datetime parameters and returned values are passed in UTC format. However, if the endpoint is a Get that is passing a date parameter without a suffix to be translated to the specified time zone, you can provide the tz_id parameter to specify the date's time zone. The value for this parameter is a Microsoft time zone identifier. If a time zone is supplied in the call, then the time is handled by the middleware as a local time. Otherwise, if no time zone is supplied or it is invalid, the UTC time is used.

If the tz_id parameter is included both in header and in the URL, the header takes precedence over the value in the URL. In that case, only the time zone supplied in the header is considered.

tz_id in header example

User-Agent: Fiddler
Content-Type: application/json; charset=utf-8
Host: fullyqualifiedhostname
tz_Id: Egypt Standard Time

tz_id in URL example

https://fullyqualifiedhostname/mesmw/api/v3/Sample?tz_Id=India%20Standard%20Time

max_rows

 For any Gets, specifies the maximum number of records to include in the retrieved data. Specifying a maximum number of rows can avoid performance issues when retrieving a large number of records.

• If max_rows is supplied in both the header and the URL, the value in the header is used.
• If max_rows is not supplied in the header or the URL, then the value for the MES middleware Max Data Set Rows setting will be used.
• Setting max_rows to 0 or less returns all records that match the specified filters, regardless of the middleware setting.

max_rows in header example

User-Agent: Fiddler
Content-Type: application/json; charset=utf-8
Host: fullyqualifiedhostname
max_rows: 200

max_rows in URL example

https://fullyqualifiedhostname/mesmw/api/v3/Cause?max_rows=200