Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get harvester details

GET /spaces/{id}/harvesters/{hid}

Returns details about a specific harvester in a space.

This operation requires any of the following authentication:

as user who has space_view privilege in the space ({id}),
as provider that supports the space ({id}),
as user who has oz_harvesters_view admin privilege.

Example cURL requests

Get space harvester details

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

{
  "harvesterId": "2c0160248ba9a66f45da751ca459535a",
  "name": "new_harvester1",
  "public" : true,
  "harvestingBackendType" : "elasticsearch_harvesting_backend",
  "harvestingBackendEndpoint" : "example.elastic.com:9200",
  "creator": {
    "type": "user",
    "id": "7434b256e71e1052e0d5e3e9da657ebf"
  },
  "creationTime": 1576152793
}

Path parameters

Parameter	Type & Description
id required	string Space Id.
hid required	string Harvester Id.

Request Examples

Shell

onezone-rest-cli getSpaceHarvester id=b752ceafabb662b4e5728b2ded25cdd1 hid=f1c8b1a37aa7447b22eb65a742d40524

Responses

application/json

200

Details of a specific harvester in a space.

Property Type & Description

harvesterId

string

Unique harvester Id.

name

string

The name of the harvester.

public

boolean

Whether given harvester is public. More on public harvesters: Query harvester index

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.

creator

object (Subject)

Object representing a subject in the system, can be perceived as client (actor) identity.

type string Type of the subject Enum: nobodyuseroneprovider
id string Id of the subject (`null` for nobody)

creationTime

integer (Timestamp)

Timestamp in seconds (UNIX epoch), e.g. 1563819329.

Example

application/json

{
  "harvesterId": "5989b9476b7d1b2f955c65efb24c0917",
  "name": "Test harvester",
  "public": true,
  "harvestingBackendType": "elasticsearch_harvesting_backend",
  "harvestingBackendEndpoint": "example.elastic.com:9200",
  "creator": {
    "type": "user",
    "id": "7434b256e71e1052e0d5e3e9da657ebf"
  },
  "creationTime": 1576152793
}

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