{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "http:\/\/localhost" } ], "info": { "name": "Laravel API Documentation", "_postman_id": "ca026c5a-15e9-4b5d-9fcb-6160129c2a5d", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Endpoints", "description": "", "item": [ { "name": "GET api\/user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user", "query": [], "raw": "{{baseUrl}}\/api\/user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "GA4GH DRS API v1.2", "description": "\nImplementation of the GA4GH Data Repository Service (DRS) API specification v1.2.\nThis API provides methods to retrieve data objects and their metadata, as well as\nservice information.", "item": [ { "name": "Get Service Info", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/ga4gh\/drs\/v1\/service-info", "query": [], "raw": "{{baseUrl}}\/api\/ga4gh\/drs\/v1\/service-info" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns information about the DRS service including the version, supported API versions,\nand other service-specific information.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"com.example.drs\",\n \"name\": \"GA4GH DRS Demo Service\",\n \"type\": {\n \"group\": \"org.ga4gh\",\n \"artifact\": \"drs\",\n \"version\": \"1.2.0\"\n },\n \"description\": \"A demonstration implementation of the GA4GH DRS specification for genomic neuroscience datasets\",\n \"organization\": {\n \"name\": \"Genomic Neuroscience Research Center\",\n \"url\": \"https:\/\/example.com\"\n },\n \"version\": \"1.0.0\",\n \"contactUrl\": \"mailto:support@example.com\",\n \"documentationUrl\": \"https:\/\/example.com\/docs\",\n \"createdAt\": \"2025-01-01T00:00:00Z\",\n \"updatedAt\": \"2025-01-01T00:00:00Z\",\n \"environment\": \"production\"\n}", "name": "" } ] }, { "name": "List Objects", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/ga4gh\/drs\/v1\/objects", "query": [ { "key": "page", "value": "1", "description": "The page number for pagination.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of items per page.", "disabled": false }, { "key": "public_only", "value": "1", "description": "Filter to only show public objects.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/ga4gh\/drs\/v1\/objects?page=1&per_page=20&public_only=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a list of DRS objects. This is a custom endpoint not part of the core DRS spec\nbut useful for browsing available datasets.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"brain_scan_subject_001.nii\",\n \"size\": 2147483648,\n \"mime_type\": \"application\/octet-stream\",\n \"description\": \"fMRI scan of subject 001\",\n \"created_time\": \"2025-01-01T10:00:00Z\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"per_page\": 20,\n \"total\": 50\n }\n}", "name": "" } ] }, { "name": "Get Object", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/ga4gh\/drs\/v1\/objects\/:object_id", "query": [ { "key": "expand", "value": "1", "description": "Optional. If false and the object_id refers to a bundle, the response will not include the contents array. If true and the object_id refers to a bundle, the response will include the contents array.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/ga4gh\/drs\/v1\/objects\/:object_id?expand=1", "variable": [ { "id": "object_id", "key": "object_id", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The DRS object identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns object metadata and a list of access methods that can be used to fetch the object bytes.\nMethod is guaranteed to return a single object or an error.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"brain_scan_subject_001.nii\",\n \"self_uri\": \"drs:\/\/example.com\/550e8400-e29b-41d4-a716-446655440000\",\n \"size\": 2147483648,\n \"created_time\": \"2025-01-01T10:00:00Z\",\n \"updated_time\": \"2025-01-01T10:30:00Z\",\n \"version\": \"1.0\",\n \"mime_type\": \"application\/octet-stream\",\n \"checksums\": [\n {\n \"type\": \"md5\",\n \"checksum\": \"a1b2c3d4e5f6\"\n },\n {\n \"type\": \"sha256\",\n \"checksum\": \"1234567890abcdef\"\n }\n ],\n \"access_methods\": [\n {\n \"type\": \"https\",\n \"access_url\": {\n \"url\": \"https:\/\/example.com\/storage\/brain_scan_subject_001.nii\"\n }\n }\n ],\n \"description\": \"fMRI scan of subject 001\",\n \"aliases\": [\"subject_001_fmri\", \"scan_001\"]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"msg\": \"Unauthorized - authentication is required\",\n \"status_code\": 401\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"msg\": \"Forbidden - you do not have permission to access this object\",\n \"status_code\": 403\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"msg\": \"The requested DRS object was not found\",\n \"status_code\": 404\n}", "name": "" } ] }, { "name": "Get Access URL", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/ga4gh\/drs\/v1\/objects\/:object_id\/access\/:access_id", "query": [], "raw": "{{baseUrl}}\/api\/ga4gh\/drs\/v1\/objects\/:object_id\/access\/:access_id", "variable": [ { "id": "object_id", "key": "object_id", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The DRS object identifier." }, { "id": "access_id", "key": "access_id", "value": "architecto", "description": "Optional The access method ID if multiple access methods exist." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a URL that can be used to fetch the bytes of a DRS object.\nThis method only works for objects with a single access method that supports direct download.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"url\": \"https:\/\/example.com\/storage\/brain_scan_subject_001.nii?token=abc123&expires=1234567890\",\n \"headers\": {\n \"Authorization\": \"Bearer token123\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"msg\": \"Unauthorized - authentication is required\",\n \"status_code\": 401\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"msg\": \"Forbidden - you do not have permission to access this object\",\n \"status_code\": 403\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"msg\": \"The requested DRS object or access method was not found\",\n \"status_code\": 404\n}", "name": "" } ] } ] } ], "auth": { "type": "noauth" } }