PGS Catalog logo
API docs by Redocly

PGS Submission Service API (0.1.0)

Download OpenAPI specification:

E-mail: pgs-info@ebi.ac.uk URL: https://github.com/PGScatalog/pgs_submission_service License: Apache 2.0

API for submitting data to the PGS Submission Service.

Authentication

See authentication.md for instructions on generating tokens.

Validate metadata file

Upload a file to validate its metadata. Returns validation results including errors, warnings, and score names.

Authorizations:
BearerAuth
Request Body schema: multipart/form-data
required
file
required
string <binary>

File to be validated. Expected to be a .xlsx file containing PGS submission metadata.

Responses

Response samples

Content type
application/json
{
  • "valid": true,
  • "errorMessages": {
    },
  • "warningMessages": {
    },
  • "scoreNames": [
    ]
}

Create a Globus directory

Creates a directory in Globus for a given unique ID and email address.

Authorizations:
BearerAuth
Request Body schema: application/json
required
unique_id
required
string >= 8 characters

Unique identifier for the directory (minimum 8 characters)

email_address
required
string <email>

Valid email address of the user

Responses

Request samples

Content type
application/json
{
  • "unique_id": "stringst",
  • "email_address": "user@example.com"
}

Response samples

Content type
application/json
{
  • "globusOriginID": "string"
}

Deactivate and delete a Globus directory

Authorizations:
BearerAuth
path Parameters
unique_id
required
string

Unique identifier of the directory

Responses

Response samples

Content type
application/json
{
  • "message": "Endpoint deactivated successfully."
}

Get contents of a Globus directory

Authorizations:
BearerAuth
path Parameters
unique_id
required
string

Unique identifier of the directory

Responses

Response samples

Content type
application/json
{
  • "unique_id": "string",
  • "data": { }
}