Skip to content

data acquisition API 0.7

mlaboszc edited this page May 24, 2016 · 1 revision

Overview

Api endpoints for managing request states when uploading file to HDFS

Contact information

License information

License: Apache License Version 2.0 License URL: http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host: das.branch-v07-nokrb.gotapaas.eu BasePath: /

Tags

  • rest-data-acquisition-service: Rest Data Acquisition Service
  • callbacks-service: Callbacks Service

Paths

Updates downloader status

POST /rest/das/callbacks/downloader/{id}

Description

Privilege level: Consumer of this endpoint must be a member of organization based on valid access token

Parameters

Type Name Description Required Schema Default
BodyParameter status status true DownloadStatus
PathParameter id id true string

Responses

HTTP Code Description Schema
200 OK string
500 Internal server error, see logs for details No Content

Consumes

  • application/json

Produces

  • /

Tags

  • callbacks-service

Updates metadata status

POST /rest/das/callbacks/metadata/{id}

Description

Privilege level: Consumer of this endpoint must be a member of organization based on valid access token

Parameters

Type Name Description Required Schema Default
BodyParameter status status true MetadataParseStatus
PathParameter id id true string

Responses

HTTP Code Description Schema
200 OK string
500 Internal server error, see logs for details No Content

Consumes

  • application/json

Produces

  • /

Tags

  • callbacks-service

Updates uploader status

POST /rest/das/callbacks/uploader

Description

Privilege level: Consumer of this endpoint must be a member of organization based on valid access token

Parameters

Type Name Description Required Schema Default
BodyParameter requestDto requestDto true RequestDTO

Responses

HTTP Code Description Schema
200 OK string
500 Internal server error, see logs for details No Content

Consumes

  • application/json

Produces

  • /

Tags

  • callbacks-service

Get acquisition requests for all file transfers

GET /rest/das/requests

Description

Privilege level: Consumer of this endpoint must be a member of organization based on valid access token

Parameters

Type Name Description Required Schema Default
QueryParameter orgs orgs false string

Responses

HTTP Code Description Schema
200 OK object array array
401 Unauthorized No Content
403 Can't access this organization. No Content
500 Internal server error, see logs for details. No Content

Consumes

  • application/json

Produces

  • /

Tags

  • rest-data-acquisition-service

Add new acquisition request for file transfer

POST /rest/das/requests

Description

Privilege level: Consumer of this endpoint must be a member of organization based on valid access token

Parameters

Type Name Description Required Schema Default
BodyParameter requestDto requestDto true RequestDTO

Responses

HTTP Code Description Schema
200 OK RequestDTO
202 Accepted RequestDTO
401 Unauthorized No Content
403 Can't access this organization. No Content
500 Internal server error, see logs for details. No Content

Consumes

  • application/json

Produces

  • /

Tags

  • rest-data-acquisition-service

Delete specific acquisition request with given id

DELETE /rest/das/requests/{id}

Description

Privilege level: Consumer of this endpoint must be a member of organization based on valid access token

Parameters

Type Name Description Required Schema Default
PathParameter id id true string

Responses

HTTP Code Description Schema
200 OK DefaultResponse
401 Unauthorized No Content
403 Can't access this organization. No Content
500 Internal server error, see logs for details No Content

Consumes

  • application/json

Produces

  • /

Tags

  • rest-data-acquisition-service

Get specific acquisition request of file transfer with given id

GET /rest/das/requests/{id}

Description

Privilege level: Consumer of this endpoint must be a member of organization based on valid access token

Parameters

Type Name Description Required Schema Default
PathParameter id id true string

Responses

HTTP Code Description Schema
200 OK RequestDTO
401 Unauthorized No Content
403 Can't access this organization. No Content
500 Internal server error, see logs for details. No Content

Consumes

  • application/json

Produces

  • /

Tags

  • rest-data-acquisition-service

Definitions

DefaultResponse

Name Description Required Schema Default
message false string

DownloadStatus

Name Description Required Schema Default
downloadedBytes false integer (int64)
id false string
objectStoreId false string
savedObjectId false string
source false string
state false string

Map«string,long»

MetadataParseStatus

Name Description Required Schema Default
description false string
state false enum (DONE, FAILED)

RequestDTO

Name Description Required Schema Default
category false string
id false string
idInObjectStore false string
orgUUID false string
publicRequest false boolean
source false string
state false enum (NEW, VALIDATED, DOWNLOADED, FINISHED, ERROR)
timestamps false object
title false string
userId false integer (int32)
Clone this wiki locally