General Lesen

pixiTagGet

Liefert Tag-Definitionen, die in einem Zeitraum angelegt wurden, optional gefiltert nach Tag-Typ, inklusive Name des Tag-Typs.

Liefert die in Pixi definierten Tags (Tabelle Tag) zusammen mit ihrem Tag-Typ (TagType).

DateFrom / DateTo filtern auf das Anlagedatum des Tags (RecordCreatedOn, an beiden Grenzen inklusive). Ohne DateFrom wird das Anlagedatum des ältesten Tags verwendet, ohne DateTo das aktuelle Datum mit Uhrzeit.
TypeId schränkt das Ergebnis auf einen Tag-Typ ein. Ohne Angabe werden Tags aller Typen geliefert.
RowCount begrenzt die Anzahl der Zeilen (Standard 1000, auch bei Übergabe von NULL).

Es werden nur Tags geliefert, deren TypeId in TagType vorhanden ist (Inner Join). Sortiert wird aufsteigend nach TagId.

Hinweise

Alle Lesezugriffe erfolgen mit NOLOCK, daher können nicht festgeschriebene Daten geliefert werden.
Die Datumsparameter sind smalldatetime (Minutengenauigkeit); Sekunden werden gerundet.
Es gibt keinen Offset-Parameter. Für große Datenmengen den Zeitraum eingrenzen oder RowCount erhöhen.
Geliefert werden nur die Tag-Definitionen, nicht die Zuordnungen von Tags zu Objekten.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`RowCount`	int	1000	Maximale Anzahl gelieferter Zeilen. `NULL` wird als 1000 behandelt. Beispiel: `500`
`DateFrom`	smalldatetime dateTime	NULL	Beginn des Zeitraums für das Anlagedatum (inklusive). Bei `NULL` wird das Anlagedatum des ältesten Tags verwendet. Beispiel: `2024-01-01T00:00:00`
`DateTo`	smalldatetime dateTime	NULL	Ende des Zeitraums für das Anlagedatum (inklusive). Bei `NULL` wird das aktuelle Datum mit Uhrzeit verwendet. Beispiel: `2024-12-31T23:59:00`
`TypeId`	int	NULL	ID des Tag-Typs (`TagType.Id`), nach dem gefiltert wird. `NULL` liefert Tags aller Typen. Beispiel: `1`

Antwort

Result-Set 1 · Immer

Eine Zeile je Tag, das den Filtern entspricht, sortiert nach TagId.

Spalte	Typ	Beschreibung
`TagId`	int	ID des Tags.
`Name` Kann leer sein	string	Name des Tags.
`Description` Kann leer sein	string	Beschreibung des Tags.
`IsSystemTag` Kann leer sein	boolean	Kennzeichen, ob es sich um ein System-Tag handelt.
`CreateDate` Kann leer sein	dateTime	Anlagedatum des Tags (`Tag.RecordCreatedOn`).
`TypeId`	int	ID des Tag-Typs.
`TypeName` Kann leer sein	string	Name des Tag-Typs (`TagType.Name`).

Beispielantwort

<SqlRowSet1>
  <row>
    <TagId>1</TagId>
    <Name>Express</Name>
    <Description>Express shipping requested</Description>
    <IsSystemTag>false</IsSystemTag>
    <CreateDate>2024-03-12T09:15:00</CreateDate>
    <TypeId>1</TypeId>
    <TypeName>Order</TypeName>
  </row>
  <row>
    <TagId>2</TagId>
    <Name>Fragile</Name>
    <Description>Handle with care</Description>
    <IsSystemTag>true</IsSystemTag>
    <CreateDate>2024-03-14T11:40:00</CreateDate>
    <TypeId>2</TypeId>
    <TypeName>Item</TypeName>
  </row>
</SqlRowSet1>

Beispiele

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:pixiTagGet>
      <!-- <RowCount>500</RowCount> -->
      <!-- <DateFrom>2024-01-01T00:00:00</DateFrom> -->
      <!-- <DateTo>2024-12-31T23:59:00</DateTo> -->
      <!-- <TypeId>1</TypeId> -->
    </ns1:pixiTagGet>
  </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:pixiTagGet>
      <!-- <RowCount>500</RowCount> -->
      <!-- <DateFrom>2024-01-01T00:00:00</DateFrom> -->
      <!-- <DateTo>2024-12-31T23:59:00</DateTo> -->
      <!-- <TypeId>1</TypeId> -->
    </ns1:pixiTagGet>
  </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 = [
    // 'RowCount' => '500',
    // 'DateFrom' => '2024-01-01T00:00:00',
    // 'DateTo' => '2024-12-31T23:59:00',
    // 'TypeId' => '1',
];

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

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

Verwendete Tabellen

Tag · Lesen TagType · Lesen

SQL-Objekt:: dbo.pipiTagGet