Method: nodes.devices.patch
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
PATCH https://sasportal.googleapis.com/v1alpha1/{device.name=nodes/*/devices/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
device.name |
string
Output only. The resource path name.
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Fields to be updated. This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
|
Request body
The request body contains an instance of Device.
Response body
If successful, the response body contains an instance of Device.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/sasportal
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-12-05 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eThis operation updates a device's information using an HTTP PATCH request to a specific URL.\u003c/p\u003e\n"],["\u003cp\u003eThe request should include path and query parameters, and the body should contain the updated device data in JSON format, as per the Device object specification.\u003c/p\u003e\n"],["\u003cp\u003eA successful response will return the updated Device object, indicating the changes have been applied.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required using the \u003ccode\u003ehttps://www.googleapis.com/auth/sasportal\u003c/code\u003e OAuth scope for this operation to be permitted.\u003c/p\u003e\n"]]],["This document details updating a device via a PATCH request to a specified URL using gRPC Transcoding. The request targets a device resource identified by its path (`device.name`). Modifications are made using the `updateMask` query parameter, which dictates the fields to be updated. The request body holds the updated `Device` instance, and upon successful execution, the response body returns the modified `Device` data. Authorization requires the `sasportal` OAuth scope.\n"],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n\nUpdates a [device](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device).\n\nHTTP request\n\n`PATCH https://sasportal.googleapis.com/v1alpha1/{device.name=nodes/*/devices/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|---------------|-----------------------------------------------|\n| `device.name` | `string` Output only. The resource path name. |\n\nQuery parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask)` format)` Fields to be updated. This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n\nRequest body\n\nThe request body contains an instance of [Device](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device).\n\nResponse body\n\nIf successful, the response body contains an instance of [Device](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device).\n\nAuthorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/sasportal`"]]