Method: customers.devices.patch
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
PATCH https://sasportal.googleapis.com/v1alpha1/{device.name=customers/*/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.
[null,null,["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eUpdates a specific device's information within the Spectrum Access System.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires providing the device's resource path name as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eYou can optionally specify fields to update using the \u003ccode\u003eupdateMask\u003c/code\u003e query parameter and a FieldMask format.\u003c/p\u003e\n"],["\u003cp\u003eThe request body and successful response both contain a \u003ccode\u003eDevice\u003c/code\u003e object representing the device's details.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization necessitates the \u003ccode\u003ehttps://www.googleapis.com/auth/sasportal\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document outlines the process for updating a device via a PATCH request to the specified URL: `https://sasportal.googleapis.com/v1alpha1/{device.name=customers/*/devices/*}`. The device's name is a required path parameter. Updates are specified through the `updateMask` query parameter, using comma-separated field names. The request body includes the `Device` instance data. A successful operation returns an updated `Device` instance in the response body. `https://www.googleapis.com/auth/sasportal` authorization scope is required.\n"],null,["# Method: customers.devices.patch\n\n- [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\n### HTTP request\n\n`PATCH https://sasportal.googleapis.com/v1alpha1/{device.name=customers/*/devices/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-----------------------------------------------|\n| `device.name` | `string` Output only. The resource path name. |\n\n### Query 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\n### Request body\n\nThe request body contains an instance of [Device](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device).\n\n### Response body\n\nIf successful, the response body contains an instance of [Device](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/sasportal`"]]