Function: createSpace()

function createSpace(client, parameters): Promise<{
[key: string]: unknown;
  _links?:   | {
   [key: string]: unknown;
     base?: string;
     byOperation?: string;
     collection?: string;
     context?: string;
     download?: string;
     editui?: string;
     edituiv2?: string;
     next?: string;
     prev?: string;
     self?: string;
     tinyui?: string;
     webui?: string;
   }
     | null;
  authorId?: string;
  createdAt?: Date;
  currentActiveAlias?: string;
  description?:   | {
   [key: string]: unknown;
     plain?:   | {
      [key: string]: unknown;
        representation?: string;
        value?: string;
      }
        | null;
     view?:   | {
      [key: string]: unknown;
        representation?: string;
        value?: string;
      }
        | null;
   }
     | null;
  homepageId?: string;
  icon?:   | {
   [key: string]: unknown;
     apiDownloadLink?: string;
     path?: string;
   }
     | null;
  id?: string;
  key?: string;
  name?: string;
  spaceOwnerId?: string;
  status?: "current" | "archived";
  type?:   | "global"
     | "personal"
     | "collaboration"
     | "knowledge_base"
     | "system"
     | "onboarding"
     | "xflow_sample_space";
}>;

Defined in: src/v2/api/space.ts:49

Creates a Space as specified in the payload.

Available on tenants with Role-Based Access Control.

Permissions required: Permission to create spaces.

Parameters

Parameter	Type
client	Client
parameters	{ body?: Record<string, any>; }
parameters.body?	Record<string, any>

Returns

Promise<{ [key: string]: unknown; _links?: | { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; } | null; authorId?: string; createdAt?: Date; currentActiveAlias?: string; description?: | { [key: string]: unknown; plain?: | { [key: string]: unknown; representation?: string; value?: string; } | null; view?: | { [key: string]: unknown; representation?: string; value?: string; } | null; } | null; homepageId?: string; icon?: | { [key: string]: unknown; apiDownloadLink?: string; path?: string; } | null; id?: string; key?: string; name?: string; spaceOwnerId?: string; status?: "current" | "archived"; type?: | "global" | "personal" | "collaboration" | "knowledge_base" | "system" | "onboarding" | "xflow_sample_space"; }>