DataSphere API v2, REST: Community.list
List communities in specified organization.
HTTP request
GET https://datasphere.api.cloud.yandex.net/datasphere/v2/communities
Query parameters
Parameter | Description |
---|---|
pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. |
pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. |
nameOrDescriptionPattern | Community name or description pattern. Only communities with names or descriptions matching specified pattern will be returned. |
ownedById | ID of the user. Only communities owned by specified user will be returned. |
listPublic | If set to true, only public communities will be returned. |
organizationId | Required. ID of the organization to list communities in. |
Response
HTTP Code: 200 - OK
{
"communities": [
{
"id": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"createdById": "string",
"organizationId": "string",
"zoneId": "string"
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
communities[] | object List of communities matching filters in list communities request. |
communities[]. id |
string ID of the community. |
communities[]. createdAt |
string (date-time) Time when community was created. String in RFC3339 text format. The range of possible values is from 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). |
communities[]. name |
string Name of the community. |
communities[]. description |
string Description of the comminuty. |
communities[]. labels |
object Labels of the community. |
communities[]. createdById |
string ID of the user who created the community. |
communities[]. organizationId |
string ID of the organization to which community belongs. |
communities[]. zoneId |
string ID of the zone where this community was created |
nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |