Group Files

Operations related to the group's files. A group is a figure that allows several users to work with the same files so, any user in that group will be able to reference them in their submissions.

Group Files

GET http://biostudy-prod.ebi.ac.uk:8788/files/groups/{groupName}/{path}

Lists all the files in the specified path.

Path Parameters

Name
Type
Description

groupName

string

The name of the group to list the files

path

string

The path in which files will be listed. If empty, the root group directory will be listed.

Headers

Name
Type
Description

X-SESSION-TOKEN

string

User authentication token

[{
  "name": "file1.txt",
  "path": "folder/file1.txt",
  "size": 34,
  "type": "FILE"
}, {
  "name": "file2.txt",
  "path": "file1.txt",
  "size": 36,
  "type": "FILE"
}]

Group Files

POST http://biostudy-prod.ebi.ac.uk:8788/files/groups/{groupName}/{path}

Uploads a file to the group directory in the given path

Path Parameters

Name
Type
Description

groupName

string

The name of the group to upload the files

path

string

The path where the file will be uploaded inside the group folder

Headers

Name
Type
Description

X-SESSION-TOKEN

string

User authentication token

OK

Group Folder

POST http://biostudy-prod.ebi.ac.uk:8788/folder/groups/{groupName}/{path}

Creates a folder inside the group's directory.

Path Parameters

Name
Type
Description

groupName

string

The name of the group to create the folder

path

string

Path of the new folder

Headers

Name
Type
Description

X-SESSION-TOKEN

string

User token authentication

OK

Delete Group File

DELETE http://biostudy-prod.ebi.ac.uk:8788/files/groups/{groupName}/{path}

Delete the given file contained in the given path and with the given name. Example: curl -X DELETE \ -H "X-SESSION-TOKEN: <authToken>" \ -f "fileName=file.txt" \ http://biostudy-prod.ebi.ac.uk:8788/files/groups/arrayexpress/the/path/to/file

Path Parameters

Name
Type
Description

groupName

string

The name of the group which holds the file to be deleted

path

string

The path of the directory that contains the file to be deleted

Headers

Name
Type
Description

X-SESSION-TOKEN

string

User token authentication

Request Body

Name
Type
Description

fileName

string

Name of the file to be deleted

OK

Last updated

Was this helpful?