Related Resources
Paginated related resources for the current user by default, or team-scoped when uploaded_by_team is set. Filter by related_resource_type, related_resource_type_label, or search.
Token-based authentication with required prefix "Token"
Sort field; prefix with - for descending. Allowed: uploaded_date, label.
Page number (1-based).
Items per page (max 2000).
Filter by related resource type primary key.
Filter by type label (case-insensitive). Use Other for resources whose type is not JournalArticle, Dataset, or Image.
Substring match on resource label or linked sample IGSN.
When set, list resources uploaded by this team.
123http://api.example.org/accounts/?page=4http://api.example.org/accounts/?page=2GET /api/related-resources/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"count": 1,
"next": "text",
"previous": "text",
"data": [
{
"id": 1,
"label": "text",
"description": "text",
"related_resource_type": "text",
"uri": "text",
"uri_type": "text",
"file_type": "text",
"uploaded_date": "2026-01-01T00:00:00.000Z"
}
],
"page_size": 1,
"current_page": 1,
"total_pages": 1
}
]
}Creates a related resource from a file upload (multipart) or URI metadata (JSON). Ownership defaults to the current user unless uploaded_by_team is set.
Token-based authentication with required prefix "Token"
POST /api/related-resources/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 225
{
"label": "text",
"description": "text",
"related_resource_type": "text",
"uri": "text",
"uri_type": "text",
"file_type": "text",
"file_size": 1,
"uploaded_date": "2026-01-01T00:00:00.000Z",
"uploaded_by_team": 1,
"file": "https://example.com"
}{
"data": {
"id": 1,
"label": "text",
"description": "text",
"related_resource_type": "text",
"uri": "text",
"uri_type": "text",
"file_type": "text",
"uploaded_date": "2026-01-01T00:00:00.000Z"
}
}Token-based authentication with required prefix "Token"
GET /api/related-resources/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"id": 1,
"label": "text",
"description": "text",
"related_resource_type": "text",
"uri": "text",
"uri_type": "text",
"file_type": "text",
"uploaded_date": "2026-01-01T00:00:00.000Z"
}
}Deletes the resource, subtracts storage quota, and removes the local file when applicable.
Token-based authentication with required prefix "Token"
DELETE /api/related-resources/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"success": true
}
}Token-based authentication with required prefix "Token"
PATCH /api/related-resources/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 225
{
"label": "text",
"description": "text",
"related_resource_type": "text",
"uri": "text",
"uri_type": "text",
"file_type": "text",
"file_size": 1,
"uploaded_date": "2026-01-01T00:00:00.000Z",
"uploaded_by_team": 1,
"file": "https://example.com"
}{
"data": {
"id": 1,
"label": "text",
"description": "text",
"related_resource_type": "text",
"uri": "text",
"uri_type": "text",
"file_type": "text",
"uploaded_date": "2026-01-01T00:00:00.000Z"
}
}Bulk link or unlink samples to a related resource. Use sample_ids or select_all with filters to resolve the sample set.
Token-based authentication with required prefix "Token"
Whether to link or unlink the resolved samples.
Related resource primary key.
Sample primary keys to link or unlink.
When true, apply filters to resolve samples instead of sample_ids.
falseInvalid action or no samples to process.
Insufficient permission on this resource.
Related resource not found.
Unexpected error while updating sample links.
POST /api/related-resources/{id}/{action}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 82
{
"sample_ids": [
1
],
"select_all": false,
"filters": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}{
"data": {
"message": "text",
"count": 1
}
}Last updated
Was this helpful?