General Read

pixiGetPixiVersion

Returns the database change log entries that carry a revision number, newest revision first, to determine the installed Pixi version.

Reads the database change log (DB_change_log) and returns every entry whose revision is not NULL.

The call has no parameters.
Rows are sorted by revision in descending order. Sorting is numeric per segment: the revision string is split at . and every segment is left-padded with zeros to 7 digits, so 6.10.2 ranks above 6.9.15.
The first row therefore holds the highest revision, which a caller can use as the current Pixi version.

Notes

The table is read with NOLOCK, so uncommitted entries may be visible.
All matching rows are returned without paging; the result can be long. Take the first row if only the current version is needed.
Segments longer than 7 characters are not padded and can distort the sort order. Non-numeric segments are sorted as text.
The column types are not visible in the code, because the definition of DB_change_log is not attached.

Parameters

This call has no parameters.

Response

Result set 1 · Always

Change log entries with a revision, sorted by revision descending (segment-wise numeric).

Column	Type	Description
`objectName` Nullable	string	Name of the database object that was changed.
`revision`	string	Revision or version number of the change, dot-separated, e.g. `6.20.3`.
`scriptName` Nullable	string	Name of the update script that applied the change.
`updateEmp` Nullable	string	Employee or user who applied the change.
`updateDate` Nullable	dateTime	Date and time when the change was applied.

Response example

<SqlRowSet1>
  <row>
    <objectName>pipiGetItemInfo</objectName>
    <revision>23.11.2</revision>
    <scriptName>update_23.11.2.sql</scriptName>
    <updateEmp>dbo</updateEmp>
    <updateDate>2023-11-14T09:12:45.000+01:00</updateDate>
  </row>
  <row>
    <objectName>pipiReadOrder</objectName>
    <revision>23.11.1</revision>
    <scriptName>update_23.11.1.sql</scriptName>
    <updateEmp>dbo</updateEmp>
    <updateDate>2023-11-02T08:30:10.000+01:00</updateDate>
  </row>
</SqlRowSet1>

Examples

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiGetPixiVersion/>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiGetPixiVersion/>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiGetPixiVersion', $soapArguments);

Tables used

DB_change_log · Read

SQL object:: dbo.pipiGetPixiVersion