DataSphere API v2, REST: Community.Update
Updates specified community.
HTTP request
PATCH https://datasphere.api.cloud.yandex.net/datasphere/v2/communities/{communityId}
Path parameters
Field |
Description |
communityId |
string Required field. ID of the community. |
Body parameters
{
"updateMask": "object",
"name": "string",
"description": "string",
"labels": "object"
}
Field |
Description |
updateMask |
object (field-mask) A comma-separated names off ALL fields to be updated. If |
name |
string Name of the community. |
description |
string Description of the community. |
labels |
object (map<string, string>) Labels of the community. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"communityId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"createdById": "string",
"organizationId": "string",
"zoneId": "string"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateCommunityMetadata
Field |
Description |
communityId |
string ID of the community that is being updated. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |
Community
Field |
Description |
id |
string ID of the community. |
createdAt |
string (date-time) Time when community was created. String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Name of the community. |
description |
string Description of the comminuty. |
labels |
object (map<string, string>) Labels of the community. |
createdById |
string ID of the user who created the community. |
organizationId |
string ID of the organization to which community belongs. |
zoneId |
string ID of the zone where this community was created |