Workspaces API

Create New Workspace

POST /api/workspaces

Parameters

Name	Description
name	Workspace name
public	true if the workspace should be public, false if it should be private. Defaults to private if the parameter is not provided.
summary	Notes about the workspace

Request

Headers

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

Route

POST /api/workspaces

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/"6e610fcde31f20f13b238e20a82e8b41"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _session_id=NUV4RUpsN2VxQ0dsaFpUdDlGbjR3NExRYmdmMzlBMEJiMVI1a2RZSHprTkR3Uk9nUkt4M0hsRzhoVndpeE1Kd2w2VnF4Rk9IdktHWjNONnhhdnVSelRWUzRxb0M2VXVManlEQ1d3TlBYdjhnSmtiNUIwMTFnM1RVUUxlSlVMek5rNzJvNVZGK2JMN3VrV3QzVzJKcEgxYWFQemxkRWZPcEcvUXZSbjhzMXJuM1U3MkU1VmZsTjlOVksveDJXLzBOMXpmZ1pCVmpxT1lPZjU1V25MYmxKUkdpNjVUcTArQnhUcWFyTE94S2ZjVTRzQUplVUZ1TG9ZZ3VFSzQ4eXBzYjdHTUo0Rm5CL2N2L0dkSUkyUUFSN3lTMEQ5Y3RvN0I3TndLTWcrV0Q4TWlhNmhpOExQMll3S0lFTzJlR2tFUFYxbDBzaXNJaVU2aWUwdjE1bHJVU2YweEJDSkV1K3l6SVhSbW45aUJkSkVQTCtub3ArWlJiM3dHVjN3bHlMWGN1bTV3SzhyNDdwa1crK0o1MDJzUmdjT3RoQnZlMjRkZkQxOXpzYVo0ZC9UbHVNUDE0UFk1dUpXbmsySTI2dUNHWS0tclR1ZUsvdWswUGZVMDZZTXVwa1Ywdz09--ff1ca6b804d65588cf930520c50a0646ef36dc4a; path=/; HttpOnly
X-Request-Id: 6879efc9-e346-468a-939f-438e52eda8a1
X-Runtime: 0.186422
Content-Length: 2019

Status

201 Created

Body

{"response":{"id":1000016,"name":"Awesome Workspace","is_deleted":null,"entity_type":"workspace","archived":false,"public":false,"archived_at":null,"summary":"Lots of good data in here","permission":["admin","create_workflow"],"datasets_count":0,"members_count":1,"workfiles_count":0,"insights_count":0,"recent_insights_count":0,"recent_comments_count":0,"has_recent_comments":false,"has_milestones":false,"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":false,"has_added_sandbox":false,"has_changed_settings":false,"sandbox_info":null,"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":0,"milestone_completed_count":0,"project_target_date":null,"complete_json":true}}