Type Alias SpacesAPI

type SpacesAPI = {
    clearCache: typeof clearCache;
    createSpace: typeof createSpace;
    createSpaceAssignment: typeof createSpaceAssignment;
    createSpaceShare: typeof createSpaceShare;
    deleteSpace: typeof deleteSpace;
    deleteSpaceAssignment: typeof deleteSpaceAssignment;
    deleteSpaceShare: typeof deleteSpaceShare;
    getSpace: typeof getSpace;
    getSpaceAssignment: typeof getSpaceAssignment;
    getSpaceAssignments: typeof getSpaceAssignments;
    getSpaces: typeof getSpaces;
    getSpaceShare: typeof getSpaceShare;
    getSpaceShares: typeof getSpaceShares;
    getSpaceTypes: typeof getSpaceTypes;
    patchShare: typeof patchShare;
    patchSpace: typeof patchSpace;
    updateSpace: typeof updateSpace;
    updateSpaceAssignment: typeof updateSpaceAssignment;
}
Index

Properties

clearCache: typeof clearCache

Clears the cache for spaces api requests.

createSpace: typeof createSpace

Creates a space. Spaces names must be unique. Spaces of type data should only be used for Qlik Talend Data Integration projects.

an object with the body content

CreateSpaceHttpError

createSpaceAssignment: typeof createSpaceAssignment

Creates an assignment for a user or group (assignee) to a space with the specified roles. Assignments are not required for space owners, who receive all assignableRoles by default. Only one assignment can exist per space, per user or group.

The ID of the space of the assignment.

an object with the body content

CreateSpaceAssignmentHttpError

createSpaceShare: typeof createSpaceShare

Create a space share

The ID of the space of the share.

an object with the body content

CreateSpaceShareHttpError

deleteSpace: typeof deleteSpace

Deletes a space. Ensure that you first delete all resources from the space to avoid orphaning content.

The ID of the space to delete.

DeleteSpaceHttpError

deleteSpaceAssignment: typeof deleteSpaceAssignment

Deletes an assignment.

The ID of the space of the assignment.

The ID of the assignment to delete.

DeleteSpaceAssignmentHttpError

deleteSpaceShare: typeof deleteSpaceShare

Deletes a space share.

The ID of the space to which the share belongs.

The ID of the share to delete.

DeleteSpaceShareHttpError

getSpace: typeof getSpace

Retrieves a single space by ID.

The ID of the space to retrieve.

GetSpaceHttpError

getSpaceAssignment: typeof getSpaceAssignment

Retrieves a single assignment by assignment ID. Use GET /spaces/{spaceId}/assignments to list all users and groups assigned to the space and their assignment ID.

The ID of the space of the assignment.

The ID of the assignment to retrieve.

GetSpaceAssignmentHttpError

getSpaceAssignments: typeof getSpaceAssignments

Retrieves the assignments of the space matching the query. Each assignment represents one user or group and their corresponding roles in the space. Assignments are not shown for the owner of a space, who receive all assignableRoles by default.

The ID of the space of the assignment.

an object with query parameters

GetSpaceAssignmentsHttpError

getSpaces: typeof getSpaces

Retrieves spaces that the current user has access to and match the query.

an object with query parameters

GetSpacesHttpError

getSpaceShare: typeof getSpaceShare

Retrieves a single space share by ID.

The ID of the space to which the share belongs.

The ID of the share to retrieve.

GetSpaceShareHttpError

getSpaceShares: typeof getSpaceShares

Retrieves the shares of the space matching the query.

The ID of the space containing the shares.

an object with query parameters

GetSpaceSharesHttpError

getSpaceTypes: typeof getSpaceTypes

Gets a list of distinct space types available for use in the tenant.

GetSpaceTypesHttpError

patchShare: typeof patchShare

Updates properties of a space share (roles, and disabled state for link shares).

The ID of the space to which the share belongs.

The ID of the share to update.

an object with the body content

PatchShareHttpError

patchSpace: typeof patchSpace

Updates one or more properties of a space. To update all properties at once, use PUT /spaces/{spaceId}.

The ID of the space to update.

an object with the body content

PatchSpaceHttpError

updateSpace: typeof updateSpace

Updates a space. To update specific properties, use PATCH /spaces/{spaceId}.

The ID of the space to update.

an object with the body content

UpdateSpaceHttpError

updateSpaceAssignment: typeof updateSpaceAssignment

Updates a single assignment by assignment ID. Use GET /spaces/{spaceId}/assignments to list all users and groups assigned to the space and their assignment ID. The complete list of roles must be provided.

The ID of the space of the assignment.

The ID of the assignment to update.

an object with the body content

UpdateSpaceAssignmentHttpError