Workspaces API

Update workspace details

PUT /api/workspaces/:id

Parameters

Name	Description
id	Id of a workspace
name	Name of workspace
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=d0I0Rnp3blBHMFhNMkZVbFJWNjQ3cUhldFhxZ3BlOE94YnZpdkRyNklIMndmOUNCK0ZDZEgwMDZSVlZNbC9OdGRlZ2hxTzN6L2JwTjBZdkREc1FBejVCbWFzNFRlaVMrUzFiRUlyai9QR2dKMUM0VW43Sm4ycHo2ZTdGcndrY3FsSUVBNkE0TDdiQ0NiZTFUQ0tCUnFIWG9yU0VtbDh6TlBiUldVUXRiMWJ3STJxZWpPeVVuRFNjWXVnUWVxYTIrMFBLVThJbjRxWDlLckp2QWpudEVCcVQxbU8xMGE1RU1QNDVVQWdwc3IxTHFyZDc0WFhJOGxueTEvaVZmV0ZTZllaL0dtZ3MxOSt3ZEh5bktSUnlueTc4RUlvbDVOeXJucE1lSEwvVExBc1U5bE8zMUowODdjMUNDeEozeXZidDl2T2FRK2J1OUNXVEtldlp0TUN5bGFpdVRSYjVuUlhQa1pCV29pejBWemphU1FRNytDL2Njckx0RVhteW5hSWVwMFA0STcxM2ZKL0F4dDl4bVllMVhCNVc4UnZsRzZmMi9HRHpTOVNhUS95UT0tLXBTQ1F5MXVzUGprdVVPZGhBNDZlOXc9PQ%3D%3D--ea6231d05b4a40775ef9a46c8628e8039a235598

Route

PUT /api/workspaces/1000008

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/"0bb95d421b45ce343357444deb2c1550"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _session_id=Mk16aW5IY0cwLzlSUnRiYzFmbi9nT2xVYVp6V0dCelhsSkVHSVhDVUZ4SnlEUjc0ajNSbkduUksrQzdOQ2IrejBueExiVWQwaktacXEybUI3YSt5WmtRWU1kb0s4RzZqS2V3ZmRCMG5IaGFWWE8xUzl4MDdXZ25LT3JjT0Z2M1VlS092QzdUdk93c2xOQ1Z1RGRrLzJZZ2RFMmlZalB3WVV1UTFqSDhnQVpLZVMzVnZFYjdHVUQvU1JaVzhXeDc0TW9YeExIZ2JZbWk0NzhyOWgzbStTQytHRTRtLzZNR2NQUDdqR0d1N0xWcU12eUdwUXpGSCtLZDBnOHB3RVB5SytnU213bSs4RGgwYlRGd090RDQrZ1RYOVNDMUdjVUtKVUI5Q2I3VkxRTnZhbW53R1ZvMitkcGN1THlWd1lwZEZ3Q3EwN251djdPNklzb0NwMVJVbEYwUmk3dWcvNkcyK0Y4am1mZTZLVGtXZng4UXc4SDlhS01MdDg3anpzS1ZNS2R1clIxK0RHdHdmTDJQVFRLM2JTSnRieTFaQ09xdnpQZUo3N05pOXB5Q21FSG51RldCUG95QzA2bEtjKzIvSy0tMWllRmJ2UUJscllKTGZjMEhlUVVCZz09--fac90ddcd705e81359f20c1650db48fc134e9e1f; path=/; HttpOnly
X-Request-Id: 05a07e99-b081-4e32-a6fe-97fe1b94b384
X-Runtime: 0.198005
Content-Length: 2545

Status

200 OK

Body

{"response":{"id":1000008,"name":"Awesome Workspace","is_deleted":null,"entity_type":"workspace","archived":false,"public":false,"archived_at":null,"summary":"I like big data and I cannot lie, all the other coders can't deny","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}}