Workfiles API

Update a workfile

PUT /api/workfiles/:id

Parameters

Name	Description
id	Id of a workfile
execution_schema[id]	Id of the execution schema
file_name	Filename

Request

Headers

Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: _session_id=dU1JVXFRZGt3SVpNNVRnV2wwVVlWUEplMm9HZTRjODV4VlFaeDd2RktaMTgrQmlycmRpbFNMRzZPaUVKdHpZSlJNT3lweFRxdFRsYllHRlMzaGt6cjNVeG12ekxCa01JcEZTNm9LUjJCUGYzd2s1cG55UmRBODRVc3FpblpCSFJqMFdNZGt2ejUvN3JFRTQ0NXFNVXdaTk1JU1ByR1ZObTFQSzR2RmFlY0ZkWXRuajVqam5qOVZrM0ZmeHhqcFk4bXFNelZyS09saEpEYnN5cGx4b2lYUElZYXhKWDlqczdFbmF4VHRGdk5GTmxmWVlVNzV5OEFIbjBMZEkvL1VwK0Z3TWsrUnRJa1RvTExDcDBpcnNKenVnK2E5cS9jbW5XWW1YcTlPYTMxNW40SHA2TzFGNWt3M003L0JTSGZqZU1uZ1RoTUZ0cjlmTDdvQmlJVlFla1ZWZGQyZjRNMzd2dU1DTEU5T01ybkZMWUY2ODZ1ZTFBakxUcEpYUzJzdy9kTkx2Ujd0L3NIbzU0TVQ5VEhrMTA5dXBjK1NDN01NZkZvVE5JRjhiUlYxND0tLW5kT2E0SW1rVklkcFZiSGhHL0QyQmc9PQ%3D%3D--9719f09e2f2e6994d34fb1a32e11bf189e90ed58

Route

PUT /api/workfiles/1000018

Body

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/"3209da009c345c6ff63e797d8e2f7c1b"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _session_id=YmdyY1FmT1dYLzEzK1pPWnFjMVhqd2RwZUdrV1Z5QU1aL1phR2lIaWkxS3J3cjl5OGd5b3hyeHNmSDZZa0JhUnlFcGxtWFllRHcwemlYVmh5K0xXOXhaajRiKzZJNzNYMUNYemFub0NpTFcrRU80TXhpc1VGWFZqbWF1ajNxRnZMb3FSUlRXdkh3Y1VKVXdtcXZIbzZ4K3UvdEFBWmhMNTBhMnV1Mm1RR1NFQUZaenpBQ0xqWFlBbFNNQzJuV05MMGZNbzdHRTd2Q2cra2dzcTRJLzBDS3ZGSmhTZllTNU1DaitGNUZFN1pyZkdhUVlFd29hamh5b2ZVbDRndUN6R1d2MGdpUUozRFRYL3dvUGYzam9nY0J6TnVVcms2RStVSzlSMktCakg2dEhHMWZ0REowYlMyWTZhaDB0d1k2TFo1VUVWektpWnNyc3BkUUJoY0k5UHFFNTgvd0NlQUZTSjVPNVZEY0xoeWdMNVhERy95dFZTaDJpSmJ3dGJIdlM1OGxzNitnNmRxY25GMURjSUx1eTZyaEZLYm9kYlRMQy9RTkFKMEZVbVc2NDI5cXZOVEo2ZGlVZGZEKzJPVnhCUC0ta0oyQTNqTW1CclBNS1lyQUJTU3MwQT09--9fa7a972a22bcb646a88725eb6de4e424af7cda3; path=/; HttpOnly
X-Request-Id: 3c70c042-da1f-48e5-8171-692f9a559954
X-Runtime: 0.228121
Content-Length: 5444

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":"newname.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}}