@@ -4678,16 +5146,7 @@ $(document).ready(function() {
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getCards
+Fetches cards for the specified board.
++
/boards/{boardID}/cards+
Usage and SDK Samples
+ + + +
+
+
+
+
+ curl -X GET \
+-H "Authorization: [[apiKey]]" \
+ -H "Accept: application/json" \
+ "http://localhost/api/v2/boards/{boardID}/cards?page=56&per_page=56"
+
+
+
+ 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
+ Integer page = 56; // Integer | The page to select (default=0)
+ Integer perPage = 56; // Integer | Number of cards to return per page(default=100)
+
+ try {
+ array[Object] result = apiInstance.getCards(boardID, page, perPage);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling DefaultApi#getCards");
+ 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
+ Integer page = 56; // Integer | The page to select (default=0)
+ Integer perPage = 56; // Integer | Number of cards to return per page(default=100)
+
+ try {
+ array[Object] result = apiInstance.getCards(boardID, page, perPage);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling DefaultApi#getCards");
+ 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)
+Integer *page = 56; // The page to select (default=0) (optional) (default to null)
+Integer *perPage = 56; // Number of cards to return per page(default=100) (optional) (default to null)
+
+// Fetches cards for the specified board.
+[apiInstance getCardsWith:boardID
+ page:page
+ perPage:perPage
+ completionHandler: ^(array[Object] 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 opts = {
+ 'page': 56, // {Integer} The page to select (default=0)
+ 'perPage': 56 // {Integer} Number of cards to return per page(default=100)
+};
+
+var callback = function(error, data, response) {
+ if (error) {
+ console.error(error);
+ } else {
+ console.log('API called successfully. Returned data: ' + data);
+ }
+};
+api.getCards(boardID, opts, callback);
+
+
+
+ using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+ public class getCardsExample
+ {
+ 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 page = 56; // Integer | The page to select (default=0) (optional) (default to null)
+ var perPage = 56; // Integer | Number of cards to return per page(default=100) (optional) (default to null)
+
+ try {
+ // Fetches cards for the specified board.
+ array[Object] result = apiInstance.getCards(boardID, page, perPage);
+ Debug.WriteLine(result);
+ } catch (Exception e) {
+ Debug.Print("Exception when calling DefaultApi.getCards: " + 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
+$page = 56; // Integer | The page to select (default=0)
+$perPage = 56; // Integer | Number of cards to return per page(default=100)
+
+try {
+ $result = $api_instance->getCards($boardID, $page, $perPage);
+ print_r($result);
+} catch (Exception $e) {
+ echo 'Exception when calling DefaultApi->getCards: ', $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 $page = 56; # Integer | The page to select (default=0)
+my $perPage = 56; # Integer | Number of cards to return per page(default=100)
+
+eval {
+ my $result = $api_instance->getCards(boardID => $boardID, page => $page, perPage => $perPage);
+ print Dumper($result);
+};
+if ($@) {
+ warn "Exception when calling DefaultApi->getCards: $@\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)
+page = 56 # Integer | The page to select (default=0) (optional) (default to null)
+perPage = 56 # Integer | Number of cards to return per page(default=100) (optional) (default to null)
+
+try:
+ # Fetches cards for the specified board.
+ api_response = api_instance.get_cards(boardID, page=page, perPage=perPage)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling DefaultApi->getCards: %s\n" % e)
+
+ extern crate DefaultApi;
+
+pub fn main() {
+ let boardID = boardID_example; // String
+ let page = 56; // Integer
+ let perPage = 56; // Integer
+
+ let mut context = DefaultApi::Context::default();
+ let result = client.getCards(boardID, page, perPage, &context).wait();
+
+ println!("{:?}", result);
+}
+Scopes
+Parameters
+ +Path parameters
+ | Name | +Description | +
|---|---|
| boardID* | +
+
+
+
+
+
+
+
+
+ String
+
+
+
+
+Board ID
+
+
+ Required
+
+ |
+
Query parameters
+ | Name | +Description | +
|---|---|
| page | +
+
+
+
+
+
+
+
+
+ Integer
+
+
+
+
+The page to select (default=0)
+
+ |
+
| per_page | +
+
+
+
+
+
+
+
+
+ Integer
+
+
+
+
+Number of cards to return per page(default=100)
+
+ |
+
Responses
+ + + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -11221,19 +12452,7 @@ Channel ID
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -19442,19 +20758,7 @@ limit for boards in a page.
+
+
+
+
+
+
+
+
+
+
+
+
+ Query parameters
+ | Name | +Description | +
|---|---|
| disable_notify | +
+
+
+
+
+
+
+
+
+ oas_any_type_not_mapped
+
+
+
+
+Disables notifications (for bulk data patching)
+
+ |
+
Responses
+ + + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ping
+Responds with server metadata if the web service is running.
++
/ping+
Usage and SDK Samples
+ + + +
+
+
+
+
+ curl -X GET \
+ "http://localhost/api/v2/ping"
+
+
+
+ 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) {
+
+ // Create an instance of the API class
+ DefaultApi apiInstance = new DefaultApi();
+
+ try {
+ apiInstance.ping();
+ } catch (ApiException e) {
+ System.err.println("Exception when calling DefaultApi#ping");
+ e.printStackTrace();
+ }
+ }
+}
+
+
+
+ import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+ public static void main(String[] args) {
+ DefaultApi apiInstance = new DefaultApi();
+
+ try {
+ apiInstance.ping();
+ } catch (ApiException e) {
+ System.err.println("Exception when calling DefaultApi#ping");
+ e.printStackTrace();
+ }
+ }
+}
+
+
+
+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Responds with server metadata if the web service is running.
+[apiInstance pingWithCompletionHandler:
+ ^(NSError* error) {
+ if (error) {
+ NSLog(@"Error: %@", error);
+ }
+}];
+
+
+
+
+ var FocalboardServer = require('focalboard_server');
+
+// 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.');
+ }
+};
+api.ping(callback);
+
+
+
+ using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+ public class pingExample
+ {
+ public void main()
+ {
+
+ // Create an instance of the API class
+ var apiInstance = new DefaultApi();
+
+ try {
+ // Responds with server metadata if the web service is running.
+ apiInstance.ping();
+ } catch (Exception e) {
+ Debug.Print("Exception when calling DefaultApi.ping: " + e.Message );
+ }
+ }
+ }
+}
+
+
+
+ <?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+ $api_instance->ping();
+} catch (Exception $e) {
+ echo 'Exception when calling DefaultApi->ping: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+
+ use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval {
+ $api_instance->ping();
+};
+if ($@) {
+ warn "Exception when calling DefaultApi->ping: $@\n";
+}
+
+
+ from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try:
+ # Responds with server metadata if the web service is running.
+ api_instance.ping()
+except ApiException as e:
+ print("Exception when calling DefaultApi->ping: %s\n" % e)
+
+ extern crate DefaultApi;
+
+pub fn main() {
+
+ let mut context = DefaultApi::Context::default();
+ let result = client.ping(&context).wait();
+
+ println!("{:?}", result);
+}
+Scopes
+Parameters
+ + + + + + +Responses
+ + + + + + + + +
+
+
@@ -24978,16 +26925,7 @@ $(document).ready(function() {