Workfiles API

Stop a running workflow

POST /api/workfiles/:id/stop

Parameters

Name	Description
id	Id of a workflow

Request

Headers

Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: _session_id=MEdIdGxlUDcrKzJHM1Fzek1vR1Z2dzNUT3k2ZUFKdEp4Y1AzM3JJQ1Bjem1ldG1RSk5OanRoN1FnclRFdEc4U3J2VEhjTkJZY056aU5QTjJEa1EybmljZUJ3ZmtOZlE0SWpKWENZWDEvNU15ZVNmRUhHZ3M0eEFWaGtYZXNRNDBhWTZxMlZURHNOSldLZng5b0ZUTUFJeG5vOUZldHBkeGpiRkJaK1VDWFZsaUMxajZSalJyRENkdFBMNW1BOTNnUEtXbis5SkJRN1FaNFRLNUY4WFByMDBZNlhWcS9wZkUrSkIwNkVwakFzeXV1cUlnWThxYk9kMXE0VE5ra2VXR2RQbTJ1UFBIRzlENHQwVWJuUXEwOElEaTR3MWVCbUovQXBzQTB0WUkyUlBReW9HVjBzT1p5d0dxcU1NRzdJRTJxdXAvU01SZno3dUp0eXIxbTVuSU03NUVmWktZeWVCbEg2QjFtNkduYUFIUGZoMVQxbHVQMWpXY2l6bGM1MXBrYlVoL3d0ckRHK2ZXKy81QXVFbjd4SEprdDRxN2FWNFp6Q1Vzc3VKeEZDbz0tLVBIaWxPVTEyTEdab3hvdkZ0aHlTY0E9PQ%3D%3D--2df03f77097aa16c3ccd0619f24fd7b4fd7ccf53

Route

POST /api/workfiles/1000004/stop

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Set-Cookie: _session_id=VmpidHVGd1Fqd3AzVVdwZHlsK1c1OVhuNTZRc1hGK2p0d0F2cnlraWh3V0ZpbnlCYlVEc3Q1S3ZzRkg0R2dOTW5tajJzeGxoNERhSHdpSDR1TWlvZzlEVnJxSTk1VUJxcFBrV0FpeWtFZjNyc1ZpYUJEVDFjVFhJaUtOWnF6ck1QNGVENlZlRFhwRk5EN0hudFZ2dXNud3dWdDQ4ak1KOHFZcnB2S1hiM1I1ZWJiUEplRHFSUjhINVg3ZElEUnBhaUp1djBjQ2JEU0o3bXo5cElEMzVZN1V5REVsT1ZPdFM2MzE0NC9yeWl6RG9aQUUzcWVIMjY3VGNtdHF3Sm1RbW1LWU91dTQrZ2ZBbk45QitGZFdpYTd1STYrZ2ZsME91ZkVVRmZWaGk1dFhUaHk5Q0U1UWFLNTI2S2dBRFZ3T3dsTFBRTW85cXAwTUVRYW1WTE5tRnU2Tll1UU5vR1haZjBnamtYQUdNSXkrQXdBUzUzbkQ3bU1NemFGMmxsOUhVTXFuSlFCTjVRV1hheFR3UHJpWE1lTkg1cWpqT0xmYWx3R3EzdnFQYUpadDRjOUpGRmhOc2J3TFlpRlZpZmtodC0tS3ZoWVhPUXFoTFV0L0lsMm1sbHUrdz09--5805ce479373ceac00581537d42cfe83cbac8684; path=/; HttpOnly
X-Request-Id: f93ba14d-b2a3-48a5-8a0a-4d6ef8387c24
X-Runtime: 0.176805
Content-Length: 3678

Status

202 Accepted

Body

{"response":{"id":1000004,"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":"alpine_flow","file_type":"work_flow","latest_version_id":null,"is_deleted":null,"recent_comments":[],"comment_count":0,"tags":[],"entity_type":"workfile","entity_subtype":"alpine","user_modified_at":"2019-04-03T22:09:35Z","status":"idle","description":null,"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":[],"execution_locations":[{"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}],"dataset_ids":[],"complete_json":true}}