Page Summary
-
Makes a line available by sending a POST request to the specified URL.
-
The request body can optionally include the periods when availability will start.
-
If the request is successful, the response includes the line name and updated paths.
-
The request utilizes gRPC Transcoding syntax and requires path parameters for network and line identification.
Makes a line available.
HTTP request
POST https://middlemileoptimization.googleapis.com/v1/{name=networks/*/lines/*}:makeAvailable
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
name |
Required. The name of the line to make available. Format: "networks/{network}/lines/{line}" |
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{
"availabilityStarts": [
{
object ( |
| Fields | |
|---|---|
availability |
Required. The periods where availability will start. They must be points in time in the future. If this field is absent, availability starts when the message is received. |
Response body
The response message for lines.makeAvailable method.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"name": string,
"path": [
{
object ( |
| Fields | |
|---|---|
name |
The name of the line whose unavailability was updated. Format: "networks/{network}/lines/{line}" |
path[] |
The paths that were updated. |