{"openapi":"3.1.0","info":{"title":"Search Service","description":"Service for performing searches.","version":"2.1.0"},"paths":{"/v1/metadata-items/":{"get":{"tags":["Metadata Items"],"summary":"List all metadata items.","description":"List metadata items.","operationId":"list_metadata_items_v1_metadata_items__get","parameters":[{"required":false,"schema":{"type":"string","title":"Name"},"name":"name","in":"query"},{"required":false,"schema":{"type":"string","title":"Owner"},"name":"owner","in":"query"},{"required":false,"schema":{"type":"string","title":"Parent Path"},"name":"parent_path","in":"query"},{"required":false,"schema":{"type":"integer","title":"Zone"},"name":"zone","in":"query"},{"required":false,"schema":{"type":"string","title":"Container Code"},"name":"container_code","in":"query"},{"required":false,"schema":{"$ref":"#/components/schemas/ContainerType"},"name":"container_type","in":"query"},{"required":false,"schema":{"type":"string","format":"date-time","title":"Created Time Start"},"name":"created_time_start","in":"query"},{"required":false,"schema":{"type":"string","format":"date-time","title":"Created Time End"},"name":"created_time_end","in":"query"},{"required":false,"schema":{"type":"integer","exclusiveMinimum":0.0,"title":"Size Gte"},"name":"size_gte","in":"query"},{"required":false,"schema":{"type":"integer","exclusiveMinimum":0.0,"title":"Size Lte"},"name":"size_lte","in":"query"},{"required":false,"schema":{"type":"string","format":"uuid","title":"Template Id"},"name":"template_id","in":"query"},{"required":false,"schema":{"type":"string","title":"Attributes"},"name":"attributes","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Is Archived"},"name":"is_archived","in":"query"},{"required":false,"schema":{"type":"string","title":"Tags All"},"name":"tags_all","in":"query"},{"required":false,"schema":{"type":"string","title":"Type"},"name":"type","in":"query"},{"required":false,"schema":{"$ref":"#/components/schemas/MetadataItemSortByFields"},"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":1.0,"title":"Page","default":1},"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/MetadataItemListResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset-activity-logs/":{"get":{"tags":["Dataset Activity"],"summary":"List all dataset and items activity logs.","description":"List dataset and item activity logs.","operationId":"list_dataset_and_item_activity_logs_v1_dataset_activity_logs__get","parameters":[{"required":false,"schema":{"type":"string","title":"Activity Type"},"name":"activity_type","in":"query"},{"required":false,"schema":{"type":"string","format":"date-time","title":"Activity Time Start"},"name":"activity_time_start","in":"query"},{"required":false,"schema":{"type":"string","format":"date-time","title":"Activity Time End"},"name":"activity_time_end","in":"query"},{"required":false,"schema":{"type":"string","title":"Container Code"},"name":"container_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Version"},"name":"version","in":"query"},{"required":false,"schema":{"type":"string","title":"Target Name"},"name":"target_name","in":"query"},{"required":false,"schema":{"type":"string","title":"User"},"name":"user","in":"query"},{"required":false,"schema":{"$ref":"#/components/schemas/ContainerType"},"name":"container_type","in":"query"},{"required":false,"schema":{"type":"string","format":"uuid","title":"Item Id"},"name":"item_id","in":"query"},{"required":false,"schema":{"type":"string","title":"Item Type"},"name":"item_type","in":"query"},{"required":false,"schema":{"type":"string","title":"Item Name"},"name":"item_name","in":"query"},{"required":false,"schema":{"type":"string","title":"Item Parent Path"},"name":"item_parent_path","in":"query"},{"required":false,"schema":{"type":"integer","title":"Zone"},"name":"zone","in":"query"},{"required":false,"schema":{"type":"string","title":"Imported From"},"name":"imported_from","in":"query"},{"required":false,"schema":{"$ref":"#/components/schemas/DatasetActivitySortByFields"},"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":1.0,"title":"Page","default":1},"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/DatasetAndItemActivityListResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/item-activity-logs/":{"get":{"tags":["Item Activity"],"summary":"List project items activity logs.","description":"List item activity logs.","operationId":"list_item_activity_logs_v1_item_activity_logs__get","parameters":[{"required":false,"schema":{"type":"string","title":"Activity Type"},"name":"activity_type","in":"query"},{"required":false,"schema":{"type":"string","format":"date-time","title":"Activity Time Start"},"name":"activity_time_start","in":"query"},{"required":false,"schema":{"type":"string","format":"date-time","title":"Activity Time End"},"name":"activity_time_end","in":"query"},{"required":false,"schema":{"type":"string","title":"Container Code"},"name":"container_code","in":"query"},{"required":false,"schema":{"type":"string","title":"User"},"name":"user","in":"query"},{"required":false,"schema":{"type":"integer","title":"Zone"},"name":"zone","in":"query"},{"required":false,"schema":{"$ref":"#/components/schemas/ItemActivitySortByFields"},"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":1.0,"title":"Page","default":1},"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/ItemActivityListResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/project-files/{project_code}/size":{"get":{"tags":["Project Files"],"summary":"Get storage usage in the project.","description":"Get storage usage in a project for the period.","operationId":"get_project_size_usage_v1_project_files__project_code__size_get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"},{"required":false,"schema":{"type":"string","title":"Parent Path"},"name":"parent_path","in":"query"},{"required":true,"schema":{"type":"string","format":"date-time","title":"From"},"name":"from","in":"query"},{"required":true,"schema":{"type":"string","format":"date-time","title":"To"},"name":"to","in":"query"},{"required":false,"schema":{"type":"string","pattern":"^[-+][0-9]{2}:[0-9]{2}$","title":"Time Zone","default":"+00:00"},"name":"time_zone","in":"query"},{"required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/SizeGroupBy"}],"default":"month"},"name":"group_by","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFilesSizeResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/project-files/{project_code}/statistics":{"get":{"tags":["Project Files"],"summary":"Get files and transfer activity statistics in the project.","description":"Get files and transfer activity statistics in a project for the period.","operationId":"get_project_statistics_v1_project_files__project_code__statistics_get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"},{"required":false,"schema":{"type":"string","title":"Parent Path"},"name":"parent_path","in":"query"},{"required":false,"schema":{"type":"integer","title":"Zone"},"name":"zone","in":"query"},{"required":false,"schema":{"type":"string","pattern":"^[-+][0-9]{2}:[0-9]{2}$","title":"Time Zone","default":"+00:00"},"name":"time_zone","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFilesStatisticsResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/project-files/{project_code}/activity":{"get":{"tags":["Project Files"],"summary":"Get file activity in the project.","description":"Get file activity in a project for the period.","operationId":"get_project_file_activity_v1_project_files__project_code__activity_get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"},{"required":true,"schema":{"type":"string","format":"date-time","title":"From"},"name":"from","in":"query"},{"required":true,"schema":{"type":"string","format":"date-time","title":"To"},"name":"to","in":"query"},{"required":false,"schema":{"type":"string","pattern":"^[-+][0-9]{2}:[0-9]{2}$","title":"Time Zone","default":"+00:00"},"name":"time_zone","in":"query"},{"required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/ActivityGroupBy"}],"default":"day"},"name":"group_by","in":"query"},{"required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/ItemActivityType"}],"default":"download"},"name":"type","in":"query"},{"required":false,"schema":{"type":"string","title":"User"},"name":"user","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFilesActivityResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ActivityGroupBy":{"type":"string","enum":["day"],"title":"ActivityGroupBy","description":"Store possible group by options for item activities."},"ContainerType":{"type":"string","enum":["project","dataset"],"title":"ContainerType","description":"Available container types."},"DatasetActivityIndexedSchema":{"properties":{"activity_type":{"$ref":"#/components/schemas/DatasetActivityType"},"activity_time":{"type":"string","format":"date-time","title":"Activity Time"},"container_code":{"type":"string","title":"Container Code"},"version":{"type":"string","title":"Version"},"target_name":{"type":"string","title":"Target Name"},"user":{"type":"string","title":"User"},"changes":{"items":{"type":"object"},"type":"array","title":"Changes"},"network_origin":{"type":"string","title":"Network Origin"},"index":{"type":"string","enum":["dataset"],"title":"Index"}},"type":"object","required":["activity_type","activity_time","container_code","user","changes","network_origin","index"],"title":"DatasetActivityIndexedSchema","description":"Dataset activity schema with source index."},"DatasetActivitySortByFields":{"type":"string","enum":["activity_time"],"title":"DatasetActivitySortByFields","description":"Fields by which dataset activity logs can be sorted."},"DatasetActivityType":{"type":"string","enum":["download","update","create","release","schema_delete","schema_update","schema_create","template_delete","template_update","template_create","kg_create","kg_metadata_upload","kg_metadata_refresh","kg_metadata_download","kg_metadata_delete","sharing_request_update"],"title":"DatasetActivityType","description":"Store all available dataset activity types."},"DatasetAndItemActivityListResponseSchema":{"properties":{"num_of_pages":{"type":"integer","title":"Num Of Pages"},"page":{"type":"integer","title":"Page"},"total":{"type":"integer","title":"Total"},"result":{"items":{"anyOf":[{"$ref":"#/components/schemas/DatasetActivityIndexedSchema"},{"$ref":"#/components/schemas/ItemActivityIndexedSchema"}],"discriminator":{"propertyName":"index","mapping":{"dataset":"#/components/schemas/DatasetActivityIndexedSchema","file":"#/components/schemas/ItemActivityIndexedSchema"}}},"type":"array","title":"Result"}},"type":"object","required":["num_of_pages","page","total","result"],"title":"DatasetAndItemActivityListResponseSchema","description":"Default schema for multiple dataset and item activities in response."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ItemActivityIndexedSchema":{"properties":{"activity_type":{"$ref":"#/components/schemas/ItemActivityType"},"activity_time":{"type":"string","format":"date-time","title":"Activity Time"},"container_code":{"type":"string","title":"Container Code"},"container_type":{"$ref":"#/components/schemas/ContainerType"},"item_id":{"type":"string","format":"uuid","title":"Item Id"},"item_type":{"type":"string","title":"Item Type"},"item_name":{"type":"string","title":"Item Name"},"item_parent_path":{"type":"string","title":"Item Parent Path"},"zone":{"type":"integer","title":"Zone"},"user":{"type":"string","title":"User"},"imported_from":{"type":"string","title":"Imported From"},"changes":{"items":{"type":"object"},"type":"array","title":"Changes"},"network_origin":{"type":"string","title":"Network Origin"},"index":{"type":"string","enum":["file"],"title":"Index"}},"type":"object","required":["activity_type","activity_time","container_code","container_type","item_type","item_name","item_parent_path","zone","user","changes","network_origin","index"],"title":"ItemActivityIndexedSchema","description":"Item activity schema with source index."},"ItemActivityListResponseSchema":{"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/ItemActivitySchema"},"type":"array","title":"Result"}},"type":"object","required":["num_of_pages","page","total","result"],"title":"ItemActivityListResponseSchema","description":"Default schema for item activities in response."},"ItemActivitySchema":{"properties":{"activity_type":{"$ref":"#/components/schemas/ItemActivityType"},"activity_time":{"type":"string","format":"date-time","title":"Activity Time"},"container_code":{"type":"string","title":"Container Code"},"container_type":{"$ref":"#/components/schemas/ContainerType"},"item_id":{"type":"string","format":"uuid","title":"Item Id"},"item_type":{"type":"string","title":"Item Type"},"item_name":{"type":"string","title":"Item Name"},"item_parent_path":{"type":"string","title":"Item Parent Path"},"zone":{"type":"integer","title":"Zone"},"user":{"type":"string","title":"User"},"imported_from":{"type":"string","title":"Imported From"},"changes":{"items":{"type":"object"},"type":"array","title":"Changes"},"network_origin":{"type":"string","title":"Network Origin"}},"type":"object","required":["activity_type","activity_time","container_code","container_type","item_type","item_name","item_parent_path","zone","user","changes","network_origin"],"title":"ItemActivitySchema","description":"General item activity schema."},"ItemActivitySortByFields":{"type":"string","enum":["activity_time"],"title":"ItemActivitySortByFields","description":"Fields by which dataset activity logs can be sorted."},"ItemActivityType":{"type":"string","enum":["download","upload","delete","copy","import","create","approve","update"],"title":"ItemActivityType","description":"Store all available item activity types."},"MetadataItemListResponseSchema":{"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/MetadataItemResponseSchema"},"type":"array","title":"Result"}},"type":"object","required":["num_of_pages","page","total","result"],"title":"MetadataItemListResponseSchema","description":"Default schema for multiple metadata items in response."},"MetadataItemResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"parent":{"type":"string","format":"uuid","title":"Parent"},"parent_path":{"type":"string","title":"Parent Path"},"type":{"type":"string","title":"Type"},"zone":{"type":"integer","title":"Zone"},"name":{"type":"string","title":"Name"},"size":{"type":"integer","title":"Size"},"owner":{"type":"string","title":"Owner"},"container_code":{"type":"string","title":"Container Code"},"container_type":{"$ref":"#/components/schemas/ContainerType"},"created_time":{"type":"string","format":"date-time","title":"Created Time"},"last_updated_time":{"type":"string","format":"date-time","title":"Last Updated Time"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"template_id":{"type":"string","format":"uuid","title":"Template Id"},"template_name":{"type":"string","title":"Template Name"},"attributes":{"type":"object","title":"Attributes"},"status":{"$ref":"#/components/schemas/MetadataItemStatus"},"pk":{"type":"string","title":"Pk"}},"type":"object","required":["id","type","zone","name","size","owner","container_code","container_type","created_time","last_updated_time","tags","status","pk"],"title":"MetadataItemResponseSchema","description":"Default schema for single metadata item in response."},"MetadataItemSortByFields":{"type":"string","enum":["size","created_time","last_updated_time"],"title":"MetadataItemSortByFields","description":"Fields by which metadata items can be sorted."},"MetadataItemStatus":{"type":"string","enum":["ACTIVE","ARCHIVED"],"title":"MetadataItemStatus","description":"Store status of metadata item."},"ProjectFilesActivityResponseSchema":{"properties":{"data":{"additionalProperties":{"type":"integer"},"type":"object","title":"Data"}},"type":"object","required":["data"],"title":"ProjectFilesActivityResponseSchema","description":"Default schema for project files activity response."},"ProjectFilesSizeDatasetSchema":{"properties":{"label":{"type":"integer","title":"Label"},"values":{"items":{"type":"integer"},"type":"array","title":"Values"}},"type":"object","required":["label","values"],"title":"ProjectFilesSizeDatasetSchema","description":"General project files size datasets schema."},"ProjectFilesSizeResponseSchema":{"properties":{"data":{"$ref":"#/components/schemas/ProjectFilesSizeSchema"}},"type":"object","required":["data"],"title":"ProjectFilesSizeResponseSchema","description":"Default schema for project files size response."},"ProjectFilesSizeSchema":{"properties":{"labels":{"items":{"type":"string"},"type":"array","title":"Labels"},"datasets":{"items":{"$ref":"#/components/schemas/ProjectFilesSizeDatasetSchema"},"type":"array","title":"Datasets"}},"type":"object","required":["labels","datasets"],"title":"ProjectFilesSizeSchema","description":"General project files size schema."},"ProjectFilesStatisticsResponseSchema":{"properties":{"files":{"$ref":"#/components/schemas/ProjectFilesTotalStatistics"},"activity":{"$ref":"#/components/schemas/ProjectFilesTodayActivity"}},"type":"object","required":["files","activity"],"title":"ProjectFilesStatisticsResponseSchema","description":"Default schema for project files statistics response."},"ProjectFilesTodayActivity":{"properties":{"today_uploaded":{"type":"integer","title":"Today Uploaded"},"today_downloaded":{"type":"integer","title":"Today Downloaded"}},"type":"object","required":["today_uploaded","today_downloaded"],"title":"ProjectFilesTodayActivity","description":"Project files today's activity schema."},"ProjectFilesTotalStatistics":{"properties":{"total_count":{"type":"integer","title":"Total Count"},"total_size":{"type":"integer","title":"Total Size"}},"type":"object","required":["total_count","total_size"],"title":"ProjectFilesTotalStatistics","description":"Project files total statistics schema."},"SizeGroupBy":{"type":"string","enum":["month"],"title":"SizeGroupBy","description":"Store possible group by options for metadata items."},"SortingOrder":{"type":"string","enum":["asc","desc"],"title":"SortingOrder","description":"Available sorting orders."},"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"}}}}