Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Create a new harvester for given group

POST /groups/{id}/harvesters

Creates a new harvester for a specific group.

This operation requires group_add_harvester privilege. For administrator who does not belong to this group oz_groups_add_relationships and oz_harvesters_create privileges are required.

Example cURL requests

Create new harvester for group

curl -u admin:password -H "Content-type: application/json" \
-X POST -d '{ "name" : "new_harvester", "harvestingBackendEndpoint" : "example.elastic.com:9200", "harvestingBackendType" : "elasticsearch_harvesting_backend"  \
"config" : { "typeMapping": [ { "id": 0, "name": "Type 1" }, { "id": 1, "name": "Type 1" } ],
             "externalHelpLink": "http://example.com/some_help_page",
             "refreshDataTimeout": 1000 }, \
https://$HOST/api/v3/onezone/groups/$GROUP_ID/harvesters

Path parameters

Parameter	Type & Description
id required	string Group Id.

Request body

Harvester properties.

Property

Type & Description

name

string

The name of the harvester.

harvestingBackendType

string

Type of external harvesting backend that will provide persistence and analytics for harvested metadata. Can be chosen from predefined backends and optionally custom ones configured by Onezone admins. Can be omitted if default harvester backend is set up in Onezone.

harvestingBackendEndpoint

string

Endpoint where the specified harvesting backend can be reached by Onezone to feed incoming metadata and perform queries. Can be omitted if default harvester backend is set up in Onezone.

guiPluginConfig

object (HarvesterGuiPluginConfig)

Custom JSON configuration passed to harvester GUI plugin.

guiPluginConfig required

object

Request Examples

application/json

{
  "name": "My private harvester",
  "harvestingBackendType": "elasticsearch_harvesting_backend",
  "harvestingBackendEndpoint": "example.elastic.com:9200",
  "guiPluginConfig": {
    "typeMapping": [
      {
        "id": 0,
        "name": "Type 1"
      },
      {
        "id": 1,
        "name": "Type 1"
      }
    ],
    "externalHelpLink": "http://example.com/some_help_page",
    "refreshDataTimeout": 1000
  }
}

Responses

application/json

204

Id of the created harvester in the form /groups/{id}/harvesters/{hid} is returned in the response Location header.

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."
  }
}

403

Forbidden 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."
  }
}

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."
  }
}