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. 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/userinfo.email
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 documentation outlines how to update a device using the Spectrum Access System API with a \u003ccode\u003ePATCH\u003c/code\u003e request to a specified endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe request involves path and query parameters, including \u003ccode\u003edevice.name\u003c/code\u003e for device identification and \u003ccode\u003eupdateMask\u003c/code\u003e for specifying fields to update.\u003c/p\u003e\n"],["\u003cp\u003eBoth the request and response bodies utilize the \u003ccode\u003eDevice\u003c/code\u003e object, detailed in external documentation.\u003c/p\u003e\n"],["\u003cp\u003eProper authorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/userinfo.email\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document details updating a device via a PATCH request to a specified URL. The URL utilizes gRPC Transcoding and includes a `device.name` path parameter. The `updateMask` query parameter specifies which fields to modify, while the request body carries the updated `Device` instance. A successful response returns the modified `Device`. The action needs `https://www.googleapis.com/auth/userinfo.email` authorization scope.\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/customers.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://github.com/googleapis/googleapis/blob/master/google/api/http.proto) 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](/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask)` format)` Fields to be updated. 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/customers.devices#Device).\n\n### Response body\n\nIf successful, the response body contains an instance of [Device](/spectrum-access-system/reference/rest/customers.devices#Device).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/userinfo.email`"]]