-
Notifications
You must be signed in to change notification settings - Fork 9
data acquisition API 0.7
Api endpoints for managing request states when uploading file to HDFS
License: Apache License Version 2.0 License URL: http://www.apache.org/licenses/LICENSE-2.0
Host: das.branch-v07-nokrb.gotapaas.eu BasePath: /
- rest-data-acquisition-service: Rest Data Acquisition Service
- callbacks-service: Callbacks Service
POST /rest/das/callbacks/downloader/{id}
Privilege level: Consumer of this endpoint must be a member of organization based on valid access token
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
| BodyParameter | status | status | true | DownloadStatus | |
| PathParameter | id | id | true | string |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | string |
| 500 | Internal server error, see logs for details | No Content |
- application/json
- /
- callbacks-service
POST /rest/das/callbacks/metadata/{id}
Privilege level: Consumer of this endpoint must be a member of organization based on valid access token
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
| BodyParameter | status | status | true | MetadataParseStatus | |
| PathParameter | id | id | true | string |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | string |
| 500 | Internal server error, see logs for details | No Content |
- application/json
- /
- callbacks-service
POST /rest/das/callbacks/uploader
Privilege level: Consumer of this endpoint must be a member of organization based on valid access token
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
| BodyParameter | requestDto | requestDto | true | RequestDTO |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | string |
| 500 | Internal server error, see logs for details | No Content |
- application/json
- /
- callbacks-service
GET /rest/das/requests
Privilege level: Consumer of this endpoint must be a member of organization based on valid access token
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
| QueryParameter | orgs | orgs | false | string |
| 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 |
- application/json
- /
- rest-data-acquisition-service
POST /rest/das/requests
Privilege level: Consumer of this endpoint must be a member of organization based on valid access token
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
| BodyParameter | requestDto | requestDto | true | RequestDTO |
| 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 |
- application/json
- /
- rest-data-acquisition-service
DELETE /rest/das/requests/{id}
Privilege level: Consumer of this endpoint must be a member of organization based on valid access token
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
| PathParameter | id | id | true | string |
| 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 |
- application/json
- /
- rest-data-acquisition-service
GET /rest/das/requests/{id}
Privilege level: Consumer of this endpoint must be a member of organization based on valid access token
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
| PathParameter | id | id | true | string |
| 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 |
- application/json
- /
- rest-data-acquisition-service
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
| message | false | string |
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
| downloadedBytes | false | integer (int64) | ||
| id | false | string | ||
| objectStoreId | false | string | ||
| savedObjectId | false | string | ||
| source | false | string | ||
| state | false | string |
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
| description | false | string | ||
| state | false | enum (DONE, FAILED) |
| 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) |