{"openapi":"3.1.0","info":{"title":"Service Dataset","description":"Service to manage datasets","version":"2.3.42"},"paths":{"/v1/dataset/{dataset_id}/files":{"get":{"tags":["Files"],"summary":"API will list files under the target dataset","description":"API list the children from folder_id within Dataser.","operationId":"list_files_v1_dataset__dataset_id__files_get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Folder Id"},"name":"folder_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyFileListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Files"],"summary":"API will recieve the file list from a project and copy them under the dataset.","description":"API imports file list from project to dataset.","operationId":"import_dataset_v1_dataset__dataset_id__files_put","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Session-Id"},"name":"Session-ID","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportDataPost"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyFileResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Files"],"summary":"API will move files within the dataset","description":"API moves files within the dataset.","operationId":"move_files_v1_dataset__dataset_id__files_post","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Session-Id"},"name":"Session-ID","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetFileMove"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyFileResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Files"],"summary":"API will delete file by geid from list","description":"API deletes file by id within Dataset.","operationId":"delete_files_v1_dataset__dataset_id__files_delete","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Session-Id"},"name":"Session-ID","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetFileDelete"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyFileResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/files/{target_file}":{"post":{"tags":["Files"],"summary":"API will update files within the dataset","description":"API will rename file/folder within dataset.","operationId":"rename_file_v1_dataset__dataset_id__files__target_file__post","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Target File"},"name":"target_file","in":"path"},{"required":false,"schema":{"type":"string","title":"Session-Id"},"name":"Session-ID","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetFileRename"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyFileResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/publish":{"post":{"tags":["Version"],"summary":"Publish a dataset version","description":"Create a version in Minio.","operationId":"publish_v1_dataset__dataset_id__publish_post","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionCreateSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/publish/status":{"get":{"tags":["Version"],"summary":"Publish status","description":"Get status of publish background task.","operationId":"publish_status_v1_dataset__dataset_id__publish_status_get","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Status Id"},"name":"status_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/versions":{"get":{"tags":["Version"],"summary":"Get dataset versions","description":"Get list of a versions from dataset.","operationId":"list_versions_v1_dataset_versions_get","parameters":[{"required":false,"schema":{"type":"integer","minimum":0.0,"title":"Page","default":0},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","minimum":1.0,"title":"Page Size","default":20},"name":"page_size","in":"query"},{"required":false,"schema":{"type":"string","format":"uuid","title":"Dataset Id"},"name":"dataset_id","in":"query"},{"required":false,"schema":{"$ref":"#/components/schemas/VersionSortByFields"},"name":"sort_by","in":"query"},{"required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/SortingOrder"}],"default":"asc"},"name":"sort_order","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionListResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/versions/{version_id}":{"get":{"tags":["Version"],"summary":"Get dataset version","description":"Get specific dataset version.","operationId":"get_version_v1_dataset_versions__version_id__get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Version Id"},"name":"version_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/download/pre":{"get":{"tags":["Version"],"summary":"Download dataset version","description":"Get download url for dataset version.","operationId":"download_url_v1_dataset__dataset_id__download_pre_get","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Version"},"name":"version","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/version-sharing-requests/":{"get":{"tags":["Version Sharing Requests"],"summary":"List all Version Sharing Requests.","description":"List all Version Sharing Requests.","operationId":"list_version_sharing_requests_v1_version_sharing_requests__get","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"$ref":"#/components/schemas/VersionSharingRequestSortByFields"},"name":"sort_by","in":"query"},{"required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/SortingOrder"}],"default":"asc"},"name":"sort_order","in":"query"},{"required":false,"schema":{"type":"integer","minimum":0.0,"title":"Page","default":0},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","minimum":1.0,"title":"Page Size","default":20},"name":"page_size","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionSharingRequestListResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Version Sharing Requests"],"summary":"Create a new Version Sharing Request.","description":"Create a new Version Sharing Request.","operationId":"create_version_sharing_request_v1_version_sharing_requests__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionSharingRequestCreateSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionSharingRequestResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/version-sharing-requests/{version_sharing_request_id}":{"get":{"tags":["Version Sharing Requests"],"summary":"Get a Version Sharing Request by id.","description":"Get a Version Sharing Request by id.","operationId":"get_version_sharing_request_by_id_v1_version_sharing_requests__version_sharing_request_id__get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Version Sharing Request Id"},"name":"version_sharing_request_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionSharingRequestResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Version Sharing Requests"],"summary":"Update a Version Sharing Request.","description":"Update a Version Sharing Request.","operationId":"update_version_sharing_request_v1_version_sharing_requests__version_sharing_request_id__patch","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Version Sharing Request Id"},"name":"version_sharing_request_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionSharingRequestUpdateSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionSharingRequestResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/version-sharing-requests/{version_sharing_request_id}/start":{"post":{"tags":["Version Sharing Requests"],"summary":"Start sharing of the Dataset Version specified in Version Sharing Request.","description":"Start sharing of the Dataset Version specified in Version Sharing Request.","operationId":"start_version_sharing_request_v1_version_sharing_requests__version_sharing_request_id__start_post","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Version Sharing Request Id"},"name":"version_sharing_request_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionSharingRequestStartSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/{file_id}/preview":{"get":{"tags":["Preview"],"summary":"CSV/JSON/TSV File preview","description":"Get file preview.","operationId":"get_preview_v1__file_id__preview_get","parameters":[{"required":true,"schema":{"type":"string","title":"File Id"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyPreviewResultResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/{file_id}/preview/stream":{"get":{"tags":["Preview"],"summary":"CSV/JSON/TSV File preview stream","description":"Get a file preview stream.","operationId":"stream_v1__file_id__preview_stream_get","parameters":[{"required":true,"schema":{"type":"string","title":"File Id"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/folder":{"post":{"tags":["Folder"],"summary":"Create an empty folder","description":"Create an empty folder.","operationId":"create_folder_v1_dataset__dataset_id__folder_post","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderCreateSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyFolderResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schema":{"post":{"tags":["Schema"],"summary":"Create a new schema","description":"Create a new schema.","operationId":"create_v1_schema_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacySchemaResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schema/{schema_id}":{"get":{"tags":["Schema"],"summary":"Get a schema","description":"Get a schema by id.","operationId":"get_v1_schema__schema_id__get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Schema Id"},"name":"schema_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacySchemaResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Schema"],"summary":"update a schema","description":"Update a schema.","operationId":"update_v1_schema__schema_id__put","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Schema Id"},"name":"schema_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacySchemaResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Schema"],"summary":"Delete a schema","description":"Delete a schema.","operationId":"delete_v1_schema__schema_id__delete","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Schema Id"},"name":"schema_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETESchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schema/list":{"post":{"tags":["Schema"],"summary":"API will list the schema by condition","description":"List schemas by condition.","operationId":"list_schema_v1_schema_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTSchemaList"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacySchemaListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/schemaTPL":{"post":{"tags":["Schema Template"],"summary":"API will create the new schema template","operationId":"create_schema_template_v1_dataset__dataset_id__schemaTPL_post","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaTemplateCreateSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacySchemaTemplateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/schemaTPL/list":{"post":{"tags":["Schema Template"],"summary":"API will list the template by condition","operationId":"list_schema_template_v1_dataset__dataset_id__schemaTPL_list_post","parameters":[{"required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacySchemaTemplateListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/schemaTPL/{template_id}":{"get":{"tags":["Schema Template"],"summary":"API will get the template by geid","operationId":"get_schema_template_v1_dataset__dataset_id__schemaTPL__template_id__get","parameters":[{"required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":true,"schema":{"type":"string","format":"uuid","title":"Template Id"},"name":"template_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacySchemaTemplateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Schema Template"],"summary":"API will create the new schema template","operationId":"remove_schema_template_v1_dataset__dataset_id__schemaTPL__template_id__delete","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":true,"schema":{"type":"string","format":"uuid","title":"Template Id"},"name":"template_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacySchemaTemplateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/health":{"get":{"tags":["Internal"],"summary":"Healthcheck if all service dependencies are online.","description":"Return response that represents status of the database and kafka connections.","operationId":"get_db_status_v1_health_get","responses":{"204":{"description":"Successful Response","message":""},"503":{"description":"error on database and/or kafka connections"}}}},"/v1/dataset/verify/pre":{"post":{"tags":["Datasets","BIDS"],"summary":"Pre verify a bids for dataset.","description":"Start the BIDS verification sending a msg to queue service.","operationId":"pre_verify_dataset_v1_dataset_verify_pre_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BIDSResultSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/bids-msg/{dataset_code}":{"get":{"tags":["Datasets","BIDS"],"summary":"Get bids verification results for dataset.","description":"Retrieve BIDS results by dataset code.","operationId":"get_bids_msg_v1_dataset_bids_msg__dataset_code__get","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Code"},"name":"dataset_code","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyBIDSResultResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/bids-result/{dataset_code}":{"put":{"tags":["Datasets","BIDS"],"summary":"Update the bids verification results for dataset","description":"Retrieve BIDS results by dataset code.","operationId":"update_bids_result_v1_dataset_bids_result__dataset_code__put","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Code"},"name":"dataset_code","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBIDSResultSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BIDSResultResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/":{"get":{"tags":["Datasets"],"summary":"List all datasets.","description":"List all datasets.","operationId":"list_datasets_v1_datasets__get","parameters":[{"required":false,"schema":{"type":"integer","minimum":0.0,"title":"Page","default":0},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","minimum":1.0,"title":"Page Size","default":20},"name":"page_size","in":"query"},{"required":false,"schema":{"type":"string","title":"Code"},"name":"code","in":"query"},{"required":false,"schema":{"type":"string","title":"Creator"},"name":"creator","in":"query"},{"required":false,"schema":{"type":"string","format":"date-time","title":"Created At Start"},"name":"created_at_start","in":"query"},{"required":false,"schema":{"type":"string","format":"date-time","title":"Created At End"},"name":"created_at_end","in":"query"},{"required":false,"schema":{"type":"string","title":"Ids"},"name":"ids","in":"query"},{"required":false,"schema":{"type":"string","title":"Code Any"},"name":"code_any","in":"query"},{"required":false,"schema":{"type":"string","format":"uuid","title":"Project Id"},"name":"project_id","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id Any"},"name":"project_id_any","in":"query"},{"required":false,"schema":{"type":"string","title":"Or Creator"},"name":"or_creator","in":"query"},{"required":false,"schema":{"$ref":"#/components/schemas/DatasetSortByFields"},"name":"sort_by","in":"query"},{"required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/SortingOrder"}],"default":"asc"},"name":"sort_order","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetListResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Datasets"],"summary":"Create a dataset.","description":"Dataset creation api.","operationId":"create_dataset_v1_datasets__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/{dataset_id}":{"get":{"tags":["Datasets"],"summary":"Get a dataset by id or code.","description":"Get a dataset by id or code.","operationId":"get_dataset_v1_datasets__dataset_id__get","parameters":[{"required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Datasets"],"summary":"Delete a dataset by id or code.","description":"Delete a dataset by id or code.","operationId":"delete_dataset_v1_datasets__dataset_id__delete","parameters":[{"required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetDeleteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ActivityDetailsSchema":{"properties":{"name":{"type":"string","title":"Name"},"targets":{"items":{"type":"string"},"type":"array","title":"Targets"}},"type":"object","required":["name","targets"],"title":"ActivityDetailsSchema","description":"Base class for all available schemas."},"ActivitySchema":{"properties":{"action":{"type":"string","title":"Action"},"resource":{"type":"string","title":"Resource"},"detail":{"$ref":"#/components/schemas/ActivityDetailsSchema"}},"type":"object","required":["action","resource","detail"],"title":"ActivitySchema","description":"Base class for all available schemas."},"BIDSResultResponseSchema":{"properties":{"dataset_code":{"type":"string","title":"Dataset Code"},"created_time":{"type":"string","format":"date-time","title":"Created Time"},"updated_time":{"type":"string","format":"date-time","title":"Updated Time"},"validate_output":{"type":"object","title":"Validate Output"}},"type":"object","required":["dataset_code","created_time","updated_time","validate_output"],"title":"BIDSResultResponseSchema","description":"Default schema for single BIDS result in response."},"BIDSResultSchema":{"properties":{"dataset_code":{"type":"string","title":"Dataset Code"}},"type":"object","required":["dataset_code"],"title":"BIDSResultSchema","description":"General BIDS result schema."},"DELETESchema":{"properties":{"dataset_geid":{"type":"string","title":"Dataset Geid"},"username":{"type":"string","title":"Username"},"activity":{"items":{"$ref":"#/components/schemas/ActivitySchema"},"type":"array","title":"Activity"}},"type":"object","required":["dataset_geid","username","activity"],"title":"DELETESchema","description":"Schema for DELETE request."},"DatasetDeleteResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"DatasetDeleteResponse","description":"Base class for all available schemas."},"DatasetFileDelete":{"properties":{"source_list":{"items":{},"type":"array","title":"Source List"},"operator":{"type":"string","title":"Operator"}},"type":"object","required":["source_list","operator"],"title":"DatasetFileDelete","description":"The delete request payload for dataset to delete files."},"DatasetFileMove":{"properties":{"source_list":{"items":{},"type":"array","title":"Source List"},"operator":{"type":"string","title":"Operator"},"target_geid":{"type":"string","title":"Target Geid"}},"type":"object","required":["source_list","operator","target_geid"],"title":"DatasetFileMove","description":"The post request payload for dataset to move files under the dataset."},"DatasetFileRename":{"properties":{"new_name":{"type":"string","title":"New Name"},"operator":{"type":"string","title":"Operator"}},"type":"object","required":["new_name","operator"],"title":"DatasetFileRename","description":"The post request payload for dataset to move files under the dataset."},"DatasetListResponseSchema":{"properties":{"num_of_pages":{"type":"integer","title":"Num Of Pages"},"page":{"type":"integer","title":"Page"},"total":{"type":"integer","title":"Total"},"result":{"items":{"$ref":"#/components/schemas/DatasetResponseSchema"},"type":"array","title":"Result"}},"type":"object","required":["num_of_pages","page","total","result"],"title":"DatasetListResponseSchema","description":"Default schema for multiple datasets in response."},"DatasetResponseSchema":{"properties":{"title":{"type":"string","maxLength":100,"title":"Title"},"authors":{"items":{"type":"string","maxLength":50},"type":"array","maxItems":10,"title":"Authors"},"type":{"allOf":[{"$ref":"#/components/schemas/DatasetType"}],"default":"GENERAL"},"modality":{"items":{"$ref":"#/components/schemas/Modality"},"type":"array","default":[]},"collection_method":{"items":{"type":"string","maxLength":20},"type":"array","maxItems":10,"title":"Collection Method","default":[]},"license":{"type":"string","maxLength":20,"title":"License","default":""},"tags":{"items":{"type":"string","maxLength":32},"type":"array","maxItems":10,"title":"Tags","default":[]},"description":{"type":"string","maxLength":5000,"title":"Description"},"code":{"type":"string","pattern":"^[a-z0-9]{3,32}$","title":"Code"},"project_id":{"type":"string","format":"uuid","title":"Project Id"},"total_files":{"type":"integer","title":"Total Files","default":0},"size":{"type":"integer","title":"Size","default":0},"source":{"type":"string","title":"Source","default":""},"creator":{"type":"string","title":"Creator"},"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["title","authors","description","code","project_id","creator","id","created_at","updated_at"],"title":"DatasetResponseSchema","description":"Default schema for single dataset in response."},"DatasetSchema":{"properties":{"title":{"type":"string","maxLength":100,"title":"Title"},"authors":{"items":{"type":"string","maxLength":50},"type":"array","maxItems":10,"title":"Authors"},"type":{"allOf":[{"$ref":"#/components/schemas/DatasetType"}],"default":"GENERAL"},"modality":{"items":{"$ref":"#/components/schemas/Modality"},"type":"array","default":[]},"collection_method":{"items":{"type":"string","maxLength":20},"type":"array","maxItems":10,"title":"Collection Method","default":[]},"license":{"type":"string","maxLength":20,"title":"License","default":""},"tags":{"items":{"type":"string","maxLength":32},"type":"array","maxItems":10,"title":"Tags","default":[]},"description":{"type":"string","maxLength":5000,"title":"Description"},"code":{"type":"string","pattern":"^[a-z0-9]{3,32}$","title":"Code"},"project_id":{"type":"string","format":"uuid","title":"Project Id"},"total_files":{"type":"integer","title":"Total Files","default":0},"size":{"type":"integer","title":"Size","default":0},"source":{"type":"string","title":"Source","default":""},"creator":{"type":"string","title":"Creator"}},"type":"object","required":["title","authors","description","code","project_id","creator"],"title":"DatasetSchema","description":"General dataset schema."},"DatasetSortByFields":{"type":"string","enum":["code","creator","created_at"],"title":"DatasetSortByFields","description":"Fields by which datasets can be sorted."},"DatasetType":{"type":"string","enum":["GENERAL","BIDS"],"title":"DatasetType","description":"An enumeration."},"FileOperationResponse":{"properties":{"processing":{"items":{"type":"object"},"type":"array","title":"Processing"},"ignored":{"items":{"type":"object"},"type":"array","title":"Ignored"}},"type":"object","required":["processing","ignored"],"title":"FileOperationResponse","description":"Schema for file operation response."},"FolderCreateSchema":{"properties":{"folder_name":{"type":"string","maxLength":20,"pattern":"^[^\\\\\\/:?\\*<>|\"]+$","title":"Folder Name"},"username":{"type":"string","title":"Username"},"parent_folder_geid":{"type":"string","title":"Parent Folder Geid","default":""},"status":{"allOf":[{"$ref":"#/components/schemas/ItemStatusSchema"}],"default":"ACTIVE"}},"type":"object","required":["folder_name","username"],"title":"FolderCreateSchema","description":"Base schema to create folder."},"FolderResponseSchema":{"properties":{"id":{"type":"string","title":"Id"},"parent":{"type":"string","title":"Parent"},"parent_path":{"type":"string","title":"Parent Path"},"status":{"$ref":"#/components/schemas/ItemStatusSchema"},"type":{"type":"string","title":"Type"},"name":{"type":"string","title":"Name"},"size":{"type":"integer","title":"Size"},"owner":{"type":"string","title":"Owner"},"container_code":{"type":"string","title":"Container Code"},"container_type":{"type":"string","title":"Container Type"},"created_time":{"type":"string","format":"date-time","title":"Created Time"},"last_updated_time":{"type":"string","format":"date-time","title":"Last Updated Time"},"storage":{"$ref":"#/components/schemas/StorageSchema"}},"type":"object","required":["id","status","type","name","size","owner","container_code","container_type","created_time","last_updated_time"],"title":"FolderResponseSchema","description":"Base folder schema."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ImportDataPost":{"properties":{"source_list":{"items":{},"type":"array","title":"Source List"},"operator":{"type":"string","title":"Operator"},"project_geid":{"type":"string","title":"Project Geid"}},"type":"object","required":["source_list","operator","project_geid"],"title":"ImportDataPost","description":"The post request payload for import data from project."},"ItemStatusSchema":{"type":"string","enum":["REGISTERED","ACTIVE","ARCHIVED"],"title":"ItemStatusSchema","description":"Schema for item file status."},"LegacyBIDSResultResponseSchema":{"properties":{"result":{"$ref":"#/components/schemas/BIDSResultResponseSchema"}},"type":"object","required":["result"],"title":"LegacyBIDSResultResponseSchema","description":"Legacy schema for single BIDS result in response."},"LegacyFileListResponse":{"properties":{"total":{"type":"integer","title":"Total"},"result":{"type":"object","title":"Result"}},"type":"object","required":["total","result"],"title":"LegacyFileListResponse","description":"Legacy schema for single file response."},"LegacyFileResponse":{"properties":{"result":{"$ref":"#/components/schemas/FileOperationResponse"}},"type":"object","required":["result"],"title":"LegacyFileResponse","description":"Legacy schema for single file response."},"LegacyFolderResponseSchema":{"properties":{"result":{"$ref":"#/components/schemas/FolderResponseSchema"}},"type":"object","required":["result"],"title":"LegacyFolderResponseSchema","description":"Legacy schema for single BIDS result in response."},"LegacyPreviewResultResponseSchema":{"properties":{"result":{"$ref":"#/components/schemas/PreviewResponseSchema"}},"type":"object","required":["result"],"title":"LegacyPreviewResultResponseSchema","description":"Legacy schema for single preview result in response."},"LegacyResponseSchema":{"properties":{"result":{"type":"object","title":"Result"}},"type":"object","required":["result"],"title":"LegacyResponseSchema","description":"Legacy schema to keep old response body and avoid to break other services."},"LegacySchemaListResponse":{"properties":{"result":{"items":{"$ref":"#/components/schemas/SchemaResponse"},"type":"array","title":"Result"}},"type":"object","title":"LegacySchemaListResponse","description":"Legacy schema for multiple schemas in response."},"LegacySchemaResponse":{"properties":{"result":{"$ref":"#/components/schemas/SchemaResponse"}},"type":"object","title":"LegacySchemaResponse","description":"Legacy schema for single schema in response."},"LegacySchemaTemplateItemListResponse":{"properties":{"geid":{"type":"string","format":"uuid","title":"Geid"},"name":{"type":"string","title":"Name"},"system_defined":{"type":"boolean","title":"System Defined"},"standard":{"type":"string","title":"Standard"}},"type":"object","required":["geid","name","system_defined","standard"],"title":"LegacySchemaTemplateItemListResponse","description":"Legacy schema for multiple schema template in response."},"LegacySchemaTemplateListResponse":{"properties":{"result":{"items":{"$ref":"#/components/schemas/LegacySchemaTemplateItemListResponse"},"type":"array","title":"Result"}},"type":"object","required":["result"],"title":"LegacySchemaTemplateListResponse","description":"Legacy schema for multiple schema templates in response."},"LegacySchemaTemplateResponse":{"properties":{"result":{"$ref":"#/components/schemas/SchemaTemplateResponse"}},"type":"object","required":["result"],"title":"LegacySchemaTemplateResponse","description":"Legacy schema for single schema template in response."},"Modality":{"type":"string","enum":["anatomical approach","neuroimaging","microscopy","histological approach","neural connectivity","molecular expression characterization","multimodal approach","electrophysiology","behavioral approach","molecular expression approach","cell population imaging","physiological approach","morphological approach","cell morphology","cell counting","cell population characterization","computational modeling"],"title":"Modality","description":"An enumeration."},"POSTSchema":{"properties":{"name":{"type":"string","title":"Name"},"dataset_geid":{"type":"string","title":"Dataset Geid"},"tpl_geid":{"type":"string","title":"Tpl Geid"},"standard":{"type":"string","title":"Standard"},"system_defined":{"type":"boolean","title":"System Defined"},"is_draft":{"type":"boolean","title":"Is Draft"},"content":{"type":"object","title":"Content"},"creator":{"type":"string","title":"Creator"}},"type":"object","required":["name","dataset_geid","tpl_geid","standard","system_defined","is_draft","content","creator"],"title":"POSTSchema","description":"Schema for POST request."},"POSTSchemaList":{"properties":{"name":{"type":"string","title":"Name"},"dataset_geid":{"type":"string","title":"Dataset Geid"},"tpl_geid":{"type":"string","title":"Tpl Geid"},"standard":{"type":"string","title":"Standard"},"system_defined":{"type":"boolean","title":"System Defined"},"is_draft":{"type":"boolean","title":"Is Draft"},"create_timestamp":{"type":"number","title":"Create Timestamp"},"update_timestamp":{"type":"number","title":"Update Timestamp"},"creator":{"type":"string","title":"Creator"}},"type":"object","title":"POSTSchemaList","description":"Schema for POST List request."},"PUTSchema":{"properties":{"name":{"type":"string","title":"Name"},"dataset_geid":{"type":"string","title":"Dataset Geid"},"tpl_geid":{"type":"string","title":"Tpl Geid"},"standard":{"type":"string","title":"Standard"},"system_defined":{"type":"boolean","title":"System Defined"},"is_draft":{"type":"boolean","title":"Is Draft"},"content":{"type":"object","title":"Content"},"creator":{"type":"string","title":"Creator"},"activity":{"items":{"$ref":"#/components/schemas/ActivitySchema"},"type":"array","title":"Activity"},"username":{"type":"string","title":"Username"}},"type":"object","required":["activity","username"],"title":"PUTSchema","description":"Schema for PUT request."},"PreviewResponseSchema":{"properties":{"type":{"type":"string","title":"Type"},"is_concatenated":{"type":"boolean","title":"Is Concatenated"},"content":{"type":"string","title":"Content"}},"type":"object","required":["type","is_concatenated","content"],"title":"PreviewResponseSchema","description":"Base schema to dataset preview."},"SchemaResponse":{"properties":{"geid":{"type":"string","format":"uuid","title":"Geid"},"name":{"type":"string","title":"Name"},"dataset_geid":{"type":"string","format":"uuid","title":"Dataset Geid"},"tpl_geid":{"type":"string","format":"uuid","title":"Tpl Geid"},"standard":{"type":"string","title":"Standard"},"system_defined":{"type":"boolean","title":"System Defined"},"is_draft":{"type":"boolean","title":"Is Draft"},"creator":{"type":"string","title":"Creator"},"content":{"type":"object","title":"Content"},"create_timestamp":{"type":"string","format":"date-time","title":"Create Timestamp"},"update_timestamp":{"type":"string","format":"date-time","title":"Update Timestamp"}},"type":"object","required":["geid","name","dataset_geid","tpl_geid","standard","system_defined","is_draft","creator","content","create_timestamp","update_timestamp"],"title":"SchemaResponse","description":"General schema for schema response."},"SchemaTemplateCreateSchema":{"properties":{"name":{"type":"string","title":"Name"},"is_draft":{"type":"boolean","title":"Is Draft"},"content":{"type":"object","title":"Content"},"standard":{"type":"string","title":"Standard"},"system_defined":{"type":"boolean","title":"System Defined"},"creator":{"type":"string","title":"Creator"},"dataset_id":{"type":"string","format":"uuid","title":"Dataset Id"}},"type":"object","required":["name","is_draft","content","standard","system_defined","creator"],"title":"SchemaTemplateCreateSchema","description":"Schema for create schema template."},"SchemaTemplateResponse":{"properties":{"name":{"type":"string","title":"Name"},"is_draft":{"type":"boolean","title":"Is Draft"},"content":{"type":"object","title":"Content"},"geid":{"type":"string","format":"uuid","title":"Geid"},"standard":{"type":"string","title":"Standard"},"system_defined":{"type":"boolean","title":"System Defined"},"creator":{"type":"string","title":"Creator"},"dataset_id":{"type":"string","format":"uuid","title":"Dataset Id"},"create_timestamp":{"type":"string","format":"date-time","title":"Create Timestamp"},"update_timestamp":{"type":"string","format":"date-time","title":"Update Timestamp"}},"type":"object","required":["name","is_draft","content","geid","standard","system_defined","creator","create_timestamp","update_timestamp"],"title":"SchemaTemplateResponse","description":"General schema for schema template response."},"SortingOrder":{"type":"string","enum":["asc","desc"],"title":"SortingOrder","description":"Available sorting orders."},"StorageSchema":{"properties":{"location_uri":{"type":"string","title":"Location Uri"}},"type":"object","title":"StorageSchema","description":"Base storage schema."},"UpdateBIDSResultSchema":{"properties":{"validate_output":{"type":"object","title":"Validate Output"}},"type":"object","required":["validate_output"],"title":"UpdateBIDSResultSchema","description":"Schema for create or update the BIDS result."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VersionCreateSchema":{"properties":{"operator":{"type":"string","title":"Operator"},"notes":{"type":"string","maxLength":250,"title":"Notes"},"version":{"type":"string","pattern":"^\\d+\\.\\d+$","title":"Version"}},"type":"object","required":["operator","notes","version"],"title":"VersionCreateSchema","description":"Schema for create version."},"VersionListResponseSchema":{"properties":{"num_of_pages":{"type":"integer","title":"Num Of Pages"},"page":{"type":"integer","title":"Page"},"total":{"type":"integer","title":"Total"},"result":{"items":{"$ref":"#/components/schemas/VersionResponseSchema"},"type":"array","title":"Result"}},"type":"object","required":["num_of_pages","page","total","result"],"title":"VersionListResponseSchema","description":"Legacy schema for multiple versions in response."},"VersionResponseSchema":{"properties":{"dataset_id":{"type":"string","format":"uuid","title":"Dataset Id"},"dataset_code":{"type":"string","title":"Dataset Code"},"location":{"type":"string","title":"Location"},"created_by":{"type":"string","title":"Created By"},"notes":{"type":"string","title":"Notes"},"version":{"type":"string","title":"Version"},"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["dataset_id","dataset_code","location","created_by","notes","version","id","created_at"],"title":"VersionResponseSchema","description":"General schema for single version response."},"VersionSharingRequestCreateSchema":{"properties":{"version_id":{"type":"string","format":"uuid","title":"Version Id"},"project_code":{"type":"string","title":"Project Code"},"initiator_username":{"type":"string","title":"Initiator Username"},"status":{"allOf":[{"$ref":"#/components/schemas/VersionSharingRequestStatus"}],"default":"sent"}},"type":"object","required":["version_id","project_code","initiator_username"],"title":"VersionSharingRequestCreateSchema","description":"Version Sharing Request schema used for creation."},"VersionSharingRequestListResponseSchema":{"properties":{"num_of_pages":{"type":"integer","title":"Num Of Pages"},"page":{"type":"integer","title":"Page"},"total":{"type":"integer","title":"Total"},"result":{"items":{"$ref":"#/components/schemas/VersionSharingRequestResponseSchema"},"type":"array","title":"Result"}},"type":"object","required":["num_of_pages","page","total","result"],"title":"VersionSharingRequestListResponseSchema","description":"Default schema for multiple Version Sharing Requests in response."},"VersionSharingRequestResponseSchema":{"properties":{"version_id":{"type":"string","format":"uuid","title":"Version Id"},"project_code":{"type":"string","title":"Project Code"},"initiator_username":{"type":"string","title":"Initiator Username"},"receiver_username":{"type":"string","title":"Receiver Username"},"status":{"$ref":"#/components/schemas/VersionSharingRequestStatus"},"id":{"type":"string","format":"uuid","title":"Id"},"dataset_id":{"type":"string","format":"uuid","title":"Dataset Id"},"dataset_code":{"type":"string","title":"Dataset Code"},"source_project_id":{"type":"string","format":"uuid","title":"Source Project Id"},"version_number":{"type":"string","title":"Version Number"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["version_id","project_code","initiator_username","status","id","dataset_id","dataset_code","source_project_id","version_number","created_at"],"title":"VersionSharingRequestResponseSchema","description":"Default schema for single Version Sharing Request in response."},"VersionSharingRequestSortByFields":{"type":"string","enum":["created_at"],"title":"VersionSharingRequestSortByFields","description":"Fields by which Version Sharing Requests can be sorted."},"VersionSharingRequestStartSchema":{"properties":{"job_id":{"type":"string","title":"Job Id"},"session_id":{"type":"string","title":"Session Id"}},"type":"object","required":["job_id","session_id"],"title":"VersionSharingRequestStartSchema","description":"Version Sharing Request schema used to start the sharing process."},"VersionSharingRequestStatus":{"type":"string","enum":["sent","accepted","declined"],"title":"VersionSharingRequestStatus","description":"An enumeration."},"VersionSharingRequestUpdateSchema":{"properties":{"status":{"$ref":"#/components/schemas/VersionSharingRequestStatus"},"receiver_username":{"type":"string","title":"Receiver Username"}},"type":"object","required":["status","receiver_username"],"title":"VersionSharingRequestUpdateSchema","description":"Version Sharing Request schema used for update."},"VersionSortByFields":{"type":"string","enum":["created_at"],"title":"VersionSortByFields","description":"Fields by which versions can be sorted."}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}}}}