Method: networks.shipments.path.commit

Confirma la ruta de un envío indicando que no puede ser modificado en el futuro, ni siquiera por el usuario, excepto por fuerza mayor o acto fortuito que se indique en los métodos Vehicles.makeUnavailable, hubs.make sueño y líneas.makeUnavailable. Este método no se usa para etiquetar una revisión en particular de una ruta de acceso.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. El nombre del envío cuya ruta debe confirmarse. Formato: “networks/{network}/shipments/{shipment}”

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{

  // 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.
}
Campos
Campo de unión path_to_commit. La ruta o las partes de la ruta que se deben confirmar. Las direcciones (path_to_commit) solo pueden ser una de las siguientes opciones:
completeShipmentPath

object (PathToCommit)

Son los segmentos de una ruta desde un origen hasta un destino.
segments

object (IncompletePathToCommit)

Es un subconjunto de los segmentos de una ruta desde un origen hasta un destino.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Path.

PathToCommit

La ruta de acceso completa que se confirma, desde el origen hasta el destino.

Representación JSON 
{
  "segments": [
    {
      object (PathSegment)
    }
  ]
}
Campos
segments[]

object (PathSegment)

Obligatorio. Los segmentos deben estar en orden desde el origen hasta el destino.

IncompletePathToCommit

Parte de la ruta que se confirma, es decir, algunos segmentos entre el origen y el destino.

Representación JSON 
{
  "segments": [
    {
      object (PathSegment)
    }
  ]
}
Campos
segments[]

object (PathSegment)

Obligatorio. Es un subconjunto de los segmentos de una ruta desde un origen hasta un destino.