Workfiles API

Get workfile details

GET /api/workfiles/:id

Parameters

Name	Description
id	Id of a workfile

Request

Headers

Host: example.org
Cookie: _session_id=akNZckMxK3VvTE11M2g2MkkwYjZaQWtxdldwckRBNVZPWmlMVjV5WTRjb2pVajRmSEJoYTkrMk9xbXQ5UitjK0ZuS2dGRmdIaS9YNzMrZGNMZUZabHpacS9wY0RQdXFsODUxQ3ROM3o3L1BqSDVISWlOQnNTRk1yVzJIL0MwUk55RTZSQ0dJVjV6ODJmZDJUSGN2WDdWYUhrR1k0MUo3MmhXZUJKY1phc0oyYUJZOFozelUrVHhIbUFXVkcrVlVwRGpQbDVTeHJLVjhiOFlibm9sNVRpaVVhZTlYdXJheUdUT2FtbUgvclF6dHZxbHpaME5jSStyRzdpUTN6dk04ZEtqZGlOKy9aRlM0QW9sajZwSkdFQXFnRU9JYndPYXdrRTgzSTlxSVFqczloZ3Z6L1JaalRtZVBHOU1vbktJbXYzZ0hLZ2V1Yk1mZFc1VkdnTHl4QTNDQXE3S1Btc0oya1NjQTlLL1orV3BFUVpBSkhpQlI1Z3hYb1RDTDllSks3eFRrUmZVRjcxQ0FnMnkrd3dEWk1PZkhROFptdk9sRGJQbTRjR2t6M0JUaz0tLUR2WXZjOEdBMmpvZlZHb05yUGc1dXc9PQ%3D%3D--157dc4a573ae827265b5b7ee10c6fdee59a7f897

Route

GET /api/workfiles/1000018

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"781271404e6631dad1a9d21c64e9903c"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _session_id=amRVWGUyOFlwa21QR3J0K282Mk16QTlZeEpDUmFLS21NSzdDMUU0TXE0czBkTHZPTzR1dzBicU14Z0RqcWJXOXpxdDZLdWlBK3lRRGVmaW5BSTBWTFEwZE51OU4xVWpuOHNwcXAvOTB6RlhZRHEzKyt1OTlLVmFRSDVmNHNGMDZhbGh5dGJIY1djdGpLQTZ3SmR3VFMxQmF3VnQrSGxubUtQVlJQUjREUVJLRERGaDd2MHlCODdweUlidFF1ZU41YktiSWlKM0tyZ3lSZitOdmU3NDlQUDR6aC9lZTdMZVBBQ3hFMFh6VHc5cUN0VEtXYTRaZ241d3FJSC8zVkhUT3E0dFQwSGJIZEk5MGxxTUNLMWpOVVJCdUo3Qm94dUtEV1BDc3dqZ0JwUElEb3RpakF1STFHU0FuQnVGSWNlU0VYS2czUmt6SVFjZzRIUjF1cHlRbHZGSHhuWXdnd3RRMVNvS3VTaEtvakxhdTdIdFhQK3dMYld3eU4zb05uRTVKN1NIeFRHZkx0SHRha1J5Q0t6dS9tVERvTXRXbWo3dFcrTHEyNGIydENsM1I2OGl1UlBXcDZPcFNkM0JOZUhiZy0tallHTGFoSURiZ2tLYXBCTmlja0tyUT09--641e511d67d376732931dc19cae302af903c3697; path=/; HttpOnly
X-Request-Id: 4eb88da1-a8fd-4916-851c-2407ff6dd6b1
X-Runtime: 0.196665
Content-Length: 6771

Status

200 OK

Body

{"response":{"id":1000018,"workspace":{"id":1000008,"name":"Public","is_deleted":null,"entity_type":"workspace","archived":false,"public":true,"archived_at":null,"summary":"searchquery","permission":["admin","create_workflow"],"datasets_count":11,"members_count":2,"workfiles_count":17,"insights_count":1,"recent_insights_count":1,"recent_comments_count":9,"has_recent_comments":true,"has_milestones":true,"workspace_stage":{"default":true,"id":1000000,"name":"Define","position":0,"description_long":"Define the essential components of the project.","description_short":"Define the two essential components of a machine learning project. What business problem are we solving? How should the solution change the way our business operates? Locate or acquire all necessary data.","complete_json":true},"workspace_stage_id":1000000,"archiver":null,"image":{"original":"","icon":"","entity_type":"image","complete_json":true},"tags":[],"has_added_member":false,"has_added_workfile":true,"has_added_sandbox":true,"has_changed_settings":false,"sandbox_info":{"id":1000006,"name":"default","dataset_count":0,"refreshed_at":"2019-04-03T22:09:24Z","entity_type":"gpdb_schema","is_deleted":null,"stale":false,"database":{"id":1000001,"name":"default","data_source":{"id":1000002,"name":"Owners","entity_type":"gpdb_data_source","is_deleted":null,"shared":false,"owner_id":1000006,"version":"9.1.2 - FactoryVersion","is_hawq":null,"state":"online","public":false},"entity_type":"gpdb_database","complete_json":true},"complete_json":true},"show_sandbox_datasets":true,"owner":{"id":1000006,"username":"owner","first_name":"searchquery","last_name":"User_1","image":{"original":"/paperclip/users/images/001/000/006/original/User.png?1554329366","icon":"/paperclip/users/images/001/000/006/icon/User.png?1554329366","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":["data_admin"],"email":"chorususer282295@alpinenow.com","title":"Chief Data Scientist","dept":"Corporation Corp., Inc.","notes":"One of our top performers","admin":false,"subscribed_to_emails":true,"tags":[],"deactivated_at":null,"complete_json":true},"is_member":true,"is_project":true,"project_status":"on_track","project_status_reason":null,"milestone_count":3,"milestone_completed_count":0,"project_target_date":"2019-04-28T00:00:00Z","complete_json":true},"file_name":"sql.sql","file_type":"sql","latest_version_id":1000013,"is_deleted":null,"recent_comments":[{"body":"note on workfile","author":{"id":1000006,"username":"owner","first_name":"searchquery","last_name":"User_1","image":{"original":"/paperclip/users/images/001/000/006/original/User.png?1554329366","icon":"/paperclip/users/images/001/000/006/icon/User.png?1554329366","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":["data_admin"]},"timestamp":"2019-04-03T22:09:38Z","complete_json":true}],"comment_count":1,"tags":[],"entity_type":"workfile","entity_subtype":null,"user_modified_at":"2019-04-03T22:09:38Z","status":"idle","description":"A nice description","link_url":null,"owner":{"id":1000006,"username":"owner","first_name":"searchquery","last_name":"User_1","image":{"original":"/paperclip/users/images/001/000/006/original/User.png?1554329366","icon":"/paperclip/users/images/001/000/006/icon/User.png?1554329366","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":["data_admin"]},"associated_worklets":[],"has_draft":false,"execution_schema":{"id":1000006,"name":"default","dataset_count":0,"refreshed_at":"2019-04-03T22:09:24Z","entity_type":"gpdb_schema","is_deleted":null,"stale":false,"has_credentials":true,"database":{"id":1000001,"name":"default","data_source":{"id":1000002,"name":"Owners","entity_type":"gpdb_data_source","is_deleted":false,"shared":false,"owner_id":1000006,"version":"9.1.2 - FactoryVersion","is_hawq":null,"state":"online","public":false,"host":"data_source.emc.com","port":5000,"ssl":false,"online":true,"db_name":"postgres","description":null,"db_username":"username","owner":{"id":1000006,"username":"owner","first_name":"searchquery","last_name":"User_1","image":{"original":"/paperclip/users/images/001/000/006/original/User.png?1554329366","icon":"/paperclip/users/images/001/000/006/icon/User.png?1554329366","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":["data_admin"],"email":"chorususer282295@alpinenow.com","title":"Chief Data Scientist","dept":"Corporation Corp., Inc.","notes":"One of our top performers","admin":false,"subscribed_to_emails":true,"tags":[],"deactivated_at":null,"complete_json":true},"tags":[],"schema_blacklist":[],"data_source_provider":"Greenplum Database","complete_json":true},"entity_type":"gpdb_database","complete_json":true},"complete_json":true},"complete_json":true,"version_info":{"id":1000013,"version_num":1,"commit_message":null,"owner":{"id":1000006,"username":"owner","first_name":"searchquery","last_name":"User_1","image":{"original":"/paperclip/users/images/001/000/006/original/User.png?1554329366","icon":"/paperclip/users/images/001/000/006/icon/User.png?1554329366","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":["data_admin"]},"modifier":{"id":1000006,"username":"owner","first_name":"searchquery","last_name":"User_1","image":{"original":"/paperclip/users/images/001/000/006/original/User.png?1554329366","icon":"/paperclip/users/images/001/000/006/icon/User.png?1554329366","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":["data_admin"]},"created_at":"2019-04-03T22:09:38Z","updated_at":"2019-04-03T22:09:38Z","content_url":"/api/workfile_versions/1000013/image?style=original\u00261554329378","partial_file":false,"icon_url":null,"content":"SELECT test FROM rspec WHERE lame = 'false';\n"}}}