editable | sourcePath |
---|---|
false |
en/_api-ref/datasphere/v2/api-ref/Community/get.md |
Returns community.
GET https://datasphere.{{ api-host }}/datasphere/v2/communities/{communityId}
#| ||Field | Description || || communityId | string
Required field. ID of the community. || |#
HTTP Code: 200 - OK
{
"id": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"createdById": "string",
"organizationId": "string",
"zoneId": "string"
}
#| ||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 || |#