Loading ...

REST API: Spaces | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Spaces
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 45

REST API: Spaces

0 
 /5
0 (0votes)
Open API Guide

Create, configure, and manage spaces that organize content, members, and permissions into distinct areas of the site. Control access, customize navigation, manage wall posts, and automate space provisioning.

Available Endpoints

Method Endpoint Description
POST Add Space Role /api/spaces/{SpaceID}/roles Adds a new role to the space
POST Add Space User /api/spaces/{SpaceID}/users Adds a new user to the space
PUT Approve Decline Space User /api/spaces/{SpaceID}/users/{UserID}/membership/status Users need approval to join moderated spaces. This join request goes to the space admin; who can approve or decline the request. This can be done by passing "true/false" in the request body for approving/declining user's space join request.
POST Assign Space Role /api/users/{UserID}/spaces/{SpaceID}/roles Assign a space role to an existing space user
POST Bulk Add Users to Spaces /api/spaces/users Adds multiple users to several spaces
GET Check Space Moderation /api/spaces/{SpaceID}/moderation/status Check if the space is moderated or not
GET Check Space Name Availability /api/spaces/availability Check if the desired space name is available or not
POST Create Space /api/spaces Establish a brand new Space for collaboration. This is the first step in creating a new team or project area.
DELETE Delete All Space Roles of User /api/users/{UserID}/spaces/{SpaceID}/roles Provides an automated mechanism for removing remove all space roles of user data from the system. Returns JSON indicating whether or not the roles removal was successful.
DELETE Delete Space /api/spaces/{spaceid} Permanently retire a Space. This removes the group and its data from the system. Use this with care for pruning old projects or removing duplicate teams that are no longer needed.
DELETE Delete Space Role /api/spaces/{spaceid}/roles/{roleid} Provides an automated mechanism for removing delete space role data from the system.. Returns JSON indicating whether or not the specified role was actually deleted.
DELETE Delete User from Space /api/spaces/{SpaceID}/users/{UserID} Provides an automated mechanism for removing unjoin user data from the system.
GET Get All Spaces /api/spaces Browse the entire directory of public Spaces. This helps users discover new teams, projects, or interest groups they might want to join. Use this to power a search-and-join experience for your community members.
GET Get Child Spaces /api/spaces/child Finds all the spaces created under the parent space.
GET Get My Spaces /api/spaces/me Enables administrators and developers to programmatically retrieve a list of the logged in user's spaces.
GET Get Space /api/spaces/{SpaceID} Get space details. SpaceID of the space. Allow the user to get space's basic info, if it is a space where user does not have access.
GET Get Space Directories /api/spaces/{SpaceID}/file/directories/{ParentDirectoryID} Enables administrators and developers to programmatically retrieve a list of directories based on the space ID and parent directory ID.
GET Get Space Features /api/spaces/{SpaceID}/features Get space features. SpaceID of the space. 0 for TLC.
GET Get Space Files /api/files/space Enables administrators and developers to programmatically retrieve a list of files in a space.
GET Get Space Role /api/spaces/{SpaceID}/roles/{RoleID} Get a space role from database
GET Get Space Role by Role Name /api/spaces/{SpaceID}/roles Enables administrators and developers to programmatically retrieve a space role from database specified by role name.
GET Get Space Roles /api/spaces/{SpaceID}/roles Enables administrators and developers to programmatically retrieve all roles for a specific space.
GET Get Space Root Directory /api/spaces/{SpaceID}/files/directories/root Enables administrators and developers to programmatically retrieve the root directory of a particular space.
GET Get Space URL /api/spaces/{SpaceID}/url Fetches the space url based on the Space ID.
GET Get Space Users /api/spaces/{SpaceID}/users Enables administrators and developers to programmatically retrieve space users from database.
GET Get User Membership Status /api/users/{UserID}/spaces/{SpaceID}/membership/status Enables administrators and developers to programmatically retrieve user's space membership status.
GET Get User Space Ids /api/users/{UserID}/spaces/ids Fetches all the space IDs of the user.
GET Get User Space Roles /api/spaces/{SpaceID}/roles Find all space roles assigned to user.
GET Get User Spaces /api/spaces/me List all the groups you belong to. These "Spaces" are where the collaboration happens.
PUT Set Space Status /api/spaces/{SpaceID}/status Sets the status of an existing space specified by Space ID and Status ID. Returns JSON indicating whether or not the specified space status was actually updated.
DELETE Unassign Space Role /api/users/{UserID}/spaces/{SpaceID}/roles/{RoleID} Remove the user's space role based on Role ID
PUT Update Space /api/spaces/{spaceid} Edit the details of an existing Space. Change descriptions, rename teams, or adjust security settings as needs evolve. Use this for programmatic site maintenance and keeping your groups up-to-date.
POST Update Space Image /api/spaces/{SpaceID}/image Updates the photo for the space
PUT Update Space Role /api/spaces/{SpaceID}/roles/{RoleID} Supports the synchronization and modification of update space role properties via the API.

Wiki Index

Pages