Method: networks.shipments.path.commit

Überschreibt den Versandpfad und gibt an, dass dieser in Zukunft nicht mehr geändert werden kann, auch nicht durch den Nutzer. Ausgenommen davon sind höhere Gewalt bzw. höhere Gewalt, wie sie durch die Methoden „vehicles.makeUnavailable, hubs.makeUnavailable, lines.makeUnavailable“ gekennzeichnet wird. Diese Methode wird nicht verwendet, um eine bestimmte Version eines Pfads mit einem Tag zu versehen.

HTTP-Anfrage

POST https://middlemileoptimization.googleapis.com/v1/{name=networks/*/shipments/*}/path:commit

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Der Name der Sendung, für die ein Commit durchgeführt werden muss. Format: „networks/{network}/shipments/{shipment}“

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{

  // Union field path_to_commit can be only one of the following:
  "completeShipmentPath": {
    object (PathToCommit)
  },
  "segments": {
    object (IncompletePathToCommit)
  }
  // End of list of possible types for union field path_to_commit.
}
Felder
Union-Feld path_to_commit. Der Pfad oder Teile des Pfads, für den ein Commit durchgeführt werden soll. Für path_to_commit ist nur einer der folgenden Werte zulässig:
completeShipmentPath

object (PathToCommit)

Die Segmente eines Pfads von einer Quelle zum Ziel.

segments

object (IncompletePathToCommit)

Eine Teilmenge der Segmente eines Pfads von einer Quelle zum Ziel.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Path.

PathToCommit

Vollständiger Pfad wird per Commit übertragen, von der Quelle zum Ziel.

JSON-Darstellung
{
  "segments": [
    {
      object (PathSegment)
    }
  ]
}
Felder
segments[]

object (PathSegment)

Erforderlich. Segmente müssen geordnet sein, von der Quelle bis zum Ziel.

IncompletePathToCommit

Teil des Pfads, für den ein Commit durchgeführt wird, d.h. einige Segmente zwischen Quelle und Ziel.

JSON-Darstellung
{
  "segments": [
    {
      object (PathSegment)
    }
  ]
}
Felder
segments[]

object (PathSegment)

Erforderlich. Eine Teilmenge der Segmente eines Pfads von einer Quelle zum Ziel.