Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

List harvester groups

GET /harvesters/{id}/groups

Returns the list of groups belonging to a specific harvester.

This operation requires harvester_view privilege in the harvester.

For administrator who does not belong to the harvester, oz_harvesters_list_relationships privilege is required.

Example cURL requests

Get harvester groups

curl -u username:password -X GET \
https://$HOST/api/v3/onezone/harvesters/$HARVESTER_ID/groups

{
  "groups": [
    "f1c8b1a37aa7447b22eb65a742d40524",
    "8e1cea0b379e3683257c32f896d55115"
  ]
}

Path parameters

Parameter	Type & Description
id required	string Harvester Id.

Request Examples

Shell

onezone-rest-cli listHarvesterGroups id=b752ceafabb662b4e5728b2ded25cdd1

Responses

application/json

200

The list of all group Ids that belong to a specific harvester

Property	Type & Description
groups array of strings The list of group Ids.

Example

application/json

{
  "groups": [
    "1d24c36707d99197c6cd995810a43aca",
    "6825604b0eb6a47b8b7a04b6369eb24d"
  ]
}

400

Invalid request.

Property

Type & Description

error

object

Object describing an error.

id required string String identifying the error type. Does not change between error instances.
description required string Human readable error description. May contain information specific to given error instance.
details object Details about the error instance. The object schema is specific to each error type.

Example

application/json

{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}

401

Authentication error.

Property

Type & Description

error

object

Object describing an error.

id required string String identifying the error type. Does not change between error instances.
description required string Human readable error description. May contain information specific to given error instance.
details object Details about the error instance. The object schema is specific to each error type.

Example

application/json

{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}

403

Authorization error.

Property

Type & Description

error

object

Object describing an error.

id required string String identifying the error type. Does not change between error instances.
description required string Human readable error description. May contain information specific to given error instance.
details object Details about the error instance. The object schema is specific to each error type.

Example

application/json

{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}

404

Resource not found.

Property

Type & Description

error

object

Object describing an error.

id required string String identifying the error type. Does not change between error instances.
description required string Human readable error description. May contain information specific to given error instance.
details object Details about the error instance. The object schema is specific to each error type.

Example

application/json

{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}

500

Internal server Error.

Property

Type & Description

error

object

Object describing an error.

id required string String identifying the error type. Does not change between error instances.
description required string Human readable error description. May contain information specific to given error instance.
details object Details about the error instance. The object schema is specific to each error type.

Example

application/json

{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}