From 4c61ae96234f41ab1f1e7f99757f231106a4e42d Mon Sep 17 00:00:00 2001 From: Miguel de la Cruz Date: Wed, 13 Apr 2022 22:24:32 +0200 Subject: [PATCH] Update focalboard endpoints to v2 namespace (#2781) --- experiments/webext/src/utils/networking.ts | 2 +- server/admin-scripts/reset-password.sh | 2 +- server/api/api.go | 194 +- server/api/archive.go | 6 +- server/api/auth.go | 8 +- server/client/client.go | 2 +- server/main/doc.go | 2 +- server/swagger/README.md | 2 +- server/swagger/docs/html/index.html | 16246 ++++++++++++++++--- server/swagger/swagger.yml | 1497 +- webapp/cypress/support/api_commands.ts | 14 +- webapp/src/octoClient.ts | 90 +- website/site/content/guide/admin/_index.md | 4 +- 13 files changed, 14754 insertions(+), 3315 deletions(-) diff --git a/experiments/webext/src/utils/networking.ts b/experiments/webext/src/utils/networking.ts index 18cfa7c33..705d8ad74 100644 --- a/experiments/webext/src/utils/networking.ts +++ b/experiments/webext/src/utils/networking.ts @@ -10,7 +10,7 @@ declare global { } async function request(method: string, host: string, resource: string, body: any, token: string | null) { - const response = await fetch(`${host}/api/v1/${resource}`, { + const response = await fetch(`${host}/api/v2/${resource}`, { 'credentials': 'include', 'headers': { 'Accept': 'application/json', diff --git a/server/admin-scripts/reset-password.sh b/server/admin-scripts/reset-password.sh index 5b50a2e21..6c614ed1b 100755 --- a/server/admin-scripts/reset-password.sh +++ b/server/admin-scripts/reset-password.sh @@ -5,4 +5,4 @@ if [[ $# < 2 ]] ; then exit 1 fi -curl --unix-socket /var/tmp/focalboard_local.socket http://localhost/api/v1/admin/users/$1/password -X POST -H 'Content-Type: application/json' -d '{ "password": "'$2'" }' +curl --unix-socket /var/tmp/focalboard_local.socket http://localhost/api/v2/admin/users/$1/password -X POST -H 'Content-Type: application/json' -d '{ "password": "'$2'" }' diff --git a/server/api/api.go b/server/api/api.go index 4490f457b..8109db263 100644 --- a/server/api/api.go +++ b/server/api/api.go @@ -68,94 +68,94 @@ func NewAPI(app *app.App, singleUserToken string, authService string, permission } func (a *API) RegisterRoutes(r *mux.Router) { - apiv1 := r.PathPrefix("/api/v1").Subrouter() - apiv1.Use(a.panicHandler) - apiv1.Use(a.requireCSRFToken) + apiv2 := r.PathPrefix("/api/v2").Subrouter() + apiv2.Use(a.panicHandler) + apiv2.Use(a.requireCSRFToken) // Board APIs - apiv1.HandleFunc("/teams/{teamID}/boards", a.sessionRequired(a.handleGetBoards)).Methods("GET") - apiv1.HandleFunc("/teams/{teamID}/boards/search", a.sessionRequired(a.handleSearchBoards)).Methods("GET") - apiv1.HandleFunc("/teams/{teamID}/templates", a.sessionRequired(a.handleGetTemplates)).Methods("GET") - apiv1.HandleFunc("/boards", a.sessionRequired(a.handleCreateBoard)).Methods("POST") - apiv1.HandleFunc("/boards/{boardID}", a.attachSession(a.handleGetBoard, false)).Methods("GET") - apiv1.HandleFunc("/boards/{boardID}", a.sessionRequired(a.handlePatchBoard)).Methods("PATCH") - apiv1.HandleFunc("/boards/{boardID}", a.sessionRequired(a.handleDeleteBoard)).Methods("DELETE") - apiv1.HandleFunc("/boards/{boardID}/duplicate", a.sessionRequired(a.handleDuplicateBoard)).Methods("POST") - apiv1.HandleFunc("/boards/{boardID}/undelete", a.sessionRequired(a.handleUndeleteBoard)).Methods("POST") - apiv1.HandleFunc("/boards/{boardID}/blocks", a.attachSession(a.handleGetBlocks, false)).Methods("GET") - apiv1.HandleFunc("/boards/{boardID}/blocks", a.sessionRequired(a.handlePostBlocks)).Methods("POST") - apiv1.HandleFunc("/boards/{boardID}/blocks", a.sessionRequired(a.handlePatchBlocks)).Methods("PATCH") - apiv1.HandleFunc("/boards/{boardID}/blocks/{blockID}", a.sessionRequired(a.handleDeleteBlock)).Methods("DELETE") - apiv1.HandleFunc("/boards/{boardID}/blocks/{blockID}", a.sessionRequired(a.handlePatchBlock)).Methods("PATCH") - apiv1.HandleFunc("/boards/{boardID}/blocks/{blockID}/undelete", a.sessionRequired(a.handleUndeleteBlock)).Methods("POST") - apiv1.HandleFunc("/boards/{boardID}/blocks/{blockID}/duplicate", a.sessionRequired(a.handleDuplicateBlock)).Methods("POST") - apiv1.HandleFunc("/boards/{boardID}/metadata", a.sessionRequired(a.handleGetBoardMetadata)).Methods("GET") + apiv2.HandleFunc("/teams/{teamID}/boards", a.sessionRequired(a.handleGetBoards)).Methods("GET") + apiv2.HandleFunc("/teams/{teamID}/boards/search", a.sessionRequired(a.handleSearchBoards)).Methods("GET") + apiv2.HandleFunc("/teams/{teamID}/templates", a.sessionRequired(a.handleGetTemplates)).Methods("GET") + apiv2.HandleFunc("/boards", a.sessionRequired(a.handleCreateBoard)).Methods("POST") + apiv2.HandleFunc("/boards/{boardID}", a.attachSession(a.handleGetBoard, false)).Methods("GET") + apiv2.HandleFunc("/boards/{boardID}", a.sessionRequired(a.handlePatchBoard)).Methods("PATCH") + apiv2.HandleFunc("/boards/{boardID}", a.sessionRequired(a.handleDeleteBoard)).Methods("DELETE") + apiv2.HandleFunc("/boards/{boardID}/duplicate", a.sessionRequired(a.handleDuplicateBoard)).Methods("POST") + apiv2.HandleFunc("/boards/{boardID}/undelete", a.sessionRequired(a.handleUndeleteBoard)).Methods("POST") + apiv2.HandleFunc("/boards/{boardID}/blocks", a.attachSession(a.handleGetBlocks, false)).Methods("GET") + apiv2.HandleFunc("/boards/{boardID}/blocks", a.sessionRequired(a.handlePostBlocks)).Methods("POST") + apiv2.HandleFunc("/boards/{boardID}/blocks", a.sessionRequired(a.handlePatchBlocks)).Methods("PATCH") + apiv2.HandleFunc("/boards/{boardID}/blocks/{blockID}", a.sessionRequired(a.handleDeleteBlock)).Methods("DELETE") + apiv2.HandleFunc("/boards/{boardID}/blocks/{blockID}", a.sessionRequired(a.handlePatchBlock)).Methods("PATCH") + apiv2.HandleFunc("/boards/{boardID}/blocks/{blockID}/undelete", a.sessionRequired(a.handleUndeleteBlock)).Methods("POST") + apiv2.HandleFunc("/boards/{boardID}/blocks/{blockID}/duplicate", a.sessionRequired(a.handleDuplicateBlock)).Methods("POST") + apiv2.HandleFunc("/boards/{boardID}/metadata", a.sessionRequired(a.handleGetBoardMetadata)).Methods("GET") // Member APIs - apiv1.HandleFunc("/boards/{boardID}/members", a.sessionRequired(a.handleGetMembersForBoard)).Methods("GET") - apiv1.HandleFunc("/boards/{boardID}/members", a.sessionRequired(a.handleAddMember)).Methods("POST") - apiv1.HandleFunc("/boards/{boardID}/members/{userID}", a.sessionRequired(a.handleUpdateMember)).Methods("PUT") - apiv1.HandleFunc("/boards/{boardID}/members/{userID}", a.sessionRequired(a.handleDeleteMember)).Methods("DELETE") - apiv1.HandleFunc("/boards/{boardID}/join", a.sessionRequired(a.handleJoinBoard)).Methods("POST") - apiv1.HandleFunc("/boards/{boardID}/leave", a.sessionRequired(a.handleLeaveBoard)).Methods("POST") + apiv2.HandleFunc("/boards/{boardID}/members", a.sessionRequired(a.handleGetMembersForBoard)).Methods("GET") + apiv2.HandleFunc("/boards/{boardID}/members", a.sessionRequired(a.handleAddMember)).Methods("POST") + apiv2.HandleFunc("/boards/{boardID}/members/{userID}", a.sessionRequired(a.handleUpdateMember)).Methods("PUT") + apiv2.HandleFunc("/boards/{boardID}/members/{userID}", a.sessionRequired(a.handleDeleteMember)).Methods("DELETE") + apiv2.HandleFunc("/boards/{boardID}/join", a.sessionRequired(a.handleJoinBoard)).Methods("POST") + apiv2.HandleFunc("/boards/{boardID}/leave", a.sessionRequired(a.handleLeaveBoard)).Methods("POST") // Sharing APIs - apiv1.HandleFunc("/boards/{boardID}/sharing", a.sessionRequired(a.handlePostSharing)).Methods("POST") - apiv1.HandleFunc("/boards/{boardID}/sharing", a.sessionRequired(a.handleGetSharing)).Methods("GET") + apiv2.HandleFunc("/boards/{boardID}/sharing", a.sessionRequired(a.handlePostSharing)).Methods("POST") + apiv2.HandleFunc("/boards/{boardID}/sharing", a.sessionRequired(a.handleGetSharing)).Methods("GET") // Team APIs - apiv1.HandleFunc("/teams", a.sessionRequired(a.handleGetTeams)).Methods("GET") - apiv1.HandleFunc("/teams/{teamID}", a.sessionRequired(a.handleGetTeam)).Methods("GET") - apiv1.HandleFunc("/teams/{teamID}/regenerate_signup_token", a.sessionRequired(a.handlePostTeamRegenerateSignupToken)).Methods("POST") - apiv1.HandleFunc("/teams/{teamID}/users", a.sessionRequired(a.handleGetTeamUsers)).Methods("GET") - apiv1.HandleFunc("/teams/{teamID}/archive/export", a.sessionRequired(a.handleArchiveExportTeam)).Methods("GET") - apiv1.HandleFunc("/teams/{teamID}/{boardID}/files", a.sessionRequired(a.handleUploadFile)).Methods("POST") + apiv2.HandleFunc("/teams", a.sessionRequired(a.handleGetTeams)).Methods("GET") + apiv2.HandleFunc("/teams/{teamID}", a.sessionRequired(a.handleGetTeam)).Methods("GET") + apiv2.HandleFunc("/teams/{teamID}/regenerate_signup_token", a.sessionRequired(a.handlePostTeamRegenerateSignupToken)).Methods("POST") + apiv2.HandleFunc("/teams/{teamID}/users", a.sessionRequired(a.handleGetTeamUsers)).Methods("GET") + apiv2.HandleFunc("/teams/{teamID}/archive/export", a.sessionRequired(a.handleArchiveExportTeam)).Methods("GET") + apiv2.HandleFunc("/teams/{teamID}/{boardID}/files", a.sessionRequired(a.handleUploadFile)).Methods("POST") // User APIs - apiv1.HandleFunc("/users/me", a.sessionRequired(a.handleGetMe)).Methods("GET") - apiv1.HandleFunc("/users/me/memberships", a.sessionRequired(a.handleGetMyMemberships)).Methods("GET") - apiv1.HandleFunc("/users/{userID}", a.sessionRequired(a.handleGetUser)).Methods("GET") - apiv1.HandleFunc("/users/{userID}/changepassword", a.sessionRequired(a.handleChangePassword)).Methods("POST") - apiv1.HandleFunc("/users/{userID}/config", a.sessionRequired(a.handleUpdateUserConfig)).Methods(http.MethodPut) + apiv2.HandleFunc("/users/me", a.sessionRequired(a.handleGetMe)).Methods("GET") + apiv2.HandleFunc("/users/me/memberships", a.sessionRequired(a.handleGetMyMemberships)).Methods("GET") + apiv2.HandleFunc("/users/{userID}", a.sessionRequired(a.handleGetUser)).Methods("GET") + apiv2.HandleFunc("/users/{userID}/changepassword", a.sessionRequired(a.handleChangePassword)).Methods("POST") + apiv2.HandleFunc("/users/{userID}/config", a.sessionRequired(a.handleUpdateUserConfig)).Methods(http.MethodPut) // BoardsAndBlocks APIs - apiv1.HandleFunc("/boards-and-blocks", a.sessionRequired(a.handleCreateBoardsAndBlocks)).Methods("POST") - apiv1.HandleFunc("/boards-and-blocks", a.sessionRequired(a.handlePatchBoardsAndBlocks)).Methods("PATCH") - apiv1.HandleFunc("/boards-and-blocks", a.sessionRequired(a.handleDeleteBoardsAndBlocks)).Methods("DELETE") + apiv2.HandleFunc("/boards-and-blocks", a.sessionRequired(a.handleCreateBoardsAndBlocks)).Methods("POST") + apiv2.HandleFunc("/boards-and-blocks", a.sessionRequired(a.handlePatchBoardsAndBlocks)).Methods("PATCH") + apiv2.HandleFunc("/boards-and-blocks", a.sessionRequired(a.handleDeleteBoardsAndBlocks)).Methods("DELETE") // Auth APIs - apiv1.HandleFunc("/login", a.handleLogin).Methods("POST") - apiv1.HandleFunc("/logout", a.sessionRequired(a.handleLogout)).Methods("POST") - apiv1.HandleFunc("/register", a.handleRegister).Methods("POST") - apiv1.HandleFunc("/clientConfig", a.getClientConfig).Methods("GET") + apiv2.HandleFunc("/login", a.handleLogin).Methods("POST") + apiv2.HandleFunc("/logout", a.sessionRequired(a.handleLogout)).Methods("POST") + apiv2.HandleFunc("/register", a.handleRegister).Methods("POST") + apiv2.HandleFunc("/clientConfig", a.getClientConfig).Methods("GET") // Category APIs - apiv1.HandleFunc("/teams/{teamID}/categories", a.sessionRequired(a.handleCreateCategory)).Methods(http.MethodPost) - apiv1.HandleFunc("/teams/{teamID}/categories/{categoryID}", a.sessionRequired(a.handleUpdateCategory)).Methods(http.MethodPut) - apiv1.HandleFunc("/teams/{teamID}/categories/{categoryID}", a.sessionRequired(a.handleDeleteCategory)).Methods(http.MethodDelete) + apiv2.HandleFunc("/teams/{teamID}/categories", a.sessionRequired(a.handleCreateCategory)).Methods(http.MethodPost) + apiv2.HandleFunc("/teams/{teamID}/categories/{categoryID}", a.sessionRequired(a.handleUpdateCategory)).Methods(http.MethodPut) + apiv2.HandleFunc("/teams/{teamID}/categories/{categoryID}", a.sessionRequired(a.handleDeleteCategory)).Methods(http.MethodDelete) // Category Block APIs - apiv1.HandleFunc("/teams/{teamID}/categories", a.sessionRequired(a.handleGetUserCategoryBlocks)).Methods(http.MethodGet) - apiv1.HandleFunc("/teams/{teamID}/categories/{categoryID}/blocks/{blockID}", a.sessionRequired(a.handleUpdateCategoryBlock)).Methods(http.MethodPost) + apiv2.HandleFunc("/teams/{teamID}/categories", a.sessionRequired(a.handleGetUserCategoryBlocks)).Methods(http.MethodGet) + apiv2.HandleFunc("/teams/{teamID}/categories/{categoryID}/blocks/{blockID}", a.sessionRequired(a.handleUpdateCategoryBlock)).Methods(http.MethodPost) // Get Files API - apiv1.HandleFunc("/files/teams/{teamID}/{boardID}/{filename}", a.attachSession(a.handleServeFile, false)).Methods("GET") + apiv2.HandleFunc("/files/teams/{teamID}/{boardID}/{filename}", a.attachSession(a.handleServeFile, false)).Methods("GET") // Subscriptions - apiv1.HandleFunc("/subscriptions", a.sessionRequired(a.handleCreateSubscription)).Methods("POST") - apiv1.HandleFunc("/subscriptions/{blockID}/{subscriberID}", a.sessionRequired(a.handleDeleteSubscription)).Methods("DELETE") - apiv1.HandleFunc("/subscriptions/{subscriberID}", a.sessionRequired(a.handleGetSubscriptions)).Methods("GET") + apiv2.HandleFunc("/subscriptions", a.sessionRequired(a.handleCreateSubscription)).Methods("POST") + apiv2.HandleFunc("/subscriptions/{blockID}/{subscriberID}", a.sessionRequired(a.handleDeleteSubscription)).Methods("DELETE") + apiv2.HandleFunc("/subscriptions/{subscriberID}", a.sessionRequired(a.handleGetSubscriptions)).Methods("GET") // onboarding tour endpoints - apiv1.HandleFunc("/teams/{teamID}/onboard", a.sessionRequired(a.handleOnboard)).Methods(http.MethodPost) + apiv2.HandleFunc("/teams/{teamID}/onboard", a.sessionRequired(a.handleOnboard)).Methods(http.MethodPost) // archives - apiv1.HandleFunc("/boards/{boardID}/archive/export", a.sessionRequired(a.handleArchiveExportBoard)).Methods("GET") - apiv1.HandleFunc("/teams/{teamID}/archive/import", a.sessionRequired(a.handleArchiveImport)).Methods("POST") + apiv2.HandleFunc("/boards/{boardID}/archive/export", a.sessionRequired(a.handleArchiveExportBoard)).Methods("GET") + apiv2.HandleFunc("/teams/{teamID}/archive/import", a.sessionRequired(a.handleArchiveImport)).Methods("POST") } func (a *API) RegisterAdminRoutes(r *mux.Router) { - r.HandleFunc("/api/v1/admin/users/{username}/password", a.adminRequired(a.handleAdminSetPassword)).Methods("POST") + r.HandleFunc("/api/v2/admin/users/{username}/password", a.adminRequired(a.handleAdminSetPassword)).Methods("POST") } func getUserID(r *http.Request) string { @@ -230,7 +230,7 @@ func (a *API) hasValidReadTokenForBoard(r *http.Request, boardID string) bool { } func (a *API) handleGetBlocks(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/boards/{boardID}/blocks getBlocks + // swagger:operation GET /boards/{boardID}/blocks getBlocks // // Returns blocks // @@ -591,7 +591,7 @@ func (a *API) handleUpdateCategoryBlock(w http.ResponseWriter, r *http.Request) } func (a *API) handlePostBlocks(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/boards/{boardID}/blocks updateBlocks + // swagger:operation POST /boards/{boardID}/blocks updateBlocks // // Insert blocks. The specified IDs will only be used to link // blocks with existing ones, the rest will be replaced by server @@ -719,7 +719,7 @@ func (a *API) handlePostBlocks(w http.ResponseWriter, r *http.Request) { } func (a *API) handleUpdateUserConfig(w http.ResponseWriter, r *http.Request) { - // swagger:operation PATCH /api/v1/users/{userID}/config updateUserConfig + // swagger:operation PATCH /users/{userID}/config updateUserConfig // // Updates user config // @@ -793,7 +793,7 @@ func (a *API) handleUpdateUserConfig(w http.ResponseWriter, r *http.Request) { } func (a *API) handleGetUser(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/users/{userID} getUser + // swagger:operation GET /users/{userID} getUser // // Returns a user // @@ -842,7 +842,7 @@ func (a *API) handleGetUser(w http.ResponseWriter, r *http.Request) { } func (a *API) handleGetMe(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/users/me getMe + // swagger:operation GET /users/me getMe // // Returns the currently logged-in user // @@ -899,7 +899,7 @@ func (a *API) handleGetMe(w http.ResponseWriter, r *http.Request) { } func (a *API) handleGetMyMemberships(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/users/me/memberships getMyMemberships + // swagger:operation GET /users/me/memberships getMyMemberships // // Returns the currently users board memberships // @@ -944,7 +944,7 @@ func (a *API) handleGetMyMemberships(w http.ResponseWriter, r *http.Request) { } func (a *API) handleDeleteBlock(w http.ResponseWriter, r *http.Request) { - // swagger:operation DELETE /api/v1/boards/{boardID}/blocks/{blockID} deleteBlock + // swagger:operation DELETE /boards/{boardID}/blocks/{blockID} deleteBlock // // Deletes a block // @@ -1012,7 +1012,7 @@ func (a *API) handleDeleteBlock(w http.ResponseWriter, r *http.Request) { } func (a *API) handleUndeleteBlock(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/boards/{boardID}/blocks/{blockID}/undelete undeleteBlock + // swagger:operation POST /boards/{boardID}/blocks/{blockID}/undelete undeleteBlock // // Undeletes a block // @@ -1105,7 +1105,7 @@ func (a *API) handleUndeleteBlock(w http.ResponseWriter, r *http.Request) { } func (a *API) handleUndeleteBoard(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/boards/{boardID}/undelete undeleteBoard + // swagger:operation POST /boards/{boardID}/undelete undeleteBoard // // Undeletes a board // @@ -1157,7 +1157,7 @@ func (a *API) handleUndeleteBoard(w http.ResponseWriter, r *http.Request) { } func (a *API) handlePatchBlock(w http.ResponseWriter, r *http.Request) { - // swagger:operation PATCH /api/v1/boards/{boardID}/blocks/{blockID} patchBlock + // swagger:operation PATCH /boards/{boardID}/blocks/{blockID} patchBlock // // Partially updates a block // @@ -1244,7 +1244,7 @@ func (a *API) handlePatchBlock(w http.ResponseWriter, r *http.Request) { } func (a *API) handlePatchBlocks(w http.ResponseWriter, r *http.Request) { - // swagger:operation PATCH /api/v1/boards/{boardID}/blocks/ patchBlocks + // swagger:operation PATCH /boards/{boardID}/blocks/ patchBlocks // // Partially updates batch of blocks // @@ -1327,7 +1327,7 @@ func (a *API) handlePatchBlocks(w http.ResponseWriter, r *http.Request) { // Sharing func (a *API) handleGetSharing(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/boards/{boardID}/sharing getSharing + // swagger:operation GET /boards/{boardID}/sharing getSharing // // Returns sharing information for a board // @@ -1396,7 +1396,7 @@ func (a *API) handleGetSharing(w http.ResponseWriter, r *http.Request) { } func (a *API) handlePostSharing(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/boards/{boardID}/sharing postSharing + // swagger:operation POST /boards/{boardID}/sharing postSharing // // Sets sharing information for a board // @@ -1491,7 +1491,7 @@ func (a *API) handlePostSharing(w http.ResponseWriter, r *http.Request) { // Team func (a *API) handleGetTeams(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/teams getTeams + // swagger:operation GET /teams getTeams // // Returns information of all the teams // @@ -1534,7 +1534,7 @@ func (a *API) handleGetTeams(w http.ResponseWriter, r *http.Request) { } func (a *API) handleGetTeam(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/teams/{teamID} getTeam + // swagger:operation GET /teams/{teamID} getTeam // // Returns information of the root team // @@ -1603,7 +1603,7 @@ func (a *API) handleGetTeam(w http.ResponseWriter, r *http.Request) { } func (a *API) handlePostTeamRegenerateSignupToken(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/teams/{teamID}/regenerate_signup_token regenerateSignupToken + // swagger:operation POST /teams/{teamID}/regenerate_signup_token regenerateSignupToken // // Regenerates the signup token for the root team // @@ -1654,7 +1654,7 @@ func (a *API) handlePostTeamRegenerateSignupToken(w http.ResponseWriter, r *http // File upload func (a *API) handleServeFile(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET "api/v1/files/teams/{teamID}/{boardID}/{filename} getFile + // swagger:operation GET "api/v2/files/teams/{teamID}/{boardID}/{filename} getFile // // Returns the contents of an uploaded file // @@ -1765,7 +1765,7 @@ func FileUploadResponseFromJSON(data io.Reader) (*FileUploadResponse, error) { } func (a *API) handleUploadFile(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/teams/{teamID}/boards/{boardID}/files uploadFile + // swagger:operation POST /teams/{teamID}/boards/{boardID}/files uploadFile // // Upload a binary file, attached to a root block // @@ -1866,7 +1866,7 @@ func (a *API) handleUploadFile(w http.ResponseWriter, r *http.Request) { } func (a *API) handleGetTeamUsers(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/teams/{teamID}/users getTeamUsers + // swagger:operation GET /teams/{teamID}/users getTeamUsers // // Returns team users // @@ -1931,7 +1931,7 @@ func (a *API) handleGetTeamUsers(w http.ResponseWriter, r *http.Request) { } func (a *API) handleGetBoards(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/teams/{teamID}/boards getBoards + // swagger:operation GET /teams/{teamID}/boards getBoards // // Returns team boards // @@ -1996,7 +1996,7 @@ func (a *API) handleGetBoards(w http.ResponseWriter, r *http.Request) { } func (a *API) handleGetTemplates(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/teams/{teamID}/templates getTemplates + // swagger:operation GET /teams/{teamID}/templates getTemplates // // Returns team templates // @@ -2072,7 +2072,7 @@ func (a *API) handleGetTemplates(w http.ResponseWriter, r *http.Request) { // subscriptions func (a *API) handleCreateSubscription(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/subscriptions createSubscription + // swagger:operation POST /subscriptions createSubscription // // Creates a subscription to a block for a user. The user will receive change notifications for the block. // @@ -2159,7 +2159,7 @@ func (a *API) handleCreateSubscription(w http.ResponseWriter, r *http.Request) { } func (a *API) handleDeleteSubscription(w http.ResponseWriter, r *http.Request) { - // swagger:operation DELETE /api/v1/subscriptions/{blockID}/{subscriberID} deleteSubscription + // swagger:operation DELETE /subscriptions/{blockID}/{subscriberID} deleteSubscription // // Deletes a subscription a user has for a a block. The user will no longer receive change notifications for the block. // @@ -2221,7 +2221,7 @@ func (a *API) handleDeleteSubscription(w http.ResponseWriter, r *http.Request) { } func (a *API) handleGetSubscriptions(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/subscriptions/{subscriberID} getSubscriptions + // swagger:operation GET /subscriptions/{subscriberID} getSubscriptions // // Gets subscriptions for a user. // @@ -2286,7 +2286,7 @@ func (a *API) handleGetSubscriptions(w http.ResponseWriter, r *http.Request) { } func (a *API) handleCreateBoard(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/boards createBoard + // swagger:operation POST /boards createBoard // // Creates a new board // @@ -2375,7 +2375,7 @@ func (a *API) handleCreateBoard(w http.ResponseWriter, r *http.Request) { } func (a *API) handleOnboard(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/team/{teamID}/onboard onboard + // swagger:operation POST /team/{teamID}/onboard onboard // // Onboards a user on Boards. // @@ -2427,7 +2427,7 @@ func (a *API) handleOnboard(w http.ResponseWriter, r *http.Request) { } func (a *API) handleGetBoard(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/boards/{boardID} getBoard + // swagger:operation GET /boards/{boardID} getBoard // // Returns a board // @@ -2508,7 +2508,7 @@ func (a *API) handleGetBoard(w http.ResponseWriter, r *http.Request) { } func (a *API) handlePatchBoard(w http.ResponseWriter, r *http.Request) { - // swagger:operation PATCH /api/v1/boards/{boardID} patchBoard + // swagger:operation PATCH /boards/{boardID} patchBoard // // Partially updates a board // @@ -2613,7 +2613,7 @@ func (a *API) handlePatchBoard(w http.ResponseWriter, r *http.Request) { } func (a *API) handleDeleteBoard(w http.ResponseWriter, r *http.Request) { - // swagger:operation DELETE /api/v1/boards/{boardID} deleteBoard + // swagger:operation DELETE /boards/{boardID} deleteBoard // // Removes a board // @@ -2673,7 +2673,7 @@ func (a *API) handleDeleteBoard(w http.ResponseWriter, r *http.Request) { } func (a *API) handleDuplicateBoard(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/boards/{boardID}/duplicate duplicateBoard + // swagger:operation POST /boards/{boardID}/duplicate duplicateBoard // // Returns the new created board and all the blocks // @@ -2765,7 +2765,7 @@ func (a *API) handleDuplicateBoard(w http.ResponseWriter, r *http.Request) { } func (a *API) handleDuplicateBlock(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/boards/{boardID}/blocks/{blockID}/duplicate duplicateBlock + // swagger:operation POST /boards/{boardID}/blocks/{blockID}/duplicate duplicateBlock // // Returns the new created blocks // @@ -2868,7 +2868,7 @@ func (a *API) handleDuplicateBlock(w http.ResponseWriter, r *http.Request) { } func (a *API) handleGetBoardMetadata(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/boards/{boardID}/metadata getBoardMetadata + // swagger:operation GET /boards/{boardID}/metadata getBoardMetadata // // Returns a board's metadata // @@ -2943,7 +2943,7 @@ func (a *API) handleGetBoardMetadata(w http.ResponseWriter, r *http.Request) { } func (a *API) handleSearchBoards(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/teams/{teamID}/boards/search searchBoards + // swagger:operation GET /teams/{teamID}/boards/search searchBoards // // Returns the boards that match with a search term // @@ -3019,7 +3019,7 @@ func (a *API) handleSearchBoards(w http.ResponseWriter, r *http.Request) { } func (a *API) handleGetMembersForBoard(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/boards/{boardID}/members getMembersForBoard + // swagger:operation GET /boards/{boardID}/members getMembersForBoard // // Returns the members of the board // @@ -3453,7 +3453,7 @@ func (a *API) handleUpdateMember(w http.ResponseWriter, r *http.Request) { } func (a *API) handleDeleteMember(w http.ResponseWriter, r *http.Request) { - // swagger:operation DELETE /api/v1/boards/{boardID}/members/{userID} deleteMember + // swagger:operation DELETE /boards/{boardID}/members/{userID} deleteMember // // Deletes a member from a board // @@ -3529,7 +3529,7 @@ func (a *API) handleDeleteMember(w http.ResponseWriter, r *http.Request) { } func (a *API) handleCreateBoardsAndBlocks(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/boards-and-blocks insertBoardsAndBlocks + // swagger:operation POST /boards-and-blocks insertBoardsAndBlocks // // Creates new boards and blocks // @@ -3673,7 +3673,7 @@ func (a *API) handleCreateBoardsAndBlocks(w http.ResponseWriter, r *http.Request } func (a *API) handlePatchBoardsAndBlocks(w http.ResponseWriter, r *http.Request) { - // swagger:operation PATCH /api/v1/boards-and-blocks patchBoardsAndBlocks + // swagger:operation PATCH /boards-and-blocks patchBoardsAndBlocks // // Patches a set of related boards and blocks // @@ -3811,7 +3811,7 @@ func (a *API) handlePatchBoardsAndBlocks(w http.ResponseWriter, r *http.Request) } func (a *API) handleDeleteBoardsAndBlocks(w http.ResponseWriter, r *http.Request) { - // swagger:operation DELETE /api/v1/boards-and-blocks deleteBoardsAndBlocks + // swagger:operation DELETE /boards-and-blocks deleteBoardsAndBlocks // // Deletes boards and blocks // diff --git a/server/api/archive.go b/server/api/archive.go index 594551688..8b63b14d8 100644 --- a/server/api/archive.go +++ b/server/api/archive.go @@ -17,7 +17,7 @@ const ( ) func (a *API) handleArchiveExportBoard(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/boards/{boardID}/archive/export archiveExportBoard + // swagger:operation GET /boards/{boardID}/archive/export archiveExportBoard // // Exports an archive of all blocks for one boards. // @@ -85,7 +85,7 @@ func (a *API) handleArchiveExportBoard(w http.ResponseWriter, r *http.Request) { } func (a *API) handleArchiveExportTeam(w http.ResponseWriter, r *http.Request) { - // swagger:operation GET /api/v1/teams/{teamID}/archive/export archiveExportTeam + // swagger:operation GET /teams/{teamID}/archive/export archiveExportTeam // // Exports an archive of all blocks for all the boards in a team. // @@ -154,7 +154,7 @@ func (a *API) handleArchiveExportTeam(w http.ResponseWriter, r *http.Request) { } func (a *API) handleArchiveImport(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/teams/{teamID}/archive/import archiveImport + // swagger:operation POST /teams/{teamID}/archive/import archiveImport // // Import an archive of boards. // diff --git a/server/api/auth.go b/server/api/auth.go index a23efcc75..2df40e162 100644 --- a/server/api/auth.go +++ b/server/api/auth.go @@ -139,7 +139,7 @@ func isValidPassword(password string) error { } func (a *API) handleLogin(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/login login + // swagger:operation POST /login login // // Login user // @@ -220,7 +220,7 @@ func (a *API) handleLogin(w http.ResponseWriter, r *http.Request) { } func (a *API) handleLogout(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/logout logout + // swagger:operation POST /logout logout // // Logout user // @@ -271,7 +271,7 @@ func (a *API) handleLogout(w http.ResponseWriter, r *http.Request) { } func (a *API) handleRegister(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/register register + // swagger:operation POST /register register // // Register new user // @@ -369,7 +369,7 @@ func (a *API) handleRegister(w http.ResponseWriter, r *http.Request) { } func (a *API) handleChangePassword(w http.ResponseWriter, r *http.Request) { - // swagger:operation POST /api/v1/users/{userID}/changepassword changePassword + // swagger:operation POST /users/{userID}/changepassword changePassword // // Change a user's password // diff --git a/server/client/client.go b/server/client/client.go index 0879002fd..5ad828228 100644 --- a/server/client/client.go +++ b/server/client/client.go @@ -15,7 +15,7 @@ import ( ) const ( - APIURLSuffix = "/api/v1" + APIURLSuffix = "/api/v2" ) type RequestReaderError struct { diff --git a/server/main/doc.go b/server/main/doc.go index f9fe2b892..ede43ced9 100644 --- a/server/main/doc.go +++ b/server/main/doc.go @@ -4,7 +4,7 @@ // // Schemes: http, https // Host: localhost -// BasePath: /api/v1 +// BasePath: /api/v2 // Version: 1.0.0 // License: Custom https://github.com/mattermost/focalboard/blob/main/LICENSE.txt // Contact: Focalboard https://www.focalboard.com diff --git a/server/swagger/README.md b/server/swagger/README.md index f349f1129..f6e2714a4 100644 --- a/server/swagger/README.md +++ b/server/swagger/README.md @@ -34,7 +34,7 @@ Refer to the [Mattermost API documentation here](https://api.mattermost.com/#tag Pass this token as a bearer token to the Boards APIs, e.g. ``` -curl -i -H "X-Requested-With: XMLHttpRequest" -H 'Authorization: Bearer abcdefghijklmnopqrstuvwxyz' https://community.mattermost.com/plugins/focalboard/api/v1/workspaces +curl -i -H "X-Requested-With: XMLHttpRequest" -H 'Authorization: Bearer abcdefghijklmnopqrstuvwxyz' https://community.mattermost.com/plugins/focalboard/api/v2/workspaces ``` Note that the `X-Requested-With: XMLHttpRequest` header is required to pass the CSRF check. diff --git a/server/swagger/docs/html/index.html b/server/swagger/docs/html/index.html index b752694d4..cc05a2b4e 100644 --- a/server/swagger/docs/html/index.html +++ b/server/swagger/docs/html/index.html @@ -847,9 +847,14 @@ ul.nav-tabs { // Script section to load models into a JS Var var defs = {} defs["Block"] = { - "required" : [ "createAt", "createdBy", "id", "modifiedBy", "rootId", "schema", "type", "updateAt", "workspaceId" ], + "required" : [ "boardId", "createAt", "createdBy", "id", "modifiedBy", "schema", "type", "updateAt" ], "type" : "object", "properties" : { + "boardId" : { + "type" : "string", + "description" : "The board id that the block belongs to", + "x-go-name" : "BoardID" + }, "createAt" : { "type" : "integer", "description" : "The creation time", @@ -891,11 +896,6 @@ ul.nav-tabs { "description" : "The id for this block's parent block. Empty for root blocks", "x-go-name" : "ParentID" }, - "rootId" : { - "type" : "string", - "description" : "The id for this block's root block", - "x-go-name" : "RootID" - }, "schema" : { "type" : "integer", "description" : "The schema version of this block", @@ -915,11 +915,6 @@ ul.nav-tabs { "description" : "The last modified time", "format" : "int64", "x-go-name" : "UpdateAt" - }, - "workspaceId" : { - "type" : "string", - "description" : "The workspace id that the block belongs to", - "x-go-name" : "WorkspaceID" } }, "description" : "Block is the basic data unit", @@ -928,6 +923,11 @@ ul.nav-tabs { defs["BlockPatch"] = { "type" : "object", "properties" : { + "boardId" : { + "type" : "string", + "description" : "The board id that the block belongs to", + "x-go-name" : "BoardID" + }, "deletedFields" : { "type" : "array", "description" : "The block removed fields", @@ -941,11 +941,6 @@ ul.nav-tabs { "description" : "The id for this block's parent block. Empty for root blocks", "x-go-name" : "ParentID" }, - "rootId" : { - "type" : "string", - "description" : "The id for this block's root block", - "x-go-name" : "RootID" - }, "schema" : { "type" : "integer", "description" : "The schema version of this block", @@ -995,6 +990,335 @@ ul.nav-tabs { }, "description" : "BlockPatchBatch is a batch of IDs and patches for modify blocks", "x-go-package" : "github.com/mattermost/focalboard/server/model" +}; + defs["Board"] = { + "required" : [ "createAt", "createdBy", "id", "modifiedBy", "teamId", "type", "updateAt" ], + "type" : "object", + "properties" : { + "cardProperties" : { + "type" : "array", + "description" : "The properties of the board cards", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { } + } + }, + "x-go-name" : "CardProperties" + }, + "channelId" : { + "type" : "string", + "description" : "The ID of the channel that the board was created from", + "x-go-name" : "ChannelID" + }, + "columnCalculations" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { } + }, + "description" : "The calculations on the board's cards", + "x-go-name" : "ColumnCalculations" + }, + "createAt" : { + "type" : "integer", + "description" : "The creation time", + "format" : "int64", + "x-go-name" : "CreateAt" + }, + "createdBy" : { + "type" : "string", + "description" : "The ID of the user that created the board", + "x-go-name" : "CreatedBy" + }, + "deleteAt" : { + "type" : "integer", + "description" : "The deleted time. Set to indicate this block is deleted", + "format" : "int64", + "x-go-name" : "DeleteAt" + }, + "description" : { + "type" : "string", + "description" : "The description of the board", + "x-go-name" : "Description" + }, + "icon" : { + "type" : "string", + "description" : "The icon of the board", + "x-go-name" : "Icon" + }, + "id" : { + "type" : "string", + "description" : "The ID for the board", + "x-go-name" : "ID" + }, + "isTemplate" : { + "type" : "boolean", + "description" : "Marks the template boards", + "x-go-name" : "IsTemplate" + }, + "modifiedBy" : { + "type" : "string", + "description" : "The ID of the last user that updated the board", + "x-go-name" : "ModifiedBy" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { } + }, + "description" : "The properties of the board", + "x-go-name" : "Properties" + }, + "showDescription" : { + "type" : "boolean", + "description" : "Indicates if the board shows the description on the interface", + "x-go-name" : "ShowDescription" + }, + "teamId" : { + "type" : "string", + "description" : "The ID of the team that the board belongs to", + "x-go-name" : "TeamID" + }, + "templateVersion" : { + "type" : "integer", + "description" : "Marks the template boards", + "format" : "int64", + "x-go-name" : "TemplateVersion" + }, + "title" : { + "type" : "string", + "description" : "The title of the board", + "x-go-name" : "Title" + }, + "type" : { + "$ref" : "#/components/schemas/BoardType" + }, + "updateAt" : { + "type" : "integer", + "description" : "The last modified time", + "format" : "int64", + "x-go-name" : "UpdateAt" + } + }, + "description" : "Board groups a set of blocks and its layout", + "x-go-package" : "github.com/mattermost/focalboard/server/model" +}; + defs["BoardMember"] = { + "required" : [ "boardId", "schemeAdmin", "schemeCommenter", "schemeEditor", "schemeViewer", "userId" ], + "type" : "object", + "properties" : { + "boardId" : { + "type" : "string", + "description" : "The ID of the board", + "x-go-name" : "BoardID" + }, + "roles" : { + "type" : "string", + "description" : "The independent roles of the user on the board", + "x-go-name" : "Roles" + }, + "schemeAdmin" : { + "type" : "boolean", + "description" : "Marks the user as an admin of the board", + "x-go-name" : "SchemeAdmin" + }, + "schemeCommenter" : { + "type" : "boolean", + "description" : "Marks the user as an commenter of the board", + "x-go-name" : "SchemeCommenter" + }, + "schemeEditor" : { + "type" : "boolean", + "description" : "Marks the user as an editor of the board", + "x-go-name" : "SchemeEditor" + }, + "schemeViewer" : { + "type" : "boolean", + "description" : "Marks the user as an viewer of the board", + "x-go-name" : "SchemeViewer" + }, + "userId" : { + "type" : "string", + "description" : "The ID of the user", + "x-go-name" : "UserID" + } + }, + "description" : "BoardMember stores the information of the membership of a user on a board", + "x-go-package" : "github.com/mattermost/focalboard/server/model" +}; + defs["BoardMemberHistoryEntry"] = { + "required" : [ "boardId", "insertAt", "userId" ], + "type" : "object", + "properties" : { + "action" : { + "type" : "string", + "description" : "The action that added this history entry (created or deleted)", + "x-go-name" : "Action" + }, + "boardId" : { + "type" : "string", + "description" : "The ID of the board", + "x-go-name" : "BoardID" + }, + "insertAt" : { + "type" : "integer", + "description" : "The insertion time", + "format" : "int64", + "x-go-name" : "InsertAt" + }, + "userId" : { + "type" : "string", + "description" : "The ID of the user", + "x-go-name" : "UserID" + } + }, + "description" : "BoardMemberHistoryEntry stores the information of the membership of a user on a board", + "x-go-package" : "github.com/mattermost/focalboard/server/model" +}; + defs["BoardMetadata"] = { + "required" : [ "boardId", "createdBy", "descendantFirstUpdateAt", "descendantLastUpdateAt", "lastModifiedBy" ], + "type" : "object", + "properties" : { + "boardId" : { + "type" : "string", + "description" : "The ID for the board", + "x-go-name" : "BoardID" + }, + "createdBy" : { + "type" : "string", + "description" : "The ID of the user that created the board", + "x-go-name" : "CreatedBy" + }, + "descendantFirstUpdateAt" : { + "type" : "integer", + "description" : "The earliest time a descendant of this board was added, modified, or deleted", + "format" : "int64", + "x-go-name" : "DescendantFirstUpdateAt" + }, + "descendantLastUpdateAt" : { + "type" : "integer", + "description" : "The most recent time a descendant of this board was added, modified, or deleted", + "format" : "int64", + "x-go-name" : "DescendantLastUpdateAt" + }, + "lastModifiedBy" : { + "type" : "string", + "description" : "The ID of the user that last modified the most recently modified descendant", + "x-go-name" : "LastModifiedBy" + } + }, + "description" : "BoardMetadata contains metadata for a Board", + "x-go-package" : "github.com/mattermost/focalboard/server/model" +}; + defs["BoardPatch"] = { + "type" : "object", + "properties" : { + "deletedCardProperties" : { + "type" : "array", + "description" : "The board removed card properties", + "items" : { + "type" : "string" + }, + "x-go-name" : "DeletedCardProperties" + }, + "deletedColumnCalculations" : { + "type" : "array", + "description" : "The board deleted column calculations", + "items" : { + "type" : "string" + }, + "x-go-name" : "DeletedColumnCalculations" + }, + "deletedProperties" : { + "type" : "array", + "description" : "The board removed properties", + "items" : { + "type" : "string" + }, + "x-go-name" : "DeletedProperties" + }, + "description" : { + "type" : "string", + "description" : "The description of the board", + "x-go-name" : "Description" + }, + "icon" : { + "type" : "string", + "description" : "The icon of the board", + "x-go-name" : "Icon" + }, + "showDescription" : { + "type" : "boolean", + "description" : "Indicates if the board shows the description on the interface", + "x-go-name" : "ShowDescription" + }, + "title" : { + "type" : "string", + "description" : "The title of the board", + "x-go-name" : "Title" + }, + "type" : { + "$ref" : "#/components/schemas/BoardType" + }, + "updatedCardProperties" : { + "type" : "array", + "description" : "The board updated card properties", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { } + } + }, + "x-go-name" : "UpdatedCardProperties" + }, + "updatedColumnCalculations" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { } + }, + "description" : "The board updated column calculations", + "x-go-name" : "UpdatedColumnCalculations" + }, + "updatedProperties" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { } + }, + "description" : "The board updated properties", + "x-go-name" : "UpdatedProperties" + } + }, + "description" : "BoardPatch is a patch for modify boards", + "x-go-package" : "github.com/mattermost/focalboard/server/model" +}; + defs["BoardsAndBlocks"] = { + "type" : "object", + "properties" : { + "blocks" : { + "type" : "array", + "description" : "The blocks", + "items" : { + "$ref" : "#/components/schemas/Block" + }, + "x-go-name" : "Blocks" + }, + "boards" : { + "type" : "array", + "description" : "The boards", + "items" : { + "$ref" : "#/components/schemas/Board" + }, + "x-go-name" : "Boards" + } + }, + "description" : "BoardsAndBlocks is used to operate over boards and blocks at the\nsame time", + "x-go-package" : "github.com/mattermost/focalboard/server/model" }; defs["ChangePasswordRequest"] = { "required" : [ "newPassword", "oldPassword" ], @@ -1013,6 +1337,30 @@ ul.nav-tabs { }, "description" : "ChangePasswordRequest is a user password change request", "x-go-package" : "github.com/mattermost/focalboard/server/api" +}; + defs["DeleteBoardsAndBlocks"] = { + "required" : [ "blocks", "boards" ], + "type" : "object", + "properties" : { + "blocks" : { + "type" : "array", + "description" : "The blocks", + "items" : { + "type" : "string" + }, + "x-go-name" : "Blocks" + }, + "boards" : { + "type" : "array", + "description" : "The boards", + "items" : { + "type" : "string" + }, + "x-go-name" : "Boards" + } + }, + "description" : "DeleteBoardsAndBlocks is used to list the boards and blocks to\ndelete on a request", + "x-go-package" : "github.com/mattermost/focalboard/server/model" }; defs["ErrorResponse"] = { "type" : "object", @@ -1087,7 +1435,7 @@ ul.nav-tabs { "x-go-package" : "github.com/mattermost/focalboard/server/api" }; defs["NotificationHint"] = { - "required" : [ "block_id", "block_type", "create_at", "notify_at", "workspace_id" ], + "required" : [ "block_id", "block_type", "create_at", "notify_at" ], "type" : "object", "properties" : { "block_id" : { @@ -1114,15 +1462,50 @@ ul.nav-tabs { "description" : "NotifyAt is the timestamp this notification should be scheduled", "format" : "int64", "x-go-name" : "NotifyAt" - }, - "workspace_id" : { - "type" : "string", - "description" : "WorkspaceID is id of workspace the block belongs to", - "x-go-name" : "WorkspaceID" } }, "description" : "NotificationHint provides a hint that a block has been modified and has subscribers that\nshould be notified.", "x-go-package" : "github.com/mattermost/focalboard/server/model" +}; + defs["PatchBoardsAndBlocks"] = { + "required" : [ "blockIDs", "blockPatches", "boardIDs", "boardPatches" ], + "type" : "object", + "properties" : { + "blockIDs" : { + "type" : "array", + "description" : "The block IDs to patch", + "items" : { + "type" : "string" + }, + "x-go-name" : "BlockIDs" + }, + "blockPatches" : { + "type" : "array", + "description" : "The block patches", + "items" : { + "$ref" : "#/components/schemas/BlockPatch" + }, + "x-go-name" : "BlockPatches" + }, + "boardIDs" : { + "type" : "array", + "description" : "The board IDs to patch", + "items" : { + "type" : "string" + }, + "x-go-name" : "BoardIDs" + }, + "boardPatches" : { + "type" : "array", + "description" : "The board patches", + "items" : { + "$ref" : "#/components/schemas/BoardPatch" + }, + "x-go-name" : "BoardPatches" + } + }, + "description" : "PatchBoardsAndBlocks is used to patch multiple boards and blocks on\na single request", + "x-go-package" : "github.com/mattermost/focalboard/server/model" }; defs["RegisterRequest"] = { "required" : [ "email", "password", "token", "username" ], @@ -1210,7 +1593,7 @@ ul.nav-tabs { }; defs["Subscription"] = { "title" : "Subscription is a subscription to a board, card, etc, for a user or channel.", - "required" : [ "blockId", "blockType", "createAt", "deleteAt", "notifiedAt", "subscriberId", "subscriberType", "workspaceId" ], + "required" : [ "blockId", "blockType", "createAt", "deleteAt", "notifiedAt", "subscriberId", "subscriberType" ], "type" : "object", "properties" : { "blockId" : { @@ -1246,17 +1629,55 @@ ul.nav-tabs { }, "subscriberType" : { "$ref" : "#/components/schemas/SubscriberType" - }, - "workspaceId" : { - "type" : "string", - "description" : "WorkspaceID is id of the workspace the block belongs to", - "x-go-name" : "WorkspaceID" } }, "x-go-package" : "github.com/mattermost/focalboard/server/model" +}; + defs["Team"] = { + "required" : [ "id", "modifiedBy", "signupToken", "updateAt" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "ID of the team", + "x-go-name" : "ID" + }, + "modifiedBy" : { + "type" : "string", + "description" : "ID of user who last modified this", + "x-go-name" : "ModifiedBy" + }, + "settings" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "properties" : { } + }, + "description" : "Team settings", + "x-go-name" : "Settings" + }, + "signupToken" : { + "type" : "string", + "description" : "Token required to register new users", + "x-go-name" : "SignupToken" + }, + "title" : { + "type" : "string", + "description" : "Title of the team", + "x-go-name" : "Title" + }, + "updateAt" : { + "type" : "integer", + "description" : "Updated time", + "format" : "int64", + "x-go-name" : "UpdateAt" + } + }, + "description" : "Team is information global to a team", + "x-go-package" : "github.com/mattermost/focalboard/server/model" }; defs["User"] = { - "required" : [ "create_at", "delete_at", "id", "is_bot", "props", "update_at", "username" ], + "required" : [ "create_at", "delete_at", "id", "is_bot", "is_guest", "props", "update_at", "username" ], "type" : "object", "properties" : { "create_at" : { @@ -1281,6 +1702,11 @@ ul.nav-tabs { "description" : "If the user is a bot or not", "x-go-name" : "IsBot" }, + "is_guest" : { + "type" : "boolean", + "description" : "If the user is a guest or not", + "x-go-name" : "IsGuest" + }, "props" : { "type" : "object", "additionalProperties" : { @@ -1305,71 +1731,27 @@ ul.nav-tabs { "description" : "User is a user", "x-go-package" : "github.com/mattermost/focalboard/server/model" }; - defs["UserWorkspace"] = { - "required" : [ "id" ], + defs["UserPropPatch"] = { "type" : "object", "properties" : { - "boardCount" : { - "type" : "integer", - "description" : "Number of boards in the workspace", - "format" : "int64", - "x-go-name" : "BoardCount" + "deletedFields" : { + "type" : "array", + "description" : "The user prop removed fields", + "items" : { + "type" : "string" + }, + "x-go-name" : "DeletedFields" }, - "id" : { - "type" : "string", - "description" : "ID of the workspace", - "x-go-name" : "ID" - }, - "title" : { - "type" : "string", - "description" : "Title of the workspace", - "x-go-name" : "Title" - } - }, - "description" : "UserWorkspace is a summary of a single association between\na user and a workspace", - "x-go-package" : "github.com/mattermost/focalboard/server/model" -}; - defs["Workspace"] = { - "required" : [ "id", "modifiedBy", "signupToken", "updateAt" ], - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "description" : "ID of the workspace", - "x-go-name" : "ID" - }, - "modifiedBy" : { - "type" : "string", - "description" : "ID of user who last modified this", - "x-go-name" : "ModifiedBy" - }, - "settings" : { + "updatedFields" : { "type" : "object", "additionalProperties" : { - "type" : "object", - "properties" : { } + "type" : "string" }, - "description" : "Workspace settings", - "x-go-name" : "Settings" - }, - "signupToken" : { - "type" : "string", - "description" : "Token required to register new users", - "x-go-name" : "SignupToken" - }, - "title" : { - "type" : "string", - "description" : "Title of the workspace", - "x-go-name" : "Title" - }, - "updateAt" : { - "type" : "integer", - "description" : "Updated time", - "format" : "int64", - "x-go-name" : "UpdateAt" + "description" : "The user prop updated fields", + "x-go-name" : "UpdatedFields" } }, - "description" : "Workspace is information global to a workspace", + "description" : "UserPropPatch is a user property patch", "x-go-package" : "github.com/mattermost/focalboard/server/model" }; @@ -1391,50 +1773,98 @@ ul.nav-tabs { +
  • + addMember +
  • +
  • + archiveExportBoard +
  • +
  • + archiveExportTeam +
  • +
  • + archiveImport +
  • changePassword
  • +
  • + createBoard +
  • createSubscription
  • deleteBlock
  • +
  • + deleteBoard +
  • +
  • + deleteBoardsAndBlocks +
  • +
  • + deleteMember +
  • deleteSubscription
  • -
  • - exportBlocks +
  • + duplicateBlock +
  • +
  • + duplicateBoard
  • getBlocks
  • -
  • - getFile +
  • + getBoard +
  • +
  • + getBoardMetadata +
  • +
  • + getBoards
  • getMe
  • +
  • + getMembersForBoard +
  • +
  • + getMyMemberships +
  • getSharing
  • -
  • - getSubTree -
  • getSubscriptions
  • +
  • + getTeam +
  • +
  • + getTeamUsers +
  • +
  • + getTeams +
  • +
  • + getTemplates +
  • getUser
  • -
  • - getWorkspace +
  • + insertBoardsAndBlocks
  • -
  • - getWorkspaceUsers +
  • + joinBoard
  • -
  • - importBlocks +
  • + leaveBoard
  • login @@ -1442,12 +1872,21 @@ ul.nav-tabs {
  • logout
  • +
  • + onboard +
  • patchBlock
  • patchBlocks
  • +
  • + patchBoard +
  • +
  • + patchBoardsAndBlocks +
  • postSharing
  • @@ -1457,9 +1896,24 @@ ul.nav-tabs {
  • register
  • +
  • + searchBoards +
  • +
  • + undeleteBlock +
  • +
  • + undeleteBoard +
  • updateBlocks
  • +
  • + updateMember +
  • +
  • + updateUserConfig +
  • uploadFile
  • @@ -1486,6 +1940,1765 @@ ul.nav-tabs {

    Default

    +
    +
    +
    +

    addMember

    +

    +
    +
    +
    +

    +

    Adds a new member to a board

    +

    +
    +
    /boards/{boardID}/members
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X POST \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + -H "Content-Type: application/json" \
    + "http://localhost/api/v2/boards/{boardID}/members" \
    + -d '{
    +  "schemeAdmin" : true,
    +  "schemeCommenter" : true,
    +  "schemeViewer" : true,
    +  "roles" : "roles",
    +  "schemeEditor" : true,
    +  "boardId" : "boardId",
    +  "userId" : "userId"
    +}'
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        String boardID = boardID_example; // String | Board ID
    +        BoardMember body = ; // BoardMember | 
    +
    +        try {
    +            BoardMember result = apiInstance.addMember(boardID, body);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#addMember");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        String boardID = boardID_example; // String | Board ID
    +        BoardMember body = ; // BoardMember | 
    +
    +        try {
    +            BoardMember result = apiInstance.addMember(boardID, body);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#addMember");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +String *boardID = boardID_example; // Board ID (default to null)
    +BoardMember *body = ; // 
    +
    +[apiInstance addMemberWith:boardID
    +    body:body
    +              completionHandler: ^(BoardMember output, NSError* error) {
    +    if (output) {
    +        NSLog(@"%@", output);
    +    }
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var boardID = boardID_example; // {String} Board ID
    +var body = ; // {BoardMember} 
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully. Returned data: ' + data);
    +  }
    +};
    +api.addMember(boardID, body, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class addMemberExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var boardID = boardID_example;  // String | Board ID (default to null)
    +            var body = new BoardMember(); // BoardMember | 
    +
    +            try {
    +                BoardMember result = apiInstance.addMember(boardID, body);
    +                Debug.WriteLine(result);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.addMember: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$boardID = boardID_example; // String | Board ID
    +$body = ; // BoardMember | 
    +
    +try {
    +    $result = $api_instance->addMember($boardID, $body);
    +    print_r($result);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->addMember: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $boardID = boardID_example; # String | Board ID
    +my $body = WWW::OPenAPIClient::Object::BoardMember->new(); # BoardMember | 
    +
    +eval {
    +    my $result = $api_instance->addMember(boardID => $boardID, body => $body);
    +    print Dumper($result);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->addMember: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +boardID = boardID_example # String | Board ID (default to null)
    +body =  # BoardMember | 
    +
    +try:
    +    api_response = api_instance.add_member(boardID, body)
    +    pprint(api_response)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->addMember: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let boardID = boardID_example; // String
    +    let body = ; // BoardMember
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.addMember(boardID, body, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + + +
    NameDescription
    boardID* + + +
    +
    +
    + + String + + +
    +Board ID +
    +
    +
    + Required +
    +
    +
    +
    + + +
    Body parameters
    + + + + + + + + + +
    NameDescription
    body * +

    membership to replace the current one with

    + +
    +
    + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +

    +

    + + + + + + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +

    archiveExportBoard

    +

    Exports an archive of all blocks for one boards.

    +
    +
    +
    +

    +

    +

    +
    +
    /boards/{boardID}/archive/export
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X GET \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + "http://localhost/api/v2/boards/{boardID}/archive/export"
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        String boardID = boardID_example; // String | Id of board to export
    +
    +        try {
    +            apiInstance.archiveExportBoard(boardID);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#archiveExportBoard");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        String boardID = boardID_example; // String | Id of board to export
    +
    +        try {
    +            apiInstance.archiveExportBoard(boardID);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#archiveExportBoard");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +String *boardID = boardID_example; // Id of board to export (default to null)
    +
    +// Exports an archive of all blocks for one boards.
    +[apiInstance archiveExportBoardWith:boardID
    +              completionHandler: ^(NSError* error) {
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var boardID = boardID_example; // {String} Id of board to export
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully.');
    +  }
    +};
    +api.archiveExportBoard(boardID, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class archiveExportBoardExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var boardID = boardID_example;  // String | Id of board to export (default to null)
    +
    +            try {
    +                // Exports an archive of all blocks for one boards.
    +                apiInstance.archiveExportBoard(boardID);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.archiveExportBoard: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$boardID = boardID_example; // String | Id of board to export
    +
    +try {
    +    $api_instance->archiveExportBoard($boardID);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->archiveExportBoard: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $boardID = boardID_example; # String | Id of board to export
    +
    +eval {
    +    $api_instance->archiveExportBoard(boardID => $boardID);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->archiveExportBoard: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +boardID = boardID_example # String | Id of board to export (default to null)
    +
    +try:
    +    # Exports an archive of all blocks for one boards.
    +    api_instance.archive_export_board(boardID)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->archiveExportBoard: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let boardID = boardID_example; // String
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.archiveExportBoard(boardID, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + + +
    NameDescription
    boardID* + + +
    +
    +
    + + String + + +
    +Id of board to export +
    +
    +
    + Required +
    +
    +
    +
    + + + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +

    archiveExportTeam

    +

    Exports an archive of all blocks for all the boards in a team.

    +
    +
    +
    +

    +

    +

    +
    +
    /teams/{teamID}/archive/export
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X GET \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + "http://localhost/api/v2/teams/{teamID}/archive/export"
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        String teamID = teamID_example; // String | Id of team
    +
    +        try {
    +            apiInstance.archiveExportTeam(teamID);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#archiveExportTeam");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        String teamID = teamID_example; // String | Id of team
    +
    +        try {
    +            apiInstance.archiveExportTeam(teamID);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#archiveExportTeam");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +String *teamID = teamID_example; // Id of team (default to null)
    +
    +// Exports an archive of all blocks for all the boards in a team.
    +[apiInstance archiveExportTeamWith:teamID
    +              completionHandler: ^(NSError* error) {
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var teamID = teamID_example; // {String} Id of team
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully.');
    +  }
    +};
    +api.archiveExportTeam(teamID, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class archiveExportTeamExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var teamID = teamID_example;  // String | Id of team (default to null)
    +
    +            try {
    +                // Exports an archive of all blocks for all the boards in a team.
    +                apiInstance.archiveExportTeam(teamID);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.archiveExportTeam: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$teamID = teamID_example; // String | Id of team
    +
    +try {
    +    $api_instance->archiveExportTeam($teamID);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->archiveExportTeam: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $teamID = teamID_example; # String | Id of team
    +
    +eval {
    +    $api_instance->archiveExportTeam(teamID => $teamID);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->archiveExportTeam: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +teamID = teamID_example # String | Id of team (default to null)
    +
    +try:
    +    # Exports an archive of all blocks for all the boards in a team.
    +    api_instance.archive_export_team(teamID)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->archiveExportTeam: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let teamID = teamID_example; // String
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.archiveExportTeam(teamID, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + + +
    NameDescription
    teamID* + + +
    +
    +
    + + String + + +
    +Id of team +
    +
    +
    + Required +
    +
    +
    +
    + + + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +

    archiveImport

    +

    Import an archive of boards.

    +
    +
    +
    +

    +

    +

    +
    +
    /teams/{teamID}/archive/import
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X POST \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + -H "Content-Type: multipart/form-data" \
    + "http://localhost/api/v2/teams/{teamID}/archive/import"
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        String teamID = teamID_example; // String | Team ID
    +        File file = BINARY_DATA_HERE; // File | archive file to import
    +
    +        try {
    +            apiInstance.archiveImport(teamID, file);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#archiveImport");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        String teamID = teamID_example; // String | Team ID
    +        File file = BINARY_DATA_HERE; // File | archive file to import
    +
    +        try {
    +            apiInstance.archiveImport(teamID, file);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#archiveImport");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +String *teamID = teamID_example; // Team ID (default to null)
    +File *file = BINARY_DATA_HERE; // archive file to import (default to null)
    +
    +// Import an archive of boards.
    +[apiInstance archiveImportWith:teamID
    +    file:file
    +              completionHandler: ^(NSError* error) {
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var teamID = teamID_example; // {String} Team ID
    +var file = BINARY_DATA_HERE; // {File} archive file to import
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully.');
    +  }
    +};
    +api.archiveImport(teamID, file, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class archiveImportExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var teamID = teamID_example;  // String | Team ID (default to null)
    +            var file = BINARY_DATA_HERE;  // File | archive file to import (default to null)
    +
    +            try {
    +                // Import an archive of boards.
    +                apiInstance.archiveImport(teamID, file);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.archiveImport: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$teamID = teamID_example; // String | Team ID
    +$file = BINARY_DATA_HERE; // File | archive file to import
    +
    +try {
    +    $api_instance->archiveImport($teamID, $file);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->archiveImport: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $teamID = teamID_example; # String | Team ID
    +my $file = BINARY_DATA_HERE; # File | archive file to import
    +
    +eval {
    +    $api_instance->archiveImport(teamID => $teamID, file => $file);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->archiveImport: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +teamID = teamID_example # String | Team ID (default to null)
    +file = BINARY_DATA_HERE # File | archive file to import (default to null)
    +
    +try:
    +    # Import an archive of boards.
    +    api_instance.archive_import(teamID, file)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->archiveImport: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let teamID = teamID_example; // String
    +    let file = BINARY_DATA_HERE; // File
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.archiveImport(teamID, file, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + + +
    NameDescription
    teamID* + + +
    +
    +
    + + String + + +
    +Team ID +
    +
    +
    + Required +
    +
    +
    +
    + + + +
    Form parameters
    + + + + + + + + + +
    NameDescription
    file* + + +
    +
    +
    + + File + + + (binary) + + +
    +archive file to import +
    +
    +
    + Required +
    +
    +
    +
    + + +

    Responses

    +

    +

    + + + + + + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    @@ -1498,7 +3711,7 @@ ul.nav-tabs {

    Change a user's password


    -
    /api/v1/users/{userID}/changepassword
    +
    /users/{userID}/changepassword

    Usage and SDK Samples

    @@ -1523,7 +3736,7 @@ ul.nav-tabs { -H "Authorization: [[apiKey]]" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ - "http://localhost/api/v1/api/v1/users/{userID}/changepassword" \ + "http://localhost/api/v2/users/{userID}/changepassword" \ -d '{ "oldPassword" : "oldPassword", "newPassword" : "newPassword" @@ -2005,6 +4218,496 @@ $(document).ready(function() {

    +
    +
    +
    +

    createBoard

    +

    +
    +
    +
    +

    +

    Creates a new board

    +

    +
    +
    /boards
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X POST \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + -H "Content-Type: application/json" \
    + "http://localhost/api/v2/boards" \
    + -d '{
    +  "deleteAt" : 6,
    +  "icon" : "icon",
    +  "description" : "description",
    +  "updateAt" : 5,
    +  "title" : "title",
    +  "type" : "type",
    +  "createAt" : 0,
    +  "showDescription" : true,
    +  "createdBy" : "createdBy",
    +  "isTemplate" : true,
    +  "teamId" : "teamId",
    +  "cardProperties" : [ {
    +    "key" : "{}"
    +  }, {
    +    "key" : "{}"
    +  } ],
    +  "modifiedBy" : "modifiedBy",
    +  "templateVersion" : 1,
    +  "columnCalculations" : {
    +    "key" : "{}"
    +  },
    +  "id" : "id",
    +  "channelId" : "channelId",
    +  "properties" : {
    +    "key" : "{}"
    +  }
    +}'
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        Board body = ; // Board | 
    +
    +        try {
    +            Board result = apiInstance.createBoard(body);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#createBoard");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        Board body = ; // Board | 
    +
    +        try {
    +            Board result = apiInstance.createBoard(body);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#createBoard");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +Board *body = ; // 
    +
    +[apiInstance createBoardWith:body
    +              completionHandler: ^(Board output, NSError* error) {
    +    if (output) {
    +        NSLog(@"%@", output);
    +    }
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var body = ; // {Board} 
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully. Returned data: ' + data);
    +  }
    +};
    +api.createBoard(body, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class createBoardExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var body = new Board(); // Board | 
    +
    +            try {
    +                Board result = apiInstance.createBoard(body);
    +                Debug.WriteLine(result);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.createBoard: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$body = ; // Board | 
    +
    +try {
    +    $result = $api_instance->createBoard($body);
    +    print_r($result);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->createBoard: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $body = WWW::OPenAPIClient::Object::Board->new(); # Board | 
    +
    +eval {
    +    my $result = $api_instance->createBoard(body => $body);
    +    print Dumper($result);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->createBoard: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +body =  # Board | 
    +
    +try:
    +    api_response = api_instance.create_board(body)
    +    pprint(api_response)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->createBoard: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let body = ; // Board
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.createBoard(body, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + + + +
    Body parameters
    + + + + + + + + + +
    NameDescription
    body * +

    the board to create

    + +
    +
    + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    @@ -2017,7 +4720,7 @@ $(document).ready(function() {


    -
    /api/v1/workspaces/{workspaceID}/subscriptions
    +
    /subscriptions

    Usage and SDK Samples

    @@ -2042,7 +4745,7 @@ $(document).ready(function() { -H "Authorization: [[apiKey]]" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ - "http://localhost/api/v1/api/v1/workspaces/{workspaceID}/subscriptions" \ + "http://localhost/api/v2/subscriptions" \ -d '{ "blockId" : "blockId", "deleteAt" : 6, @@ -2050,8 +4753,7 @@ $(document).ready(function() { "blockType" : "blockType", "subscriberId" : "subscriberId", "notifiedAt" : 1, - "createAt" : 0, - "workspaceId" : "workspaceId" + "createAt" : 0 }'
    @@ -2076,11 +4778,10 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID Subscription body = ; // Subscription | try { - User result = apiInstance.createSubscription(workspaceID, body); + User result = apiInstance.createSubscription(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#createSubscription"); @@ -2097,11 +4798,10 @@ public class DefaultApiExample { public class DefaultApiExample { public static void main(String[] args) { DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID Subscription body = ; // Subscription | try { - User result = apiInstance.createSubscription(workspaceID, body); + User result = apiInstance.createSubscription(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#createSubscription"); @@ -2125,12 +4825,10 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi *apiInstance = [[DefaultApi alloc] init]; -String *workspaceID = workspaceID_example; // Workspace ID (default to null) Subscription *body = ; // // Creates a subscription to a block for a user. The user will receive change notifications for the block. -[apiInstance createSubscriptionWith:workspaceID - body:body +[apiInstance createSubscriptionWith:body completionHandler: ^(User output, NSError* error) { if (output) { NSLog(@"%@", output); @@ -2154,7 +4852,6 @@ BearerAuth.apiKey = "YOUR API KEY"; // Create an instance of the API class var api = new FocalboardServer.DefaultApi() -var workspaceID = workspaceID_example; // {String} Workspace ID var body = ; // {Subscription} var callback = function(error, data, response) { @@ -2164,7 +4861,7 @@ var callback = function(error, data, response) { console.log('API called successfully. Returned data: ' + data); } }; -api.createSubscription(workspaceID, body, callback); +api.createSubscription(body, callback);
    @@ -2191,12 +4888,11 @@ namespace Example // Create an instance of the API class var apiInstance = new DefaultApi(); - var workspaceID = workspaceID_example; // String | Workspace ID (default to null) var body = new Subscription(); // Subscription | try { // Creates a subscription to a block for a user. The user will receive change notifications for the block. - User result = apiInstance.createSubscription(workspaceID, body); + User result = apiInstance.createSubscription(body); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling DefaultApi.createSubscription: " + e.Message ); @@ -2218,11 +4914,10 @@ OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authori // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\DefaultApi(); -$workspaceID = workspaceID_example; // String | Workspace ID $body = ; // Subscription | try { - $result = $api_instance->createSubscription($workspaceID, $body); + $result = $api_instance->createSubscription($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling DefaultApi->createSubscription: ', $e->getMessage(), PHP_EOL; @@ -2242,11 +4937,10 @@ $WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY'; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::DefaultApi->new(); -my $workspaceID = workspaceID_example; # String | Workspace ID my $body = WWW::OPenAPIClient::Object::Subscription->new(); # Subscription | eval { - my $result = $api_instance->createSubscription(workspaceID => $workspaceID, body => $body); + my $result = $api_instance->createSubscription(body => $body); print Dumper($result); }; if ($@) { @@ -2268,12 +4962,11 @@ openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Create an instance of the API class api_instance = openapi_client.DefaultApi() -workspaceID = workspaceID_example # String | Workspace ID (default to null) body = # Subscription | try: # Creates a subscription to a block for a user. The user will receive change notifications for the block. - api_response = api_instance.create_subscription(workspaceID, body) + api_response = api_instance.create_subscription(body) pprint(api_response) except ApiException as e: print("Exception when calling DefaultApi->createSubscription: %s\n" % e) @@ -2283,11 +4976,10 @@ except ApiException as e:
    extern crate DefaultApi;
     
     pub fn main() {
    -    let workspaceID = workspaceID_example; // String
         let body = ; // Subscription
     
         let mut context = DefaultApi::Context::default();
    -    let result = client.createSubscription(workspaceID, body, &context).wait();
    +    let result = client.createSubscription(body, &context).wait();
     
         println!("{:?}", result);
     }
    @@ -2302,36 +4994,6 @@ pub fn main() {
     
                               

    Parameters

    -
    Path parameters
    - - - - - - - - - -
    NameDescription
    workspaceID* - - -
    -
    -
    - - String - - -
    -Workspace ID -
    -
    -
    - Required -
    -
    -
    -
    Body parameters
    @@ -2532,7 +5194,7 @@ $(document).ready(function() {

    Deletes a block


    -
    /api/v1/workspaces/{workspaceID}/blocks/{blockID}
    +
    /boards/{boardID}/blocks/{blockID}

    Usage and SDK Samples

    @@ -2556,7 +5218,7 @@ $(document).ready(function() {
    curl -X DELETE \
     -H "Authorization: [[apiKey]]" \
      -H "Accept: application/json" \
    - "http://localhost/api/v1/api/v1/workspaces/{workspaceID}/blocks/{blockID}"
    + "http://localhost/api/v2/boards/{boardID}/blocks/{blockID}"
     
    @@ -2580,11 +5242,11 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID + String boardID = boardID_example; // String | Board ID String blockID = blockID_example; // String | ID of block to delete try { - apiInstance.deleteBlock(workspaceID, blockID); + apiInstance.deleteBlock(boardID, blockID); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#deleteBlock"); e.printStackTrace(); @@ -2600,11 +5262,11 @@ public class DefaultApiExample { public class DefaultApiExample { public static void main(String[] args) { DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID + String boardID = boardID_example; // String | Board ID String blockID = blockID_example; // String | ID of block to delete try { - apiInstance.deleteBlock(workspaceID, blockID); + apiInstance.deleteBlock(boardID, blockID); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#deleteBlock"); e.printStackTrace(); @@ -2627,10 +5289,10 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi *apiInstance = [[DefaultApi alloc] init]; -String *workspaceID = workspaceID_example; // Workspace ID (default to null) +String *boardID = boardID_example; // Board ID (default to null) String *blockID = blockID_example; // ID of block to delete (default to null) -[apiInstance deleteBlockWith:workspaceID +[apiInstance deleteBlockWith:boardID blockID:blockID completionHandler: ^(NSError* error) { if (error) { @@ -2652,7 +5314,7 @@ BearerAuth.apiKey = "YOUR API KEY"; // Create an instance of the API class var api = new FocalboardServer.DefaultApi() -var workspaceID = workspaceID_example; // {String} Workspace ID +var boardID = boardID_example; // {String} Board ID var blockID = blockID_example; // {String} ID of block to delete var callback = function(error, data, response) { @@ -2662,7 +5324,7 @@ var callback = function(error, data, response) { console.log('API called successfully.'); } }; -api.deleteBlock(workspaceID, blockID, callback); +api.deleteBlock(boardID, blockID, callback);
    @@ -2689,11 +5351,11 @@ namespace Example // Create an instance of the API class var apiInstance = new DefaultApi(); - var workspaceID = workspaceID_example; // String | Workspace ID (default to null) + var boardID = boardID_example; // String | Board ID (default to null) var blockID = blockID_example; // String | ID of block to delete (default to null) try { - apiInstance.deleteBlock(workspaceID, blockID); + apiInstance.deleteBlock(boardID, blockID); } catch (Exception e) { Debug.Print("Exception when calling DefaultApi.deleteBlock: " + e.Message ); } @@ -2714,11 +5376,11 @@ OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authori // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\DefaultApi(); -$workspaceID = workspaceID_example; // String | Workspace ID +$boardID = boardID_example; // String | Board ID $blockID = blockID_example; // String | ID of block to delete try { - $api_instance->deleteBlock($workspaceID, $blockID); + $api_instance->deleteBlock($boardID, $blockID); } catch (Exception $e) { echo 'Exception when calling DefaultApi->deleteBlock: ', $e->getMessage(), PHP_EOL; } @@ -2737,11 +5399,11 @@ $WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY'; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::DefaultApi->new(); -my $workspaceID = workspaceID_example; # String | Workspace ID +my $boardID = boardID_example; # String | Board ID my $blockID = blockID_example; # String | ID of block to delete eval { - $api_instance->deleteBlock(workspaceID => $workspaceID, blockID => $blockID); + $api_instance->deleteBlock(boardID => $boardID, blockID => $blockID); }; if ($@) { warn "Exception when calling DefaultApi->deleteBlock: $@\n"; @@ -2762,11 +5424,11 @@ openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Create an instance of the API class api_instance = openapi_client.DefaultApi() -workspaceID = workspaceID_example # String | Workspace ID (default to null) +boardID = boardID_example # String | Board ID (default to null) blockID = blockID_example # String | ID of block to delete (default to null) try: - api_instance.delete_block(workspaceID, blockID) + api_instance.delete_block(boardID, blockID) except ApiException as e: print("Exception when calling DefaultApi->deleteBlock: %s\n" % e) @@ -2775,11 +5437,11 @@ except ApiException as e:
    extern crate DefaultApi;
     
     pub fn main() {
    -    let workspaceID = workspaceID_example; // String
    +    let boardID = boardID_example; // String
         let blockID = blockID_example; // String
     
         let mut context = DefaultApi::Context::default();
    -    let result = client.deleteBlock(workspaceID, blockID, &context).wait();
    +    let result = client.deleteBlock(boardID, blockID, &context).wait();
     
         println!("{:?}", result);
     }
    @@ -2800,11 +5462,11 @@ pub fn main() {
                                       Name
                                       Description
                                     
    -                                  workspaceID*
    +                                  boardID*
     
     
     
    -    
    +
    @@ -2812,7 +5474,7 @@ pub fn main() {
    -Workspace ID +Board ID
    @@ -2875,6 +5537,28 @@ ID of block to delete
    +

    +

    + + + + + + +
    +

    + + + + + +
    +
    +

    +

    + + + + + + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    +
    +
    +

    deleteBoardsAndBlocks

    +

    +
    +
    +
    +

    +

    Deletes boards and blocks

    +

    +
    +
    /boards-and-blocks
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X DELETE \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + -H "Content-Type: application/json" \
    + "http://localhost/api/v2/boards-and-blocks" \
    + -d '{
    +  "blocks" : [ "blocks", "blocks" ],
    +  "boards" : [ "boards", "boards" ]
    +}'
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        DeleteBoardsAndBlocks body = ; // DeleteBoardsAndBlocks | 
    +
    +        try {
    +            apiInstance.deleteBoardsAndBlocks(body);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#deleteBoardsAndBlocks");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        DeleteBoardsAndBlocks body = ; // DeleteBoardsAndBlocks | 
    +
    +        try {
    +            apiInstance.deleteBoardsAndBlocks(body);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#deleteBoardsAndBlocks");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +DeleteBoardsAndBlocks *body = ; // 
    +
    +[apiInstance deleteBoardsAndBlocksWith:body
    +              completionHandler: ^(NSError* error) {
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var body = ; // {DeleteBoardsAndBlocks} 
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully.');
    +  }
    +};
    +api.deleteBoardsAndBlocks(body, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class deleteBoardsAndBlocksExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var body = new DeleteBoardsAndBlocks(); // DeleteBoardsAndBlocks | 
    +
    +            try {
    +                apiInstance.deleteBoardsAndBlocks(body);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.deleteBoardsAndBlocks: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$body = ; // DeleteBoardsAndBlocks | 
    +
    +try {
    +    $api_instance->deleteBoardsAndBlocks($body);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->deleteBoardsAndBlocks: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $body = WWW::OPenAPIClient::Object::DeleteBoardsAndBlocks->new(); # DeleteBoardsAndBlocks | 
    +
    +eval {
    +    $api_instance->deleteBoardsAndBlocks(body => $body);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->deleteBoardsAndBlocks: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +body =  # DeleteBoardsAndBlocks | 
    +
    +try:
    +    api_instance.delete_boards_and_blocks(body)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->deleteBoardsAndBlocks: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let body = ; // DeleteBoardsAndBlocks
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.deleteBoardsAndBlocks(body, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + + + +
    Body parameters
    + + + + + + + + + +
    NameDescription
    body * +

    the boards and blocks to delete

    + +
    +
    + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +

    deleteMember

    +

    +
    +
    +
    +

    +

    Deletes a member from a board

    +

    +
    +
    /boards/{boardID}/members/{userID}
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X DELETE \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + "http://localhost/api/v2/boards/{boardID}/members/{userID}"
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        String boardID = boardID_example; // String | Board ID
    +        String userID = userID_example; // String | User ID
    +
    +        try {
    +            apiInstance.deleteMember(boardID, userID);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#deleteMember");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        String boardID = boardID_example; // String | Board ID
    +        String userID = userID_example; // String | User ID
    +
    +        try {
    +            apiInstance.deleteMember(boardID, userID);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#deleteMember");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +String *boardID = boardID_example; // Board ID (default to null)
    +String *userID = userID_example; // User ID (default to null)
    +
    +[apiInstance deleteMemberWith:boardID
    +    userID:userID
    +              completionHandler: ^(NSError* error) {
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var boardID = boardID_example; // {String} Board ID
    +var userID = userID_example; // {String} User ID
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully.');
    +  }
    +};
    +api.deleteMember(boardID, userID, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class deleteMemberExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var boardID = boardID_example;  // String | Board ID (default to null)
    +            var userID = userID_example;  // String | User ID (default to null)
    +
    +            try {
    +                apiInstance.deleteMember(boardID, userID);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.deleteMember: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$boardID = boardID_example; // String | Board ID
    +$userID = userID_example; // String | User ID
    +
    +try {
    +    $api_instance->deleteMember($boardID, $userID);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->deleteMember: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $boardID = boardID_example; # String | Board ID
    +my $userID = userID_example; # String | User ID
    +
    +eval {
    +    $api_instance->deleteMember(boardID => $boardID, userID => $userID);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->deleteMember: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +boardID = boardID_example # String | Board ID (default to null)
    +userID = userID_example # String | User ID (default to null)
    +
    +try:
    +    api_instance.delete_member(boardID, userID)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->deleteMember: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let boardID = boardID_example; // String
    +    let userID = userID_example; // String
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.deleteMember(boardID, userID, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + + + + + + +
    NameDescription
    boardID* + + +
    +
    +
    + + String + + +
    +Board ID +
    +
    +
    + Required +
    +
    +
    +
    userID* + + +
    +
    +
    + + String + + +
    +User ID +
    +
    +
    + Required +
    +
    +
    +
    + + + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +

    +

    + + + + + + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    @@ -2956,7 +6912,7 @@ ID of block to delete


    -
    /api/v1/workspaces/{workspaceID}/subscriptions/{blockID}/{subscriberID}
    +
    /subscriptions/{blockID}/{subscriberID}

    Usage and SDK Samples

    @@ -2980,7 +6936,7 @@ ID of block to delete
    curl -X DELETE \
     -H "Authorization: [[apiKey]]" \
      -H "Accept: application/json" \
    - "http://localhost/api/v1/api/v1/workspaces/{workspaceID}/subscriptions/{blockID}/{subscriberID}"
    + "http://localhost/api/v2/subscriptions/{blockID}/{subscriberID}"
     
    @@ -3004,12 +6960,11 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID String blockID = blockID_example; // String | Block ID String subscriberID = subscriberID_example; // String | Subscriber ID try { - apiInstance.deleteSubscription(workspaceID, blockID, subscriberID); + apiInstance.deleteSubscription(blockID, subscriberID); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#deleteSubscription"); e.printStackTrace(); @@ -3025,12 +6980,11 @@ public class DefaultApiExample { public class DefaultApiExample { public static void main(String[] args) { DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID String blockID = blockID_example; // String | Block ID String subscriberID = subscriberID_example; // String | Subscriber ID try { - apiInstance.deleteSubscription(workspaceID, blockID, subscriberID); + apiInstance.deleteSubscription(blockID, subscriberID); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#deleteSubscription"); e.printStackTrace(); @@ -3053,13 +7007,11 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi *apiInstance = [[DefaultApi alloc] init]; -String *workspaceID = workspaceID_example; // Workspace ID (default to null) String *blockID = blockID_example; // Block ID (default to null) String *subscriberID = subscriberID_example; // Subscriber ID (default to null) // Deletes a subscription a user has for a a block. The user will no longer receive change notifications for the block. -[apiInstance deleteSubscriptionWith:workspaceID - blockID:blockID +[apiInstance deleteSubscriptionWith:blockID subscriberID:subscriberID completionHandler: ^(NSError* error) { if (error) { @@ -3081,7 +7033,6 @@ BearerAuth.apiKey = "YOUR API KEY"; // Create an instance of the API class var api = new FocalboardServer.DefaultApi() -var workspaceID = workspaceID_example; // {String} Workspace ID var blockID = blockID_example; // {String} Block ID var subscriberID = subscriberID_example; // {String} Subscriber ID @@ -3092,7 +7043,7 @@ var callback = function(error, data, response) { console.log('API called successfully.'); } }; -api.deleteSubscription(workspaceID, blockID, subscriberID, callback); +api.deleteSubscription(blockID, subscriberID, callback);
    @@ -3119,13 +7070,12 @@ namespace Example // Create an instance of the API class var apiInstance = new DefaultApi(); - var workspaceID = workspaceID_example; // String | Workspace ID (default to null) var blockID = blockID_example; // String | Block ID (default to null) var subscriberID = subscriberID_example; // String | Subscriber ID (default to null) try { // Deletes a subscription a user has for a a block. The user will no longer receive change notifications for the block. - apiInstance.deleteSubscription(workspaceID, blockID, subscriberID); + apiInstance.deleteSubscription(blockID, subscriberID); } catch (Exception e) { Debug.Print("Exception when calling DefaultApi.deleteSubscription: " + e.Message ); } @@ -3146,12 +7096,11 @@ OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authori // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\DefaultApi(); -$workspaceID = workspaceID_example; // String | Workspace ID $blockID = blockID_example; // String | Block ID $subscriberID = subscriberID_example; // String | Subscriber ID try { - $api_instance->deleteSubscription($workspaceID, $blockID, $subscriberID); + $api_instance->deleteSubscription($blockID, $subscriberID); } catch (Exception $e) { echo 'Exception when calling DefaultApi->deleteSubscription: ', $e->getMessage(), PHP_EOL; } @@ -3170,12 +7119,11 @@ $WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY'; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::DefaultApi->new(); -my $workspaceID = workspaceID_example; # String | Workspace ID my $blockID = blockID_example; # String | Block ID my $subscriberID = subscriberID_example; # String | Subscriber ID eval { - $api_instance->deleteSubscription(workspaceID => $workspaceID, blockID => $blockID, subscriberID => $subscriberID); + $api_instance->deleteSubscription(blockID => $blockID, subscriberID => $subscriberID); }; if ($@) { warn "Exception when calling DefaultApi->deleteSubscription: $@\n"; @@ -3196,13 +7144,12 @@ openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Create an instance of the API class api_instance = openapi_client.DefaultApi() -workspaceID = workspaceID_example # String | Workspace ID (default to null) blockID = blockID_example # String | Block ID (default to null) subscriberID = subscriberID_example # String | Subscriber ID (default to null) try: # Deletes a subscription a user has for a a block. The user will no longer receive change notifications for the block. - api_instance.delete_subscription(workspaceID, blockID, subscriberID) + api_instance.delete_subscription(blockID, subscriberID) except ApiException as e: print("Exception when calling DefaultApi->deleteSubscription: %s\n" % e) @@ -3211,12 +7158,11 @@ except ApiException as e:
    extern crate DefaultApi;
     
     pub fn main() {
    -    let workspaceID = workspaceID_example; // String
         let blockID = blockID_example; // String
         let subscriberID = subscriberID_example; // String
     
         let mut context = DefaultApi::Context::default();
    -    let result = client.deleteSubscription(workspaceID, blockID, subscriberID, &context).wait();
    +    let result = client.deleteSubscription(blockID, subscriberID, &context).wait();
     
         println!("{:?}", result);
     }
    @@ -3237,29 +7183,6 @@ pub fn main() {
                                       Name
                                       Description
                                     
    -                                  workspaceID*
    -
    -
    -
    -    
    -
    -
    - - String - - -
    -Workspace ID -
    -
    -
    - Required -
    -
    -
    - - - blockID* @@ -3404,46 +7327,46 @@ Subscriber ID
    -
    -
    +
    +
    -

    exportBlocks

    +

    duplicateBlock

    -

    Returns all blocks

    +

    Returns the new created blocks


    -
    /api/v1/workspaces/{workspaceID}/blocks/export
    +
    /boards/{boardID}/blocks/{blockID}/duplicate

    Usage and SDK Samples

    -
    -
    curl -X GET \
    +                          
    +
    curl -X POST \
     -H "Authorization: [[apiKey]]" \
      -H "Accept: application/json" \
    - "http://localhost/api/v1/api/v1/workspaces/{workspaceID}/blocks/export"
    + "http://localhost/api/v2/boards/{boardID}/blocks/{blockID}/duplicate"
     
    -
    +
    import org.openapitools.client.*;
     import org.openapitools.client.auth.*;
     import org.openapitools.client.model.*;
    @@ -3464,13 +7387,14 @@ public class DefaultApiExample {
     
             // Create an instance of the API class
             DefaultApi apiInstance = new DefaultApi();
    -        String workspaceID = workspaceID_example; // String | Workspace ID
    +        String boardID = boardID_example; // String | Board ID
    +        String blockID = blockID_example; // String | Block ID
     
             try {
    -            array[Block] result = apiInstance.exportBlocks(workspaceID);
    +            array[Block] result = apiInstance.duplicateBlock(boardID, blockID);
                 System.out.println(result);
             } catch (ApiException e) {
    -            System.err.println("Exception when calling DefaultApi#exportBlocks");
    +            System.err.println("Exception when calling DefaultApi#duplicateBlock");
                 e.printStackTrace();
             }
         }
    @@ -3478,29 +7402,30 @@ public class DefaultApiExample {
     
    -
    +
    import org.openapitools.client.api.DefaultApi;
     
     public class DefaultApiExample {
         public static void main(String[] args) {
             DefaultApi apiInstance = new DefaultApi();
    -        String workspaceID = workspaceID_example; // String | Workspace ID
    +        String boardID = boardID_example; // String | Board ID
    +        String blockID = blockID_example; // String | Block ID
     
             try {
    -            array[Block] result = apiInstance.exportBlocks(workspaceID);
    +            array[Block] result = apiInstance.duplicateBlock(boardID, blockID);
                 System.out.println(result);
             } catch (ApiException e) {
    -            System.err.println("Exception when calling DefaultApi#exportBlocks");
    +            System.err.println("Exception when calling DefaultApi#duplicateBlock");
                 e.printStackTrace();
             }
         }
     }
    -
    +
    Configuration *apiConfig = [Configuration sharedConfig];
     
     // Configure API key authorization: (authentication scheme: BearerAuth)
    @@ -3511,9 +7436,11 @@ public class DefaultApiExample {
     
     // Create an instance of the API class
     DefaultApi *apiInstance = [[DefaultApi alloc] init];
    -String *workspaceID = workspaceID_example; // Workspace ID (default to null)
    +String *boardID = boardID_example; // Board ID (default to null)
    +String *blockID = blockID_example; // Block ID (default to null)
     
    -[apiInstance exportBlocksWith:workspaceID
    +[apiInstance duplicateBlockWith:boardID
    +    blockID:blockID
                   completionHandler: ^(array[Block] output, NSError* error) {
         if (output) {
             NSLog(@"%@", output);
    @@ -3525,7 +7452,7 @@ String *workspaceID = workspaceID_example; // Workspace ID (default to null)
     
    -
    +
    var FocalboardServer = require('focalboard_server');
     var defaultClient = FocalboardServer.ApiClient.instance;
     
    @@ -3537,7 +7464,8 @@ BearerAuth.apiKey = "YOUR API KEY";
     
     // Create an instance of the API class
     var api = new FocalboardServer.DefaultApi()
    -var workspaceID = workspaceID_example; // {String} Workspace ID
    +var boardID = boardID_example; // {String} Board ID
    +var blockID = blockID_example; // {String} Block ID
     
     var callback = function(error, data, response) {
       if (error) {
    @@ -3546,14 +7474,14 @@ var callback = function(error, data, response) {
         console.log('API called successfully. Returned data: ' + data);
       }
     };
    -api.exportBlocks(workspaceID, callback);
    +api.duplicateBlock(boardID, blockID, callback);
     
    - -
    +
    using System;
     using System.Diagnostics;
     using Org.OpenAPITools.Api;
    @@ -3562,7 +7490,7 @@ using Org.OpenAPITools.Model;
     
     namespace Example
     {
    -    public class exportBlocksExample
    +    public class duplicateBlockExample
         {
             public void main()
             {
    @@ -3573,13 +7501,14 @@ namespace Example
     
                 // Create an instance of the API class
                 var apiInstance = new DefaultApi();
    -            var workspaceID = workspaceID_example;  // String | Workspace ID (default to null)
    +            var boardID = boardID_example;  // String | Board ID (default to null)
    +            var blockID = blockID_example;  // String | Block ID (default to null)
     
                 try {
    -                array[Block] result = apiInstance.exportBlocks(workspaceID);
    +                array[Block] result = apiInstance.duplicateBlock(boardID, blockID);
                     Debug.WriteLine(result);
                 } catch (Exception e) {
    -                Debug.Print("Exception when calling DefaultApi.exportBlocks: " + e.Message );
    +                Debug.Print("Exception when calling DefaultApi.duplicateBlock: " + e.Message );
                 }
             }
         }
    @@ -3587,7 +7516,7 @@ namespace Example
     
    -
    +
    <?php
     require_once(__DIR__ . '/vendor/autoload.php');
     
    @@ -3598,18 +7527,19 @@ OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authori
     
     // Create an instance of the API class
     $api_instance = new OpenAPITools\Client\Api\DefaultApi();
    -$workspaceID = workspaceID_example; // String | Workspace ID
    +$boardID = boardID_example; // String | Board ID
    +$blockID = blockID_example; // String | Block ID
     
     try {
    -    $result = $api_instance->exportBlocks($workspaceID);
    +    $result = $api_instance->duplicateBlock($boardID, $blockID);
         print_r($result);
     } catch (Exception $e) {
    -    echo 'Exception when calling DefaultApi->exportBlocks: ', $e->getMessage(), PHP_EOL;
    +    echo 'Exception when calling DefaultApi->duplicateBlock: ', $e->getMessage(), PHP_EOL;
     }
     ?>
    -
    +
    use Data::Dumper;
     use WWW::OPenAPIClient::Configuration;
     use WWW::OPenAPIClient::DefaultApi;
    @@ -3621,18 +7551,19 @@ $WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
     
     # Create an instance of the API class
     my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    -my $workspaceID = workspaceID_example; # String | Workspace ID
    +my $boardID = boardID_example; # String | Board ID
    +my $blockID = blockID_example; # String | Block ID
     
     eval {
    -    my $result = $api_instance->exportBlocks(workspaceID => $workspaceID);
    +    my $result = $api_instance->duplicateBlock(boardID => $boardID, blockID => $blockID);
         print Dumper($result);
     };
     if ($@) {
    -    warn "Exception when calling DefaultApi->exportBlocks: $@\n";
    +    warn "Exception when calling DefaultApi->duplicateBlock: $@\n";
     }
    -
    +
    from __future__ import print_statement
     import time
     import openapi_client
    @@ -3646,23 +7577,25 @@ openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
     
     # Create an instance of the API class
     api_instance = openapi_client.DefaultApi()
    -workspaceID = workspaceID_example # String | Workspace ID (default to null)
    +boardID = boardID_example # String | Board ID (default to null)
    +blockID = blockID_example # String | Block ID (default to null)
     
     try:
    -    api_response = api_instance.export_blocks(workspaceID)
    +    api_response = api_instance.duplicate_block(boardID, blockID)
         pprint(api_response)
     except ApiException as e:
    -    print("Exception when calling DefaultApi->exportBlocks: %s\n" % e)
    + print("Exception when calling DefaultApi->duplicateBlock: %s\n" % e)
    -
    +
    extern crate DefaultApi;
     
     pub fn main() {
    -    let workspaceID = workspaceID_example; // String
    +    let boardID = boardID_example; // String
    +    let blockID = blockID_example; // String
     
         let mut context = DefaultApi::Context::default();
    -    let result = client.exportBlocks(workspaceID, &context).wait();
    +    let result = client.duplicateBlock(boardID, blockID, &context).wait();
     
         println!("{:?}", result);
     }
    @@ -3683,11 +7616,11 @@ pub fn main() {
                                       Name
                                       Description
                                     
    -                                  workspaceID*
    +                                  boardID*
     
     
     
    -    
    +
    @@ -3695,7 +7628,30 @@ pub fn main() {
    -Workspace ID +Board ID +
    +
    +
    + Required +
    +
    +
    + + + + blockID* + + + +
    +
    +
    + + String + + +
    +Block ID
    @@ -3713,23 +7669,23 @@ Workspace ID

    Responses

    -

    -

    +

    +

    -
    +
    +
    +
    +
    +
    +

    duplicateBoard

    +

    +
    +
    +
    +

    +

    Returns the new created board and all the blocks

    +

    +
    +
    /boards/{boardID}/duplicate
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X POST \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + "http://localhost/api/v2/boards/{boardID}/duplicate"
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        String boardID = boardID_example; // String | Board ID
    +
    +        try {
    +            BoardsAndBlocks result = apiInstance.duplicateBoard(boardID);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#duplicateBoard");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        String boardID = boardID_example; // String | Board ID
    +
    +        try {
    +            BoardsAndBlocks result = apiInstance.duplicateBoard(boardID);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#duplicateBoard");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +String *boardID = boardID_example; // Board ID (default to null)
    +
    +[apiInstance duplicateBoardWith:boardID
    +              completionHandler: ^(BoardsAndBlocks output, NSError* error) {
    +    if (output) {
    +        NSLog(@"%@", output);
    +    }
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var boardID = boardID_example; // {String} Board ID
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully. Returned data: ' + data);
    +  }
    +};
    +api.duplicateBoard(boardID, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class duplicateBoardExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var boardID = boardID_example;  // String | Board ID (default to null)
    +
    +            try {
    +                BoardsAndBlocks result = apiInstance.duplicateBoard(boardID);
    +                Debug.WriteLine(result);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.duplicateBoard: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$boardID = boardID_example; // String | Board ID
    +
    +try {
    +    $result = $api_instance->duplicateBoard($boardID);
    +    print_r($result);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->duplicateBoard: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $boardID = boardID_example; # String | Board ID
    +
    +eval {
    +    my $result = $api_instance->duplicateBoard(boardID => $boardID);
    +    print Dumper($result);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->duplicateBoard: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +boardID = boardID_example # String | Board ID (default to null)
    +
    +try:
    +    api_response = api_instance.duplicate_board(boardID)
    +    pprint(api_response)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->duplicateBoard: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let boardID = boardID_example; // String
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.duplicateBoard(boardID, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + + +
    NameDescription
    boardID* + + +
    +
    +
    + + String + + +
    +Board ID +
    +
    +
    + Required +
    +
    +
    +
    + + + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +

    +

    + + + + + + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    +
    @@ -3863,7 +8307,7 @@ Workspace ID

    Returns blocks


    -
    /api/v1/workspaces/{workspaceID}/blocks
    +
    /boards/{boardID}/blocks

    Usage and SDK Samples

    @@ -3887,7 +8331,7 @@ Workspace ID
    curl -X GET \
     -H "Authorization: [[apiKey]]" \
      -H "Accept: application/json" \
    - "http://localhost/api/v1/api/v1/workspaces/{workspaceID}/blocks?parent_id=parentId_example&type=type_example"
    + "http://localhost/api/v2/boards/{boardID}/blocks?parent_id=parentId_example&type=type_example"
     
    @@ -3911,12 +8355,12 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID + String boardID = boardID_example; // String | Board ID String parentId = parentId_example; // String | ID of parent block, omit to specify all blocks String type = type_example; // String | Type of blocks to return, omit to specify all types try { - array[Block] result = apiInstance.getBlocks(workspaceID, parentId, type); + array[Block] result = apiInstance.getBlocks(boardID, parentId, type); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#getBlocks"); @@ -3933,12 +8377,12 @@ public class DefaultApiExample { public class DefaultApiExample { public static void main(String[] args) { DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID + String boardID = boardID_example; // String | Board ID String parentId = parentId_example; // String | ID of parent block, omit to specify all blocks String type = type_example; // String | Type of blocks to return, omit to specify all types try { - array[Block] result = apiInstance.getBlocks(workspaceID, parentId, type); + array[Block] result = apiInstance.getBlocks(boardID, parentId, type); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#getBlocks"); @@ -3962,11 +8406,11 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi *apiInstance = [[DefaultApi alloc] init]; -String *workspaceID = workspaceID_example; // Workspace ID (default to null) +String *boardID = boardID_example; // Board ID (default to null) String *parentId = parentId_example; // ID of parent block, omit to specify all blocks (optional) (default to null) String *type = type_example; // Type of blocks to return, omit to specify all types (optional) (default to null) -[apiInstance getBlocksWith:workspaceID +[apiInstance getBlocksWith:boardID parentId:parentId type:type completionHandler: ^(array[Block] output, NSError* error) { @@ -3992,7 +8436,7 @@ BearerAuth.apiKey = "YOUR API KEY"; // Create an instance of the API class var api = new FocalboardServer.DefaultApi() -var workspaceID = workspaceID_example; // {String} Workspace ID +var boardID = boardID_example; // {String} Board ID var opts = { 'parentId': parentId_example, // {String} ID of parent block, omit to specify all blocks 'type': type_example // {String} Type of blocks to return, omit to specify all types @@ -4005,7 +8449,7 @@ var callback = function(error, data, response) { console.log('API called successfully. Returned data: ' + data); } }; -api.getBlocks(workspaceID, opts, callback); +api.getBlocks(boardID, opts, callback);
    @@ -4032,12 +8476,12 @@ namespace Example // Create an instance of the API class var apiInstance = new DefaultApi(); - var workspaceID = workspaceID_example; // String | Workspace ID (default to null) + var boardID = boardID_example; // String | Board ID (default to null) var parentId = parentId_example; // String | ID of parent block, omit to specify all blocks (optional) (default to null) var type = type_example; // String | Type of blocks to return, omit to specify all types (optional) (default to null) try { - array[Block] result = apiInstance.getBlocks(workspaceID, parentId, type); + array[Block] result = apiInstance.getBlocks(boardID, parentId, type); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling DefaultApi.getBlocks: " + e.Message ); @@ -4059,12 +8503,12 @@ OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authori // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\DefaultApi(); -$workspaceID = workspaceID_example; // String | Workspace ID +$boardID = boardID_example; // String | Board ID $parentId = parentId_example; // String | ID of parent block, omit to specify all blocks $type = type_example; // String | Type of blocks to return, omit to specify all types try { - $result = $api_instance->getBlocks($workspaceID, $parentId, $type); + $result = $api_instance->getBlocks($boardID, $parentId, $type); print_r($result); } catch (Exception $e) { echo 'Exception when calling DefaultApi->getBlocks: ', $e->getMessage(), PHP_EOL; @@ -4084,12 +8528,12 @@ $WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY'; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::DefaultApi->new(); -my $workspaceID = workspaceID_example; # String | Workspace ID +my $boardID = boardID_example; # String | Board ID my $parentId = parentId_example; # String | ID of parent block, omit to specify all blocks my $type = type_example; # String | Type of blocks to return, omit to specify all types eval { - my $result = $api_instance->getBlocks(workspaceID => $workspaceID, parentId => $parentId, type => $type); + my $result = $api_instance->getBlocks(boardID => $boardID, parentId => $parentId, type => $type); print Dumper($result); }; if ($@) { @@ -4111,12 +8555,12 @@ openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Create an instance of the API class api_instance = openapi_client.DefaultApi() -workspaceID = workspaceID_example # String | Workspace ID (default to null) +boardID = boardID_example # String | Board ID (default to null) parentId = parentId_example # String | ID of parent block, omit to specify all blocks (optional) (default to null) type = type_example # String | Type of blocks to return, omit to specify all types (optional) (default to null) try: - api_response = api_instance.get_blocks(workspaceID, parentId=parentId, type=type) + api_response = api_instance.get_blocks(boardID, parentId=parentId, type=type) pprint(api_response) except ApiException as e: print("Exception when calling DefaultApi->getBlocks: %s\n" % e) @@ -4126,12 +8570,12 @@ except ApiException as e:
    extern crate DefaultApi;
     
     pub fn main() {
    -    let workspaceID = workspaceID_example; // String
    +    let boardID = boardID_example; // String
         let parentId = parentId_example; // String
         let type = type_example; // String
     
         let mut context = DefaultApi::Context::default();
    -    let result = client.getBlocks(workspaceID, parentId, type, &context).wait();
    +    let result = client.getBlocks(boardID, parentId, type, &context).wait();
     
         println!("{:?}", result);
     }
    @@ -4152,11 +8596,11 @@ pub fn main() {
                                       Name
                                       Description
                                     
    -                                  workspaceID*
    +                                  boardID*
     
     
     
    -    
    +
    @@ -4164,7 +8608,7 @@ pub fn main() {
    -Workspace ID +Board ID
    @@ -4298,6 +8742,28 @@ Type of blocks to return, omit to specify all types
    +

    +

    + + + + + + +
    +

    - - - -
    -
    -

    -

    - - - -
    @@ -5412,11 +11661,10 @@ namespace Example // Create an instance of the API class var apiInstance = new DefaultApi(); - var workspaceID = workspaceID_example; // String | Workspace ID (default to null) - var rootID = rootID_example; // String | ID of the root block (default to null) + var boardID = boardID_example; // String | Board ID (default to null) try { - Sharing result = apiInstance.getSharing(workspaceID, rootID); + Sharing result = apiInstance.getSharing(boardID); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling DefaultApi.getSharing: " + e.Message ); @@ -5438,11 +11686,10 @@ OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authori // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\DefaultApi(); -$workspaceID = workspaceID_example; // String | Workspace ID -$rootID = rootID_example; // String | ID of the root block +$boardID = boardID_example; // String | Board ID try { - $result = $api_instance->getSharing($workspaceID, $rootID); + $result = $api_instance->getSharing($boardID); print_r($result); } catch (Exception $e) { echo 'Exception when calling DefaultApi->getSharing: ', $e->getMessage(), PHP_EOL; @@ -5462,11 +11709,10 @@ $WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY'; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::DefaultApi->new(); -my $workspaceID = workspaceID_example; # String | Workspace ID -my $rootID = rootID_example; # String | ID of the root block +my $boardID = boardID_example; # String | Board ID eval { - my $result = $api_instance->getSharing(workspaceID => $workspaceID, rootID => $rootID); + my $result = $api_instance->getSharing(boardID => $boardID); print Dumper($result); }; if ($@) { @@ -5488,11 +11734,10 @@ openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Create an instance of the API class api_instance = openapi_client.DefaultApi() -workspaceID = workspaceID_example # String | Workspace ID (default to null) -rootID = rootID_example # String | ID of the root block (default to null) +boardID = boardID_example # String | Board ID (default to null) try: - api_response = api_instance.get_sharing(workspaceID, rootID) + api_response = api_instance.get_sharing(boardID) pprint(api_response) except ApiException as e: print("Exception when calling DefaultApi->getSharing: %s\n" % e) @@ -5502,11 +11747,10 @@ except ApiException as e:
    extern crate DefaultApi;
     
     pub fn main() {
    -    let workspaceID = workspaceID_example; // String
    -    let rootID = rootID_example; // String
    +    let boardID = boardID_example; // String
     
         let mut context = DefaultApi::Context::default();
    -    let result = client.getSharing(workspaceID, rootID, &context).wait();
    +    let result = client.getSharing(boardID, &context).wait();
     
         println!("{:?}", result);
     }
    @@ -5527,11 +11771,11 @@ pub fn main() {
                                       Name
                                       Description
                                     
    -                                  workspaceID*
    +                                  boardID*
     
     
     
    -    
    +
    @@ -5539,30 +11783,7 @@ pub fn main() {
    -Workspace ID -
    -
    -
    - Required -
    -
    -
    - - - - rootID* - - - -
    -
    -
    - - String - - -
    -ID of the root block +Board ID
    @@ -5646,6 +11867,28 @@ ID of the root block
    +

    +

    + + + + + + +
    +

    - - - - - -
    -
    -
    - -
    - -
    -
    -

    -

    - - - - - - -
    -
    -
    - -
    - -
    -
    - -
    -
    @@ -6246,7 +11970,7 @@ The number of levels to return. 2 or 3. Defaults to 2.


    -
    /api/v1/workspaces/{workspaceID}/subscriptions/{subscriberID}
    +
    /subscriptions/{subscriberID}

    Usage and SDK Samples

    @@ -6270,7 +11994,7 @@ The number of levels to return. 2 or 3. Defaults to 2.
    curl -X GET \
     -H "Authorization: [[apiKey]]" \
      -H "Accept: application/json" \
    - "http://localhost/api/v1/api/v1/workspaces/{workspaceID}/subscriptions/{subscriberID}"
    + "http://localhost/api/v2/subscriptions/{subscriberID}"
     
    @@ -6294,11 +12018,10 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID String subscriberID = subscriberID_example; // String | Subscriber ID try { - array[User] result = apiInstance.getSubscriptions(workspaceID, subscriberID); + array[User] result = apiInstance.getSubscriptions(subscriberID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#getSubscriptions"); @@ -6315,11 +12038,10 @@ public class DefaultApiExample { public class DefaultApiExample { public static void main(String[] args) { DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID String subscriberID = subscriberID_example; // String | Subscriber ID try { - array[User] result = apiInstance.getSubscriptions(workspaceID, subscriberID); + array[User] result = apiInstance.getSubscriptions(subscriberID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#getSubscriptions"); @@ -6343,12 +12065,10 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi *apiInstance = [[DefaultApi alloc] init]; -String *workspaceID = workspaceID_example; // Workspace ID (default to null) String *subscriberID = subscriberID_example; // Subscriber ID (default to null) // Gets subscriptions for a user. -[apiInstance getSubscriptionsWith:workspaceID - subscriberID:subscriberID +[apiInstance getSubscriptionsWith:subscriberID completionHandler: ^(array[User] output, NSError* error) { if (output) { NSLog(@"%@", output); @@ -6372,7 +12092,6 @@ BearerAuth.apiKey = "YOUR API KEY"; // Create an instance of the API class var api = new FocalboardServer.DefaultApi() -var workspaceID = workspaceID_example; // {String} Workspace ID var subscriberID = subscriberID_example; // {String} Subscriber ID var callback = function(error, data, response) { @@ -6382,7 +12101,7 @@ var callback = function(error, data, response) { console.log('API called successfully. Returned data: ' + data); } }; -api.getSubscriptions(workspaceID, subscriberID, callback); +api.getSubscriptions(subscriberID, callback);
    @@ -6409,12 +12128,11 @@ namespace Example // Create an instance of the API class var apiInstance = new DefaultApi(); - var workspaceID = workspaceID_example; // String | Workspace ID (default to null) var subscriberID = subscriberID_example; // String | Subscriber ID (default to null) try { // Gets subscriptions for a user. - array[User] result = apiInstance.getSubscriptions(workspaceID, subscriberID); + array[User] result = apiInstance.getSubscriptions(subscriberID); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling DefaultApi.getSubscriptions: " + e.Message ); @@ -6436,11 +12154,10 @@ OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authori // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\DefaultApi(); -$workspaceID = workspaceID_example; // String | Workspace ID $subscriberID = subscriberID_example; // String | Subscriber ID try { - $result = $api_instance->getSubscriptions($workspaceID, $subscriberID); + $result = $api_instance->getSubscriptions($subscriberID); print_r($result); } catch (Exception $e) { echo 'Exception when calling DefaultApi->getSubscriptions: ', $e->getMessage(), PHP_EOL; @@ -6460,11 +12177,10 @@ $WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY'; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::DefaultApi->new(); -my $workspaceID = workspaceID_example; # String | Workspace ID my $subscriberID = subscriberID_example; # String | Subscriber ID eval { - my $result = $api_instance->getSubscriptions(workspaceID => $workspaceID, subscriberID => $subscriberID); + my $result = $api_instance->getSubscriptions(subscriberID => $subscriberID); print Dumper($result); }; if ($@) { @@ -6486,12 +12202,11 @@ openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Create an instance of the API class api_instance = openapi_client.DefaultApi() -workspaceID = workspaceID_example # String | Workspace ID (default to null) subscriberID = subscriberID_example # String | Subscriber ID (default to null) try: # Gets subscriptions for a user. - api_response = api_instance.get_subscriptions(workspaceID, subscriberID) + api_response = api_instance.get_subscriptions(subscriberID) pprint(api_response) except ApiException as e: print("Exception when calling DefaultApi->getSubscriptions: %s\n" % e)
    @@ -6501,11 +12216,10 @@ except ApiException as e:
    extern crate DefaultApi;
     
     pub fn main() {
    -    let workspaceID = workspaceID_example; // String
         let subscriberID = subscriberID_example; // String
     
         let mut context = DefaultApi::Context::default();
    -    let result = client.getSubscriptions(workspaceID, subscriberID, &context).wait();
    +    let result = client.getSubscriptions(subscriberID, &context).wait();
     
         println!("{:?}", result);
     }
    @@ -6526,29 +12240,6 @@ pub fn main() {
                                       Name
                                       Description
                                     
    -                                  workspaceID*
    -
    -
    -
    -    
    -
    -
    - - String - - -
    -Workspace ID -
    -
    -
    - Required -
    -
    -
    - - - subscriberID* @@ -6717,6 +12408,1790 @@ Subscriber ID
    +
    +
    +
    +

    getTeam

    +

    +
    +
    +
    +

    +

    Returns information of the root team

    +

    +
    +
    /teams/{teamID}
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X GET \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + "http://localhost/api/v2/teams/{teamID}"
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        String teamID = teamID_example; // String | Team ID
    +
    +        try {
    +            Team result = apiInstance.getTeam(teamID);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#getTeam");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        String teamID = teamID_example; // String | Team ID
    +
    +        try {
    +            Team result = apiInstance.getTeam(teamID);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#getTeam");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +String *teamID = teamID_example; // Team ID (default to null)
    +
    +[apiInstance getTeamWith:teamID
    +              completionHandler: ^(Team output, NSError* error) {
    +    if (output) {
    +        NSLog(@"%@", output);
    +    }
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var teamID = teamID_example; // {String} Team ID
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully. Returned data: ' + data);
    +  }
    +};
    +api.getTeam(teamID, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class getTeamExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var teamID = teamID_example;  // String | Team ID (default to null)
    +
    +            try {
    +                Team result = apiInstance.getTeam(teamID);
    +                Debug.WriteLine(result);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.getTeam: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$teamID = teamID_example; // String | Team ID
    +
    +try {
    +    $result = $api_instance->getTeam($teamID);
    +    print_r($result);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->getTeam: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $teamID = teamID_example; # String | Team ID
    +
    +eval {
    +    my $result = $api_instance->getTeam(teamID => $teamID);
    +    print Dumper($result);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->getTeam: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +teamID = teamID_example # String | Team ID (default to null)
    +
    +try:
    +    api_response = api_instance.get_team(teamID)
    +    pprint(api_response)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->getTeam: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let teamID = teamID_example; // String
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.getTeam(teamID, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + + +
    NameDescription
    teamID* + + +
    +
    +
    + + String + + +
    +Team ID +
    +
    +
    + Required +
    +
    +
    +
    + + + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +

    getTeamUsers

    +

    +
    +
    +
    +

    +

    Returns team users

    +

    +
    +
    /teams/{teamID}/users
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X GET \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + "http://localhost/api/v2/teams/{teamID}/users?search=search_example"
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        String teamID = teamID_example; // String | Team ID
    +        String search = search_example; // String | string to filter users list
    +
    +        try {
    +            array[User] result = apiInstance.getTeamUsers(teamID, search);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#getTeamUsers");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        String teamID = teamID_example; // String | Team ID
    +        String search = search_example; // String | string to filter users list
    +
    +        try {
    +            array[User] result = apiInstance.getTeamUsers(teamID, search);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#getTeamUsers");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +String *teamID = teamID_example; // Team ID (default to null)
    +String *search = search_example; // string to filter users list (optional) (default to null)
    +
    +[apiInstance getTeamUsersWith:teamID
    +    search:search
    +              completionHandler: ^(array[User] output, NSError* error) {
    +    if (output) {
    +        NSLog(@"%@", output);
    +    }
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var teamID = teamID_example; // {String} Team ID
    +var opts = {
    +  'search': search_example // {String} string to filter users list
    +};
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully. Returned data: ' + data);
    +  }
    +};
    +api.getTeamUsers(teamID, opts, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class getTeamUsersExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var teamID = teamID_example;  // String | Team ID (default to null)
    +            var search = search_example;  // String | string to filter users list (optional)  (default to null)
    +
    +            try {
    +                array[User] result = apiInstance.getTeamUsers(teamID, search);
    +                Debug.WriteLine(result);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.getTeamUsers: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$teamID = teamID_example; // String | Team ID
    +$search = search_example; // String | string to filter users list
    +
    +try {
    +    $result = $api_instance->getTeamUsers($teamID, $search);
    +    print_r($result);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->getTeamUsers: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $teamID = teamID_example; # String | Team ID
    +my $search = search_example; # String | string to filter users list
    +
    +eval {
    +    my $result = $api_instance->getTeamUsers(teamID => $teamID, search => $search);
    +    print Dumper($result);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->getTeamUsers: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +teamID = teamID_example # String | Team ID (default to null)
    +search = search_example # String | string to filter users list (optional) (default to null)
    +
    +try:
    +    api_response = api_instance.get_team_users(teamID, search=search)
    +    pprint(api_response)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->getTeamUsers: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let teamID = teamID_example; // String
    +    let search = search_example; // String
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.getTeamUsers(teamID, search, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + + +
    NameDescription
    teamID* + + +
    +
    +
    + + String + + +
    +Team ID +
    +
    +
    + Required +
    +
    +
    +
    + + + + +
    Query parameters
    + + + + + + + + + +
    NameDescription
    search + + + +
    + +

    Responses

    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +

    getTeams

    +

    +
    +
    +
    +

    +

    Returns information of all the teams

    +

    +
    +
    /teams
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X GET \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + "http://localhost/api/v2/teams"
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +
    +        try {
    +            array[Team] result = apiInstance.getTeams();
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#getTeams");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +
    +        try {
    +            array[Team] result = apiInstance.getTeams();
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#getTeams");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +
    +[apiInstance getTeamsWithCompletionHandler: 
    +              ^(array[Team] output, NSError* error) {
    +    if (output) {
    +        NSLog(@"%@", output);
    +    }
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully. Returned data: ' + data);
    +  }
    +};
    +api.getTeams(callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class getTeamsExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +
    +            try {
    +                array[Team] result = apiInstance.getTeams();
    +                Debug.WriteLine(result);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.getTeams: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +
    +try {
    +    $result = $api_instance->getTeams();
    +    print_r($result);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->getTeams: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +
    +eval {
    +    my $result = $api_instance->getTeams();
    +    print Dumper($result);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->getTeams: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +
    +try:
    +    api_response = api_instance.get_teams()
    +    pprint(api_response)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->getTeams: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.getTeams(&context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + + + + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +

    getTemplates

    +

    +
    +
    +
    +

    +

    Returns team templates

    +

    +
    +
    /teams/{teamID}/templates
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X GET \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + "http://localhost/api/v2/teams/{teamID}/templates"
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        String teamID = teamID_example; // String | Team ID
    +
    +        try {
    +            array[Board] result = apiInstance.getTemplates(teamID);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#getTemplates");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        String teamID = teamID_example; // String | Team ID
    +
    +        try {
    +            array[Board] result = apiInstance.getTemplates(teamID);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#getTemplates");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +String *teamID = teamID_example; // Team ID (default to null)
    +
    +[apiInstance getTemplatesWith:teamID
    +              completionHandler: ^(array[Board] output, NSError* error) {
    +    if (output) {
    +        NSLog(@"%@", output);
    +    }
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var teamID = teamID_example; // {String} Team ID
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully. Returned data: ' + data);
    +  }
    +};
    +api.getTemplates(teamID, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class getTemplatesExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var teamID = teamID_example;  // String | Team ID (default to null)
    +
    +            try {
    +                array[Board] result = apiInstance.getTemplates(teamID);
    +                Debug.WriteLine(result);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.getTemplates: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$teamID = teamID_example; // String | Team ID
    +
    +try {
    +    $result = $api_instance->getTemplates($teamID);
    +    print_r($result);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->getTemplates: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $teamID = teamID_example; # String | Team ID
    +
    +eval {
    +    my $result = $api_instance->getTemplates(teamID => $teamID);
    +    print Dumper($result);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->getTemplates: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +teamID = teamID_example # String | Team ID (default to null)
    +
    +try:
    +    api_response = api_instance.get_templates(teamID)
    +    pprint(api_response)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->getTemplates: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let teamID = teamID_example; // String
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.getTemplates(teamID, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + + +
    NameDescription
    teamID* + + +
    +
    +
    + + String + + +
    +Team ID +
    +
    +
    + Required +
    +
    +
    +
    + + + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    @@ -6729,7 +14204,7 @@ Subscriber ID

    Returns a user


    -
    /api/v1/users/{userID}
    +
    /users/{userID}

    Usage and SDK Samples

    @@ -6753,7 +14228,7 @@ Subscriber ID
    curl -X GET \
     -H "Authorization: [[apiKey]]" \
      -H "Accept: application/json" \
    - "http://localhost/api/v1/api/v1/users/{userID}"
    + "http://localhost/api/v2/users/{userID}"
     
    @@ -7161,955 +14636,135 @@ User ID

    -
    -
    +
    +
    -

    getWorkspace

    +

    insertBoardsAndBlocks

    -

    Returns information of the root workspace

    +

    Creates new boards and blocks


    -
    /api/v1/workspaces/{workspaceID}
    +
    /boards-and-blocks

    Usage and SDK Samples

    -
    -
    curl -X GET \
    --H "Authorization: [[apiKey]]" \
    - -H "Accept: application/json" \
    - "http://localhost/api/v1/api/v1/workspaces/{workspaceID}"
    -
    -
    -
    -
    import org.openapitools.client.*;
    -import org.openapitools.client.auth.*;
    -import org.openapitools.client.model.*;
    -import org.openapitools.client.api.DefaultApi;
    -
    -import java.io.File;
    -import java.util.*;
    -
    -public class DefaultApiExample {
    -    public static void main(String[] args) {
    -        ApiClient defaultClient = Configuration.getDefaultApiClient();
    -        
    -        // Configure API key authorization: BearerAuth
    -        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    -        BearerAuth.setApiKey("YOUR API KEY");
    -        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    -        //BearerAuth.setApiKeyPrefix("Token");
    -
    -        // Create an instance of the API class
    -        DefaultApi apiInstance = new DefaultApi();
    -        String workspaceID = workspaceID_example; // String | Workspace ID
    -
    -        try {
    -            Workspace result = apiInstance.getWorkspace(workspaceID);
    -            System.out.println(result);
    -        } catch (ApiException e) {
    -            System.err.println("Exception when calling DefaultApi#getWorkspace");
    -            e.printStackTrace();
    -        }
    -    }
    -}
    -
    -
    - -
    -
    import org.openapitools.client.api.DefaultApi;
    -
    -public class DefaultApiExample {
    -    public static void main(String[] args) {
    -        DefaultApi apiInstance = new DefaultApi();
    -        String workspaceID = workspaceID_example; // String | Workspace ID
    -
    -        try {
    -            Workspace result = apiInstance.getWorkspace(workspaceID);
    -            System.out.println(result);
    -        } catch (ApiException e) {
    -            System.err.println("Exception when calling DefaultApi#getWorkspace");
    -            e.printStackTrace();
    -        }
    -    }
    -}
    -
    - -
    -
    Configuration *apiConfig = [Configuration sharedConfig];
    -
    -// Configure API key authorization: (authentication scheme: BearerAuth)
    -[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    -// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    -//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    -
    -
    -// Create an instance of the API class
    -DefaultApi *apiInstance = [[DefaultApi alloc] init];
    -String *workspaceID = workspaceID_example; // Workspace ID (default to null)
    -
    -[apiInstance getWorkspaceWith:workspaceID
    -              completionHandler: ^(Workspace output, NSError* error) {
    -    if (output) {
    -        NSLog(@"%@", output);
    -    }
    -    if (error) {
    -        NSLog(@"Error: %@", error);
    -    }
    -}];
    -
    -
    - -
    -
    var FocalboardServer = require('focalboard_server');
    -var defaultClient = FocalboardServer.ApiClient.instance;
    -
    -// Configure API key authorization: BearerAuth
    -var BearerAuth = defaultClient.authentications['BearerAuth'];
    -BearerAuth.apiKey = "YOUR API KEY";
    -// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    -//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    -
    -// Create an instance of the API class
    -var api = new FocalboardServer.DefaultApi()
    -var workspaceID = workspaceID_example; // {String} Workspace ID
    -
    -var callback = function(error, data, response) {
    -  if (error) {
    -    console.error(error);
    -  } else {
    -    console.log('API called successfully. Returned data: ' + data);
    -  }
    -};
    -api.getWorkspace(workspaceID, callback);
    -
    -
    - - -
    -
    using System;
    -using System.Diagnostics;
    -using Org.OpenAPITools.Api;
    -using Org.OpenAPITools.Client;
    -using Org.OpenAPITools.Model;
    -
    -namespace Example
    -{
    -    public class getWorkspaceExample
    -    {
    -        public void main()
    -        {
    -            // Configure API key authorization: BearerAuth
    -            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    -            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    -            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    -
    -            // Create an instance of the API class
    -            var apiInstance = new DefaultApi();
    -            var workspaceID = workspaceID_example;  // String | Workspace ID (default to null)
    -
    -            try {
    -                Workspace result = apiInstance.getWorkspace(workspaceID);
    -                Debug.WriteLine(result);
    -            } catch (Exception e) {
    -                Debug.Print("Exception when calling DefaultApi.getWorkspace: " + e.Message );
    -            }
    -        }
    -    }
    -}
    -
    -
    - -
    -
    <?php
    -require_once(__DIR__ . '/vendor/autoload.php');
    -
    -// Configure API key authorization: BearerAuth
    -OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    -// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    -// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    -
    -// Create an instance of the API class
    -$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    -$workspaceID = workspaceID_example; // String | Workspace ID
    -
    -try {
    -    $result = $api_instance->getWorkspace($workspaceID);
    -    print_r($result);
    -} catch (Exception $e) {
    -    echo 'Exception when calling DefaultApi->getWorkspace: ', $e->getMessage(), PHP_EOL;
    -}
    -?>
    -
    - -
    -
    use Data::Dumper;
    -use WWW::OPenAPIClient::Configuration;
    -use WWW::OPenAPIClient::DefaultApi;
    -
    -# Configure API key authorization: BearerAuth
    -$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    -# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    -#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    -
    -# Create an instance of the API class
    -my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    -my $workspaceID = workspaceID_example; # String | Workspace ID
    -
    -eval {
    -    my $result = $api_instance->getWorkspace(workspaceID => $workspaceID);
    -    print Dumper($result);
    -};
    -if ($@) {
    -    warn "Exception when calling DefaultApi->getWorkspace: $@\n";
    -}
    -
    - -
    -
    from __future__ import print_statement
    -import time
    -import openapi_client
    -from openapi_client.rest import ApiException
    -from pprint import pprint
    -
    -# Configure API key authorization: BearerAuth
    -openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    -# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    -
    -# Create an instance of the API class
    -api_instance = openapi_client.DefaultApi()
    -workspaceID = workspaceID_example # String | Workspace ID (default to null)
    -
    -try:
    -    api_response = api_instance.get_workspace(workspaceID)
    -    pprint(api_response)
    -except ApiException as e:
    -    print("Exception when calling DefaultApi->getWorkspace: %s\n" % e)
    -
    - -
    -
    extern crate DefaultApi;
    -
    -pub fn main() {
    -    let workspaceID = workspaceID_example; // String
    -
    -    let mut context = DefaultApi::Context::default();
    -    let result = client.getWorkspace(workspaceID, &context).wait();
    -
    -    println!("{:?}", result);
    -}
    -
    -
    -
    - -

    Scopes

    - - -
    - -

    Parameters

    - -
    Path parameters
    - - - - - - - - - -
    NameDescription
    workspaceID* - - -
    -
    -
    - - String - - -
    -Workspace ID -
    -
    -
    - Required -
    -
    -
    -
    - - - - - -

    Responses

    -

    -

    - - - - - - -
    -
    -
    - -
    - -
    -
    -

    -

    - - - - - - -
    -
    -
    - -
    - -
    -
    -
    -
    -
    -
    -
    -
    -

    getWorkspaceUsers

    -

    -
    -
    -
    -

    -

    Returns workspace users

    -

    -
    -
    /api/v1/workspaces/{workspaceID}/users
    -

    -

    Usage and SDK Samples

    -

    - - -
    -
    -
    curl -X GET \
    --H "Authorization: [[apiKey]]" \
    - -H "Accept: application/json" \
    - "http://localhost/api/v1/api/v1/workspaces/{workspaceID}/users"
    -
    -
    -
    -
    import org.openapitools.client.*;
    -import org.openapitools.client.auth.*;
    -import org.openapitools.client.model.*;
    -import org.openapitools.client.api.DefaultApi;
    -
    -import java.io.File;
    -import java.util.*;
    -
    -public class DefaultApiExample {
    -    public static void main(String[] args) {
    -        ApiClient defaultClient = Configuration.getDefaultApiClient();
    -        
    -        // Configure API key authorization: BearerAuth
    -        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    -        BearerAuth.setApiKey("YOUR API KEY");
    -        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    -        //BearerAuth.setApiKeyPrefix("Token");
    -
    -        // Create an instance of the API class
    -        DefaultApi apiInstance = new DefaultApi();
    -        String workspaceID = workspaceID_example; // String | Workspace ID
    -
    -        try {
    -            array[User] result = apiInstance.getWorkspaceUsers(workspaceID);
    -            System.out.println(result);
    -        } catch (ApiException e) {
    -            System.err.println("Exception when calling DefaultApi#getWorkspaceUsers");
    -            e.printStackTrace();
    -        }
    -    }
    -}
    -
    -
    - -
    -
    import org.openapitools.client.api.DefaultApi;
    -
    -public class DefaultApiExample {
    -    public static void main(String[] args) {
    -        DefaultApi apiInstance = new DefaultApi();
    -        String workspaceID = workspaceID_example; // String | Workspace ID
    -
    -        try {
    -            array[User] result = apiInstance.getWorkspaceUsers(workspaceID);
    -            System.out.println(result);
    -        } catch (ApiException e) {
    -            System.err.println("Exception when calling DefaultApi#getWorkspaceUsers");
    -            e.printStackTrace();
    -        }
    -    }
    -}
    -
    - -
    -
    Configuration *apiConfig = [Configuration sharedConfig];
    -
    -// Configure API key authorization: (authentication scheme: BearerAuth)
    -[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    -// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    -//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    -
    -
    -// Create an instance of the API class
    -DefaultApi *apiInstance = [[DefaultApi alloc] init];
    -String *workspaceID = workspaceID_example; // Workspace ID (default to null)
    -
    -[apiInstance getWorkspaceUsersWith:workspaceID
    -              completionHandler: ^(array[User] output, NSError* error) {
    -    if (output) {
    -        NSLog(@"%@", output);
    -    }
    -    if (error) {
    -        NSLog(@"Error: %@", error);
    -    }
    -}];
    -
    -
    - -
    -
    var FocalboardServer = require('focalboard_server');
    -var defaultClient = FocalboardServer.ApiClient.instance;
    -
    -// Configure API key authorization: BearerAuth
    -var BearerAuth = defaultClient.authentications['BearerAuth'];
    -BearerAuth.apiKey = "YOUR API KEY";
    -// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    -//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    -
    -// Create an instance of the API class
    -var api = new FocalboardServer.DefaultApi()
    -var workspaceID = workspaceID_example; // {String} Workspace ID
    -
    -var callback = function(error, data, response) {
    -  if (error) {
    -    console.error(error);
    -  } else {
    -    console.log('API called successfully. Returned data: ' + data);
    -  }
    -};
    -api.getWorkspaceUsers(workspaceID, callback);
    -
    -
    - - -
    -
    using System;
    -using System.Diagnostics;
    -using Org.OpenAPITools.Api;
    -using Org.OpenAPITools.Client;
    -using Org.OpenAPITools.Model;
    -
    -namespace Example
    -{
    -    public class getWorkspaceUsersExample
    -    {
    -        public void main()
    -        {
    -            // Configure API key authorization: BearerAuth
    -            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    -            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    -            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    -
    -            // Create an instance of the API class
    -            var apiInstance = new DefaultApi();
    -            var workspaceID = workspaceID_example;  // String | Workspace ID (default to null)
    -
    -            try {
    -                array[User] result = apiInstance.getWorkspaceUsers(workspaceID);
    -                Debug.WriteLine(result);
    -            } catch (Exception e) {
    -                Debug.Print("Exception when calling DefaultApi.getWorkspaceUsers: " + e.Message );
    -            }
    -        }
    -    }
    -}
    -
    -
    - -
    -
    <?php
    -require_once(__DIR__ . '/vendor/autoload.php');
    -
    -// Configure API key authorization: BearerAuth
    -OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    -// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    -// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    -
    -// Create an instance of the API class
    -$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    -$workspaceID = workspaceID_example; // String | Workspace ID
    -
    -try {
    -    $result = $api_instance->getWorkspaceUsers($workspaceID);
    -    print_r($result);
    -} catch (Exception $e) {
    -    echo 'Exception when calling DefaultApi->getWorkspaceUsers: ', $e->getMessage(), PHP_EOL;
    -}
    -?>
    -
    - -
    -
    use Data::Dumper;
    -use WWW::OPenAPIClient::Configuration;
    -use WWW::OPenAPIClient::DefaultApi;
    -
    -# Configure API key authorization: BearerAuth
    -$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    -# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    -#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    -
    -# Create an instance of the API class
    -my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    -my $workspaceID = workspaceID_example; # String | Workspace ID
    -
    -eval {
    -    my $result = $api_instance->getWorkspaceUsers(workspaceID => $workspaceID);
    -    print Dumper($result);
    -};
    -if ($@) {
    -    warn "Exception when calling DefaultApi->getWorkspaceUsers: $@\n";
    -}
    -
    - -
    -
    from __future__ import print_statement
    -import time
    -import openapi_client
    -from openapi_client.rest import ApiException
    -from pprint import pprint
    -
    -# Configure API key authorization: BearerAuth
    -openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    -# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    -
    -# Create an instance of the API class
    -api_instance = openapi_client.DefaultApi()
    -workspaceID = workspaceID_example # String | Workspace ID (default to null)
    -
    -try:
    -    api_response = api_instance.get_workspace_users(workspaceID)
    -    pprint(api_response)
    -except ApiException as e:
    -    print("Exception when calling DefaultApi->getWorkspaceUsers: %s\n" % e)
    -
    - -
    -
    extern crate DefaultApi;
    -
    -pub fn main() {
    -    let workspaceID = workspaceID_example; // String
    -
    -    let mut context = DefaultApi::Context::default();
    -    let result = client.getWorkspaceUsers(workspaceID, &context).wait();
    -
    -    println!("{:?}", result);
    -}
    -
    -
    -
    - -

    Scopes

    - - -
    - -

    Parameters

    - -
    Path parameters
    - - - - - - - - - -
    NameDescription
    workspaceID* - - -
    -
    -
    - - String - - -
    -Workspace ID -
    -
    -
    - Required -
    -
    -
    -
    - - - - - -

    Responses

    -

    -

    - - - - - - -
    -
    -
    - -
    - -
    -
    -

    -

    - - - - - - -
    -
    -
    - -
    - -
    -
    -
    -
    -
    -
    -
    -
    -

    importBlocks

    -

    -
    -
    -
    -

    -

    Import blocks

    -

    -
    -
    /api/v1/workspaces/{workspaceID}/blocks/import
    -

    -

    Usage and SDK Samples

    -

    - - -
    -
    +
    curl -X POST \
     -H "Authorization: [[apiKey]]" \
      -H "Accept: application/json" \
      -H "Content-Type: application/json" \
    - "http://localhost/api/v1/api/v1/workspaces/{workspaceID}/blocks/import" \
    + "http://localhost/api/v2/boards-and-blocks" \
      -d '{
    -  "schema" : 1,
    -  "deleteAt" : 6,
    -  "rootId" : "rootId",
    -  "updateAt" : 5,
    -  "title" : "title",
    -  "type" : "type",
    -  "createAt" : 0,
    -  "parentId" : "parentId",
    -  "createdBy" : "createdBy",
    -  "modifiedBy" : "modifiedBy",
    -  "id" : "id",
    -  "fields" : {
    -    "key" : "{}"
    -  },
    -  "workspaceId" : "workspaceId"
    +  "blocks" : [ {
    +    "schema" : 1,
    +    "createdBy" : "createdBy",
    +    "deleteAt" : 6,
    +    "boardId" : "boardId",
    +    "updateAt" : 5,
    +    "modifiedBy" : "modifiedBy",
    +    "id" : "id",
    +    "fields" : {
    +      "key" : "{}"
    +    },
    +    "title" : "title",
    +    "type" : "type",
    +    "createAt" : 0,
    +    "parentId" : "parentId"
    +  }, {
    +    "schema" : 1,
    +    "createdBy" : "createdBy",
    +    "deleteAt" : 6,
    +    "boardId" : "boardId",
    +    "updateAt" : 5,
    +    "modifiedBy" : "modifiedBy",
    +    "id" : "id",
    +    "fields" : {
    +      "key" : "{}"
    +    },
    +    "title" : "title",
    +    "type" : "type",
    +    "createAt" : 0,
    +    "parentId" : "parentId"
    +  } ],
    +  "boards" : [ {
    +    "deleteAt" : 6,
    +    "icon" : "icon",
    +    "description" : "description",
    +    "updateAt" : 5,
    +    "title" : "title",
    +    "type" : "type",
    +    "createAt" : 0,
    +    "showDescription" : true,
    +    "createdBy" : "createdBy",
    +    "isTemplate" : true,
    +    "teamId" : "teamId",
    +    "cardProperties" : [ {
    +      "key" : "{}"
    +    }, {
    +      "key" : "{}"
    +    } ],
    +    "modifiedBy" : "modifiedBy",
    +    "templateVersion" : 1,
    +    "columnCalculations" : {
    +      "key" : "{}"
    +    },
    +    "id" : "id",
    +    "channelId" : "channelId",
    +    "properties" : {
    +      "key" : "{}"
    +    }
    +  }, {
    +    "deleteAt" : 6,
    +    "icon" : "icon",
    +    "description" : "description",
    +    "updateAt" : 5,
    +    "title" : "title",
    +    "type" : "type",
    +    "createAt" : 0,
    +    "showDescription" : true,
    +    "createdBy" : "createdBy",
    +    "isTemplate" : true,
    +    "teamId" : "teamId",
    +    "cardProperties" : [ {
    +      "key" : "{}"
    +    }, {
    +      "key" : "{}"
    +    } ],
    +    "modifiedBy" : "modifiedBy",
    +    "templateVersion" : 1,
    +    "columnCalculations" : {
    +      "key" : "{}"
    +    },
    +    "id" : "id",
    +    "channelId" : "channelId",
    +    "properties" : {
    +      "key" : "{}"
    +    }
    +  } ]
     }'
     
    -
    +
    import org.openapitools.client.*;
     import org.openapitools.client.auth.*;
     import org.openapitools.client.model.*;
    @@ -8130,13 +14785,13 @@ public class DefaultApiExample {
     
             // Create an instance of the API class
             DefaultApi apiInstance = new DefaultApi();
    -        String workspaceID = workspaceID_example; // String | Workspace ID
    -        array[Block] body = ; // array[Block] | 
    +        BoardsAndBlocks body = ; // BoardsAndBlocks | 
     
             try {
    -            apiInstance.importBlocks(workspaceID, body);
    +            BoardsAndBlocks result = apiInstance.insertBoardsAndBlocks(body);
    +            System.out.println(result);
             } catch (ApiException e) {
    -            System.err.println("Exception when calling DefaultApi#importBlocks");
    +            System.err.println("Exception when calling DefaultApi#insertBoardsAndBlocks");
                 e.printStackTrace();
             }
         }
    @@ -8144,29 +14799,29 @@ public class DefaultApiExample {
     
    -
    +
    import org.openapitools.client.api.DefaultApi;
     
     public class DefaultApiExample {
         public static void main(String[] args) {
             DefaultApi apiInstance = new DefaultApi();
    -        String workspaceID = workspaceID_example; // String | Workspace ID
    -        array[Block] body = ; // array[Block] | 
    +        BoardsAndBlocks body = ; // BoardsAndBlocks | 
     
             try {
    -            apiInstance.importBlocks(workspaceID, body);
    +            BoardsAndBlocks result = apiInstance.insertBoardsAndBlocks(body);
    +            System.out.println(result);
             } catch (ApiException e) {
    -            System.err.println("Exception when calling DefaultApi#importBlocks");
    +            System.err.println("Exception when calling DefaultApi#insertBoardsAndBlocks");
                 e.printStackTrace();
             }
         }
     }
    -
    +
    Configuration *apiConfig = [Configuration sharedConfig];
     
     // Configure API key authorization: (authentication scheme: BearerAuth)
    @@ -8177,12 +14832,13 @@ public class DefaultApiExample {
     
     // Create an instance of the API class
     DefaultApi *apiInstance = [[DefaultApi alloc] init];
    -String *workspaceID = workspaceID_example; // Workspace ID (default to null)
    -array[Block] *body = ; // 
    +BoardsAndBlocks *body = ; // 
     
    -[apiInstance importBlocksWith:workspaceID
    -    body:body
    -              completionHandler: ^(NSError* error) {
    +[apiInstance insertBoardsAndBlocksWith:body
    +              completionHandler: ^(BoardsAndBlocks output, NSError* error) {
    +    if (output) {
    +        NSLog(@"%@", output);
    +    }
         if (error) {
             NSLog(@"Error: %@", error);
         }
    @@ -8190,7 +14846,7 @@ array[Block] *body = ; //
     
    -
    +
    var FocalboardServer = require('focalboard_server');
     var defaultClient = FocalboardServer.ApiClient.instance;
     
    @@ -8202,24 +14858,23 @@ BearerAuth.apiKey = "YOUR API KEY";
     
     // Create an instance of the API class
     var api = new FocalboardServer.DefaultApi()
    -var workspaceID = workspaceID_example; // {String} Workspace ID
    -var body = ; // {array[Block]} 
    +var body = ; // {BoardsAndBlocks} 
     
     var callback = function(error, data, response) {
       if (error) {
         console.error(error);
       } else {
    -    console.log('API called successfully.');
    +    console.log('API called successfully. Returned data: ' + data);
       }
     };
    -api.importBlocks(workspaceID, body, callback);
    +api.insertBoardsAndBlocks(body, callback);
     
    - -
    +
    using System;
     using System.Diagnostics;
     using Org.OpenAPITools.Api;
    @@ -8228,7 +14883,7 @@ using Org.OpenAPITools.Model;
     
     namespace Example
     {
    -    public class importBlocksExample
    +    public class insertBoardsAndBlocksExample
         {
             public void main()
             {
    @@ -8239,13 +14894,13 @@ namespace Example
     
                 // Create an instance of the API class
                 var apiInstance = new DefaultApi();
    -            var workspaceID = workspaceID_example;  // String | Workspace ID (default to null)
    -            var body = new array[Block](); // array[Block] | 
    +            var body = new BoardsAndBlocks(); // BoardsAndBlocks | 
     
                 try {
    -                apiInstance.importBlocks(workspaceID, body);
    +                BoardsAndBlocks result = apiInstance.insertBoardsAndBlocks(body);
    +                Debug.WriteLine(result);
                 } catch (Exception e) {
    -                Debug.Print("Exception when calling DefaultApi.importBlocks: " + e.Message );
    +                Debug.Print("Exception when calling DefaultApi.insertBoardsAndBlocks: " + e.Message );
                 }
             }
         }
    @@ -8253,7 +14908,7 @@ namespace Example
     
    -
    +
    <?php
     require_once(__DIR__ . '/vendor/autoload.php');
     
    @@ -8264,18 +14919,18 @@ OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authori
     
     // Create an instance of the API class
     $api_instance = new OpenAPITools\Client\Api\DefaultApi();
    -$workspaceID = workspaceID_example; // String | Workspace ID
    -$body = ; // array[Block] | 
    +$body = ; // BoardsAndBlocks | 
     
     try {
    -    $api_instance->importBlocks($workspaceID, $body);
    +    $result = $api_instance->insertBoardsAndBlocks($body);
    +    print_r($result);
     } catch (Exception $e) {
    -    echo 'Exception when calling DefaultApi->importBlocks: ', $e->getMessage(), PHP_EOL;
    +    echo 'Exception when calling DefaultApi->insertBoardsAndBlocks: ', $e->getMessage(), PHP_EOL;
     }
     ?>
    -
    +
    use Data::Dumper;
     use WWW::OPenAPIClient::Configuration;
     use WWW::OPenAPIClient::DefaultApi;
    @@ -8287,18 +14942,18 @@ $WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
     
     # Create an instance of the API class
     my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    -my $workspaceID = workspaceID_example; # String | Workspace ID
    -my $body = [WWW::OPenAPIClient::Object::array[Block]->new()]; # array[Block] | 
    +my $body = WWW::OPenAPIClient::Object::BoardsAndBlocks->new(); # BoardsAndBlocks | 
     
     eval {
    -    $api_instance->importBlocks(workspaceID => $workspaceID, body => $body);
    +    my $result = $api_instance->insertBoardsAndBlocks(body => $body);
    +    print Dumper($result);
     };
     if ($@) {
    -    warn "Exception when calling DefaultApi->importBlocks: $@\n";
    +    warn "Exception when calling DefaultApi->insertBoardsAndBlocks: $@\n";
     }
    -
    +
    from __future__ import print_statement
     import time
     import openapi_client
    @@ -8312,24 +14967,23 @@ openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
     
     # Create an instance of the API class
     api_instance = openapi_client.DefaultApi()
    -workspaceID = workspaceID_example # String | Workspace ID (default to null)
    -body =  # array[Block] | 
    +body =  # BoardsAndBlocks | 
     
     try:
    -    api_instance.import_blocks(workspaceID, body)
    +    api_response = api_instance.insert_boards_and_blocks(body)
    +    pprint(api_response)
     except ApiException as e:
    -    print("Exception when calling DefaultApi->importBlocks: %s\n" % e)
    + print("Exception when calling DefaultApi->insertBoardsAndBlocks: %s\n" % e)
    -
    +
    extern crate DefaultApi;
     
     pub fn main() {
    -    let workspaceID = workspaceID_example; // String
    -    let body = ; // array[Block]
    +    let body = ; // BoardsAndBlocks
     
         let mut context = DefaultApi::Context::default();
    -    let result = client.importBlocks(workspaceID, body, &context).wait();
    +    let result = client.insertBoardsAndBlocks(body, &context).wait();
     
         println!("{:?}", result);
     }
    @@ -8344,36 +14998,6 @@ pub fn main() {
     
                               

    Parameters

    -
    Path parameters
    - - - - - - - - - -
    NameDescription
    workspaceID* - - -
    -
    -
    - - String - - -
    -Workspace ID -
    -
    -
    - Required -
    -
    -
    -
    Body parameters
    @@ -8384,18 +15008,15 @@ Workspace ID body * -

    array of blocks to import

    +

    the boards and blocks to create

    -
    +
    @@ -8430,45 +15051,23 @@ $(document).ready(function() {

    Responses

    -

    -

    +

    +

    - - - -
    -
    -

    -

    - - - -
    @@ -9552,12 +17587,12 @@ namespace Example // Create an instance of the API class var apiInstance = new DefaultApi(); - var workspaceID = workspaceID_example; // String | Workspace ID (default to null) + var boardID = boardID_example; // String | Board ID (default to null) var blockID = blockID_example; // String | ID of block to patch (default to null) var body = new BlockPatch(); // BlockPatch | try { - apiInstance.patchBlock(workspaceID, blockID, body); + apiInstance.patchBlock(boardID, blockID, body); } catch (Exception e) { Debug.Print("Exception when calling DefaultApi.patchBlock: " + e.Message ); } @@ -9578,12 +17613,12 @@ OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authori // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\DefaultApi(); -$workspaceID = workspaceID_example; // String | Workspace ID +$boardID = boardID_example; // String | Board ID $blockID = blockID_example; // String | ID of block to patch $body = ; // BlockPatch | try { - $api_instance->patchBlock($workspaceID, $blockID, $body); + $api_instance->patchBlock($boardID, $blockID, $body); } catch (Exception $e) { echo 'Exception when calling DefaultApi->patchBlock: ', $e->getMessage(), PHP_EOL; } @@ -9602,12 +17637,12 @@ $WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY'; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::DefaultApi->new(); -my $workspaceID = workspaceID_example; # String | Workspace ID +my $boardID = boardID_example; # String | Board ID my $blockID = blockID_example; # String | ID of block to patch my $body = WWW::OPenAPIClient::Object::BlockPatch->new(); # BlockPatch | eval { - $api_instance->patchBlock(workspaceID => $workspaceID, blockID => $blockID, body => $body); + $api_instance->patchBlock(boardID => $boardID, blockID => $blockID, body => $body); }; if ($@) { warn "Exception when calling DefaultApi->patchBlock: $@\n"; @@ -9628,12 +17663,12 @@ openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Create an instance of the API class api_instance = openapi_client.DefaultApi() -workspaceID = workspaceID_example # String | Workspace ID (default to null) +boardID = boardID_example # String | Board ID (default to null) blockID = blockID_example # String | ID of block to patch (default to null) body = # BlockPatch | try: - api_instance.patch_block(workspaceID, blockID, body) + api_instance.patch_block(boardID, blockID, body) except ApiException as e: print("Exception when calling DefaultApi->patchBlock: %s\n" % e)
    @@ -9642,12 +17677,12 @@ except ApiException as e:
    extern crate DefaultApi;
     
     pub fn main() {
    -    let workspaceID = workspaceID_example; // String
    +    let boardID = boardID_example; // String
         let blockID = blockID_example; // String
         let body = ; // BlockPatch
     
         let mut context = DefaultApi::Context::default();
    -    let result = client.patchBlock(workspaceID, blockID, body, &context).wait();
    +    let result = client.patchBlock(boardID, blockID, body, &context).wait();
     
         println!("{:?}", result);
     }
    @@ -9668,11 +17703,11 @@ pub fn main() {
                                       Name
                                       Description
                                     
    -                                  workspaceID*
    +                                  boardID*
     
     
     
    -    
    +
    @@ -9680,7 +17715,7 @@ pub fn main() {
    -Workspace ID +Board ID
    @@ -9790,6 +17825,28 @@ $(document).ready(function() {
    +

    +

    + + + + + + +
    +

    +
    + + + + + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +

    +

    + + + + + + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    +
    +
    +

    patchBoardsAndBlocks

    +

    +
    +
    +
    +

    +

    Patches a set of related boards and blocks

    +

    +
    +
    /boards-and-blocks
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X PATCH \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + -H "Content-Type: application/json" \
    + "http://localhost/api/v2/boards-and-blocks" \
    + -d '{
    +  "boardIDs" : [ "boardIDs", "boardIDs" ],
    +  "boardPatches" : [ {
    +    "showDescription" : true,
    +    "updatedProperties" : {
    +      "key" : "{}"
    +    },
    +    "deletedColumnCalculations" : [ "deletedColumnCalculations", "deletedColumnCalculations" ],
    +    "icon" : "icon",
    +    "updatedColumnCalculations" : {
    +      "key" : "{}"
    +    },
    +    "deletedCardProperties" : [ "deletedCardProperties", "deletedCardProperties" ],
    +    "description" : "description",
    +    "updatedCardProperties" : [ {
    +      "key" : "{}"
    +    }, {
    +      "key" : "{}"
    +    } ],
    +    "title" : "title",
    +    "type" : "type",
    +    "deletedProperties" : [ "deletedProperties", "deletedProperties" ]
    +  }, {
    +    "showDescription" : true,
    +    "updatedProperties" : {
    +      "key" : "{}"
    +    },
    +    "deletedColumnCalculations" : [ "deletedColumnCalculations", "deletedColumnCalculations" ],
    +    "icon" : "icon",
    +    "updatedColumnCalculations" : {
    +      "key" : "{}"
    +    },
    +    "deletedCardProperties" : [ "deletedCardProperties", "deletedCardProperties" ],
    +    "description" : "description",
    +    "updatedCardProperties" : [ {
    +      "key" : "{}"
    +    }, {
    +      "key" : "{}"
    +    } ],
    +    "title" : "title",
    +    "type" : "type",
    +    "deletedProperties" : [ "deletedProperties", "deletedProperties" ]
    +  } ],
    +  "blockIDs" : [ "blockIDs", "blockIDs" ],
    +  "blockPatches" : [ {
    +    "schema" : 0,
    +    "updatedFields" : {
    +      "key" : "{}"
    +    },
    +    "boardId" : "boardId",
    +    "title" : "title",
    +    "type" : "type",
    +    "deletedFields" : [ "deletedFields", "deletedFields" ],
    +    "parentId" : "parentId"
    +  }, {
    +    "schema" : 0,
    +    "updatedFields" : {
    +      "key" : "{}"
    +    },
    +    "boardId" : "boardId",
    +    "title" : "title",
    +    "type" : "type",
    +    "deletedFields" : [ "deletedFields", "deletedFields" ],
    +    "parentId" : "parentId"
    +  } ]
    +}'
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        PatchBoardsAndBlocks body = ; // PatchBoardsAndBlocks | 
    +
    +        try {
    +            BoardsAndBlocks result = apiInstance.patchBoardsAndBlocks(body);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#patchBoardsAndBlocks");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        PatchBoardsAndBlocks body = ; // PatchBoardsAndBlocks | 
    +
    +        try {
    +            BoardsAndBlocks result = apiInstance.patchBoardsAndBlocks(body);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#patchBoardsAndBlocks");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +PatchBoardsAndBlocks *body = ; // 
    +
    +[apiInstance patchBoardsAndBlocksWith:body
    +              completionHandler: ^(BoardsAndBlocks output, NSError* error) {
    +    if (output) {
    +        NSLog(@"%@", output);
    +    }
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var body = ; // {PatchBoardsAndBlocks} 
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully. Returned data: ' + data);
    +  }
    +};
    +api.patchBoardsAndBlocks(body, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class patchBoardsAndBlocksExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var body = new PatchBoardsAndBlocks(); // PatchBoardsAndBlocks | 
    +
    +            try {
    +                BoardsAndBlocks result = apiInstance.patchBoardsAndBlocks(body);
    +                Debug.WriteLine(result);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.patchBoardsAndBlocks: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$body = ; // PatchBoardsAndBlocks | 
    +
    +try {
    +    $result = $api_instance->patchBoardsAndBlocks($body);
    +    print_r($result);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->patchBoardsAndBlocks: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $body = WWW::OPenAPIClient::Object::PatchBoardsAndBlocks->new(); # PatchBoardsAndBlocks | 
    +
    +eval {
    +    my $result = $api_instance->patchBoardsAndBlocks(body => $body);
    +    print Dumper($result);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->patchBoardsAndBlocks: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +body =  # PatchBoardsAndBlocks | 
    +
    +try:
    +    api_response = api_instance.patch_boards_and_blocks(body)
    +    pprint(api_response)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->patchBoardsAndBlocks: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let body = ; // PatchBoardsAndBlocks
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.patchBoardsAndBlocks(body, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + + + +
    Body parameters
    + + + + + + + + + +
    NameDescription
    body * +

    the patches for the boards and blocks

    + +
    +
    + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    @@ -10341,10 +19471,10 @@ $(document).ready(function() {

    -

    Sets sharing information for a root block

    +

    Sets sharing information for a board


    -
    /api/v1/workspaces/{workspaceID}/sharing/{rootID}
    +
    /boards/{boardID}/sharing

    Usage and SDK Samples

    @@ -10369,7 +19499,7 @@ $(document).ready(function() { -H "Authorization: [[apiKey]]" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ - "http://localhost/api/v1/api/v1/workspaces/{workspaceID}/sharing/{rootID}" \ + "http://localhost/api/v2/boards/{boardID}/sharing" \ -d '{ "update_at" : 0, "modifiedBy" : "modifiedBy", @@ -10400,12 +19530,11 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID - String rootID = rootID_example; // String | ID of the root block + String boardID = boardID_example; // String | Board ID Sharing body = ; // Sharing | try { - apiInstance.postSharing(workspaceID, rootID, body); + apiInstance.postSharing(boardID, body); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#postSharing"); e.printStackTrace(); @@ -10421,12 +19550,11 @@ public class DefaultApiExample { public class DefaultApiExample { public static void main(String[] args) { DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID - String rootID = rootID_example; // String | ID of the root block + String boardID = boardID_example; // String | Board ID Sharing body = ; // Sharing | try { - apiInstance.postSharing(workspaceID, rootID, body); + apiInstance.postSharing(boardID, body); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#postSharing"); e.printStackTrace(); @@ -10449,12 +19577,10 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi *apiInstance = [[DefaultApi alloc] init]; -String *workspaceID = workspaceID_example; // Workspace ID (default to null) -String *rootID = rootID_example; // ID of the root block (default to null) +String *boardID = boardID_example; // Board ID (default to null) Sharing *body = ; // -[apiInstance postSharingWith:workspaceID - rootID:rootID +[apiInstance postSharingWith:boardID body:body completionHandler: ^(NSError* error) { if (error) { @@ -10476,8 +19602,7 @@ BearerAuth.apiKey = "YOUR API KEY"; // Create an instance of the API class var api = new FocalboardServer.DefaultApi() -var workspaceID = workspaceID_example; // {String} Workspace ID -var rootID = rootID_example; // {String} ID of the root block +var boardID = boardID_example; // {String} Board ID var body = ; // {Sharing} var callback = function(error, data, response) { @@ -10487,7 +19612,7 @@ var callback = function(error, data, response) { console.log('API called successfully.'); } }; -api.postSharing(workspaceID, rootID, body, callback); +api.postSharing(boardID, body, callback);
    @@ -10514,12 +19639,11 @@ namespace Example // Create an instance of the API class var apiInstance = new DefaultApi(); - var workspaceID = workspaceID_example; // String | Workspace ID (default to null) - var rootID = rootID_example; // String | ID of the root block (default to null) + var boardID = boardID_example; // String | Board ID (default to null) var body = new Sharing(); // Sharing | try { - apiInstance.postSharing(workspaceID, rootID, body); + apiInstance.postSharing(boardID, body); } catch (Exception e) { Debug.Print("Exception when calling DefaultApi.postSharing: " + e.Message ); } @@ -10540,12 +19664,11 @@ OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authori // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\DefaultApi(); -$workspaceID = workspaceID_example; // String | Workspace ID -$rootID = rootID_example; // String | ID of the root block +$boardID = boardID_example; // String | Board ID $body = ; // Sharing | try { - $api_instance->postSharing($workspaceID, $rootID, $body); + $api_instance->postSharing($boardID, $body); } catch (Exception $e) { echo 'Exception when calling DefaultApi->postSharing: ', $e->getMessage(), PHP_EOL; } @@ -10564,12 +19687,11 @@ $WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY'; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::DefaultApi->new(); -my $workspaceID = workspaceID_example; # String | Workspace ID -my $rootID = rootID_example; # String | ID of the root block +my $boardID = boardID_example; # String | Board ID my $body = WWW::OPenAPIClient::Object::Sharing->new(); # Sharing | eval { - $api_instance->postSharing(workspaceID => $workspaceID, rootID => $rootID, body => $body); + $api_instance->postSharing(boardID => $boardID, body => $body); }; if ($@) { warn "Exception when calling DefaultApi->postSharing: $@\n"; @@ -10590,12 +19712,11 @@ openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Create an instance of the API class api_instance = openapi_client.DefaultApi() -workspaceID = workspaceID_example # String | Workspace ID (default to null) -rootID = rootID_example # String | ID of the root block (default to null) +boardID = boardID_example # String | Board ID (default to null) body = # Sharing | try: - api_instance.post_sharing(workspaceID, rootID, body) + api_instance.post_sharing(boardID, body) except ApiException as e: print("Exception when calling DefaultApi->postSharing: %s\n" % e)
    @@ -10604,12 +19725,11 @@ except ApiException as e:
    extern crate DefaultApi;
     
     pub fn main() {
    -    let workspaceID = workspaceID_example; // String
    -    let rootID = rootID_example; // String
    +    let boardID = boardID_example; // String
         let body = ; // Sharing
     
         let mut context = DefaultApi::Context::default();
    -    let result = client.postSharing(workspaceID, rootID, body, &context).wait();
    +    let result = client.postSharing(boardID, body, &context).wait();
     
         println!("{:?}", result);
     }
    @@ -10630,11 +19750,11 @@ pub fn main() {
                                       Name
                                       Description
                                     
    -                                  workspaceID*
    +                                  boardID*
     
     
     
    -    
    +
    @@ -10642,30 +19762,7 @@ pub fn main() {
    -Workspace ID -
    -
    -
    - Required -
    -
    -
    - - - - rootID* - - - -
    -
    -
    - - String - - -
    -ID of the root block +Board ID
    @@ -10830,10 +19927,10 @@ $(document).ready(function() {

    -

    Regenerates the signup token for the root workspace

    +

    Regenerates the signup token for the root team


    -
    /api/v1/workspaces/{workspaceID}/regenerate_signup_token
    +
    /teams/{teamID}/regenerate_signup_token

    Usage and SDK Samples

    @@ -10857,7 +19954,7 @@ $(document).ready(function() {
    curl -X POST \
     -H "Authorization: [[apiKey]]" \
      -H "Accept: application/json" \
    - "http://localhost/api/v1/api/v1/workspaces/{workspaceID}/regenerate_signup_token"
    + "http://localhost/api/v2/teams/{teamID}/regenerate_signup_token"
     
    @@ -10881,10 +19978,10 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID + String teamID = teamID_example; // String | Team ID try { - apiInstance.regenerateSignupToken(workspaceID); + apiInstance.regenerateSignupToken(teamID); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#regenerateSignupToken"); e.printStackTrace(); @@ -10900,10 +19997,10 @@ public class DefaultApiExample { public class DefaultApiExample { public static void main(String[] args) { DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID + String teamID = teamID_example; // String | Team ID try { - apiInstance.regenerateSignupToken(workspaceID); + apiInstance.regenerateSignupToken(teamID); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#regenerateSignupToken"); e.printStackTrace(); @@ -10926,9 +20023,9 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi *apiInstance = [[DefaultApi alloc] init]; -String *workspaceID = workspaceID_example; // Workspace ID (default to null) +String *teamID = teamID_example; // Team ID (default to null) -[apiInstance regenerateSignupTokenWith:workspaceID +[apiInstance regenerateSignupTokenWith:teamID completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); @@ -10949,7 +20046,7 @@ BearerAuth.apiKey = "YOUR API KEY"; // Create an instance of the API class var api = new FocalboardServer.DefaultApi() -var workspaceID = workspaceID_example; // {String} Workspace ID +var teamID = teamID_example; // {String} Team ID var callback = function(error, data, response) { if (error) { @@ -10958,7 +20055,7 @@ var callback = function(error, data, response) { console.log('API called successfully.'); } }; -api.regenerateSignupToken(workspaceID, callback); +api.regenerateSignupToken(teamID, callback);
    @@ -10985,10 +20082,10 @@ namespace Example // Create an instance of the API class var apiInstance = new DefaultApi(); - var workspaceID = workspaceID_example; // String | Workspace ID (default to null) + var teamID = teamID_example; // String | Team ID (default to null) try { - apiInstance.regenerateSignupToken(workspaceID); + apiInstance.regenerateSignupToken(teamID); } catch (Exception e) { Debug.Print("Exception when calling DefaultApi.regenerateSignupToken: " + e.Message ); } @@ -11009,10 +20106,10 @@ OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authori // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\DefaultApi(); -$workspaceID = workspaceID_example; // String | Workspace ID +$teamID = teamID_example; // String | Team ID try { - $api_instance->regenerateSignupToken($workspaceID); + $api_instance->regenerateSignupToken($teamID); } catch (Exception $e) { echo 'Exception when calling DefaultApi->regenerateSignupToken: ', $e->getMessage(), PHP_EOL; } @@ -11031,10 +20128,10 @@ $WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY'; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::DefaultApi->new(); -my $workspaceID = workspaceID_example; # String | Workspace ID +my $teamID = teamID_example; # String | Team ID eval { - $api_instance->regenerateSignupToken(workspaceID => $workspaceID); + $api_instance->regenerateSignupToken(teamID => $teamID); }; if ($@) { warn "Exception when calling DefaultApi->regenerateSignupToken: $@\n"; @@ -11055,10 +20152,10 @@ openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Create an instance of the API class api_instance = openapi_client.DefaultApi() -workspaceID = workspaceID_example # String | Workspace ID (default to null) +teamID = teamID_example # String | Team ID (default to null) try: - api_instance.regenerate_signup_token(workspaceID) + api_instance.regenerate_signup_token(teamID) except ApiException as e: print("Exception when calling DefaultApi->regenerateSignupToken: %s\n" % e) @@ -11067,10 +20164,10 @@ except ApiException as e:
    extern crate DefaultApi;
     
     pub fn main() {
    -    let workspaceID = workspaceID_example; // String
    +    let teamID = teamID_example; // String
     
         let mut context = DefaultApi::Context::default();
    -    let result = client.regenerateSignupToken(workspaceID, &context).wait();
    +    let result = client.regenerateSignupToken(teamID, &context).wait();
     
         println!("{:?}", result);
     }
    @@ -11091,11 +20188,11 @@ pub fn main() {
                                       Name
                                       Description
                                     
    -                                  workspaceID*
    +                                  teamID*
     
     
     
    -    
    +
    @@ -11103,7 +20200,7 @@ pub fn main() {
    -Workspace ID +Team ID
    @@ -11224,7 +20321,7 @@ Workspace ID

    Register new user


    -
    /api/v1/register
    +
    /register

    Usage and SDK Samples

    @@ -11248,7 +20345,7 @@ Workspace ID
    curl -X POST \
      -H "Accept: application/json" \
      -H "Content-Type: application/json" \
    - "http://localhost/api/v1/api/v1/register" \
    + "http://localhost/api/v2/register" \
      -d '{
       "password" : "password",
       "email" : "email",
    @@ -11609,6 +20706,1383 @@ $(document).ready(function() {
                             
                           

    +
    +
    +
    +

    searchBoards

    +

    +
    +
    +
    +

    +

    Returns the boards that match with a search term

    +

    +
    +
    /teams/{teamID}/boards/search
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X GET \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + "http://localhost/api/v2/teams/{teamID}/boards/search?q=q_example"
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        String teamID = teamID_example; // String | Team ID
    +        String q = q_example; // String | The search term. Must have at least one character
    +
    +        try {
    +            array[Board] result = apiInstance.searchBoards(teamID, q);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#searchBoards");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        String teamID = teamID_example; // String | Team ID
    +        String q = q_example; // String | The search term. Must have at least one character
    +
    +        try {
    +            array[Board] result = apiInstance.searchBoards(teamID, q);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#searchBoards");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +String *teamID = teamID_example; // Team ID (default to null)
    +String *q = q_example; // The search term. Must have at least one character (default to null)
    +
    +[apiInstance searchBoardsWith:teamID
    +    q:q
    +              completionHandler: ^(array[Board] output, NSError* error) {
    +    if (output) {
    +        NSLog(@"%@", output);
    +    }
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var teamID = teamID_example; // {String} Team ID
    +var q = q_example; // {String} The search term. Must have at least one character
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully. Returned data: ' + data);
    +  }
    +};
    +api.searchBoards(teamID, q, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class searchBoardsExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var teamID = teamID_example;  // String | Team ID (default to null)
    +            var q = q_example;  // String | The search term. Must have at least one character (default to null)
    +
    +            try {
    +                array[Board] result = apiInstance.searchBoards(teamID, q);
    +                Debug.WriteLine(result);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.searchBoards: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$teamID = teamID_example; // String | Team ID
    +$q = q_example; // String | The search term. Must have at least one character
    +
    +try {
    +    $result = $api_instance->searchBoards($teamID, $q);
    +    print_r($result);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->searchBoards: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $teamID = teamID_example; # String | Team ID
    +my $q = q_example; # String | The search term. Must have at least one character
    +
    +eval {
    +    my $result = $api_instance->searchBoards(teamID => $teamID, q => $q);
    +    print Dumper($result);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->searchBoards: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +teamID = teamID_example # String | Team ID (default to null)
    +q = q_example # String | The search term. Must have at least one character (default to null)
    +
    +try:
    +    api_response = api_instance.search_boards(teamID, q)
    +    pprint(api_response)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->searchBoards: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let teamID = teamID_example; // String
    +    let q = q_example; // String
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.searchBoards(teamID, q, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + + +
    NameDescription
    teamID* + + +
    +
    +
    + + String + + +
    +Team ID +
    +
    +
    + Required +
    +
    +
    +
    + + + + +
    Query parameters
    + + + + + + + + + +
    NameDescription
    q* + + +
    +
    +
    + + String + + +
    +The search term. Must have at least one character +
    +
    +
    + Required +
    +
    +
    +
    + +

    Responses

    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +

    undeleteBlock

    +

    +
    +
    +
    +

    +

    Undeletes a block

    +

    +
    +
    /boards/{boardID}/blocks/{blockID}/undelete
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X POST \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + "http://localhost/api/v2/boards/{boardID}/blocks/{blockID}/undelete"
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        String boardID = boardID_example; // String | Board ID
    +        String blockID = blockID_example; // String | ID of block to undelete
    +
    +        try {
    +            BlockPatch result = apiInstance.undeleteBlock(boardID, blockID);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#undeleteBlock");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        String boardID = boardID_example; // String | Board ID
    +        String blockID = blockID_example; // String | ID of block to undelete
    +
    +        try {
    +            BlockPatch result = apiInstance.undeleteBlock(boardID, blockID);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#undeleteBlock");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +String *boardID = boardID_example; // Board ID (default to null)
    +String *blockID = blockID_example; // ID of block to undelete (default to null)
    +
    +[apiInstance undeleteBlockWith:boardID
    +    blockID:blockID
    +              completionHandler: ^(BlockPatch output, NSError* error) {
    +    if (output) {
    +        NSLog(@"%@", output);
    +    }
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var boardID = boardID_example; // {String} Board ID
    +var blockID = blockID_example; // {String} ID of block to undelete
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully. Returned data: ' + data);
    +  }
    +};
    +api.undeleteBlock(boardID, blockID, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class undeleteBlockExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var boardID = boardID_example;  // String | Board ID (default to null)
    +            var blockID = blockID_example;  // String | ID of block to undelete (default to null)
    +
    +            try {
    +                BlockPatch result = apiInstance.undeleteBlock(boardID, blockID);
    +                Debug.WriteLine(result);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.undeleteBlock: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$boardID = boardID_example; // String | Board ID
    +$blockID = blockID_example; // String | ID of block to undelete
    +
    +try {
    +    $result = $api_instance->undeleteBlock($boardID, $blockID);
    +    print_r($result);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->undeleteBlock: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $boardID = boardID_example; # String | Board ID
    +my $blockID = blockID_example; # String | ID of block to undelete
    +
    +eval {
    +    my $result = $api_instance->undeleteBlock(boardID => $boardID, blockID => $blockID);
    +    print Dumper($result);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->undeleteBlock: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +boardID = boardID_example # String | Board ID (default to null)
    +blockID = blockID_example # String | ID of block to undelete (default to null)
    +
    +try:
    +    api_response = api_instance.undelete_block(boardID, blockID)
    +    pprint(api_response)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->undeleteBlock: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let boardID = boardID_example; // String
    +    let blockID = blockID_example; // String
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.undeleteBlock(boardID, blockID, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + + + + + + +
    NameDescription
    boardID* + + +
    +
    +
    + + String + + +
    +Board ID +
    +
    +
    + Required +
    +
    +
    +
    blockID* + + +
    +
    +
    + + String + + +
    +ID of block to undelete +
    +
    +
    + Required +
    +
    +
    +
    + + + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +

    +

    + + + + + + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +

    undeleteBoard

    +

    +
    +
    +
    +

    +

    Undeletes a board

    +

    +
    +
    /boards/{boardID}/undelete
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X POST \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + "http://localhost/api/v2/boards/{boardID}/undelete"
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        String boardID = boardID_example; // String | ID of board to undelete
    +
    +        try {
    +            apiInstance.undeleteBoard(boardID);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#undeleteBoard");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        String boardID = boardID_example; // String | ID of board to undelete
    +
    +        try {
    +            apiInstance.undeleteBoard(boardID);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#undeleteBoard");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +String *boardID = boardID_example; // ID of board to undelete (default to null)
    +
    +[apiInstance undeleteBoardWith:boardID
    +              completionHandler: ^(NSError* error) {
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var boardID = boardID_example; // {String} ID of board to undelete
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully.');
    +  }
    +};
    +api.undeleteBoard(boardID, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class undeleteBoardExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var boardID = boardID_example;  // String | ID of board to undelete (default to null)
    +
    +            try {
    +                apiInstance.undeleteBoard(boardID);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.undeleteBoard: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$boardID = boardID_example; // String | ID of board to undelete
    +
    +try {
    +    $api_instance->undeleteBoard($boardID);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->undeleteBoard: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $boardID = boardID_example; # String | ID of board to undelete
    +
    +eval {
    +    $api_instance->undeleteBoard(boardID => $boardID);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->undeleteBoard: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +boardID = boardID_example # String | ID of board to undelete (default to null)
    +
    +try:
    +    api_instance.undelete_board(boardID)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->undeleteBoard: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let boardID = boardID_example; // String
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.undeleteBoard(boardID, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + + +
    NameDescription
    boardID* + + +
    +
    +
    + + String + + +
    +ID of board to undelete +
    +
    +
    + Required +
    +
    +
    +
    + + + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    @@ -11623,7 +22097,7 @@ blocks with existing ones, the rest will be replaced by server generated IDs


    -
    /api/v1/workspaces/{workspaceID}/blocks
    +
    /boards/{boardID}/blocks

    Usage and SDK Samples

    @@ -11648,23 +22122,22 @@ generated IDs

    -H "Authorization: [[apiKey]]" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ - "http://localhost/api/v1/api/v1/workspaces/{workspaceID}/blocks" \ + "http://localhost/api/v2/boards/{boardID}/blocks" \ -d '{ "schema" : 1, - "deleteAt" : 6, - "rootId" : "rootId", - "updateAt" : 5, - "title" : "title", - "type" : "type", - "createAt" : 0, - "parentId" : "parentId", "createdBy" : "createdBy", + "deleteAt" : 6, + "boardId" : "boardId", + "updateAt" : 5, "modifiedBy" : "modifiedBy", "id" : "id", "fields" : { "key" : "{}" }, - "workspaceId" : "workspaceId" + "title" : "title", + "type" : "type", + "createAt" : 0, + "parentId" : "parentId" }'
    @@ -11689,11 +22162,11 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID + String boardID = boardID_example; // String | Board ID array[Block] body = ; // array[Block] | try { - array[Block] result = apiInstance.updateBlocks(workspaceID, body); + array[Block] result = apiInstance.updateBlocks(boardID, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#updateBlocks"); @@ -11710,11 +22183,11 @@ public class DefaultApiExample { public class DefaultApiExample { public static void main(String[] args) { DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID + String boardID = boardID_example; // String | Board ID array[Block] body = ; // array[Block] | try { - array[Block] result = apiInstance.updateBlocks(workspaceID, body); + array[Block] result = apiInstance.updateBlocks(boardID, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#updateBlocks"); @@ -11738,10 +22211,10 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi *apiInstance = [[DefaultApi alloc] init]; -String *workspaceID = workspaceID_example; // Workspace ID (default to null) +String *boardID = boardID_example; // Board ID (default to null) array[Block] *body = ; // -[apiInstance updateBlocksWith:workspaceID +[apiInstance updateBlocksWith:boardID body:body completionHandler: ^(array[Block] output, NSError* error) { if (output) { @@ -11766,7 +22239,7 @@ BearerAuth.apiKey = "YOUR API KEY"; // Create an instance of the API class var api = new FocalboardServer.DefaultApi() -var workspaceID = workspaceID_example; // {String} Workspace ID +var boardID = boardID_example; // {String} Board ID var body = ; // {array[Block]} var callback = function(error, data, response) { @@ -11776,7 +22249,7 @@ var callback = function(error, data, response) { console.log('API called successfully. Returned data: ' + data); } }; -api.updateBlocks(workspaceID, body, callback); +api.updateBlocks(boardID, body, callback); @@ -11803,11 +22276,11 @@ namespace Example // Create an instance of the API class var apiInstance = new DefaultApi(); - var workspaceID = workspaceID_example; // String | Workspace ID (default to null) + var boardID = boardID_example; // String | Board ID (default to null) var body = new array[Block](); // array[Block] | try { - array[Block] result = apiInstance.updateBlocks(workspaceID, body); + array[Block] result = apiInstance.updateBlocks(boardID, body); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling DefaultApi.updateBlocks: " + e.Message ); @@ -11829,11 +22302,11 @@ OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authori // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\DefaultApi(); -$workspaceID = workspaceID_example; // String | Workspace ID +$boardID = boardID_example; // String | Board ID $body = ; // array[Block] | try { - $result = $api_instance->updateBlocks($workspaceID, $body); + $result = $api_instance->updateBlocks($boardID, $body); print_r($result); } catch (Exception $e) { echo 'Exception when calling DefaultApi->updateBlocks: ', $e->getMessage(), PHP_EOL; @@ -11853,11 +22326,11 @@ $WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY'; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::DefaultApi->new(); -my $workspaceID = workspaceID_example; # String | Workspace ID +my $boardID = boardID_example; # String | Board ID my $body = [WWW::OPenAPIClient::Object::array[Block]->new()]; # array[Block] | eval { - my $result = $api_instance->updateBlocks(workspaceID => $workspaceID, body => $body); + my $result = $api_instance->updateBlocks(boardID => $boardID, body => $body); print Dumper($result); }; if ($@) { @@ -11879,11 +22352,11 @@ openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Create an instance of the API class api_instance = openapi_client.DefaultApi() -workspaceID = workspaceID_example # String | Workspace ID (default to null) +boardID = boardID_example # String | Board ID (default to null) body = # array[Block] | try: - api_response = api_instance.update_blocks(workspaceID, body) + api_response = api_instance.update_blocks(boardID, body) pprint(api_response) except ApiException as e: print("Exception when calling DefaultApi->updateBlocks: %s\n" % e) @@ -11893,11 +22366,11 @@ except ApiException as e:
    extern crate DefaultApi;
     
     pub fn main() {
    -    let workspaceID = workspaceID_example; // String
    +    let boardID = boardID_example; // String
         let body = ; // array[Block]
     
         let mut context = DefaultApi::Context::default();
    -    let result = client.updateBlocks(workspaceID, body, &context).wait();
    +    let result = client.updateBlocks(boardID, body, &context).wait();
     
         println!("{:?}", result);
     }
    @@ -11918,11 +22391,11 @@ pub fn main() {
                                       Name
                                       Description
                                     
    -                                  workspaceID*
    +                                  boardID*
     
     
     
    -    
    +
    @@ -11930,7 +22403,7 @@ pub fn main() {
    -Workspace ID +Board ID
    @@ -12136,6 +22609,1005 @@ $(document).ready(function() {

    +
    +
    +
    +

    updateMember

    +

    +
    +
    +
    +

    +

    Updates a board member

    +

    +
    +
    /boards/{boardID}/members/{userID}
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X PUT \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + -H "Content-Type: application/json" \
    + "http://localhost/api/v2/boards/{boardID}/members/{userID}" \
    + -d '{
    +  "schemeAdmin" : true,
    +  "schemeCommenter" : true,
    +  "schemeViewer" : true,
    +  "roles" : "roles",
    +  "schemeEditor" : true,
    +  "boardId" : "boardId",
    +  "userId" : "userId"
    +}'
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        String boardID = boardID_example; // String | Board ID
    +        String userID = userID_example; // String | User ID
    +        BoardMember body = ; // BoardMember | 
    +
    +        try {
    +            BoardMember result = apiInstance.updateMember(boardID, userID, body);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#updateMember");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        String boardID = boardID_example; // String | Board ID
    +        String userID = userID_example; // String | User ID
    +        BoardMember body = ; // BoardMember | 
    +
    +        try {
    +            BoardMember result = apiInstance.updateMember(boardID, userID, body);
    +            System.out.println(result);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#updateMember");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +String *boardID = boardID_example; // Board ID (default to null)
    +String *userID = userID_example; // User ID (default to null)
    +BoardMember *body = ; // 
    +
    +[apiInstance updateMemberWith:boardID
    +    userID:userID
    +    body:body
    +              completionHandler: ^(BoardMember output, NSError* error) {
    +    if (output) {
    +        NSLog(@"%@", output);
    +    }
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var boardID = boardID_example; // {String} Board ID
    +var userID = userID_example; // {String} User ID
    +var body = ; // {BoardMember} 
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully. Returned data: ' + data);
    +  }
    +};
    +api.updateMember(boardID, userID, body, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class updateMemberExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var boardID = boardID_example;  // String | Board ID (default to null)
    +            var userID = userID_example;  // String | User ID (default to null)
    +            var body = new BoardMember(); // BoardMember | 
    +
    +            try {
    +                BoardMember result = apiInstance.updateMember(boardID, userID, body);
    +                Debug.WriteLine(result);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.updateMember: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$boardID = boardID_example; // String | Board ID
    +$userID = userID_example; // String | User ID
    +$body = ; // BoardMember | 
    +
    +try {
    +    $result = $api_instance->updateMember($boardID, $userID, $body);
    +    print_r($result);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->updateMember: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $boardID = boardID_example; # String | Board ID
    +my $userID = userID_example; # String | User ID
    +my $body = WWW::OPenAPIClient::Object::BoardMember->new(); # BoardMember | 
    +
    +eval {
    +    my $result = $api_instance->updateMember(boardID => $boardID, userID => $userID, body => $body);
    +    print Dumper($result);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->updateMember: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +boardID = boardID_example # String | Board ID (default to null)
    +userID = userID_example # String | User ID (default to null)
    +body =  # BoardMember | 
    +
    +try:
    +    api_response = api_instance.update_member(boardID, userID, body)
    +    pprint(api_response)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->updateMember: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let boardID = boardID_example; // String
    +    let userID = userID_example; // String
    +    let body = ; // BoardMember
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.updateMember(boardID, userID, body, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + + + + + + +
    NameDescription
    boardID* + + +
    +
    +
    + + String + + +
    +Board ID +
    +
    +
    + Required +
    +
    +
    +
    userID* + + +
    +
    +
    + + String + + +
    +User ID +
    +
    +
    + Required +
    +
    +
    +
    + + +
    Body parameters
    + + + + + + + + + +
    NameDescription
    body * +

    membership to replace the current one with

    + +
    +
    + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +

    updateUserConfig

    +

    +
    +
    +
    +

    +

    Updates user config

    +

    +
    +
    /users/{userID}/config
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    +
    curl -X PATCH \
    +-H "Authorization: [[apiKey]]" \
    + -H "Accept: application/json" \
    + -H "Content-Type: application/json" \
    + "http://localhost/api/v2/users/{userID}/config" \
    + -d '{
    +  "updatedFields" : {
    +    "key" : "updatedFields"
    +  },
    +  "deletedFields" : [ "deletedFields", "deletedFields" ]
    +}'
    +
    +
    +
    +
    import org.openapitools.client.*;
    +import org.openapitools.client.auth.*;
    +import org.openapitools.client.model.*;
    +import org.openapitools.client.api.DefaultApi;
    +
    +import java.io.File;
    +import java.util.*;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        ApiClient defaultClient = Configuration.getDefaultApiClient();
    +        
    +        // Configure API key authorization: BearerAuth
    +        ApiKeyAuth BearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("BearerAuth");
    +        BearerAuth.setApiKey("YOUR API KEY");
    +        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +        //BearerAuth.setApiKeyPrefix("Token");
    +
    +        // Create an instance of the API class
    +        DefaultApi apiInstance = new DefaultApi();
    +        String userID = userID_example; // String | User ID
    +        UserPropPatch body = ; // UserPropPatch | 
    +
    +        try {
    +            apiInstance.updateUserConfig(userID, body);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#updateUserConfig");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    +
    + +
    +
    import org.openapitools.client.api.DefaultApi;
    +
    +public class DefaultApiExample {
    +    public static void main(String[] args) {
    +        DefaultApi apiInstance = new DefaultApi();
    +        String userID = userID_example; // String | User ID
    +        UserPropPatch body = ; // UserPropPatch | 
    +
    +        try {
    +            apiInstance.updateUserConfig(userID, body);
    +        } catch (ApiException e) {
    +            System.err.println("Exception when calling DefaultApi#updateUserConfig");
    +            e.printStackTrace();
    +        }
    +    }
    +}
    +
    + +
    +
    Configuration *apiConfig = [Configuration sharedConfig];
    +
    +// Configure API key authorization: (authentication scheme: BearerAuth)
    +[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
    +
    +
    +// Create an instance of the API class
    +DefaultApi *apiInstance = [[DefaultApi alloc] init];
    +String *userID = userID_example; // User ID (default to null)
    +UserPropPatch *body = ; // 
    +
    +[apiInstance updateUserConfigWith:userID
    +    body:body
    +              completionHandler: ^(NSError* error) {
    +    if (error) {
    +        NSLog(@"Error: %@", error);
    +    }
    +}];
    +
    +
    + +
    +
    var FocalboardServer = require('focalboard_server');
    +var defaultClient = FocalboardServer.ApiClient.instance;
    +
    +// Configure API key authorization: BearerAuth
    +var BearerAuth = defaultClient.authentications['BearerAuth'];
    +BearerAuth.apiKey = "YOUR API KEY";
    +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    +//BearerAuth.apiKeyPrefix['Authorization'] = "Token";
    +
    +// Create an instance of the API class
    +var api = new FocalboardServer.DefaultApi()
    +var userID = userID_example; // {String} User ID
    +var body = ; // {UserPropPatch} 
    +
    +var callback = function(error, data, response) {
    +  if (error) {
    +    console.error(error);
    +  } else {
    +    console.log('API called successfully.');
    +  }
    +};
    +api.updateUserConfig(userID, body, callback);
    +
    +
    + + +
    +
    using System;
    +using System.Diagnostics;
    +using Org.OpenAPITools.Api;
    +using Org.OpenAPITools.Client;
    +using Org.OpenAPITools.Model;
    +
    +namespace Example
    +{
    +    public class updateUserConfigExample
    +    {
    +        public void main()
    +        {
    +            // Configure API key authorization: BearerAuth
    +            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
    +            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
    +
    +            // Create an instance of the API class
    +            var apiInstance = new DefaultApi();
    +            var userID = userID_example;  // String | User ID (default to null)
    +            var body = new UserPropPatch(); // UserPropPatch | 
    +
    +            try {
    +                apiInstance.updateUserConfig(userID, body);
    +            } catch (Exception e) {
    +                Debug.Print("Exception when calling DefaultApi.updateUserConfig: " + e.Message );
    +            }
    +        }
    +    }
    +}
    +
    +
    + +
    +
    <?php
    +require_once(__DIR__ . '/vendor/autoload.php');
    +
    +// Configure API key authorization: BearerAuth
    +OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
    +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
    +
    +// Create an instance of the API class
    +$api_instance = new OpenAPITools\Client\Api\DefaultApi();
    +$userID = userID_example; // String | User ID
    +$body = ; // UserPropPatch | 
    +
    +try {
    +    $api_instance->updateUserConfig($userID, $body);
    +} catch (Exception $e) {
    +    echo 'Exception when calling DefaultApi->updateUserConfig: ', $e->getMessage(), PHP_EOL;
    +}
    +?>
    +
    + +
    +
    use Data::Dumper;
    +use WWW::OPenAPIClient::Configuration;
    +use WWW::OPenAPIClient::DefaultApi;
    +
    +# Configure API key authorization: BearerAuth
    +$WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
    +# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
    +
    +# Create an instance of the API class
    +my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
    +my $userID = userID_example; # String | User ID
    +my $body = WWW::OPenAPIClient::Object::UserPropPatch->new(); # UserPropPatch | 
    +
    +eval {
    +    $api_instance->updateUserConfig(userID => $userID, body => $body);
    +};
    +if ($@) {
    +    warn "Exception when calling DefaultApi->updateUserConfig: $@\n";
    +}
    +
    + +
    +
    from __future__ import print_statement
    +import time
    +import openapi_client
    +from openapi_client.rest import ApiException
    +from pprint import pprint
    +
    +# Configure API key authorization: BearerAuth
    +openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
    +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    +# openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
    +
    +# Create an instance of the API class
    +api_instance = openapi_client.DefaultApi()
    +userID = userID_example # String | User ID (default to null)
    +body =  # UserPropPatch | 
    +
    +try:
    +    api_instance.update_user_config(userID, body)
    +except ApiException as e:
    +    print("Exception when calling DefaultApi->updateUserConfig: %s\n" % e)
    +
    + +
    +
    extern crate DefaultApi;
    +
    +pub fn main() {
    +    let userID = userID_example; // String
    +    let body = ; // UserPropPatch
    +
    +    let mut context = DefaultApi::Context::default();
    +    let result = client.updateUserConfig(userID, body, &context).wait();
    +
    +    println!("{:?}", result);
    +}
    +
    +
    +
    + +

    Scopes

    + + +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + + +
    NameDescription
    userID* + + +
    +
    +
    + + String + + +
    +User ID +
    +
    +
    + Required +
    +
    +
    +
    + + +
    Body parameters
    + + + + + + + + + +
    NameDescription
    body * +

    User config patch to apply

    + +
    +
    + + + +

    Responses

    +

    +

    + + + + + + +
    +
    +

    +

    + + + + + + +
    +
    +
    + +
    + +
    +
    +
    +
    +
    @@ -12148,7 +23620,7 @@ $(document).ready(function() {

    Upload a binary file, attached to a root block


    -
    /api/v1/workspaces/{workspaceID}/{rootID}/files
    +
    /teams/{teamID}/boards/{boardID}/files

    Usage and SDK Samples

    @@ -12173,7 +23645,7 @@ $(document).ready(function() { -H "Authorization: [[apiKey]]" \ -H "Accept: application/json" \ -H "Content-Type: multipart/form-data" \ - "http://localhost/api/v1/api/v1/workspaces/{workspaceID}/{rootID}/files" + "http://localhost/api/v2/teams/{teamID}/boards/{boardID}/files"
    @@ -12197,12 +23669,12 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID - String rootID = rootID_example; // String | ID of the root block + String teamID = teamID_example; // String | ID of the team + String boardID = boardID_example; // String | Board ID File uploaded file = BINARY_DATA_HERE; // File | The file to upload try { - FileUploadResponse result = apiInstance.uploadFile(workspaceID, rootID, uploaded file); + FileUploadResponse result = apiInstance.uploadFile(teamID, boardID, uploaded file); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#uploadFile"); @@ -12219,12 +23691,12 @@ public class DefaultApiExample { public class DefaultApiExample { public static void main(String[] args) { DefaultApi apiInstance = new DefaultApi(); - String workspaceID = workspaceID_example; // String | Workspace ID - String rootID = rootID_example; // String | ID of the root block + String teamID = teamID_example; // String | ID of the team + String boardID = boardID_example; // String | Board ID File uploaded file = BINARY_DATA_HERE; // File | The file to upload try { - FileUploadResponse result = apiInstance.uploadFile(workspaceID, rootID, uploaded file); + FileUploadResponse result = apiInstance.uploadFile(teamID, boardID, uploaded file); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DefaultApi#uploadFile"); @@ -12248,12 +23720,12 @@ public class DefaultApiExample { // Create an instance of the API class DefaultApi *apiInstance = [[DefaultApi alloc] init]; -String *workspaceID = workspaceID_example; // Workspace ID (default to null) -String *rootID = rootID_example; // ID of the root block (default to null) +String *teamID = teamID_example; // ID of the team (default to null) +String *boardID = boardID_example; // Board ID (default to null) File *uploaded file = BINARY_DATA_HERE; // The file to upload (optional) (default to null) -[apiInstance uploadFileWith:workspaceID - rootID:rootID +[apiInstance uploadFileWith:teamID + boardID:boardID uploaded file:uploaded file completionHandler: ^(FileUploadResponse output, NSError* error) { if (output) { @@ -12278,8 +23750,8 @@ BearerAuth.apiKey = "YOUR API KEY"; // Create an instance of the API class var api = new FocalboardServer.DefaultApi() -var workspaceID = workspaceID_example; // {String} Workspace ID -var rootID = rootID_example; // {String} ID of the root block +var teamID = teamID_example; // {String} ID of the team +var boardID = boardID_example; // {String} Board ID var opts = { 'uploaded file': BINARY_DATA_HERE // {File} The file to upload }; @@ -12291,7 +23763,7 @@ var callback = function(error, data, response) { console.log('API called successfully. Returned data: ' + data); } }; -api.uploadFile(workspaceID, rootID, opts, callback); +api.uploadFile(teamID, boardID, opts, callback);
    @@ -12318,12 +23790,12 @@ namespace Example // Create an instance of the API class var apiInstance = new DefaultApi(); - var workspaceID = workspaceID_example; // String | Workspace ID (default to null) - var rootID = rootID_example; // String | ID of the root block (default to null) + var teamID = teamID_example; // String | ID of the team (default to null) + var boardID = boardID_example; // String | Board ID (default to null) var uploaded file = BINARY_DATA_HERE; // File | The file to upload (optional) (default to null) try { - FileUploadResponse result = apiInstance.uploadFile(workspaceID, rootID, uploaded file); + FileUploadResponse result = apiInstance.uploadFile(teamID, boardID, uploaded file); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling DefaultApi.uploadFile: " + e.Message ); @@ -12345,12 +23817,12 @@ OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('Authori // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\DefaultApi(); -$workspaceID = workspaceID_example; // String | Workspace ID -$rootID = rootID_example; // String | ID of the root block +$teamID = teamID_example; // String | ID of the team +$boardID = boardID_example; // String | Board ID $uploaded file = BINARY_DATA_HERE; // File | The file to upload try { - $result = $api_instance->uploadFile($workspaceID, $rootID, $uploaded file); + $result = $api_instance->uploadFile($teamID, $boardID, $uploaded file); print_r($result); } catch (Exception $e) { echo 'Exception when calling DefaultApi->uploadFile: ', $e->getMessage(), PHP_EOL; @@ -12370,12 +23842,12 @@ $WWW::OPenAPIClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY'; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::DefaultApi->new(); -my $workspaceID = workspaceID_example; # String | Workspace ID -my $rootID = rootID_example; # String | ID of the root block +my $teamID = teamID_example; # String | ID of the team +my $boardID = boardID_example; # String | Board ID my $uploaded file = BINARY_DATA_HERE; # File | The file to upload eval { - my $result = $api_instance->uploadFile(workspaceID => $workspaceID, rootID => $rootID, uploaded file => $uploaded file); + my $result = $api_instance->uploadFile(teamID => $teamID, boardID => $boardID, uploaded file => $uploaded file); print Dumper($result); }; if ($@) { @@ -12397,12 +23869,12 @@ openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Create an instance of the API class api_instance = openapi_client.DefaultApi() -workspaceID = workspaceID_example # String | Workspace ID (default to null) -rootID = rootID_example # String | ID of the root block (default to null) +teamID = teamID_example # String | ID of the team (default to null) +boardID = boardID_example # String | Board ID (default to null) uploaded file = BINARY_DATA_HERE # File | The file to upload (optional) (default to null) try: - api_response = api_instance.upload_file(workspaceID, rootID, uploaded file=uploaded file) + api_response = api_instance.upload_file(teamID, boardID, uploaded file=uploaded file) pprint(api_response) except ApiException as e: print("Exception when calling DefaultApi->uploadFile: %s\n" % e) @@ -12412,12 +23884,12 @@ except ApiException as e:
    extern crate DefaultApi;
     
     pub fn main() {
    -    let workspaceID = workspaceID_example; // String
    -    let rootID = rootID_example; // String
    +    let teamID = teamID_example; // String
    +    let boardID = boardID_example; // String
         let uploaded file = BINARY_DATA_HERE; // File
     
         let mut context = DefaultApi::Context::default();
    -    let result = client.uploadFile(workspaceID, rootID, uploaded file, &context).wait();
    +    let result = client.uploadFile(teamID, boardID, uploaded file, &context).wait();
     
         println!("{:?}", result);
     }
    @@ -12438,11 +23910,11 @@ pub fn main() {
                                       Name
                                       Description
                                     
    -                                  workspaceID*
    +                                  teamID*
     
     
     
    -    
    +
    @@ -12450,7 +23922,7 @@ pub fn main() {
    -Workspace ID +ID of the team
    @@ -12461,11 +23933,11 @@ Workspace ID - rootID* + boardID* -
    +
    @@ -12473,7 +23945,7 @@ Workspace ID
    -ID of the root block +Board ID
    @@ -12587,6 +24059,28 @@ The file to upload
    +

    +

    + + + + + + +
    +