REST API v4: GET database field

Methode om één veld in een database op te vragen. Dit is een HTTP GET call naar het volgende adres:

https://api.copernica.com/v4/database/$databaseID/field/$fieldID

De code $databaseID moet je vervangen door de numerieke identifier of de naam van de database waar het veld zich in bevindt. $fieldID moet je vervangen door de numerieke identifier of de naam van het veld dat je wilt opvragen.

Geretourneerde velden

De methode retourneert de volgende eigenschappen van het veld:

• ID: numeriek ID van het veld
• name: naam van het veld
• type: veld type
• value: standaardwaarde voor dit veld
• displayed: boolean waarde of het veld wordt weergegeven in lijsten en grids in de user interface
• ordered: wordt dit veld in de user interface gebruikt standaard gesorteerd
• length: voor tekstvelden de maximum lengte van waardes die kunnen worden opgeslagen
• textlines: voor meerregelige velden: het aantal regels dat beschikbaar is om het veld te bewerken
• hidden: boolean waarde of dit veld verborgen is en nooit wordt getoond in de user interface
• index: boolean waarde die aangeeft of er een index bijgehouden word (dit maakt lookups en selecties sneller)

Voorbeeld in PHP

Het volgende PHP script demonstreert hoe je de API methode kunt aanroepen:

// vereiste scripts
require_once('CopernicaRestAPI.php');

// verander dit naar je access token
$api = new CopernicaRestAPI("your-access-token", 4);

// voer methode uit en print resultaat
print_r($api->get("database/{$databaseID}/field/{$fieldID}"));

Dit voorbeeld vereist de REST API klasse.

Meer informatie

• Overzicht van alle API calls
• Velden van een database opvragen
• Veld toevoegen aan een database
• Veld bijwerken
• Veld verwijderen