Method: deployments.devices.patch
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
PATCH https://sasportal.googleapis.com/v1alpha1/{device.name=deployments/*/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\u003eUpdates an existing device within a deployment using an HTTP PATCH request.\u003c/p\u003e\n"],["\u003cp\u003eThe request must target a specific device using its resource path in the URL.\u003c/p\u003e\n"],["\u003cp\u003eYou can specify fields to update with the \u003ccode\u003eupdateMask\u003c/code\u003e query parameter using FieldMask format.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain the updated device details in the Device object format, and the response will return the updated device if successful.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/sasportal\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["This document details the process of updating a device via a `PATCH` request to a specific URL: `https://sasportal.googleapis.com/v1alpha1/{device.name=deployments/*/devices/*}`. The `device.name` is a required path parameter. Optional updates are specified using the `updateMask` query parameter. The request body must contain a `Device` instance. A successful operation returns a `Device` instance in the response body. This operation requires the `https://www.googleapis.com/auth/sasportal` OAuth scope for authorization.\n"],null,["# Method: deployments.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=deployments/*/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`"]]