| editable | sourcePath |
|---|---|
false |
en/_api-ref/datasphere/v2/api-ref/Community/update.md |
Updates specified community.
PATCH https://datasphere.{{ api-host }}/datasphere/v2/communities/{communityId}
#| ||Field | Description || || communityId | string
Required field. ID of the community. || |#
{
"updateMask": "string",
"name": "string",
"description": "string",
"labels": "object"
}#| ||Field | Description || || updateMask | string (field-mask)
A comma-separated names off ALL fields to be updated.
Only the specified fields will be changed. The others will be left untouched.
If the field is specified in updateMask and no value for that field was sent in the request,
the field's value will be reset to the default. The default value for most fields is null or 0.
If updateMask is not sent in the request, all fields' values will be updated.
Fields specified in the request will be updated to provided values.
The rest of the fields will be reset to the default. ||
|| name | string
Name of the community. || || description | string
Description of the community. || || labels | object (map<string, string>)
Labels of the community. || |#
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 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.
To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || 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 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.
To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || done | boolean
If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available. ||
|| metadata | UpdateCommunityMetadata
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. || || error | Status
The error result of the operation in case of failure or cancellation.
Includes only one of the fields error, response.
The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set. ||
|| response | Community
The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.
Includes only one of the fields error, response.
The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set. ||
|#
#| ||Field | Description || || communityId | string
ID of the community that is being updated. || |#
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. || |#
#| ||Field | Description || || id | string
ID of the community. || || createdAt | string (date-time)
Time when community was created.
String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.
To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || 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 || |#