getObjectRecordsInEHive

/api/v2/objectrecords

All authorized users can retrieve public object records information in eHive. A request to the /api/v2/objectrecords resource will return an Object Records Collection JSON object.

Try the getObjectRecordsInEHive Method

You can enter real values into the form below and test them against our live API. The response you see is a genuine JSON response from the API.

Code Examples

Included below are some code snippets from our code samples projects. The examples show the main elements needed to use our API client libraries.

Java

Prerequisites

1. Download the Java API client library.
2. Create a new Java class file.
3. Add the Java API client library JAR to your classpath.
4. Create a blank file that is accessible from wherever you are running this example. The file is used to store your API authentication token, so it must be readable and writable. You can name the file anything you like as long as it is valid in Java.

Start Coding

5. Instantiate an EHiveApi object. The EHiveApi object contains all of the methods available in the API. The API requires authentication credentials so you will need to configure your EHiveApi object with valid credentials. There are a number of ways to instantiate the EHiveApi object but for this example you will simply pass all of the parameters you need into the EHiveApi object's constructor:

   private static String clientId = "...462";
   private static String clientSecret = "...98a9";
   private static String trackingId = "...eaca";
   private static String pathToOauthPropertiesFile = "oauth.properties";
   ...
   EHiveApi eHiveApi = new EHiveApi(clientId, clientSecret, trackingId, pathToOauthPropertiesFile);

6. Invoke the getObjectRecordsInEHive() method and assign the return value to an ObjectRecordsCollection domain object as follows:

   ObjectRecordsCollection objectRecordsCollection = eHiveApi.getObjectRecordsInEHive("red", "name", "asc", false, 0, 12);

7. Access the ObjectRecord information using the ObjectRecord domain object's getter method.

   Long recordId = objectRecord.getObjectRecordId();
   System.out.println(recordId);

View the full example below.

import com.ehive.api.EHiveApi;
import com.ehive.api.domain.objects.Attribute;
import com.ehive.api.domain.objects.Field;
import com.ehive.api.domain.objects.FieldRow;
import com.ehive.api.domain.objects.FieldSet;
import com.ehive.api.domain.objects.Media;
import com.ehive.api.domain.objects.MediaRow;
import com.ehive.api.domain.objects.MediaSet;
import com.ehive.api.domain.objects.ObjectRecord;
import com.ehive.api.domain.objects.ObjectRecordsCollection;
import com.ehive.api.domain.objects.Attribute.AttributeIdentifier;
import com.ehive.api.exceptions.EHiveApiException;
import com.ehive.api.exceptions.EHiveFatalServerException;
import com.ehive.api.exceptions.EHiveForbiddenException;
import com.ehive.api.exceptions.EHiveNotFoundException;
import com.ehive.api.exceptions.EHiveUnauthorizedException;

public class GetObjectRecordsInEHive {
	
	private static String clientId = "...462"; 
	private static String clientSecret = "...98a9"; 
	private static String trackingId = "...eaca"; 
	private static String pathToOauthPropertiesFile = "oauth.properties";
	
	private static String query = "red";
	private static Boolean hasImages = false;
	private static String sort = "name";
	private static String direction = "asc";
	private static Integer offset = 0;
	private static Integer limit = 12;
	
	public static void main(String[] args) throws EHiveApiException, EHiveFatalServerException, EHiveNotFoundException, EHiveUnauthorizedException, EHiveForbiddenException {
		
		// Instantiate the EHiveApi object
		EHiveApi eHiveApi = new EHiveApi(clientId, clientSecret, trackingId);
		
		// Invoke an API method
		ObjectRecordsCollection objectRecordsCollection = eHiveApi.getObjectRecordsInEHive(query, hasImages, sort, direction, offset, limit);
		
		// Print some output using the returned object records collection
		printObjectRecordsInEHiveInfo(objectRecordsCollection);
		
	}
	
	private static void printObjectRecordInfo(ObjectRecordsCollection objectRecordsCollection) {
		StringBuilder stringBuilder = new StringBuilder();
		
		stringBuilder.append("Search results found: " + objectRecordsCollection.getTotalObjects() + "\n\n");
		stringBuilder.append("----------------------------------------------------------------------------\n\n");
		
		for (ObjectRecord objectRecord : objectRecordsCollection.getObjectRecords()) {
			stringBuilder.append("Record ID: " + objectRecord.getObjectRecordId().toString() + "\n\n");
			
			for (FieldSet fieldSet : objectRecord.getFieldSets()) {
				stringBuilder.append("FIELD SET: " + fieldSet.getIdentifier() + "\n");
				
				for (FieldRow fieldRow : fieldSet.getFieldRows()) {
					for (Field field : fieldRow.getFields()) {
						for (Attribute attribute : field.getAttributes()) {
							if (AttributeIdentifier.getIdentifier(attribute.getKey()) == AttributeIdentifier.LABEL) { 
								stringBuilder.append(attribute.getValue() + ":");
							} else if (AttributeIdentifier.getIdentifier(attribute.getKey()) == AttributeIdentifier.VALUE) {
								stringBuilder.append("\t   " + attribute.getValue() + "\n\n");
							}
						}
					}
				}
				stringBuilder.append("\n\n");
			}
			
			for (MediaSet mediaSet : objectRecord.getMediaSets()) {
				stringBuilder.append(mediaSet.getIdentifier().toUpperCase() + " URL: \n");
				
				for (MediaRow mediaRow : mediaSet.getMediaRows()) {
					for (Media media : mediaRow.getMedia()) {
						for (Attribute attribute : media.getAttributes()) {
							if (AttributeIdentifier.getIdentifier(attribute.getKey()) == AttributeIdentifier.URL) { 
								stringBuilder.append(attribute.getValue() + "\n");
							} 
						}
					}
				}
			}
			stringBuilder.append("----------------------------------------------------------------------------\n\n");
		}
		System.out.println(stringBuilder.toString());
	}
}
		

PHP

Prerequisites

1. Download the PHP API client library.
2. Create a new php script file.
3. Add EHiveApi.php from the PHP API client library to your include path.
4. Locate the oauth.tok file in the transport/oauth directory of the PHP API client library and ensure that it has both read and write permission enabled.

Start Coding

5. Instantiate an EHiveApi object. The EHiveApi class contains all of the functions available to you in the API.
6. Configure your EHiveApi object with valid authentication credentials. There are a number of ways to instantiate the EHiveApi object but for this example you will simply pass all of the parameter you need into the EHiveApi object's constructor:

   private static $clientId = "...5935";
   private static $clientSecret = "...4c4b";
   private static $trackingId = "...7861";
   
   ...
   $eHiveApi = new EHiveApi(GetObjectRecordsInEHiveDemo::$clientId, 
   						 GetObjectRecordsInEHiveDemo::$clientSecret, 
   						 GetObjectRecordsInEHiveDemo::$trackingId);

7. Invoke the getObjectRecordsInEHive() method and assign the return value to a variable as follows:

   $objectRecordsCollection = $eHiveApi->getObjectRecordsInEHive("red", "name", "asc", false, 0, 12);

8. Access the information on the ObjectRecord object.

   echo $objectRecord->objectRecordId;

View the full example below.

require_once '../../lib/ehive_api_client-php-1.0.0/EHiveApi.php';

class GetObjectRecordsInEHiveDemo {
	
	private static $clientId = "...5935";
	private static $clientSecret = "...4c4b";
	private static $trackingId = "...7861";
	
	
	private static $query = "red";
	private static $hasImages = false;
	private static $sort = "name";
	private static $direction = "asc";
	private static $offset = 0;
	private static $limit = 12;

	public function printObjectRecordsInEHiveInfo() {
	
		$eHiveApi = new EHiveApi(GetObjectRecordsInEHiveDemo::$clientId, 
						 	 	 GetObjectRecordsInEHiveDemo::$clientSecret, 
						 		 GetObjectRecordsInEHiveDemo::$trackingId);
		
		$objectRecordsCollection = $eHiveApi->getObjectRecordsInEHive(GetObjectRecordsInEHiveDemo::$query, 
																	  GetObjectRecordsInEHiveDemo::$hasImages, 
																	  GetObjectRecordsInEHiveDemo::$sort, 
																	  GetObjectRecordsInEHiveDemo::$direction, 
																	  GetObjectRecordsInEHiveDemo::$offset, 
																	  GetObjectRecordsInEHiveDemo::$limit);
		
		// Print some output using the returned records collection object
		echo "\n\nSearch results found: {$objectRecordsCollection->totalObjects} \n\n";
		echo "----------------------------------------------------------------------------\n\n";
		
		foreach ($objectRecordsCollection->objectRecords as $key => $objectRecord) {
			echo "Record ID: {$objectRecord->objectRecordId}\n";
	
			foreach ($objectRecord->fieldSets as $key => $fieldSet) {
				echo "FIELD SET: {$fieldSet->identifier}\n";
				
				foreach ($fieldSet->fieldRows as $key => $fieldRow) {
					foreach ($fieldRow->fields as $key => $field) {
						foreach ($field->attributes as $key => $attribute) {
							if ($attribute->key == 'label') { 
								echo "{$attribute->value}:";
							} else if ($attribute->key == 'value') {
								echo "\t   {$attribute->value}\n\n";
							}
						}
					}
				}
				echo "\n\n";
			}
			
			foreach ($objectRecord->mediaSets as $key => $mediaSet) {
				echo strtoupper($mediaSet->identifier) . " URL: \n";
				
				foreach ($mediaSet->mediaRows as $key => $mediaRow) {
					foreach ($mediaRow->media as $key => $media) {
						foreach ($media->attributes as $key => $attribute) {
							if ($attribute->key == 'url') { 
								echo "\t   {$attribute->value}\n";
							} 
						}
					}
				}
			}
			echo "----------------------------------------------------------------------------\n\n";
		}
	}
}

$getObjectRecordsInEHiveDemo = new GetObjectRecordsInEHiveDemo();

$getObjectRecordsInEHiveDemo->printObjectRecordsInEHiveInfo();