Workfiles API

Run a workflow

POST /api/workfiles/:id/run

Parameters

Name	Description
id	Id of a workflow

Request

Headers

Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: _session_id=T1VYL3hoWjNDK0FSaW8xYXNuTEdCZzhjSHFvSTgvdjFTMEpJenJyRWJZb2d5bVJ2V1B6NkFqeTRYK3NuLzV3OENRNVllQndEbVpmK0dYMGllSExnQTBLRSsrMWF0azI3M0hvSk9wTXZ5TkgrTjVVRDJjNFpVbzVoWjN0cG1VdGhsVVQ3ZmNUSEcyaWw2NEpRTTJRUGErUWh1cjRYQnhYbzVNdTMrK2svVlJNZk1sZ1Z4WWNxR0xiTGtJL21uT0VhQ05nT2Nnd3ltTUJ1Ym9OS3F6c3lycXJ1aTRJS0JHSXlIYTQwN0Y3NlVGVGNpaldkSFFqaVJieVNYNWF4ZHlYQjIxVU5HOG11ZldINGVwTVQrN1BwMnhjc3lnSk5CK3lGNlFMZ25SSlR4ZFFMUjJYWGRHMUdEZXl0V0k5Y0ZDRm0wUXo3RXp2RW01ZTl0QnA4ckxnK25aNHVHeC90dkM1SFh4SnJuUWpCQUR2bEh1Q243NDFpVm53cHcvUFhZdmlZMFp3cW9VRStYZjVpVlVnOFg1VXE2TzRUb1RPOTlqaG1mZTB5RVk5RzhyVT0tLTNTU0VQRjF4VzF5TzNLUEF6NytKSXc9PQ%3D%3D--5d99cb0a11f1f5c55870b9d30c31fb2ff4871c78

Route

POST /api/workfiles/1000004/run

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=eEluOTZubGZxMGVxRGRQSmN2NmtFVVdCQjgrM1ZZdzNWT2JKaEtaTS90R1doMGJnQ1l4SC9XM3d0bi9zWVhUQm9rVVhhQ3hDL0pOcFVER3UwRnBjWnlKOTlMVzErSW9ZNVpwSWwvMWhKRGVYVkw2aEpoVCtVeTZaaUJuYldHVVZBRzQ5akhzYTEvSlpmelVqZVpBcHdpay85bjZTT25qQ25ibVRITGxtVHB2R1A3MGNGSmJTdW5zdkJ5WWtnTnlIZVYxVkc2WVI5ajNZdVU3dnp6TGp1OFlTUEt4eTlYS3RBWHQzVk1XK1BEcWRzMkFscUpJNXhZeE4waTV0NzltY3hPZ3ZpZFkvQnFZUTB3MVptMXdISmU3MmRodFJyK1N2bFRIM0UxRmVPWnVhQzNVbW9RMjRTcDRDemgzbGE0K3NRdGVwelVNTHV2UmNnYmJVZS9LRk5JNlYvSFVXd3lxNE00Ym9WWkVsc0NHQnhLVllObmNMSXNNY0I5YWZYTTBVVHBRYUxBZHBnYkVvem92S0NaWW1sYkNLSzhXeTZiQS8ySThDV3lETVN5Wmc3VURMS3h3WlpGdHRYN3IraFFyZS0tU1Y3UXBKaFc2d1EvVDlrb2V1S3JEUT09--cb5494391a6a23b1159569d2b82ca28015e1ef36; path=/; HttpOnly
X-Request-Id: 86569867-ce03-4fdb-a988-d9efb24dc69c
X-Runtime: 0.118140
Content-Length: 3681

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":"running","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}}