NAV
java python
Loading contents...

Introduction

API Version: 3.0.4

Welcome to the Rapture API docs. You can use our API to access Rapture API endpoints and functionality.

We have language bindings in Java, Python, and a myriad other languages. You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

To log in and get authenticated, use this code:

CredentialsProvider provider
    = new SimpleCredentialsProvider("rapture", "password");
HttpLoginApi loginApi
    = new HttpLoginApi("http://localhost:8665/rapture", provider);
loginApi.login();
import raptureAPI,multipart,json,pprint,idpAPI,time
uri = "http://localhost:8665/rapture" # change this to real uri
user = "rapture"  # change this to real user 
password = "password" # change this to real password

# connect to Rapture and log in 
baseApi = raptureAPI.raptureAPI(uri, user, password)
if 'valid' in baseApi.context and baseApi.context['valid']:
    print 'logged in successfully'
else:
    print 'oops. there was an error logging in.'

You must replace localhost with your URI.

Rapture uses username and password to log in. Look at the code samples on the right for a how-to.

Host: localhost

Username: rapture

Password: password

Activity API

The activity API gives clients and programs the ability to record messages about changes and status for common activity running in the system. One common use case of activities is to see what percentage of a certain task is complete and what the last message associated with that task was.

createActivity

HttpActivityApi activityApi = new HttpActivityApi(loginApi);
String retVal = activityApi.createActivity(description, message, progress, max);
retVal = baseAPI.doActivity_CreateActivity(description, message, progress, max);

Entitlement: /activity/write

This method creates and starts recording a new activity. It returns a unique id that can be used to update the status of the activity.

Function Parameters

Parameter Type Description
description String
message String
progress Long
max Long

Return value

Type Description
String

updateActivity

HttpActivityApi activityApi = new HttpActivityApi(loginApi);
boolean retVal = activityApi.updateActivity(activityId, message, progress, max);
retVal = baseAPI.doActivity_UpdateActivity(activityId, message, progress, max);

Entitlement: /activity/write

This method updates the status of an activity. The return value is false if the activity was already marked as finished or aborted. If the value is false, this function will not take effect.

Function Parameters

Parameter Type Description
activityId String
message String
progress Long
max Long

Return value

Type Description
boolean

finishActivity

HttpActivityApi activityApi = new HttpActivityApi(loginApi);
boolean retVal = activityApi.finishActivity(activityId, message);
retVal = baseAPI.doActivity_FinishActivity(activityId, message);

Entitlement: /activity/write

This method marks an activity as finished. The return value is false if the activity was already marked as finished or aborted. If the value is false, this function will not take effect.

Function Parameters

Parameter Type Description
activityId String
message String

Return value

Type Description
boolean

requestAbortActivity

HttpActivityApi activityApi = new HttpActivityApi(loginApi);
boolean retVal = activityApi.requestAbortActivity(activityId, message);
retVal = baseAPI.doActivity_RequestAbortActivity(activityId, message);

Entitlement: /activity/write

This method is used to request that an activity abort. This will indicate to callers of updateActivity that the request is aborted, via the return value of calls that write to this activity, such as updateActivity or recordActivity. The return value is false if the activity was already marked as finished or aborted. If the value is false, this function will not take effect.

Function Parameters

Parameter Type Description
activityId String
message String

Return value

Type Description
boolean

queryByExpiryTime

HttpActivityApi activityApi = new HttpActivityApi(loginApi);
ActivityQueryResponse retVal = activityApi.queryByExpiryTime(nextBatchId, batchSize, lastSeen);
retVal = baseAPI.doActivity_QueryByExpiryTime(nextBatchId, batchSize, lastSeen);

Entitlement: /activity/read

Retrieve activities updated after a given timestamp - nextBatchId: the id for the batch, if this is not the first request. Empty string to indicate the first request - batchSize: the maximum number of items you want to see in this batch. Maximum is 10000 – if the number passed in is > 10k, it gets set to 10k. - lastSeen: an epoch timestamp in milliseconds. only activities that were last updated after this time will be returned

Function Parameters

Parameter Type Description
nextBatchId String
batchSize Long
lastSeen Long

Return value

Type Description
ActivityQueryResponse

ActivityQueryResponse

A response to a query on Activities

Field Type
isLast Boolean
nextBatchId String
activities List

getById

HttpActivityApi activityApi = new HttpActivityApi(loginApi);
Activity retVal = activityApi.getById(activityId);
retVal = baseAPI.doActivity_GetById(activityId);

Entitlement: /activity/read

Get an activity by id

Function Parameters

Parameter Type Description
activityId String

Return value

Type Description
Activity

Activity

An activity.

Field Type
id String
description String
message String
progress Long
max Long
lastSeen Long
status ActivityStatus

Admin API

The Admin API is used to manipulate and access the low level entities in Rapture. Typically the methods in this API are only used during significant setup events in a Rapture environment.

getSystemProperties

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
Map<String,String> retVal = adminApi.getSystemProperties(keys);
retVal = baseAPI.doAdmin_GetSystemProperties(keys);

Entitlement: /admin/main

This function retrieves the system properties in use for this instance of Rapture. As system propertiesare often used to control external connectivity, a client can determine the inferred connectivity endpointsby using this api call. It returns a map from system property name (the key) to value. You cannot modify thesystem properties of Rapture through the api, they are set by the administrator as part of the general setup of a Rapturesystem. Note that this call returns the properties for the actual end point that the client is connected to, it is not necessarily true thatthe same properties will be set for every API endpoint.

Function Parameters

Parameter Type Description
keys List

Return value

Type Description
Map

getRepoConfig

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
List<RepoConfig> retVal = adminApi.getRepoConfig();
retVal = baseAPI.doAdmin_GetRepoConfig();

Entitlement: /admin/main

Rapture is a hierarchical set of repositories, and this method returns the config of the top most level - that usedfor general config and temporary (transient) values such as sessions. In clustered mode these configs wouldbe referencing shared storage, and in test mode they would normally refer to in-memory versions of the config. The manipulation of the top level config can be performed through the Bootstrap API.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getSessionsForUser

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
List<CallingContext> retVal = adminApi.getSessionsForUser(user);
retVal = baseAPI.doAdmin_GetSessionsForUser(user);

Entitlement: /admin/main

When a user logs into Rapture they create a transient session and this method is a way of retrieving all of the sessions for a given user. The CallingContext is a common object passed around Rapture api calls.

Function Parameters

Parameter Type Description
user String

Return value

Type Description
List

deleteUser

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.deleteUser(userName);
retVal = baseAPI.doAdmin_DeleteUser(userName);

Entitlement: /admin/main

This method removes a user from this Rapture system. The user is removed from all entitlement groups also. The actualuser definition is retained and marked as inactive (so the user cannot login). This is because the user may still be referenced in audit trails and the change history in type repositories.

Function Parameters

Parameter Type Description
userName String

Return value

Type Description
void

destroyUser

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.destroyUser(userName);
retVal = baseAPI.doAdmin_DestroyUser(userName);

Entitlement: /admin/main

This method destroys a user record. The user must have been previously disabled using ‘deleteUser’ before this method may be called. This is a severe method that should only be used in non-production machines or to correct an administrativeerror in creating an account with the wrong name before that account has been used. Reference to the missing user may stillexist, and may not display properly in some UIs

Function Parameters

Parameter Type Description
userName String

Return value

Type Description
void

restoreUser

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.restoreUser(userName);
retVal = baseAPI.doAdmin_RestoreUser(userName);

Entitlement: /admin/main

This method restores a user that has been deleted

Function Parameters

Parameter Type Description
userName String

Return value

Type Description
void

addUser

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.addUser(userName, description, hashPassword, email);
retVal = baseAPI.doAdmin_AddUser(userName, description, hashPassword, email);

Entitlement: /admin/main

This method adds a user to the Rapture environment. The user will be in no entitlement groups by default. The passwordfield passed is actually the MD5 hash of the password - or at least the same hash function that will be applied whenlogging in to the system (the password is hashed, and then hashed again with the salt returned during the login protocol).

Function Parameters

Parameter Type Description
userName String
description String
hashPassword String
email String

Return value

Type Description
void

addNamedUser

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.addNamedUser(userName, description, hashPassword, email, realName);
retVal = baseAPI.doAdmin_AddNamedUser(userName, description, hashPassword, email, realName);

Entitlement: /admin/main

This method adds a user to the Rapture environment. The user will be in no entitlement groups by default. The passwordfield passed is actually the MD5 hash of the password - or at least the same hash function that will be applied whenlogging in to the system (the password is hashed, and then hashed again with the salt returned during the login protocol).

Function Parameters

Parameter Type Description
userName String
description String
hashPassword String
email String
realName String

Return value

Type Description
void

verifyUser

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
boolean retVal = adminApi.verifyUser(userName, token);
retVal = baseAPI.doAdmin_VerifyUser(userName, token);

Entitlement: /admin/main

Verify user by providing a secret token

Function Parameters

Parameter Type Description
userName String
token String

Return value

Type Description
boolean

verifyPasswordResetToken

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
boolean retVal = adminApi.verifyPasswordResetToken(userName, token);
retVal = baseAPI.doAdmin_VerifyPasswordResetToken(userName, token);

Entitlement: /admin/main

Verify that a Password Reset Token is valid

Function Parameters

Parameter Type Description
userName String
token String

Return value

Type Description
boolean

doesUserExist

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
boolean retVal = adminApi.doesUserExist(userName);
retVal = baseAPI.doAdmin_DoesUserExist(userName);

Entitlement: /admin/main

This api call can be used to determine whether a given user exists in the Rapture system. Only system administrators can use this api call.

Function Parameters

Parameter Type Description
userName String

Return value

Type Description
boolean

getUser

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
RaptureUser retVal = adminApi.getUser(userName);
retVal = baseAPI.doAdmin_GetUser(userName);

Entitlement: /admin/main

Retrieve a single user given their name.

Function Parameters

Parameter Type Description
userName String

Return value

Type Description
RaptureUser

RaptureUser

Defines a user account for the Rapture system.

Field Type
username String
userId String
emailAddress String
salt String
hashPassword String
description String
inactive Boolean
apiKey Boolean
hasRoot Boolean
passwordResetToken String
tokenExpirationTime Long
registrationToken String
verified Boolean
apiKeys List

generateApiUser

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
RaptureUser retVal = adminApi.generateApiUser(prefix, description);
retVal = baseAPI.doAdmin_GenerateApiUser(prefix, description);

Entitlement: /admin/main

Generates an api user, for use in connecting to Rapture in a relatively opaque way using a shared secret. An api user can log in with their access key without a password.

Function Parameters

Parameter Type Description
prefix String
description String

Return value

Type Description
RaptureUser

RaptureUser

Defines a user account for the Rapture system.

Field Type
username String
userId String
emailAddress String
salt String
hashPassword String
description String
inactive Boolean
apiKey Boolean
hasRoot Boolean
passwordResetToken String
tokenExpirationTime Long
registrationToken String
verified Boolean
apiKeys List

resetUserPassword

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.resetUserPassword(userName, newHashPassword);
retVal = baseAPI.doAdmin_ResetUserPassword(userName, newHashPassword);

Entitlement: /admin/main

This method gives an administrator the ability to reset the password of a user. The user will have the new password passed. The newHashPassword parameter should be an MD5 of the new password - internally this will be hashed further against a salt for this user.

Function Parameters

Parameter Type Description
userName String
newHashPassword String

Return value

Type Description
void

createPasswordResetToken

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
String retVal = adminApi.createPasswordResetToken(username);
retVal = baseAPI.doAdmin_CreatePasswordResetToken(username);

Entitlement: /admin/main

Creates password reset token and emails it to the user

Function Parameters

Parameter Type Description
username String

Return value

Type Description
String

createRegistrationToken

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
String retVal = adminApi.createRegistrationToken(username);
retVal = baseAPI.doAdmin_CreateRegistrationToken(username);

Entitlement: /admin/main

Creates registration token and emails it to the user

Function Parameters

Parameter Type Description
username String

Return value

Type Description
String

cancelPasswordResetToken

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.cancelPasswordResetToken(username);
retVal = baseAPI.doAdmin_CancelPasswordResetToken(username);

Entitlement: /admin/main

Cancels password reset token

Function Parameters

Parameter Type Description
username String

Return value

Type Description
void

emailUser

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.emailUser(userName, emailTemplate, templateValues);
retVal = baseAPI.doAdmin_EmailUser(userName, emailTemplate, templateValues);

Entitlement: /admin/main

Emails user

Function Parameters

Parameter Type Description
userName String
emailTemplate String
templateValues Map

Return value

Type Description
void

updateUserEmail

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.updateUserEmail(userName, newEmail);
retVal = baseAPI.doAdmin_UpdateUserEmail(userName, newEmail);

Entitlement: /admin/main

This method updates user email.

Function Parameters

Parameter Type Description
userName String
newEmail String

Return value

Type Description
void

addTemplate

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.addTemplate(name, template, overwrite);
retVal = baseAPI.doAdmin_AddTemplate(name, template, overwrite);

Entitlement: /admin/main

This function adds a template to the Rapture system. A template is a simple way of registering predefined configs that can be used to automatically generate configs for repositories, queues, and the like. Templates use the popular StringTemplate library for merging values into a text template.

Function Parameters

Parameter Type Description
name String
template String
overwrite boolean

Return value

Type Description
void

runTemplate

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
String retVal = adminApi.runTemplate(name, parameters);
retVal = baseAPI.doAdmin_RunTemplate(name, parameters);

Entitlement: /admin/main

This method executes a template, replacing parts of the template with the passed parameters to create a new string.

Function Parameters

Parameter Type Description
name String
parameters String

Return value

Type Description
String

getTemplate

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
String retVal = adminApi.getTemplate(name);
retVal = baseAPI.doAdmin_GetTemplate(name);

Entitlement: /admin/main

This method returns the definition of a template.

Function Parameters

Parameter Type Description
name String

Return value

Type Description
String

copyDocumentRepo

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.copyDocumentRepo(srcAuthority, targAuthority, wipe);
retVal = baseAPI.doAdmin_CopyDocumentRepo(srcAuthority, targAuthority, wipe);

Entitlement: /admin/main

Copies the data from one DocumentRepo to another. The target repository is wiped out before hand if 'wipe’ is set to true. The target must already exist when this method is called.

Function Parameters

Parameter Type Description
srcAuthority String
targAuthority String
wipe boolean

Return value

Type Description
void

addIPToWhiteList

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.addIPToWhiteList(ipAddress);
retVal = baseAPI.doAdmin_AddIPToWhiteList(ipAddress);

Entitlement: /admin/main

Use this method to add an IP address to a white list of allowed IP addresses that can log in to this Rapture environment. Once set only IP addresses in this ipAddress list can access Rapture. By default there are no whitelist IP addresses defined which actually means that all IP addresses are allowed.

Function Parameters

Parameter Type Description
ipAddress String

Return value

Type Description
void

removeIPFromWhiteList

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.removeIPFromWhiteList(ipAddress);
retVal = baseAPI.doAdmin_RemoveIPFromWhiteList(ipAddress);

Entitlement: /admin/main

Use this method to remove an IP address from a white list

Function Parameters

Parameter Type Description
ipAddress String

Return value

Type Description
void

getIPWhiteList

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
List<String> retVal = adminApi.getIPWhiteList();
retVal = baseAPI.doAdmin_GetIPWhiteList();

Entitlement: /admin/main

Use this method to return the IP white list

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getAllUsers

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
List<RaptureUser> retVal = adminApi.getAllUsers();
retVal = baseAPI.doAdmin_GetAllUsers();

Entitlement: /admin/main

This method retrieves all of the registered users in the system

Function Parameters

This function takes no parameters.

Return value

Type Description
List

initiateTypeConversion

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.initiateTypeConversion(raptureURI, newConfig, versionsToKeep);
retVal = baseAPI.doAdmin_InitiateTypeConversion(raptureURI, newConfig, versionsToKeep);

Entitlement: /admin/main

This method kicks off a process that will migrate a DocumentRepo to an alternate config. A temporary type will be created with the new config,the old type will be locked for modifications and then all of the documents in the existing type will be copied to the new type, with the metadata intact.Optionally a number of historical versions will be kept if the source repository (and target) support it. Once all of the data has been copied the configattached to each type will be swapped and the type released for access. The temporary type will then be dropped.

Function Parameters

Parameter Type Description
raptureURI String
newConfig String
versionsToKeep int

Return value

Type Description
void

putArchiveConfig

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.putArchiveConfig(raptureURI, config);
retVal = baseAPI.doAdmin_PutArchiveConfig(raptureURI, config);

Entitlement: /admin/main

Set the archive config for a type

Function Parameters

Parameter Type Description
raptureURI String
config TypeArchiveConfig

Return value

Type Description
void

TypeArchiveConfig

The config used when archiving the data in a type.

Field Type
authority String
typeName String
useScript Boolean
scriptName String
versionsToKeep Long
timeRangeToKeepInDays Long

getArchiveConfig

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
TypeArchiveConfig retVal = adminApi.getArchiveConfig(raptureURI);
retVal = baseAPI.doAdmin_GetArchiveConfig(raptureURI);

Entitlement: /admin/main

Retrieve the archive config for a authority

Function Parameters

Parameter Type Description
raptureURI String

Return value

Type Description
TypeArchiveConfig

TypeArchiveConfig

The config used when archiving the data in a type.

Field Type
authority String
typeName String
useScript Boolean
scriptName String
versionsToKeep Long
timeRangeToKeepInDays Long

deleteArchiveConfig

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.deleteArchiveConfig(raptureURI);
retVal = baseAPI.doAdmin_DeleteArchiveConfig(raptureURI);

Entitlement: /admin/main

Delete the archive config for a authority

Function Parameters

Parameter Type Description
raptureURI String

Return value

Type Description
void

ping

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
boolean retVal = adminApi.ping();
retVal = baseAPI.doAdmin_Ping();

Entitlement: /admin/main

A general purpose function that tests (or refreshes) the api connection to Rapture with no side effects.

Function Parameters

This function takes no parameters.

Return value

Type Description
boolean

addMetadata

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.addMetadata(values, overwrite);
retVal = baseAPI.doAdmin_AddMetadata(values, overwrite);

Entitlement: /admin/main

This function adds values to the metadata field of the CallingContext. It’s used to hold values specific to this connection. Since it’s set by the caller the values cannot be considered entirely trusted, and private or secure data such as passwords shouldn’t be stored in here. If overwrite is false and an entry already exists then an exception should be thrown

Function Parameters

Parameter Type Description
values Map
overwrite boolean

Return value

Type Description
void

setMOTD

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.setMOTD(message);
retVal = baseAPI.doAdmin_SetMOTD(message);

Entitlement: /admin/main

Set the MOTD (message of the day) for this environment. Setting to a zero length string implies that there is no message of the day

Function Parameters

Parameter Type Description
message String

Return value

Type Description
void

getMOTD

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
String retVal = adminApi.getMOTD();
retVal = baseAPI.doAdmin_GetMOTD();

Entitlement: /everyone

Retrieve the MOTD

Function Parameters

This function takes no parameters.

Return value

Type Description
String

setEnvironmentName

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.setEnvironmentName(name);
retVal = baseAPI.doAdmin_SetEnvironmentName(name);

Entitlement: /admin/main

Set the name of this environment

Function Parameters

Parameter Type Description
name String

Return value

Type Description
void

setEnvironmentProperties

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
void retVal = adminApi.setEnvironmentProperties(properties);
retVal = baseAPI.doAdmin_SetEnvironmentProperties(properties);

Entitlement: /admin/main

Set the properties of this environment. Usually for displaying then name (e.g. BANNER_COLOR)

Function Parameters

Parameter Type Description
properties Map

Return value

Type Description
void

getEnvironmentName

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
String retVal = adminApi.getEnvironmentName();
retVal = baseAPI.doAdmin_GetEnvironmentName();

Entitlement: /admin/main

Get the name of this environment

Function Parameters

This function takes no parameters.

Return value

Type Description
String

getEnvironmentProperties

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
Map<String,String> retVal = adminApi.getEnvironmentProperties();
retVal = baseAPI.doAdmin_GetEnvironmentProperties();

Entitlement: /admin/main

Get the properties of this environment

Function Parameters

This function takes no parameters.

Return value

Type Description
Map

encode

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
String retVal = adminApi.encode(toEncode);
retVal = baseAPI.doAdmin_Encode(toEncode);

Entitlement: /admin/main

Encode a String using the default encoding mechanism

Function Parameters

Parameter Type Description
toEncode String

Return value

Type Description
String

createURI

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
String retVal = adminApi.createURI(path, leaf);
retVal = baseAPI.doAdmin_CreateURI(path, leaf);

Entitlement: /admin/main

Create a URI with proper encoding given a path and a leaf. Normal URI characters such as : or / in the path will not be encoded

Function Parameters

Parameter Type Description
path String
leaf String

Return value

Type Description
String

createMultipartURI

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
String retVal = adminApi.createMultipartURI(elements);
retVal = baseAPI.doAdmin_CreateMultipartURI(elements);

Entitlement: /admin/main

Create a URI with proper encoding given a list of elements. The return value will begin with // Each element will be encoded (including all punctuation characters) and the elements joined together separated by /

Function Parameters

Parameter Type Description
elements List

Return value

Type Description
String

decode

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
String retVal = adminApi.decode(encoded);
retVal = baseAPI.doAdmin_Decode(encoded);

Entitlement: /admin/main

Decode the supplied String according to the URI encoding/decoding rules

Function Parameters

Parameter Type Description
encoded String

Return value

Type Description
String

findGroupNamesByUser

HttpAdminApi adminApi = new HttpAdminApi(loginApi);
List<String> retVal = adminApi.findGroupNamesByUser(username);
retVal = baseAPI.doAdmin_FindGroupNamesByUser(username);

Entitlement: /admin/main

Find the groups for a given user and return just the names

Function Parameters

Parameter Type Description
username String

Return value

Type Description
List

Async API

The Async API works closely with the Pipeline API - it puts tasks onto the Pipeline for future execution. The most often used call is one where a Reflex script is scheduled for execution, using the asyncReflex* calls.

asyncReflexScript

HttpAsyncApi asyncApi = new HttpAsyncApi(loginApi);
String retVal = asyncApi.asyncReflexScript(reflexScript, parameters);
retVal = baseAPI.doAsync_AsyncReflexScript(reflexScript, parameters);

Entitlement: /async/reflex

Run a passed script in an asynchronous manner. Tells Rapture to run the script as part of a predefined internal workflow, and returns workOrderURI that can be used in other calls to retrieve the status. The second parameter is the set of parameters that will be passed to the script upon execution.

Function Parameters

Parameter Type Description
reflexScript String
parameters Map

Return value

Type Description
String

asyncReflexReference

HttpAsyncApi asyncApi = new HttpAsyncApi(loginApi);
String retVal = asyncApi.asyncReflexReference(scriptURI, parameters);
retVal = baseAPI.doAsync_AsyncReflexReference(scriptURI, parameters);

Entitlement: /async/reflex

Run a script that has already been loaded onto Rapture in an asynchronous manner. The script is named through its uri. As with asyncReflexScript, the parameters passed in the last parameter to this function are passed to the script upon invocation, and the return value from this function is a workOrderURI that can be used to determine the ultimate status of this WorkOrder.

Function Parameters

Parameter Type Description
scriptURI String
parameters Map

Return value

Type Description
String

asyncStatus

HttpAsyncApi asyncApi = new HttpAsyncApi(loginApi);
WorkOrderStatus retVal = asyncApi.asyncStatus(taskId);
retVal = baseAPI.doAsync_AsyncStatus(taskId);

Entitlement: /admin/main

Retrieve the status of a given async task. Will return null if the task id is not known to the environment.

Function Parameters

Parameter Type Description
taskId String

Return value

Type Description
WorkOrderStatus

WorkOrderStatus

The status of a work order.

Field Type
workerOutput Map
status WorkOrderExecutionState

setupDefaultWorkflows

HttpAsyncApi asyncApi = new HttpAsyncApi(loginApi);
void retVal = asyncApi.setupDefaultWorkflows(force);
retVal = baseAPI.doAsync_SetupDefaultWorkflows(force);

Entitlement: /admin/async

Sets up workflows needed to run any of these scripts. Should be called by Rapture internally on init

Function Parameters

Parameter Type Description
force boolean

Return value

Type Description
void

Audit API

The Audit API provides a way to create special logs that contain permanent records of activity in a Rapture system. Internally Rapture uses a system audit log for recording important events that take place in a Rapture environment. Users (or applications) can create their own custom audit logs for the same purpose.

The API provides a way of creating and removing these logs, along with a simple way of recording log entries. A final API call gives the caller the ability to retrieve log entries.

setup

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
void retVal = auditApi.setup(force);
retVal = baseAPI.doAudit_Setup(force);

Entitlement: /audit/admin

Sets up anything needed for audit to run properly. This should be called from the _startup.rfx script. This call is used internally by Rapture on startup, and is normally called only for debugging purposes.

Function Parameters

Parameter Type Description
force boolean

Return value

Type Description
void

createAuditLog

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
void retVal = auditApi.createAuditLog(name, config);
retVal = baseAPI.doAudit_CreateAuditLog(name, config);

Entitlement: /audit/admin

This method creates a new audit log, given a name and a config string. The config string defines the implementation to be used to store the audit entries.

Function Parameters

Parameter Type Description
name String
config String

Return value

Type Description
void

doesAuditLogExist

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
boolean retVal = auditApi.doesAuditLogExist(logURI);
retVal = baseAPI.doAudit_DoesAuditLogExist(logURI);

Entitlement: /audit/main

This method checks whether an audit log exists at the specified URI. The log must have been created using createAuditLog.

Function Parameters

Parameter Type Description
logURI String

Return value

Type Description
boolean

getChildren

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
List<RaptureFolderInfo> retVal = auditApi.getChildren(prefix);
retVal = baseAPI.doAudit_GetChildren(prefix);

Entitlement: /audit/main

This method searches for audit logs whose name follows the pattern prefix/anything_else/under/here, where prefix is the argument that is passed in.

Function Parameters

Parameter Type Description
prefix String

Return value

Type Description
List

deleteAuditLog

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
void retVal = auditApi.deleteAuditLog(logURI);
retVal = baseAPI.doAudit_DeleteAuditLog(logURI);

Entitlement: /audit/admin

This method removes a previously created audit log.

Function Parameters

Parameter Type Description
logURI String

Return value

Type Description
void

getAuditLog

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
AuditLogConfig retVal = auditApi.getAuditLog(logURI);
retVal = baseAPI.doAudit_GetAuditLog(logURI);

Entitlement: /audit/admin

This method retrieves the config information for a previously created audit log.

Function Parameters

Parameter Type Description
logURI String

Return value

Type Description
AuditLogConfig

AuditLogConfig

Stores the config information for an audit log.

Field Type
name String
config String

writeAuditEntry

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
void retVal = auditApi.writeAuditEntry(logURI, category, level, message);
retVal = baseAPI.doAudit_WriteAuditEntry(logURI, category, level, message);

Entitlement: /audit/admin

This method writes an audit entry to the audit log specified by the URI parameter.

Function Parameters

Parameter Type Description
logURI String
category String
level int
message String

Return value

Type Description
void

writeAuditEntryData

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
void retVal = auditApi.writeAuditEntryData(logURI, category, level, message, data);
retVal = baseAPI.doAudit_WriteAuditEntryData(logURI, category, level, message, data);

Entitlement: /audit/admin

This method writes an audit entry to an audit log.

Function Parameters

Parameter Type Description
logURI String
category String
level int
message String
data Map

Return value

Type Description
void

getRecentLogEntries

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
List<AuditLogEntry> retVal = auditApi.getRecentLogEntries(logURI, count);
retVal = baseAPI.doAudit_GetRecentLogEntries(logURI, count);

Entitlement: /audit/admin

This method retrieves previously registered log entries, given a maximum number of entries to return.

Function Parameters

Parameter Type Description
logURI String
count int

Return value

Type Description
List

getEntriesSince

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
List<AuditLogEntry> retVal = auditApi.getEntriesSince(logURI, when);
retVal = baseAPI.doAudit_GetEntriesSince(logURI, when);

Entitlement: /audit/main

This method retrieves any entries since a given entry was retrieved. The date of this audit entry is used to determine the start point of the query.

Function Parameters

Parameter Type Description
logURI String
when AuditLogEntry

Return value

Type Description
List

AuditLogEntry

Defines an audit result to be logged.

Field Type
category String
entryId String
level int
logId String
message String
source String
user String
when Date

getRecentUserActivity

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
List<AuditLogEntry> retVal = auditApi.getRecentUserActivity(user, count);
retVal = baseAPI.doAudit_GetRecentUserActivity(user, count);

Entitlement: /audit/admin

This method retrieves all of the recent API call activity (including login) performed by a user, given a maximum number of entries to return. A ‘count’ argument of less than 0 will return everything available.

Function Parameters

Parameter Type Description
user String
count int

Return value

Type Description
List

Blob API

The Blob api is used to manipulate large opaque objects that have names (displaynames) like other data but do not have any insight to be gained from their contents from within Rapture. The RESTful API can be used to efficiently download a blob as a stream (or upload it)

createBlobRepo

HttpBlobApi blobApi = new HttpBlobApi(loginApi);
void retVal = blobApi.createBlobRepo(blobRepoUri, config, metaConfig);
retVal = baseAPI.doBlob_CreateBlobRepo(blobRepoUri, config, metaConfig);

Entitlement: /repo/write

Creates a repository for unstructured data.

Function Parameters

Parameter Type Description
blobRepoUri String
config String
metaConfig String

Return value

Type Description
void

getBlobRepoConfig

HttpBlobApi blobApi = new HttpBlobApi(loginApi);
BlobRepoConfig retVal = blobApi.getBlobRepoConfig(blobRepoUri);
retVal = baseAPI.doBlob_GetBlobRepoConfig(blobRepoUri);

Entitlement: /repo/read

Retrieves blob repository information

Function Parameters

Parameter Type Description
blobRepoUri String

Return value

Type Description
BlobRepoConfig

BlobRepoConfig

Defines a BlobRepository.

Field Type
description String
config String
authority String
metaConfig String

getBlobRepoConfigs

HttpBlobApi blobApi = new HttpBlobApi(loginApi);
List<BlobRepoConfig> retVal = blobApi.getBlobRepoConfigs();
retVal = baseAPI.doBlob_GetBlobRepoConfigs();

Entitlement: /repo/read

Retrieves a collection of objects that contain the configuration information for all the defined blob repositories.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

deleteBlobRepo

HttpBlobApi blobApi = new HttpBlobApi(loginApi);
void retVal = blobApi.deleteBlobRepo(repoUri);
retVal = baseAPI.doBlob_DeleteBlobRepo(repoUri);

Entitlement: /repo/write

This method removes a blob Repository and its data from the Rapture system. There is no undo.

Function Parameters

Parameter Type Description
repoUri String

Return value

Type Description
void

blobRepoExists

HttpBlobApi blobApi = new HttpBlobApi(loginApi);
boolean retVal = blobApi.blobRepoExists(repoUri);
retVal = baseAPI.doBlob_BlobRepoExists(repoUri);

Entitlement: /repo/list

This api call can be used to determine whether a given repo exists.

Function Parameters

Parameter Type Description
repoUri String

Return value

Type Description
boolean

blobExists

HttpBlobApi blobApi = new HttpBlobApi(loginApi);
boolean retVal = blobApi.blobExists(blobUri);
retVal = baseAPI.doBlob_BlobExists(blobUri);

Entitlement: /data/list/$f(blobUri)

This api call can be used to determine whether a given blob exists.

Function Parameters

Parameter Type Description
blobUri String

Return value

Type Description
boolean

addBlobContent

HttpBlobApi blobApi = new HttpBlobApi(loginApi);
void retVal = blobApi.addBlobContent(blobUri, content);
retVal = baseAPI.doBlob_AddBlobContent(blobUri, content);

Entitlement: /data/write/$f(blobUri)

Appends to a blob.

Function Parameters

Parameter Type Description
blobUri String
content byte[]

Return value

Type Description
void

putBlob

HttpBlobApi blobApi = new HttpBlobApi(loginApi);
void retVal = blobApi.putBlob(blobUri, content, contentType);
retVal = baseAPI.doBlob_PutBlob(blobUri, content, contentType);

Entitlement: /data/write/$f(blobUri)

Stores a blob in one hit, assuming a String representation. If append, adds to any content already existing

Function Parameters

Parameter Type Description
blobUri String
content byte[]
contentType String

Return value

Type Description
void

getBlob

HttpBlobApi blobApi = new HttpBlobApi(loginApi);
BlobContainer retVal = blobApi.getBlob(blobUri);
retVal = baseAPI.doBlob_GetBlob(blobUri);

Entitlement: /data/read/$f(blobUri)

Retrieves a blob and its metadata. The blob is represented as a byte array.

Function Parameters

Parameter Type Description
blobUri String

Return value

Type Description
BlobContainer

BlobContainer

Describes a blob repository.

Field Type
headers Map(String, String)
content ByteArray

deleteBlob

HttpBlobApi blobApi = new HttpBlobApi(loginApi);
void retVal = blobApi.deleteBlob(blobUri);
retVal = baseAPI.doBlob_DeleteBlob(blobUri);

Entitlement: /data/write/$f(blobUri)

Removes a blob from the backing store. There is no undo.

Function Parameters

Parameter Type Description
blobUri String

Return value

Type Description
void

getBlobSize

HttpBlobApi blobApi = new HttpBlobApi(loginApi);
Long retVal = blobApi.getBlobSize(blobUri);
retVal = baseAPI.doBlob_GetBlobSize(blobUri);

Entitlement: /data/list/$f(blobUri)

Retrieves the number of bytes in a blob.

Function Parameters

Parameter Type Description
blobUri String

Return value

Type Description
Long

putBlobMetaData

HttpBlobApi blobApi = new HttpBlobApi(loginApi);
void retVal = blobApi.putBlobMetaData(blobUri, metadata);
retVal = baseAPI.doBlob_PutBlobMetaData(blobUri, metadata);

Entitlement: /data/write/$f(blobUri)

Store metadata associated with a blob

Function Parameters

Parameter Type Description
blobUri String
metadata Map

Return value

Type Description
void

getBlobMetaData

HttpBlobApi blobApi = new HttpBlobApi(loginApi);
Map<String,String> retVal = blobApi.getBlobMetaData(blobUri);
retVal = baseAPI.doBlob_GetBlobMetaData(blobUri);

Entitlement: /data/list/$f(blobUri)

Retrieves all metadata associated with a blob.

Function Parameters

Parameter Type Description
blobUri String

Return value

Type Description
Map

listBlobsByUriPrefix

HttpBlobApi blobApi = new HttpBlobApi(loginApi);
Map<String,RaptureFolderInfo> retVal = blobApi.listBlobsByUriPrefix(blobUri, depth);
retVal = baseAPI.doBlob_ListBlobsByUriPrefix(blobUri, depth);

Entitlement: /data/list/$f(blobUri)

Returns full pathnames for an entire subtree as a map of the path to RFI.

Function Parameters

Parameter Type Description
blobUri String
depth int

Return value

Type Description
Map

deleteBlobsByUriPrefix

HttpBlobApi blobApi = new HttpBlobApi(loginApi);
List<String> retVal = blobApi.deleteBlobsByUriPrefix(blobUri);
retVal = baseAPI.doBlob_DeleteBlobsByUriPrefix(blobUri);

Entitlement: /data/write/$f(blobUri)

Removes a folder and its contents recursively, including empty subfolders. Validates entitlement on individual blobs and folders. Returns a list of the blobs and folders removed.

Function Parameters

Parameter Type Description
blobUri String

Return value

Type Description
List

Bootstrap API

The Bootstrap API is used to setup an initial Rapture environment and to migrate existing bootstrap repositories to a new repository format.

setEmphemeralRepo

HttpBootstrapApi bootstrapApi = new HttpBootstrapApi(loginApi);
void retVal = bootstrapApi.setEmphemeralRepo(config);
retVal = baseAPI.doBootstrap_SetEmphemeralRepo(config);

Entitlement: /admin/bootstrap

The ephemeral repository is used to store information that does not need to survive a restart of Rapture. It normally holds information such as sessions, and its config is usually based around a shared non-versioned memory model

Function Parameters

Parameter Type Description
config String

Return value

Type Description
void

setConfigRepo

HttpBootstrapApi bootstrapApi = new HttpBootstrapApi(loginApi);
void retVal = bootstrapApi.setConfigRepo(config);
retVal = baseAPI.doBootstrap_SetConfigRepo(config);

Entitlement: /admin/bootstrap

The config repository is used to store general config information about entities in Rapture. These entities include users, types, indices, queues and the like.

Function Parameters

Parameter Type Description
config String

Return value

Type Description
void

setSettingsRepo

HttpBootstrapApi bootstrapApi = new HttpBootstrapApi(loginApi);
void retVal = bootstrapApi.setSettingsRepo(config);
retVal = baseAPI.doBootstrap_SetSettingsRepo(config);

Entitlement: /void/bootstrap

The settings repository is used to store general low level settings in Rapture.

Function Parameters

Parameter Type Description
config String

Return value

Type Description
void

migrateConfigRepo

HttpBootstrapApi bootstrapApi = new HttpBootstrapApi(loginApi);
void retVal = bootstrapApi.migrateConfigRepo(newConfig);
retVal = baseAPI.doBootstrap_MigrateConfigRepo(newConfig);

Entitlement: /admin/bootstrap

This method is used to migrate the top level Config repository to a new config. This task takes place in the background, and once completed the config repository is switched to the new config. Any changes to config up to this point may be lost.

Function Parameters

Parameter Type Description
newConfig String

Return value

Type Description
void

migrateEphemeralRepo

HttpBootstrapApi bootstrapApi = new HttpBootstrapApi(loginApi);
void retVal = bootstrapApi.migrateEphemeralRepo(newConfig);
retVal = baseAPI.doBootstrap_MigrateEphemeralRepo(newConfig);

Entitlement: /admin/bootstrap

This method is used to migrate the top level Ephemeral repository to a new config. This task takes place in the background, and once completed the config repository is switched to the new config. Any changes to config up to this point may be lost.

Function Parameters

Parameter Type Description
newConfig String

Return value

Type Description
void

migrateSettingsRepo

HttpBootstrapApi bootstrapApi = new HttpBootstrapApi(loginApi);
void retVal = bootstrapApi.migrateSettingsRepo(newConfig);
retVal = baseAPI.doBootstrap_MigrateSettingsRepo(newConfig);

Entitlement: /admin/bootstrap

This method is used to migrate the top level Settings repository to a new config. This task takes place in the background, and once completed the config repository is switched to the new config. Any changes to config up to this point may be lost.

Function Parameters

Parameter Type Description
newConfig String

Return value

Type Description
void

getConfigRepo

HttpBootstrapApi bootstrapApi = new HttpBootstrapApi(loginApi);
String retVal = bootstrapApi.getConfigRepo();
retVal = baseAPI.doBootstrap_GetConfigRepo();

Entitlement: /admin/main

Retrieve the current settings of the config repository.

Function Parameters

This function takes no parameters.

Return value

Type Description
String

getSettingsRepo

HttpBootstrapApi bootstrapApi = new HttpBootstrapApi(loginApi);
String retVal = bootstrapApi.getSettingsRepo();
retVal = baseAPI.doBootstrap_GetSettingsRepo();

Entitlement: /admin/main

Retrieve the current settings of the settings repository.

Function Parameters

This function takes no parameters.

Return value

Type Description
String

getEphemeralRepo

HttpBootstrapApi bootstrapApi = new HttpBootstrapApi(loginApi);
String retVal = bootstrapApi.getEphemeralRepo();
retVal = baseAPI.doBootstrap_GetEphemeralRepo();

Entitlement: /admin/main

Retrieve the current settings of the ephemeral repository.

Function Parameters

This function takes no parameters.

Return value

Type Description
String

restartBootstrap

HttpBootstrapApi bootstrapApi = new HttpBootstrapApi(loginApi);
void retVal = bootstrapApi.restartBootstrap();
retVal = baseAPI.doBootstrap_RestartBootstrap();

Entitlement: /admin/bootstrap

After changing the definition of any bootstrap repository, Rapture will need to be restarted. This method will restart Rapture.

Function Parameters

This function takes no parameters.

Return value

Type Description
void

addScriptClass

HttpBootstrapApi bootstrapApi = new HttpBootstrapApi(loginApi);
void retVal = bootstrapApi.addScriptClass(keyword, className);
retVal = baseAPI.doBootstrap_AddScriptClass(keyword, className);

Entitlement: /admin/bootstrap

All scripts that are run by Rapture are passed a set of helper instances that can be used by the script. The helpers are locked to the entitlement context of the calling user. This method sets the name of such a class in this context. It is primarily an internal function, defined during startup, as the class provided must be accessible by the main Rapture application.

Function Parameters

Parameter Type Description
keyword String
className String

Return value

Type Description
void

getScriptClasses

HttpBootstrapApi bootstrapApi = new HttpBootstrapApi(loginApi);
Map<String,String> retVal = bootstrapApi.getScriptClasses();
retVal = baseAPI.doBootstrap_GetScriptClasses();

Entitlement: /admin/bootstrap

This method retrieves previous defined script classes for this system

Function Parameters

This function takes no parameters.

Return value

Type Description
Map

deleteScriptClass

HttpBootstrapApi bootstrapApi = new HttpBootstrapApi(loginApi);
boolean retVal = bootstrapApi.deleteScriptClass(keyword);
retVal = baseAPI.doBootstrap_DeleteScriptClass(keyword);

Entitlement: /admin/bootstrap

This method removes a previously defined script class.

Function Parameters

Parameter Type Description
keyword String

Return value

Type Description
boolean

Decision API

The Decision Process api is used to manage and control decision processes and decision packets.

getAllWorkflows

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
List<Workflow> retVal = decisionApi.getAllWorkflows();
retVal = baseAPI.doDecision_GetAllWorkflows();

Entitlement: /decision/read

Returns all workflow definitions

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getWorkflowChildren

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
List<RaptureFolderInfo> retVal = decisionApi.getWorkflowChildren(workflowURI);
retVal = baseAPI.doDecision_GetWorkflowChildren(workflowURI);

Entitlement: /decision/read

Returns a list of full display names of the paths below this one. Ideally optimized depending on the repo.

Function Parameters

Parameter Type Description
workflowURI String

Return value

Type Description
List

getWorkOrderChildren

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
List<RaptureFolderInfo> retVal = decisionApi.getWorkOrderChildren(parentPath);
retVal = baseAPI.doDecision_GetWorkOrderChildren(parentPath);

Entitlement: /decision/read

Return a list of full display names of the paths below this one. Ideally optimized depending on the repo.

Function Parameters

Parameter Type Description
parentPath String

Return value

Type Description
List

putWorkflow

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
void retVal = decisionApi.putWorkflow(workflow);
retVal = baseAPI.doDecision_PutWorkflow(workflow);

Entitlement: /decision/write

Create or update a workflow to contain only the specified nodes and transitions.

Function Parameters

Parameter Type Description
workflow Workflow

Return value

Type Description
void

Workflow

Defines a workflow. Each workflow is a flowchart of WorkflowSteps and Transitions.

Field Type
workflowURI WorkflowURI
semaphoreType SemaphoreType
semaphoreConfig String
description String
steps List
startStep String
category String
view Map
expectedArguments List
jarUriDependencies List
useParentFirstClassLoader Boolean
defaultAppStatusNamePattern String

getWorkflow

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
Workflow retVal = decisionApi.getWorkflow(workflowURI);
retVal = baseAPI.doDecision_GetWorkflow(workflowURI);

Entitlement: /decision/read/$f(workflowURI)

Returns a workflow definition, or null if not found.

Function Parameters

Parameter Type Description
workflowURI String

Return value

Type Description
Workflow

Workflow

Defines a workflow. Each workflow is a flowchart of WorkflowSteps and Transitions.

Field Type
workflowURI WorkflowURI
semaphoreType SemaphoreType
semaphoreConfig String
description String
steps List
startStep String
category String
view Map
expectedArguments List
jarUriDependencies List
useParentFirstClassLoader Boolean
defaultAppStatusNamePattern String

getWorkflowStep

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
Step retVal = decisionApi.getWorkflowStep(stepURI);
retVal = baseAPI.doDecision_GetWorkflowStep(stepURI);

Entitlement: /decision/read/$f(stepURI)

Returns a step definition, or null if not found

Function Parameters

Parameter Type Description
stepURI String

Return value

Type Description
Step

Step

An executable step with config data.

Field Type
name String
description String
executable String
view Map
transitions List
categoryOverride String
softTimeout Integer
jarUriDependencies List

getStepCategory

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
String retVal = decisionApi.getStepCategory(stepURI);
retVal = baseAPI.doDecision_GetStepCategory(stepURI);

Entitlement: /decision/read/$f(stepURI)

Gets the category associated with a step. This is the step’s own categoryOverride, if present, or otherwise the category associated with the entire workflow.

Function Parameters

Parameter Type Description
stepURI String

Return value

Type Description
String

addStep

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
void retVal = decisionApi.addStep(workflowURI, step);
retVal = baseAPI.doDecision_AddStep(workflowURI, step);

Entitlement: /decision/write/$f(workflowURI)

Adds a new step to an existing workflow initially containing the specified transitions

Function Parameters

Parameter Type Description
workflowURI String
step Step

Return value

Type Description
void

Step

An executable step with config data.

Field Type
name String
description String
executable String
view Map
transitions List
categoryOverride String
softTimeout Integer
jarUriDependencies List

removeStep

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
void retVal = decisionApi.removeStep(workflowURI, stepName);
retVal = baseAPI.doDecision_RemoveStep(workflowURI, stepName);

Entitlement: /decision/write/$f(workflowURI)

Removes a step from a workflow.

Function Parameters

Parameter Type Description
workflowURI String
stepName String

Return value

Type Description
void

addTransition

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
void retVal = decisionApi.addTransition(workflowURI, stepName, transition);
retVal = baseAPI.doDecision_AddTransition(workflowURI, stepName, transition);

Entitlement: /decision/write/$f(workflowURI)

Adds a new Transition to a workflow.

Function Parameters

Parameter Type Description
workflowURI String
stepName String
transition Transition

Return value

Type Description
void

Transition

Points to the next step in a given sequence.

Field Type
name String
targetStep String

removeTransition

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
void retVal = decisionApi.removeTransition(workflowURI, stepName, transitionName);
retVal = baseAPI.doDecision_RemoveTransition(workflowURI, stepName, transitionName);

Entitlement: /decision/write/$f(workflowURI)

Removes a transition from a workflow.

Function Parameters

Parameter Type Description
workflowURI String
stepName String
transitionName String

Return value

Type Description
void

deleteWorkflow

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
void retVal = decisionApi.deleteWorkflow(workflowURI);
retVal = baseAPI.doDecision_DeleteWorkflow(workflowURI);

Entitlement: /decision/write/$f(workflowURI)

Deletes a workflow.

Function Parameters

Parameter Type Description
workflowURI String

Return value

Type Description
void

createWorkOrder

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
String retVal = decisionApi.createWorkOrder(workflowURI, argsMap);
retVal = baseAPI.doDecision_CreateWorkOrder(workflowURI, argsMap);

Entitlement: /decision/execute/$f(workflowURI)

Creates and executes a workflow.If there is a defaultAppStatusUriPattern set for this Workflow then it will be used for the appstatus URI.Otherwise, no appstatus will be created.TODO make workOrderURI format align with permission checks.

Function Parameters

Parameter Type Description
workflowURI String
argsMap Map

Return value

Type Description
String

createWorkOrderP

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
CreateResponse retVal = decisionApi.createWorkOrderP(workflowURI, argsMap, appStatusUriPattern);
retVal = baseAPI.doDecision_CreateWorkOrderP(workflowURI, argsMap, appStatusUriPattern);

Entitlement: /decision/execute/$f(workflowURI)

Creates and executes a workflow. Same as createWorkOrder, but the appStatusUriPattern is passed as an explicit argument instead of using the default appStatusUriPattern (if one has been set).Note that the app status allows the Workflow and its output to be accessed via the web interface; workflows without an app status are not accessible in this way.

Function Parameters

Parameter Type Description
workflowURI String
argsMap Map
appStatusUriPattern String

Return value

Type Description
CreateResponse

CreateResponse

An object returned by public API calls that create things. If the object was created, the URI is returned. Otherwise, the message contains the reason the object was not created.

Field Type
isCreated Boolean
uri RaptureURI
message String

releaseWorkOrderLock

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
void retVal = decisionApi.releaseWorkOrderLock(workOrderURI);
retVal = baseAPI.doDecision_ReleaseWorkOrderLock(workOrderURI);

Entitlement: /decision/admin

Releases the lock associated with this WorkOrder. This method should only be used by admins, in case therewas an unexpected problem that caused a WorkOrder to finish or die without releasing the lock.

Function Parameters

Parameter Type Description
workOrderURI String

Return value

Type Description
void

getWorkOrderStatus

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
WorkOrderStatus retVal = decisionApi.getWorkOrderStatus(workOrderURI);
retVal = baseAPI.doDecision_GetWorkOrderStatus(workOrderURI);

Entitlement: /decision/read/$f(workOrderURI)

Gets the status of a workOrder

Function Parameters

Parameter Type Description
workOrderURI String

Return value

Type Description
WorkOrderStatus

WorkOrderStatus

The status of a work order.

Field Type
workerOutput Map
status WorkOrderExecutionState

writeWorkflowAuditEntry

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
void retVal = decisionApi.writeWorkflowAuditEntry(workOrderURI, message, error);
retVal = baseAPI.doDecision_WriteWorkflowAuditEntry(workOrderURI, message, error);

Entitlement: /decision/write/$f(workOrderURI)

Writes an audit entry related to a workOrder. Messages may be INFO or ERROR based on the boolean fourth parameter

Function Parameters

Parameter Type Description
workOrderURI String
message String
error boolean

Return value

Type Description
void

getWorkOrdersByDay

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
List<WorkOrder> retVal = decisionApi.getWorkOrdersByDay(startTimeInstant);
retVal = baseAPI.doDecision_GetWorkOrdersByDay(startTimeInstant);

Entitlement: /decision/read

Gets the WorkOrder objects starting on a given day. Orders that carried over from the previous day are not included.

Function Parameters

Parameter Type Description
startTimeInstant Long

Return value

Type Description
List

getWorkOrdersByWorkflow

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
List<String> retVal = decisionApi.getWorkOrdersByWorkflow(startTimeInstant, workflowUri);
retVal = baseAPI.doDecision_GetWorkOrdersByWorkflow(startTimeInstant, workflowUri);

Entitlement: /decision/read

Gets all the workorder URIs associated with the given workflow uri, from a starting point given in Unix epoch time. Passing in 0 or null as the start time will get all workorders from the beginning of time.

Function Parameters

Parameter Type Description
startTimeInstant Long
workflowUri String

Return value

Type Description
List

getWorkOrderStatusesByWorkflow

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
Map<String,List<String>> retVal = decisionApi.getWorkOrderStatusesByWorkflow(startTimeInstant, workflowUri);
retVal = baseAPI.doDecision_GetWorkOrderStatusesByWorkflow(startTimeInstant, workflowUri);

Entitlement: /decision/read

Gets all the workorder URIs associated with the given workflow uri grouped by their status, from a starting point given in Unix epoch time. Passing in 0 or null as the start time will get all workorders from the beginning of time. This returns the workorders grouped by their WorkOrder status, for example, ACTIVE, FINISHED.

Function Parameters

Parameter Type Description
startTimeInstant Long
workflowUri String

Return value

Type Description
Map>

getWorkOrderByJobExec

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
WorkOrder retVal = decisionApi.getWorkOrderByJobExec(raptureJobExec);
retVal = baseAPI.doDecision_GetWorkOrderByJobExec(raptureJobExec);

Entitlement: /decision/read

Get the WorkOrder object associated with the given RaptureJobExec object

Function Parameters

Parameter Type Description
raptureJobExec RaptureJobExec

Return value

Type Description
WorkOrder

RaptureJobExec

Contains info about an active or queued job.

Field Type
jobURI JobURI
jobType JobType
status JobExecStatus
execTime Long
passedParams Map
execDetails String

WorkOrder

Each time a Workflow is executed, the execution is identified by a matching WorkOrder. A WorkOrderURI may be qualified with an id (index) of a particular Worker, e.g. workorder://myProj/myFlow#0

Field Type
workOrderURI WorkOrderURI
workflowURI WorkflowURI
workerIds List
outputs Map
pendingIds List
priority Integer
startTime Long
endTime Long
semaphoreType SemaphoreType
semaphoreConfig String
status WorkOrderExecutionState

getJobExecsAndWorkOrdersByDay

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
Map<RaptureJobExec,WorkOrder> retVal = decisionApi.getJobExecsAndWorkOrdersByDay(startTimeInstant);
retVal = baseAPI.doDecision_GetJobExecsAndWorkOrdersByDay(startTimeInstant);

Entitlement: /decision/read

Get a map of RaptureJobExec objects to their associated WorkOrder objects for a given day

Function Parameters

Parameter Type Description
startTimeInstant Long

Return value

Type Description
Map

getWorkOrder

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
WorkOrder retVal = decisionApi.getWorkOrder(workOrderURI);
retVal = baseAPI.doDecision_GetWorkOrder(workOrderURI);

Entitlement: /decision/read/$f(workOrderURI)

Gets the top-level status object associated with the work order

Function Parameters

Parameter Type Description
workOrderURI String

Return value

Type Description
WorkOrder

WorkOrder

Each time a Workflow is executed, the execution is identified by a matching WorkOrder. A WorkOrderURI may be qualified with an id (index) of a particular Worker, e.g. workorder://myProj/myFlow#0

Field Type
workOrderURI WorkOrderURI
workflowURI WorkflowURI
workerIds List
outputs Map
pendingIds List
priority Integer
startTime Long
endTime Long
semaphoreType SemaphoreType
semaphoreConfig String
status WorkOrderExecutionState

getWorker

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
Worker retVal = decisionApi.getWorker(workOrderURI, workerId);
retVal = baseAPI.doDecision_GetWorker(workOrderURI, workerId);

Entitlement: /decision/read/$f(workOrderURI)

Get the worker

Function Parameters

Parameter Type Description
workOrderURI String
workerId String

Return value

Type Description
Worker

Worker

Workers keep track of progress when executing a work order. Each worker handles one thread of execution.

Field Type
workOrderURI WorkOrderURI
id String
viewOverlay Map
stack List
localView List>
stepExecutionRecords List
stepRecords List
status WorkerExecutionState
detail String
effectiveUser String
priority Integer
callingContext CallingContext
activityId String
appStatusNameStack List
parent String
siblingCount Integer
siblingPosition Integer
waitCount Integer
exceptionInfo ErrorWrapper
myActivityId String

cancelWorkOrder

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
void retVal = decisionApi.cancelWorkOrder(workOrderURI);
retVal = baseAPI.doDecision_CancelWorkOrder(workOrderURI);

Entitlement: /decision/write/$f(workOrderURI)

Requests cancellation of a work order. This method returns immediately once the cancellation is recorded, but the individual workers may continue for some time before stopping, depending on the type of step being executed.

Function Parameters

Parameter Type Description
workOrderURI String

Return value

Type Description
void

resumeWorkOrder

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
CreateResponse retVal = decisionApi.resumeWorkOrder(workOrderURI, resumeStepURI);
retVal = baseAPI.doDecision_ResumeWorkOrder(workOrderURI, resumeStepURI);

Entitlement: /decision/write/$f(workOrderURI)

Resume work order

Function Parameters

Parameter Type Description
workOrderURI String
resumeStepURI String

Return value

Type Description
CreateResponse

CreateResponse

An object returned by public API calls that create things. If the object was created, the URI is returned. Otherwise, the message contains the reason the object was not created.

Field Type
isCreated Boolean
uri RaptureURI
message String

wasCancelCalled

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
boolean retVal = decisionApi.wasCancelCalled(workOrderURI);
retVal = baseAPI.doDecision_WasCancelCalled(workOrderURI);

Entitlement: /decision/read/$f(workOrderURI)

Returns true if CancelWorkOrder was called.

Function Parameters

Parameter Type Description
workOrderURI String

Return value

Type Description
boolean

getCancellationDetails

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
WorkOrderCancellation retVal = decisionApi.getCancellationDetails(workOrderURI);
retVal = baseAPI.doDecision_GetCancellationDetails(workOrderURI);

Entitlement: /decision/read/$f(workOrderURI)

Gets details for the cancellation for a workOrder – or null if not cancelled.

Function Parameters

Parameter Type Description
workOrderURI String

Return value

Type Description
WorkOrderCancellation

WorkOrderCancellation

A request to cancel a work order.

Field Type
workOrderURI WorkOrderURI
time Long

getWorkOrderDebug

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
WorkOrderDebug retVal = decisionApi.getWorkOrderDebug(workOrderURI);
retVal = baseAPI.doDecision_GetWorkOrderDebug(workOrderURI);

Entitlement: /decision/debug/$f(workOrderURI)

Gets the detailed context information for a work order in progress

Function Parameters

Parameter Type Description
workOrderURI String

Return value

Type Description
WorkOrderDebug

WorkOrderDebug

Contains extra information about a work order, useful mainly for debugging.

Field Type
order WorkOrder
workerDebugs List
passedArguments List
context ExecutionContext
logURI String
argsHashValue String
parentJobURI String

setWorkOrderIdGenConfig

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
void retVal = decisionApi.setWorkOrderIdGenConfig(config, force);
retVal = baseAPI.doDecision_SetWorkOrderIdGenConfig(config, force);

Entitlement: /decision/admin

Defines the IdGen config for work order items.

Function Parameters

Parameter Type Description
config String
force boolean

Return value

Type Description
void

setContextLiteral

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
void retVal = decisionApi.setContextLiteral(workerURI, varAlias, literalValue);
retVal = baseAPI.doDecision_SetContextLiteral(workerURI, varAlias, literalValue);

Entitlement: /decision/write

Sets a literal in the context. The literal value that is stored will be returned after a read.The workerURI is a workOrderURI with the element set to the worker ID.

Function Parameters

Parameter Type Description
workerURI String
varAlias String
literalValue String

Return value

Type Description
void
HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
void retVal = decisionApi.setContextLink(workerURI, varAlias, expressionValue);
retVal = baseAPI.doDecision_SetContextLink(workerURI, varAlias, expressionValue);

Entitlement: /decision/write

Set a link in the context. Links take the form !uri#element where uri refers to a document and element is a key within the document.A call to GetContextValue returns the value associated with the key in the document at that moment.This means that whatever is stored will be evaluated before being returned, so it must be a valid expression.The workerURI is a workOrderURI with the element set to the worker id

Function Parameters

Parameter Type Description
workerURI String
varAlias String
expressionValue String

Return value

Type Description
void

setContextTemplate

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
void retVal = decisionApi.setContextTemplate(workerURI, varAlias, templateValue);
retVal = baseAPI.doDecision_SetContextTemplate(workerURI, varAlias, templateValue);

Entitlement: /decision/write

Set a template in the context. Templates take the form %string A call to GetContextValue returns the string with any ocurrances of ${VALUE} expanded to their context values.This is done recursively, so ${VALUE} can refer to links and templates.The workerURI is a workOrderURI with the element set to the worker id

Function Parameters

Parameter Type Description
workerURI String
varAlias String
templateValue String

Return value

Type Description
void

getContextValue

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
String retVal = decisionApi.getContextValue(workerURI, varAlias);
retVal = baseAPI.doDecision_GetContextValue(workerURI, varAlias);

Entitlement: /decision/read

Gets a value in the context, as json. The workerURI is a workOrderURI with the element set to the worker id.

Function Parameters

Parameter Type Description
workerURI String
varAlias String

Return value

Type Description
String

addErrorToContext

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
void retVal = decisionApi.addErrorToContext(workerURI, errorWrapper);
retVal = baseAPI.doDecision_AddErrorToContext(workerURI, errorWrapper);

Entitlement: /decision/write

Adds an error to the context of a particular worker. The workerURI is a workOrderURI with the element set to the worker id

Function Parameters

Parameter Type Description
workerURI String
errorWrapper ErrorWrapper

Return value

Type Description
void

ErrorWrapper

Contains information associated with an error captured by the Rapture system.

Field Type
id String
status Integer
message String
stackTrace String

getErrorsFromContext

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
List<ErrorWrapper> retVal = decisionApi.getErrorsFromContext(workerURI);
retVal = baseAPI.doDecision_GetErrorsFromContext(workerURI);

Entitlement: /decision/read

Gets the errors from the context for a given worker. The workerURI is a workOrderURI with the element set to the worker id.

Function Parameters

Parameter Type Description
workerURI String

Return value

Type Description
List

getExceptionInfo

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
List<ErrorWrapper> retVal = decisionApi.getExceptionInfo(workOrderURI);
retVal = baseAPI.doDecision_GetExceptionInfo(workOrderURI);

Entitlement: /decision/read

Get info about any exception(s) thrown during execution of this workorder

Function Parameters

Parameter Type Description
workOrderURI String

Return value

Type Description
List

reportStepProgress

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
void retVal = decisionApi.reportStepProgress(workerURI, stepStartTime, message, progress, max);
retVal = baseAPI.doDecision_ReportStepProgress(workerURI, stepStartTime, message, progress, max);

Entitlement: /decision/read

Report status of the step - workerURI: the uri of this WorkOrder with the element set to the worker ID - stepStartTime: the time when the step being reported started - message: a human-friendly message to display - progress: how many units are currently complete - max: how many units in total would mark this as done

Function Parameters

Parameter Type Description
workerURI String
stepStartTime Long
message String
progress Long
max Long

Return value

Type Description
void

getAppStatuses

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
List<AppStatus> retVal = decisionApi.getAppStatuses(prefix);
retVal = baseAPI.doDecision_GetAppStatuses(prefix);

Entitlement: /decision/read

Gets app statuses by prefix.

Function Parameters

Parameter Type Description
prefix String

Return value

Type Description
List

getAppStatusDetails

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
List<AppStatusDetails> retVal = decisionApi.getAppStatusDetails(prefix, extraContextValues);
retVal = baseAPI.doDecision_GetAppStatusDetails(prefix, extraContextValues);

Entitlement: /decision/read

Gets detailed app status info by prefix. Also returns any context values requested in the second argument.

Function Parameters

Parameter Type Description
prefix String
extraContextValues List

Return value

Type Description
List

getMonthlyMetrics

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
WorkflowHistoricalMetrics retVal = decisionApi.getMonthlyMetrics(workflowURI, jobURI, argsHashValue, state);
retVal = baseAPI.doDecision_GetMonthlyMetrics(workflowURI, jobURI, argsHashValue, state);

Entitlement: /decision/read

Get any defined average runtimes for the past month for a workflow

Function Parameters

Parameter Type Description
workflowURI String
jobURI String
argsHashValue String
state String

Return value

Type Description
WorkflowHistoricalMetrics

WorkflowHistoricalMetrics

Workflow historical metrics

Field Type
workflowAverage Double
jobAverage Double
workflowWithArgsAverage Double
workflowMetricName String
jobMetricName String
argsHashMetricName String

queryLogs

HttpDecisionApi decisionApi = new HttpDecisionApi(loginApi);
LogQueryResponse retVal = decisionApi.queryLogs(workOrderURI, startTime, endTime, keepAlive, bufferSize, nextBatchId, stepName, stepStartTime);
retVal = baseAPI.doDecision_QueryLogs(workOrderURI, startTime, endTime, keepAlive, bufferSize, nextBatchId, stepName, stepStartTime);

Entitlement: /decision/read

Get log messages for a workflow. Note: logs get deleted after a certain number of days, so this only retrieves any log messages that are within theconfigured log retention period. If the retention period is before the startTime, an empty response is returned.workOrderURI: requiredstartTime: requiredendTime: requiredkeepAlive: required, milliseconds to keep alive the batch, max 30000bufferSize: required, max 100nextBatchId: optional, if null start from beginningstepName: optionalstepStartTime: optional, this is a timestamp in a string because of a limitation in Rapture where int or long arguments cannot be null

Function Parameters

Parameter Type Description
workOrderURI String
startTime Long
endTime Long
keepAlive Long
bufferSize Long
nextBatchId String
stepName String
stepStartTime String

Return value

Type Description
LogQueryResponse

LogQueryResponse

A response to a query on log messages

Field Type
isLast Boolean
nextBatchId String
messages List

Doc API

The Document api is used for manipulating document objects in Rapture. Documents are normally stored in JSON format.

validateDocRepo

HttpDocApi docApi = new HttpDocApi(loginApi);
boolean retVal = docApi.validateDocRepo(docRepoUri);
retVal = baseAPI.doDoc_ValidateDocRepo(docRepoUri);

Entitlement: /repo/write

Validates repository; requires write permission because it can cause files/tables to be created on first use.

Function Parameters

Parameter Type Description
docRepoUri String

Return value

Type Description
boolean

createDocRepo

HttpDocApi docApi = new HttpDocApi(loginApi);
void retVal = docApi.createDocRepo(docRepoUri, config);
retVal = baseAPI.doDoc_CreateDocRepo(docRepoUri, config);

Entitlement: /repo/write

A DocumentRepository is used to store JSON docs. This method creates and configures the repository for an authority.

Function Parameters

Parameter Type Description
docRepoUri String
config String

Return value

Type Description
void

docRepoExists

HttpDocApi docApi = new HttpDocApi(loginApi);
boolean retVal = docApi.docRepoExists(docRepoUri);
retVal = baseAPI.doDoc_DocRepoExists(docRepoUri);

Entitlement: /repo/list

This API call can be used to determine whether a given repository exists.

Function Parameters

Parameter Type Description
docRepoUri String

Return value

Type Description
boolean

docExists

HttpDocApi docApi = new HttpDocApi(loginApi);
boolean retVal = docApi.docExists(docUri);
retVal = baseAPI.doDoc_DocExists(docUri);

Entitlement: /repo/list

This api call can be used to determine whether a given type exists in a given authority.

Function Parameters

Parameter Type Description
docUri String

Return value

Type Description
boolean

getDocRepoConfig

HttpDocApi docApi = new HttpDocApi(loginApi);
DocumentRepoConfig retVal = docApi.getDocRepoConfig(docRepoUri);
retVal = baseAPI.doDoc_GetDocRepoConfig(docRepoUri);

Entitlement: /repo/read

Retrieves the configuration string for the given document repository.

Function Parameters

Parameter Type Description
docRepoUri String

Return value

Type Description
DocumentRepoConfig

DocumentRepoConfig

Describes config info for a repository that stores Rapture documents.

Field Type
description String
config String
authority String
idGenUri IdGenURI
strictCheck Boolean
indexes Set
fullTextIndexes Set
updateQueue String
documentRepo RaptureDocConfig
deleted Boolean

getDocRepoStatus

HttpDocApi docApi = new HttpDocApi(loginApi);
Map<String,String> retVal = docApi.getDocRepoStatus(docRepoUri);
retVal = baseAPI.doDoc_GetDocRepoStatus(docRepoUri);

Entitlement: /repo/read

Gets any available information about a repository.

Function Parameters

Parameter Type Description
docRepoUri String

Return value

Type Description
Map

getDocRepoConfigs

HttpDocApi docApi = new HttpDocApi(loginApi);
List<DocumentRepoConfig> retVal = docApi.getDocRepoConfigs();
retVal = baseAPI.doDoc_GetDocRepoConfigs();

Entitlement: /repo/read

Retrieves document repositories

Function Parameters

This function takes no parameters.

Return value

Type Description
List

deleteDocRepo

HttpDocApi docApi = new HttpDocApi(loginApi);
void retVal = docApi.deleteDocRepo(docRepoUri);
retVal = baseAPI.doDoc_DeleteDocRepo(docRepoUri);

Entitlement: /repo/write

This method removes a documentRepository and its data from the Rapture system. There is no undo.

Function Parameters

Parameter Type Description
docRepoUri String

Return value

Type Description
void

archiveRepoDocs

HttpDocApi docApi = new HttpDocApi(loginApi);
void retVal = docApi.archiveRepoDocs(docRepoUri, versionLimit, timeLimit, ensureVersionLimit);
retVal = baseAPI.doDoc_ArchiveRepoDocs(docRepoUri, versionLimit, timeLimit, ensureVersionLimit);

Entitlement: /repo/write

This method archives older versions of a documentRepository.

Function Parameters

Parameter Type Description
docRepoUri String
versionLimit int
timeLimit long
ensureVersionLimit boolean

Return value

Type Description
void

getDocAndMeta

HttpDocApi docApi = new HttpDocApi(loginApi);
DocumentWithMeta retVal = docApi.getDocAndMeta(docUri);
retVal = baseAPI.doDoc_GetDocAndMeta(docUri);

Entitlement: /data/read/$f(docUri)

Retrieves the content and the meta data associated with a document, including version and user information. If the storagedoes not support metadata, this method returns a dummy object.

Function Parameters

Parameter Type Description
docUri String

Return value

Type Description
DocumentWithMeta

DocumentWithMeta

Contains a Rapture document and its metadata.

Field Type
displayName String
metaData DocumentMetadata
content String

getDocMeta

HttpDocApi docApi = new HttpDocApi(loginApi);
DocumentMetadata retVal = docApi.getDocMeta(docUri);
retVal = baseAPI.doDoc_GetDocMeta(docUri);

Entitlement: /data/list/$f(docUri)

Retrieves only the meta data associated with a document, including version and user information. If the storage does notsupport metadata, this method returns a dummy object.

Function Parameters

Parameter Type Description
docUri String

Return value

Type Description
DocumentMetadata

DocumentMetadata

Contains the metadata, if any, in a Rapture document.

Field Type
version Integer
writeTime Date
createdTimestamp Long
modifiedTimestamp Long
user String
comment String
deleted Boolean
tags Map
semanticUri String

revertDoc

HttpDocApi docApi = new HttpDocApi(loginApi);
DocumentWithMeta retVal = docApi.revertDoc(docUri);
retVal = baseAPI.doDoc_RevertDoc(docUri);

Entitlement: /data/write/$f(docUri)

Reverts this document back to the previous version by taking the previous version and making a new version.

Function Parameters

Parameter Type Description
docUri String

Return value

Type Description
DocumentWithMeta

DocumentWithMeta

Contains a Rapture document and its metadata.

Field Type
displayName String
metaData DocumentMetadata
content String

getDoc


    CallingContext ctx = ContextFactory.getKernelUser();
    String docUri = "document://myrepo/mydoc";
    // setup our json content
    String jsonContent = "{ \"key\" : \"value\" }";
    // put a document first
    assertEquals(docUri, api.putDoc(ctx, docUri, jsonContent));
    // now get the same document out
    assertEquals(jsonContent, api.getDoc(ctx, docUri));
    // attempt to get a document that does not exist, should return null
    assertNull(api.getDoc(ctx, "document://unknown/doesntexist"));

retVal = baseAPI.doDoc_GetDoc(docUri);

Entitlement: /data/read/$f(docUri)

Retrieves the content of a document.

Function Parameters

Parameter Type Description
docUri String a string of characters used to identify a document

Return value

Type Description
String

putDoc

HttpDocApi docApi = new HttpDocApi(loginApi);
String retVal = docApi.putDoc(docUri, content);
retVal = baseAPI.doDoc_PutDoc(docUri, content);

since version 1.0.0

Entitlement: /data/write/$f(docUri)

Stores a document in the Rapture system.

Function Parameters

Parameter Type Description
docUri String a string of characters used to identify a document
content String the information to be stored within the document

Return value

Type Description
String

putDocWithVersion

HttpDocApi docApi = new HttpDocApi(loginApi);
boolean retVal = docApi.putDocWithVersion(docUri, content, currentVersion);
retVal = baseAPI.doDoc_PutDocWithVersion(docUri, content, currentVersion);

Entitlement: /data/write/$f(docUri)

Attempts to put the content into the repository, but fails if the repository supports versioning and the current version ofthe document stored does not match the version passed. A version of zero implies that the document should not exist. The purposeof this call is for a client to be able to call getDocAndMeta to retrieve an existing document, modify it, and save the contentback, using the version number in the metadata of the document. If another client has modified the data since it was loaded, thiscall will return false, indicating that the save was not possible.

Function Parameters

Parameter Type Description
docUri String
content String
currentVersion int

Return value

Type Description
boolean

putDocWithEventContext

HttpDocApi docApi = new HttpDocApi(loginApi);
DocWriteHandle retVal = docApi.putDocWithEventContext(docUri, content, eventContext);
retVal = baseAPI.doDoc_PutDocWithEventContext(docUri, content, eventContext);

Entitlement: /data/write/$f(docUri)

Store a document in the Rapture system, passing in an event context to be added to any events spawned off by this put. Parts ofthe uri could be automatically generated

Function Parameters

Parameter Type Description
docUri String
content String
eventContext Map

Return value

Type Description
DocWriteHandle A DocWriteHandle object that contains a value on whether the write was successful, the uri of the document that was written, and a handle to the event uri that was fired, if any

DocWriteHandle

This is a write handle returned after a write (update, delete, insert) operation to a document. It contains information about the document

Field Type
isSuccess Boolean
documentURI RaptureURI
eventHandle RunEventHandle

deleteDoc

HttpDocApi docApi = new HttpDocApi(loginApi);
boolean retVal = docApi.deleteDoc(docUri);
retVal = baseAPI.doDoc_DeleteDoc(docUri);

Entitlement: /data/write/$f(docUri)

Removes a document attribute. Can be used to remove all attributes for a given type as well if the key argument is null.

Function Parameters

Parameter Type Description
docUri String

Return value

Type Description
boolean

renameDoc

HttpDocApi docApi = new HttpDocApi(loginApi);
String retVal = docApi.renameDoc(fromDocUri, toDocUri);
retVal = baseAPI.doDoc_RenameDoc(fromDocUri, toDocUri);

Entitlement: /data/write/$f(fromDocUri)

Renames a document, by getting and putting it on the system without transferring the data back to the client.

Function Parameters

Parameter Type Description
fromDocUri String
toDocUri String

Return value

Type Description
String

getDocs

HttpDocApi docApi = new HttpDocApi(loginApi);
Map<String,String> retVal = docApi.getDocs(docUris);
retVal = baseAPI.doDoc_GetDocs(docUris);

Entitlement: /data/batch

Returns a map of contents where the key is the normalized input Uri and the value is the document retrieved

Function Parameters

Parameter Type Description
docUris List

Return value

Type Description
Map

getDocAndMetas

HttpDocApi docApi = new HttpDocApi(loginApi);
List<DocumentWithMeta> retVal = docApi.getDocAndMetas(docUris);
retVal = baseAPI.doDoc_GetDocAndMetas(docUris);

Entitlement: /data/batch

Returns a list of documents and their associated meta data - the meta data includes version and user information

Function Parameters

Parameter Type Description
docUris List

Return value

Type Description
List

docsExist

HttpDocApi docApi = new HttpDocApi(loginApi);
List<boolean> retVal = docApi.docsExist(docUris);
retVal = baseAPI.doDoc_DocsExist(docUris);

Entitlement: /data/batch

Returns a list of true/false statements on whether the listed Uris refer to a valid document. Note: a folder is not considered tobe a document.

Function Parameters

Parameter Type Description
docUris List

Return value

Type Description
List

putDocs

HttpDocApi docApi = new HttpDocApi(loginApi);
List<Object> retVal = docApi.putDocs(docUris, contents);
retVal = baseAPI.doDoc_PutDocs(docUris, contents);

Entitlement: /data/batch

Put a series of documents in a batch form. Refer to putDoc for details.

Function Parameters

Parameter Type Description
docUris List
contents List

Return value

Type Description
List

renameDocs

HttpDocApi docApi = new HttpDocApi(loginApi);
List<String> retVal = docApi.renameDocs(authority, comment, fromDocUris, toDocUris);
retVal = baseAPI.doDoc_RenameDocs(authority, comment, fromDocUris, toDocUris);

Entitlement: /data/batch

Renames a series of documents in batch form. See renameDoc.

Function Parameters

Parameter Type Description
authority String
comment String
fromDocUris List
toDocUris List

Return value

Type Description
List

deleteDocsByUriPrefix

HttpDocApi docApi = new HttpDocApi(loginApi);
List<String> retVal = docApi.deleteDocsByUriPrefix(docUri);
retVal = baseAPI.doDoc_DeleteDocsByUriPrefix(docUri);

Entitlement: /data/write/$f(docUri)

Removes a folder and its contents recursively, including empty subfolders. Validates entitlement on individual docs and folders. Returns a list of the documents and folders removed.

Function Parameters

Parameter Type Description
docUri String

Return value

Type Description
List

listDocsByUriPrefix

HttpDocApi docApi = new HttpDocApi(loginApi);
Map<String,RaptureFolderInfo> retVal = docApi.listDocsByUriPrefix(docUri, depth);
retVal = baseAPI.doDoc_ListDocsByUriPrefix(docUri, depth);

Entitlement: /data/read/$f(docUri)

Returns a list of Uris of all documents and folders below this point, mapping the Uri to a RaptureFolderInfo object

Function Parameters

Parameter Type Description
docUri String
depth int

Return value

Type Description
Map

setDocAttribute

HttpDocApi docApi = new HttpDocApi(loginApi);
boolean retVal = docApi.setDocAttribute(attributeUri, value);
retVal = baseAPI.doDoc_SetDocAttribute(attributeUri, value);

Entitlement: /data/write/$f(attributeUri)

Adds a single attribute to an existing document.

Function Parameters

Parameter Type Description
attributeUri String
value String

Return value

Type Description
boolean

setDocAttributes

HttpDocApi docApi = new HttpDocApi(loginApi);
Map<String,boolean> retVal = docApi.setDocAttributes(attributeUri, keys, values);
retVal = baseAPI.doDoc_SetDocAttributes(attributeUri, keys, values);

Entitlement: /data/write/$f(attributeUri)

Adds attributes to an existing document in key/value pairs.

Function Parameters

Parameter Type Description
attributeUri String
keys List
values List

Return value

Type Description
Map

getDocAttribute

HttpDocApi docApi = new HttpDocApi(loginApi);
XferDocumentAttribute retVal = docApi.getDocAttribute(attributeUri);
retVal = baseAPI.doDoc_GetDocAttribute(attributeUri);

Entitlement: /data/read/$f(attributeUri)

Get a single attribute for the given uri, attributeType, and key e.g. displayName/$attributeType/key

Function Parameters

Parameter Type Description
attributeUri String

Return value

Type Description
XferDocumentAttribute

XferDocumentAttribute

Holds a key/value pair for an attribute of a document object.

Field Type
attributeType String
key String
value String

getDocAttributes

HttpDocApi docApi = new HttpDocApi(loginApi);
List<XferDocumentAttribute> retVal = docApi.getDocAttributes(attributeUri);
retVal = baseAPI.doDoc_GetDocAttributes(attributeUri);

Entitlement: /data/read/$f(attributeUri)

Gets all known attributes for the given uri e.g. displayName/$attributeType

Function Parameters

Parameter Type Description
attributeUri String

Return value

Type Description
List

deleteDocAttribute

HttpDocApi docApi = new HttpDocApi(loginApi);
boolean retVal = docApi.deleteDocAttribute(attributeUri);
retVal = baseAPI.doDoc_DeleteDocAttribute(attributeUri);

Entitlement: /data/write/$f(attributeUri)

Removes a document attribute. Can be used to remove all attributes for a given type as well if key argument is null.

Function Parameters

Parameter Type Description
attributeUri String

Return value

Type Description
boolean

getDocRepoIdGenUri

HttpDocApi docApi = new HttpDocApi(loginApi);
String retVal = docApi.getDocRepoIdGenUri(docRepoUri);
retVal = baseAPI.doDoc_GetDocRepoIdGenUri(docRepoUri);

Entitlement: /admin/idgen

Returns the Uri that’s associated with the idgen that belongs to this document repository. Note that every repository has aidgen Uri, even if no idgen is attached to it.

Function Parameters

Parameter Type Description
docRepoUri String

Return value

Type Description
String

setDocRepoIdGenConfig

HttpDocApi docApi = new HttpDocApi(loginApi);
DocumentRepoConfig retVal = docApi.setDocRepoIdGenConfig(docRepoUri, idGenConfig);
retVal = baseAPI.doDoc_SetDocRepoIdGenConfig(docRepoUri, idGenConfig);

Entitlement: /admin/idgen

This method creates a idgen and attaches it to a document repository. This way, when a document containing an autoid stringis created that autoid will be replaced with a unique id.

Function Parameters

Parameter Type Description
docRepoUri String
idGenConfig String

Return value

Type Description
DocumentRepoConfig

DocumentRepoConfig

Describes config info for a repository that stores Rapture documents.

Field Type
description String
config String
authority String
idGenUri IdGenURI
strictCheck Boolean
indexes Set
fullTextIndexes Set
updateQueue String
documentRepo RaptureDocConfig
deleted Boolean

getDocRepoIdGenConfig

HttpDocApi docApi = new HttpDocApi(loginApi);
RaptureIdGenConfig retVal = docApi.getDocRepoIdGenConfig(docRepoUri);
retVal = baseAPI.doDoc_GetDocRepoIdGenConfig(docRepoUri);

Entitlement: /admin/idgen

This method returns any idgen associated with this doc repo, or null if there isn’t one.

Function Parameters

Parameter Type Description
docRepoUri String

Return value

Type Description
RaptureIdGenConfig

RaptureIdGenConfig

Holds the config info for a idgen as described in the idgen API.

Field Type
name String
config String
authority String

Entitlement API

Entitlements are a very important part of the security of Rapture, and the Entitlement API is the way in which information about these entitlements is updated. The API is of course protected by the same entitlements system, so care must be taken to not remove your own entitlement to this API through the use of this API. Concepts/Terminology User - A user represents a person who is making calls to Rapture or an application that is making calls to Rapture. A user is a single entity with a username/password who needs access to Rapture. Group - A group represents a collection of users. Entitlement - An entitlement is a named permission that has associated with it 0 or more groups. If an entitlement has no groups associated with it, it is essentially open, and any defined user in Rapture can access it. If an entitlement has at least 1 group associated with it, any user wishing to access the resource protected by this entitlement, must be a member of one of the associated groups.

Each API call within Rapture is associated with an entitlement path, and when users wish to execute that API call they are checked to see if they are a member of that entitlement (by seeing which groups they are members of). Some API calls have dynamic entitlements, where the full name of the entitlement is derived from the URI of the object that the method uses. For example, a method that writes a document to a specific URI can use that URI as part of the entitlement.

If an entitlement with the specified name exists, then it is used; otherwise the full entitlement path is truncated one part at a time until an entitlement is found.

getEntitlements

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
List<RaptureEntitlement> retVal = entitlementApi.getEntitlements();
retVal = baseAPI.doEntitlement_GetEntitlements();

Entitlement: /admin/ent

This method is used to retrieve all of the entitlements defined in Rapture.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getEntitlement

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
RaptureEntitlement retVal = entitlementApi.getEntitlement(entitlementName);
retVal = baseAPI.doEntitlement_GetEntitlement(entitlementName);

Entitlement: /admin/ent

Retrieves a single entitlement, or null if not found.

Function Parameters

Parameter Type Description
entitlementName String

Return value

Type Description
RaptureEntitlement

RaptureEntitlement

The base object used by the entitlements API.

Field Type
name String
entType EntitlementType
groups Set

getEntitlementByAddress

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
RaptureEntitlement retVal = entitlementApi.getEntitlementByAddress(entitlementURI);
retVal = baseAPI.doEntitlement_GetEntitlementByAddress(entitlementURI);

Entitlement: /admin/ent

Retrieves a single entitlement by using its URI.

Function Parameters

Parameter Type Description
entitlementURI String

Return value

Type Description
RaptureEntitlement

RaptureEntitlement

The base object used by the entitlements API.

Field Type
name String
entType EntitlementType
groups Set

getEntitlementGroup

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
RaptureEntitlementGroup retVal = entitlementApi.getEntitlementGroup(groupName);
retVal = baseAPI.doEntitlement_GetEntitlementGroup(groupName);

Entitlement: /admin/ent

Retrieves a single entitlement group.

Function Parameters

Parameter Type Description
groupName String

Return value

Type Description
RaptureEntitlementGroup

RaptureEntitlementGroup

A named collection of users who share any entitlements assigned to the group, as long as they remain members of the group.

Field Type
name String
users Set
dynamicEntitlementClassName String

getEntitlementGroupByAddress

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
RaptureEntitlementGroup retVal = entitlementApi.getEntitlementGroupByAddress(groupURI);
retVal = baseAPI.doEntitlement_GetEntitlementGroupByAddress(groupURI);

Entitlement: /admin/ent

Retrieves a single entitlement group from its URI.

Function Parameters

Parameter Type Description
groupURI String

Return value

Type Description
RaptureEntitlementGroup

RaptureEntitlementGroup

A named collection of users who share any entitlements assigned to the group, as long as they remain members of the group.

Field Type
name String
users Set
dynamicEntitlementClassName String

getEntitlementGroups

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
List<RaptureEntitlementGroup> retVal = entitlementApi.getEntitlementGroups();
retVal = baseAPI.doEntitlement_GetEntitlementGroups();

Entitlement: /admin/ent

This method returns all of the entitlement groups defined in the Rapture environment.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

addEntitlement

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
RaptureEntitlement retVal = entitlementApi.addEntitlement(entitlementName, initialGroup);
retVal = baseAPI.doEntitlement_AddEntitlement(entitlementName, initialGroup);

Entitlement: /admin/ent

This method adds a new entitlement, specifying an initial group that should be assigned to this entitlement. The reason for assigning an initial group is to prevent lock out.

Function Parameters

Parameter Type Description
entitlementName String
initialGroup String

Return value

Type Description
RaptureEntitlement

RaptureEntitlement

The base object used by the entitlements API.

Field Type
name String
entType EntitlementType
groups Set

addGroupToEntitlement

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
RaptureEntitlement retVal = entitlementApi.addGroupToEntitlement(entitlementName, groupName);
retVal = baseAPI.doEntitlement_AddGroupToEntitlement(entitlementName, groupName);

Entitlement: /admin/ent

This method is used to add an entitlement group to an entitlement.

Function Parameters

Parameter Type Description
entitlementName String
groupName String

Return value

Type Description
RaptureEntitlement

RaptureEntitlement

The base object used by the entitlements API.

Field Type
name String
entType EntitlementType
groups Set

removeGroupFromEntitlement

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
RaptureEntitlement retVal = entitlementApi.removeGroupFromEntitlement(entitlementName, groupName);
retVal = baseAPI.doEntitlement_RemoveGroupFromEntitlement(entitlementName, groupName);

Entitlement: /admin/ent

This method reverses the act of adding a group to an entitlement.

Function Parameters

Parameter Type Description
entitlementName String
groupName String

Return value

Type Description
RaptureEntitlement

RaptureEntitlement

The base object used by the entitlements API.

Field Type
name String
entType EntitlementType
groups Set

deleteEntitlement

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
void retVal = entitlementApi.deleteEntitlement(entitlementName);
retVal = baseAPI.doEntitlement_DeleteEntitlement(entitlementName);

Entitlement: /admin/ent

This method removes an entitlement entirely from the system.

Function Parameters

Parameter Type Description
entitlementName String

Return value

Type Description
void

deleteEntitlementGroup

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
void retVal = entitlementApi.deleteEntitlementGroup(groupName);
retVal = baseAPI.doEntitlement_DeleteEntitlementGroup(groupName);

Entitlement: /admin/ent

This method removes an entitlement group from the system.

Function Parameters

Parameter Type Description
groupName String

Return value

Type Description
void

addEntitlementGroup

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
RaptureEntitlementGroup retVal = entitlementApi.addEntitlementGroup(groupName);
retVal = baseAPI.doEntitlement_AddEntitlementGroup(groupName);

Entitlement: /admin/ent

This method adds a new entitlement group to the system.

Function Parameters

Parameter Type Description
groupName String

Return value

Type Description
RaptureEntitlementGroup

RaptureEntitlementGroup

A named collection of users who share any entitlements assigned to the group, as long as they remain members of the group.

Field Type
name String
users Set
dynamicEntitlementClassName String

addUserToEntitlementGroup

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
RaptureEntitlementGroup retVal = entitlementApi.addUserToEntitlementGroup(groupName, userName);
retVal = baseAPI.doEntitlement_AddUserToEntitlementGroup(groupName, userName);

Entitlement: /admin/ent

This method adds a user to an existing entitlement group. The user will then have all of the privileges (entitlements) associated with that group.

Function Parameters

Parameter Type Description
groupName String
userName String

Return value

Type Description
RaptureEntitlementGroup

RaptureEntitlementGroup

A named collection of users who share any entitlements assigned to the group, as long as they remain members of the group.

Field Type
name String
users Set
dynamicEntitlementClassName String

removeUserFromEntitlementGroup

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
RaptureEntitlementGroup retVal = entitlementApi.removeUserFromEntitlementGroup(groupName, userName);
retVal = baseAPI.doEntitlement_RemoveUserFromEntitlementGroup(groupName, userName);

Entitlement: /admin/ent

This method reverses the act of the adding a user to a group.

Function Parameters

Parameter Type Description
groupName String
userName String

Return value

Type Description
RaptureEntitlementGroup

RaptureEntitlementGroup

A named collection of users who share any entitlements assigned to the group, as long as they remain members of the group.

Field Type
name String
users Set
dynamicEntitlementClassName String

getEntitlementsForUser

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
List<RaptureEntitlement> retVal = entitlementApi.getEntitlementsForUser(username);
retVal = baseAPI.doEntitlement_GetEntitlementsForUser(username);

Entitlement: /admin/ent

Convenience method to get all the entitlements for a user

Function Parameters

Parameter Type Description
username String

Return value

Type Description
List

getEntitlementsForGroup

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
List<RaptureEntitlement> retVal = entitlementApi.getEntitlementsForGroup(groupname);
retVal = baseAPI.doEntitlement_GetEntitlementsForGroup(groupname);

Entitlement: /admin/ent

Convenience method to get all the entitlements for a group

Function Parameters

Parameter Type Description
groupname String

Return value

Type Description
List

getEntitlementsForSelf

HttpEntitlementApi entitlementApi = new HttpEntitlementApi(loginApi);
List<RaptureEntitlement> retVal = entitlementApi.getEntitlementsForSelf();
retVal = baseAPI.doEntitlement_GetEntitlementsForSelf();

Entitlement: /everyone

Convenience method to get all entitlements for the current user

Function Parameters

This function takes no parameters.

Return value

Type Description
List

Entity API

The entity api is used to manage structures that are stored in repositories.

getEntity

HttpEntityApi entityApi = new HttpEntityApi(loginApi);
RaptureEntity retVal = entityApi.getEntity(entityUri);
retVal = baseAPI.doEntity_GetEntity(entityUri);

Entitlement: /entity/read/$f(entityUri)

Retrieve an entity

Function Parameters

Parameter Type Description
entityUri String

Return value

Type Description
RaptureEntity

RaptureEntity

  • A RaptureEntity is a mapping of a structure with a repository*
Field Type
name String
description String
repoUri String
prefixInRepo String
structureUri String
namingFields List
indexFields List
primeIndexField String
viewFields List

putEntity

HttpEntityApi entityApi = new HttpEntityApi(loginApi);
void retVal = entityApi.putEntity(entityUri, entity);
retVal = baseAPI.doEntity_PutEntity(entityUri, entity);

Entitlement: /entity/write/$f(entityUri)

Save an entity

Function Parameters

Parameter Type Description
entityUri String
entity RaptureEntity

Return value

Type Description
void

RaptureEntity

  • A RaptureEntity is a mapping of a structure with a repository*
Field Type
name String
description String
repoUri String
prefixInRepo String
structureUri String
namingFields List
indexFields List
primeIndexField String
viewFields List

deleteEntity

HttpEntityApi entityApi = new HttpEntityApi(loginApi);
void retVal = entityApi.deleteEntity(entityUri);
retVal = baseAPI.doEntity_DeleteEntity(entityUri);

Entitlement: /entity/write/$f(entityUri)

remove an entity

Function Parameters

Parameter Type Description
entityUri String

Return value

Type Description
void

getChildren

HttpEntityApi entityApi = new HttpEntityApi(loginApi);
List<RaptureFolderInfo> retVal = entityApi.getChildren(uriPrefix);
retVal = baseAPI.doEntity_GetChildren(uriPrefix);

Entitlement: /entity/list/$f(uriPrefix)

Returns full pathnames for an entire subtree as a map of the path to RFI.

Function Parameters

Parameter Type Description
uriPrefix String

Return value

Type Description
List

putEntityDocument

HttpEntityApi entityApi = new HttpEntityApi(loginApi);
String retVal = entityApi.putEntityDocument(entityUri, content);
retVal = baseAPI.doEntity_PutEntityDocument(entityUri, content);

Entitlement: /entity/write/$f(entityUri)

Puts a document that is an entity

Function Parameters

Parameter Type Description
entityUri String
content String

Return value

Type Description
String

getEntityDocument

HttpEntityApi entityApi = new HttpEntityApi(loginApi);
String retVal = entityApi.getEntityDocument(entityUri, contentUri);
retVal = baseAPI.doEntity_GetEntityDocument(entityUri, contentUri);

Entitlement: /entity/read/$f(entityUri)

Retrieves a document that is an entity

Function Parameters

Parameter Type Description
entityUri String
contentUri String

Return value

Type Description
String

deleteEntityDocument

HttpEntityApi entityApi = new HttpEntityApi(loginApi);
void retVal = entityApi.deleteEntityDocument(entityUri, contentUri);
retVal = baseAPI.doEntity_DeleteEntityDocument(entityUri, contentUri);

Entitlement: /entity/read/$f(entityUri)

Remove a document that is an entity

Function Parameters

Parameter Type Description
entityUri String
contentUri String

Return value

Type Description
void

listDocsByUriPrefix

HttpEntityApi entityApi = new HttpEntityApi(loginApi);
Map<String,RaptureFolderInfo> retVal = entityApi.listDocsByUriPrefix(entityUri, uriPrefix, depth);
retVal = baseAPI.doEntity_ListDocsByUriPrefix(entityUri, uriPrefix, depth);

Entitlement: /entity/list/$f(uriPrefix)

Returns full pathnames for an entire subtree as a map of the path to RFI.

Function Parameters

Parameter Type Description
entityUri String
uriPrefix String
depth int

Return value

Type Description
Map

createEntityIndex

HttpEntityApi entityApi = new HttpEntityApi(loginApi);
void retVal = entityApi.createEntityIndex(entityUri, replaceIfExist);
retVal = baseAPI.doEntity_CreateEntityIndex(entityUri, replaceIfExist);

Entitlement: /entity/write/$f(entityUri)

Generate index definition for repository that underpins this entity

Function Parameters

Parameter Type Description
entityUri String
replaceIfExist boolean

Return value

Type Description
void

getViewConfiguration

HttpEntityApi entityApi = new HttpEntityApi(loginApi);
List<ViewColumn> retVal = entityApi.getViewConfiguration(entityUri);
retVal = baseAPI.doEntity_GetViewConfiguration(entityUri);

Entitlement: /entity/read/$f(entityUri)

Retrieve view display configuration (columns)

Function Parameters

Parameter Type Description
entityUri String

Return value

Type Description
List

getViewData

HttpEntityApi entityApi = new HttpEntityApi(loginApi);
List<ViewRecord> retVal = entityApi.getViewData(entityUri, where, skip, limit);
retVal = baseAPI.doEntity_GetViewData(entityUri, where, skip, limit);

Entitlement: /entity/read/$f(entityUri)

Retrieve data for an entity view

Function Parameters

Parameter Type Description
entityUri String
where String
skip int
limit int

Return value

Type Description
List

getEntityDocByKey

HttpEntityApi entityApi = new HttpEntityApi(loginApi);
String retVal = entityApi.getEntityDocByKey(entityUri, key);
retVal = baseAPI.doEntity_GetEntityDocByKey(entityUri, key);

Entitlement: /entity/read/$f(entityUri)

Retrieve an entity document given its key. Assumes that the entity has a preferred key index (prime key index)

Function Parameters

Parameter Type Description
entityUri String
key String

Return value

Type Description
String

Environment API

A data center can contain multiple instances of Rapture, such as staging, production, or testing, that are nearly identical. In fact, a single piece of hardware can host multiple instances. In this case we cannot rely on host names or IP addresses to uniquely identify systems. The Environment API generates and assigns UIDs to the Rapture instance and to its component servers. Servers in the same network share the same bootstrap configuration and low level connectivity to data source configuration. Although one topology for a Rapture network is a collection of homogeneous servers sharing the same data and messaging infrastructure, an alternate topology would be a collection of heterogeneous servers connected together through synchronization. A server in this topology is considered an “appliance” - it is essentially a Rapture network with one member. In this configuration the Rapture kernel needs to handle tasks that are normally performed by other servers. Appliance Mode can be enabled or disabled as necessary.

getThisServer

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
RaptureServerInfo retVal = environmentApi.getThisServer();
retVal = baseAPI.doEnvironment_GetThisServer();

Entitlement: /env/common

Retrieves the unique identifier and name for this Rapture server instance.

Function Parameters

This function takes no parameters.

Return value

Type Description
RaptureServerInfo

RaptureServerInfo

Holds information about a server that is running Rapture.

Field Type
serverId String
name String

getServers

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
List<RaptureServerInfo> retVal = environmentApi.getServers();
retVal = baseAPI.doEnvironment_GetServers();

Entitlement: /env/common

Returns a list of the unique identifiers and names for all Rapture servers in the network.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

setThisServer

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
RaptureServerInfo retVal = environmentApi.setThisServer(info);
retVal = baseAPI.doEnvironment_SetThisServer(info);

Entitlement: /env/admin

Sets the passed parameter as information for the current server instance.

Function Parameters

Parameter Type Description
info RaptureServerInfo

Return value

Type Description
RaptureServerInfo

RaptureServerInfo

Holds information about a server that is running Rapture.

Field Type
serverId String
name String

RaptureServerInfo

Holds information about a server that is running Rapture.

Field Type
serverId String
name String

setApplianceMode

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
void retVal = environmentApi.setApplianceMode(mode);
retVal = baseAPI.doEnvironment_SetApplianceMode(mode);

Entitlement: /env/admin

Configures the instance into or out of appliance mode.

Function Parameters

Parameter Type Description
mode boolean

Return value

Type Description
void

getApplianceMode

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
boolean retVal = environmentApi.getApplianceMode();
retVal = baseAPI.doEnvironment_GetApplianceMode();

Entitlement: /env/common

Determines whether the instance is currently in appliance mode.

Function Parameters

This function takes no parameters.

Return value

Type Description
boolean

getServerStatus

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
List<RaptureServerStatus> retVal = environmentApi.getServerStatus();
retVal = baseAPI.doEnvironment_GetServerStatus();

Entitlement: /env/common

Returns the last reported state for each server in the network. This includes a numerical status, a human readable message, and a Date object indicating the time that the status was last updated.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getAppNames

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
List<String> retVal = environmentApi.getAppNames();
retVal = baseAPI.doEnvironment_GetAppNames();

Entitlement: /env/read

Get all known appNames in the Rapture cluster. An appName is unique for an application and is of the format ‘name(at)ip:port’

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getMemoryInfo

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
Map<String,String> retVal = environmentApi.getMemoryInfo(appNames);
retVal = baseAPI.doEnvironment_GetMemoryInfo(appNames);

Entitlement: /env/read

Get the memory information, such as RAM available or heap memory used, for the app names given. Passing in null or an empty list will retrieve information for all known Rapture nodes in the cluster. Returns a map of app identifiers to the associated information in json format.

Function Parameters

Parameter Type Description
appNames List

Return value

Type Description
Map

getOperatingSystemInfo

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
Map<String,String> retVal = environmentApi.getOperatingSystemInfo(appNames);
retVal = baseAPI.doEnvironment_GetOperatingSystemInfo(appNames);

Entitlement: /env/read

Get the operating system information, such as CPUs and Average Load, for the app names given. Passing in null or an empty list will retrieve information for all known Rapture nodes in the cluster. Returns a map of app identifiers to the associated information in json format.

Function Parameters

Parameter Type Description
appNames List

Return value

Type Description
Map

getThreadInfo

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
Map<String,String> retVal = environmentApi.getThreadInfo(appNames);
retVal = baseAPI.doEnvironment_GetThreadInfo(appNames);

Entitlement: /env/read

Get the threading information, such as thread names, thread counts, and thread IDs, for the app names given. Passing in null or an empty list will retrieve information for all known Rapture nodes in the cluster. Returns a map of app identifiers to the associated information in json format.

Function Parameters

Parameter Type Description
appNames List

Return value

Type Description
Map

readByPath

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
Map<String,String> retVal = environmentApi.readByPath(appNames, path);
retVal = baseAPI.doEnvironment_ReadByPath(appNames, path);

Entitlement: /env/read

Performs a read operation for the user-supplied path for the app names given. Passing in null or an empty list will retrieve information for all known Rapture nodes in the cluster. Returns a map of app identifiers to the associated information in json format.

Function Parameters

Parameter Type Description
appNames List
path String

Return value

Type Description
Map

writeByPath

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
Map<String,String> retVal = environmentApi.writeByPath(appNames, path);
retVal = baseAPI.doEnvironment_WriteByPath(appNames, path);

Entitlement: /env/write

Performs a write operation for the user-supplied path for the app names given. Passing in null or an empty list will perform the write for all known Rapture nodes in the cluster. Returns a map of app identifiers to the associated information in json format.

Function Parameters

Parameter Type Description
appNames List
path String

Return value

Type Description
Map

execByPath

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
Map<String,String> retVal = environmentApi.execByPath(appNames, path);
retVal = baseAPI.doEnvironment_ExecByPath(appNames, path);

Entitlement: /env/exec

Performs an exec operation for the user-supplied path for the app names given. Passing in null or an empty list will perform the exec for all known Rapture nodes in the cluster. Returns a map of app identifiers to the associated information in json format.

Function Parameters

Parameter Type Description
appNames List
path String

Return value

Type Description
Map

readByJson

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
Map<String,String> retVal = environmentApi.readByJson(appNames, json);
retVal = baseAPI.doEnvironment_ReadByJson(appNames, json);

Entitlement: /env/read

Performs a read operation for the user-supplied json for the app names given. Passing in null or an empty list will retrieve information for all known Rapture nodes in the cluster. Returns a map of app identifiers to the associated information in json format.

Function Parameters

Parameter Type Description
appNames List
json String

Return value

Type Description
Map

writeByJson

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
Map<String,String> retVal = environmentApi.writeByJson(appNames, json);
retVal = baseAPI.doEnvironment_WriteByJson(appNames, json);

Entitlement: /env/write

Performs a write operation for the user-supplied json for the app names given. Passing in null or an empty list will perform the write for all known Rapture nodes in the cluster. Returns a map of app identifiers to the associated information in json format.

Function Parameters

Parameter Type Description
appNames List
json String

Return value

Type Description
Map

execByJson

HttpEnvironmentApi environmentApi = new HttpEnvironmentApi(loginApi);
Map<String,String> retVal = environmentApi.execByJson(appNames, json);
retVal = baseAPI.doEnvironment_ExecByJson(appNames, json);

Entitlement: /env/exec

Performs an exec operation for the user-supplied json for the app names given. Passing in null or an empty list will perform the exec for all known Rapture nodes in the cluster. Returns a map of app identifiers to the associated information in json format.

Function Parameters

Parameter Type Description
appNames List
json String

Return value

Type Description
Map

Event API

Events are used to coordinate large scale activity in Rapture. The process is relatively simple: a caller assigns any number of scripts to a named event (simply a unique path), and then when the event is fired all attached scripts are scheduled for execution. Some events are internally managed (system events) and other events can be user created and managed.

getEvent

HttpEventApi eventApi = new HttpEventApi(loginApi);
RaptureEvent retVal = eventApi.getEvent(eventUri);
retVal = baseAPI.doEvent_GetEvent(eventUri);

Entitlement: /event/admin

This method is used to retrieve information about an event (primarily the scripts attached to it).

Function Parameters

Parameter Type Description
eventUri String

Return value

Type Description
RaptureEvent

RaptureEvent

Describes the main object used by the Event API.

Field Type
uriFullPath String
scripts Set(RaptureEventScript)
messages Set(RaptureEventMessage)
notifications Set(RaptureEventNotification)
workflows Set(RaptureEventWorkflow)

putEvent

HttpEventApi eventApi = new HttpEventApi(loginApi);
void retVal = eventApi.putEvent(event);
retVal = baseAPI.doEvent_PutEvent(event);

Entitlement: /event/admin

This method puts an event in the system.

Function Parameters

Parameter Type Description
event RaptureEvent

Return value

Type Description
void

RaptureEvent

Describes the main object used by the Event API.

Field Type
uriFullPath String
scripts Set(RaptureEventScript)
messages Set(RaptureEventMessage)
notifications Set(RaptureEventNotification)
workflows Set(RaptureEventWorkflow)

deleteEvent

HttpEventApi eventApi = new HttpEventApi(loginApi);
void retVal = eventApi.deleteEvent(eventUri);
retVal = baseAPI.doEvent_DeleteEvent(eventUri);

Entitlement: /event/admin

This method removes an event (and any attached scripts) from the system. If the event is fired at a later point nothing will happen as there would be no scripts attached.

Function Parameters

Parameter Type Description
eventUri String

Return value

Type Description
void

listEventsByUriPrefix

HttpEventApi eventApi = new HttpEventApi(loginApi);
List<RaptureFolderInfo> retVal = eventApi.listEventsByUriPrefix(eventUriPrefix);
retVal = baseAPI.doEvent_ListEventsByUriPrefix(eventUriPrefix);

Entitlement: /user/get

Return a list of full display names of the paths below this one. Ideally optimized depending on the repo.

Function Parameters

Parameter Type Description
eventUriPrefix String

Return value

Type Description
List

addEventScript

HttpEventApi eventApi = new HttpEventApi(loginApi);
void retVal = eventApi.addEventScript(eventUri, scriptUri, performOnce);
retVal = baseAPI.doEvent_AddEventScript(eventUri, scriptUri, performOnce);

Entitlement: /event/admin

This method is used to attach a script to an event. A final parameter signals whether this script should be detached from the event when it is fired.

Function Parameters

Parameter Type Description
eventUri String
scriptUri String
performOnce boolean

Return value

Type Description
void

deleteEventScript

HttpEventApi eventApi = new HttpEventApi(loginApi);
void retVal = eventApi.deleteEventScript(eventUri, scriptUri);
retVal = baseAPI.doEvent_DeleteEventScript(eventUri, scriptUri);

Entitlement: /event/admin

This method detaches a script from the event.

Function Parameters

Parameter Type Description
eventUri String
scriptUri String

Return value

Type Description
void

addEventMessage

HttpEventApi eventApi = new HttpEventApi(loginApi);
void retVal = eventApi.addEventMessage(eventUri, name, pipeline, params);
retVal = baseAPI.doEvent_AddEventMessage(eventUri, name, pipeline, params);

Entitlement: /event/admin

This method is used to attach a message to an event. When the event is fired a message is sent to the pipeline with content based on the context of the event and parameters passed to this call.

Function Parameters

Parameter Type Description
eventUri String
name String
pipeline String
params Map

Return value

Type Description
void

deleteEventMessage

HttpEventApi eventApi = new HttpEventApi(loginApi);
void retVal = eventApi.deleteEventMessage(eventUri, name);
retVal = baseAPI.doEvent_DeleteEventMessage(eventUri, name);

Entitlement: /event/admin

This method reverses the message attachment, using the same name as passed in the original attachMessage call

Function Parameters

Parameter Type Description
eventUri String
name String

Return value

Type Description
void

addEventNotification

HttpEventApi eventApi = new HttpEventApi(loginApi);
void retVal = eventApi.addEventNotification(eventUri, name, notification, params);
retVal = baseAPI.doEvent_AddEventNotification(eventUri, name, notification, params);

Entitlement: /event/admin

This method is used to attach a notification to an event. When the event is fired a message is sent to the notification with content based on the context of the event and parameters passed to this call.

Function Parameters

Parameter Type Description
eventUri String
name String
notification String
params Map

Return value

Type Description
void

deleteEventNotification

HttpEventApi eventApi = new HttpEventApi(loginApi);
void retVal = eventApi.deleteEventNotification(eventUri, name);
retVal = baseAPI.doEvent_DeleteEventNotification(eventUri, name);

Entitlement: /event/admin

This method reverses the notification attachment, using the same name as passed in the original attachNotification call

Function Parameters

Parameter Type Description
eventUri String
name String

Return value

Type Description
void

addEventWorkflow

HttpEventApi eventApi = new HttpEventApi(loginApi);
void retVal = eventApi.addEventWorkflow(eventUri, name, workflowUri, params);
retVal = baseAPI.doEvent_AddEventWorkflow(eventUri, name, workflowUri, params);

Entitlement: /event/admin

This method is used to attach a workflow (dp) to an event. When the event is fired an instance of the workflow is started.

Function Parameters

Parameter Type Description
eventUri String
name String
workflowUri String
params Map

Return value

Type Description
void

deleteEventWorkflow

HttpEventApi eventApi = new HttpEventApi(loginApi);
void retVal = eventApi.deleteEventWorkflow(eventUri, name);
retVal = baseAPI.doEvent_DeleteEventWorkflow(eventUri, name);

Entitlement: /event/admin

This method reverses the notification attachment, using the same name as passed in the original attachWorflowToEvent call.

Function Parameters

Parameter Type Description
eventUri String
name String

Return value

Type Description
void

runEvent

HttpEventApi eventApi = new HttpEventApi(loginApi);
boolean retVal = eventApi.runEvent(eventUri, associatedUri, eventContext);
retVal = baseAPI.doEvent_RunEvent(eventUri, associatedUri, eventContext);

Entitlement: /event/admin

This method fires an event, scheduling any attached scripts to run. The optional displayName and contextparameters are passed to the script when fired.

Function Parameters

Parameter Type Description
eventUri String
associatedUri String
eventContext String

Return value

Type Description
boolean

runEventWithContext

HttpEventApi eventApi = new HttpEventApi(loginApi);
RunEventHandle retVal = eventApi.runEventWithContext(eventUri, associatedUri, eventContextMap);
retVal = baseAPI.doEvent_RunEventWithContext(eventUri, associatedUri, eventContextMap);

Entitlement: /event/admin

This method fires an event, scheduling any attached workflows or scripts to run. The optional associatedURI and contextmap are passed to the event workflow when fired. The event’s unique id is returned. This id is passed to any scripts, workflows, etcinvoked by the event

Function Parameters

Parameter Type Description
eventUri String
associatedUri String
eventContextMap Map

Return value

Type Description
RunEventHandle

RunEventHandle

This is a write handle returned after an event is executed.

Field Type
eventUri RaptureURI
eventId String
didRun Boolean

eventExists

HttpEventApi eventApi = new HttpEventApi(loginApi);
boolean retVal = eventApi.eventExists(eventUri);
retVal = baseAPI.doEvent_EventExists(eventUri);

Entitlement: /event/admin

Determines whether an event has been defined.

Function Parameters

Parameter Type Description
eventUri String

Return value

Type Description
boolean

deleteEventsByUriPrefix

HttpEventApi eventApi = new HttpEventApi(loginApi);
List<String> retVal = eventApi.deleteEventsByUriPrefix(uriPrefix);
retVal = baseAPI.doEvent_DeleteEventsByUriPrefix(uriPrefix);

Entitlement: /data/write/$f(uriPrefix)

Removes a folder and its contents recursively, including empty subfolders. Validates entitlement on individual events and folders. Returns a list of the events and folders removed.

Function Parameters

Parameter Type Description
uriPrefix String

Return value

Type Description
List

IdGen API

A idGen is a unique number generator - once defined it can be used to create unique ids that can be attached to documents or entities. idGens can be attached to a document repository so that new documents created in that repository can optionally have unique ids.

getIdGenConfigs

HttpIdGenApi idgenApi = new HttpIdGenApi(loginApi);
List<RaptureIdGenConfig> retVal = idgenApi.getIdGenConfigs(authority);
retVal = baseAPI.doIdGen_GetIdGenConfigs(authority);

Entitlement: /admin/idgen

Gets a list of idGens that have the given authority. Each idGen has a URI, and the authority is part of the URI. idGens whose URIs have an authority that matches the passed parameter will be returned.

Function Parameters

Parameter Type Description
authority String

Return value

Type Description
List

getIdGenConfig

HttpIdGenApi idgenApi = new HttpIdGenApi(loginApi);
RaptureIdGenConfig retVal = idgenApi.getIdGenConfig(idGenUri);
retVal = baseAPI.doIdGen_GetIdGenConfig(idGenUri);

Entitlement: /admin/idgen

Retrieves a single idGen config given its name.

Function Parameters

Parameter Type Description
idGenUri String

Return value

Type Description
RaptureIdGenConfig

RaptureIdGenConfig

Holds the config info for a idgen as described in the idgen API.

Field Type
name String
config String
authority String

createIdGen

HttpIdGenApi idgenApi = new HttpIdGenApi(loginApi);
RaptureIdGenConfig retVal = idgenApi.createIdGen(idGenUri, config);
retVal = baseAPI.doIdGen_CreateIdGen(idGenUri, config);

Entitlement: /admin/idgen

This method is used to define a new idGen in a given authority. The config parameter defines the storage to be used for managing the idGen.

Function Parameters

Parameter Type Description
idGenUri String
config String

Return value

Type Description
RaptureIdGenConfig

RaptureIdGenConfig

Holds the config info for a idgen as described in the idgen API.

Field Type
name String
config String
authority String

idGenExists

HttpIdGenApi idgenApi = new HttpIdGenApi(loginApi);
boolean retVal = idgenApi.idGenExists(idGenUri);
retVal = baseAPI.doIdGen_IdGenExists(idGenUri);

Entitlement: /admin/idgen

Returns true if the idGen was found.

Function Parameters

Parameter Type Description
idGenUri String

Return value

Type Description
boolean

deleteIdGen

HttpIdGenApi idgenApi = new HttpIdGenApi(loginApi);
void retVal = idgenApi.deleteIdGen(idGenUri);
retVal = baseAPI.doIdGen_DeleteIdGen(idGenUri);

Entitlement: /admin/idgen

This method is used to delete a previously defined idGen.

Function Parameters

Parameter Type Description
idGenUri String

Return value

Type Description
void

setIdGen

HttpIdGenApi idgenApi = new HttpIdGenApi(loginApi);
void retVal = idgenApi.setIdGen(idGenUri, count);
retVal = baseAPI.doIdGen_SetIdGen(idGenUri, count);

Entitlement: /admin/idgen

This method can be used to reset an idGen to a new id - all future requests will start from this new point.

Function Parameters

Parameter Type Description
idGenUri String
count Long

Return value

Type Description
void

next

HttpIdGenApi idgenApi = new HttpIdGenApi(loginApi);
String retVal = idgenApi.next(idGenUri);
retVal = baseAPI.doIdGen_Next(idGenUri);

Entitlement: /admin/idgen

This method is used to increment the idGen and returns a string that corresponds to the newly generated id.

Function Parameters

Parameter Type Description
idGenUri String

Return value

Type Description
String

nextIds

HttpIdGenApi idgenApi = new HttpIdGenApi(loginApi);
String retVal = idgenApi.nextIds(idGenUri, num);
retVal = baseAPI.doIdGen_NextIds(idGenUri, num);

Entitlement: /admin/idgen

This method is used to increment the idGen by given amount and returns a string that corresponds to the newly generated id.

Function Parameters

Parameter Type Description
idGenUri String
num Long

Return value

Type Description
String

setupDefaultIdGens

HttpIdGenApi idgenApi = new HttpIdGenApi(loginApi);
void retVal = idgenApi.setupDefaultIdGens(force);
retVal = baseAPI.doIdGen_SetupDefaultIdGens(force);

Entitlement: /admin/lock

Sets up any idGens needed by Rapture by default, should be called from any startup scripts. If force is set to true, it will force the configto be set up again, even if it already exists.

Function Parameters

Parameter Type Description
force boolean

Return value

Type Description
void

Index API

One key feature of Rapture is that it is not restricted to any particular backing store; it can leverage multiple database technologies at the same time. As a result, the underlying implementation might not support a fast searchable index. To address this issue, each backing store can provide its own index mechanism. The intention is that the implementation can use native indexing where available, but that the indexing interface is abstracted. Note that only Mongo, Memory and Postgres implementations are available as of this release of the API. There is no indexing implementation for Cassandra.

createIndex

HttpIndexApi indexApi = new HttpIndexApi(loginApi);
IndexConfig retVal = indexApi.createIndex(indexUri, config);
retVal = baseAPI.doIndex_CreateIndex(indexUri, config);

Entitlement: /admin/index/write

Generates a new index for the repository. Note that objects are indexed only when they are written. Any objects already in the repository are not automatically indexed; they need to be read and written back.

Function Parameters

Parameter Type Description
indexUri String
config String

Return value

Type Description
IndexConfig

IndexConfig

**

Field Type
name String
config String

getIndex

HttpIndexApi indexApi = new HttpIndexApi(loginApi);
IndexConfig retVal = indexApi.getIndex(indexUri);
retVal = baseAPI.doIndex_GetIndex(indexUri);

Entitlement: /admin/index/read

Gets the config for a specified index.

Function Parameters

Parameter Type Description
indexUri String

Return value

Type Description
IndexConfig

IndexConfig

**

Field Type
name String
config String

deleteIndex

HttpIndexApi indexApi = new HttpIndexApi(loginApi);
void retVal = indexApi.deleteIndex(indexUri);
retVal = baseAPI.doIndex_DeleteIndex(indexUri);

Entitlement: /admin/index/write

Removes an index.

Function Parameters

Parameter Type Description
indexUri String

Return value

Type Description
void

createTable

HttpIndexApi indexApi = new HttpIndexApi(loginApi);
TableConfig retVal = indexApi.createTable(tableUri, config);
retVal = baseAPI.doIndex_CreateTable(tableUri, config);

Entitlement: /admin/index/write

Creates a table, somewhere to store a rowset

Function Parameters

Parameter Type Description
tableUri String
config String

Return value

Type Description
TableConfig

TableConfig

Holds the config info for a Rapture table, as described in the table API.

Field Type
name String
config String
authority String

deleteTable

HttpIndexApi indexApi = new HttpIndexApi(loginApi);
void retVal = indexApi.deleteTable(tableUri);
retVal = baseAPI.doIndex_DeleteTable(tableUri);

Entitlement: /admin/index/write

Removes a table.

Function Parameters

Parameter Type Description
tableUri String

Return value

Type Description
void

getTable

HttpIndexApi indexApi = new HttpIndexApi(loginApi);
TableConfig retVal = indexApi.getTable(indexURI);
retVal = baseAPI.doIndex_GetTable(indexURI);

Entitlement: /admin/index/read

Retrieve the config for a table

Function Parameters

Parameter Type Description
indexURI String

Return value

Type Description
TableConfig

TableConfig

Holds the config info for a Rapture table, as described in the table API.

Field Type
name String
config String
authority String

queryTable

HttpIndexApi indexApi = new HttpIndexApi(loginApi);
List<TableRecord> retVal = indexApi.queryTable(indexURI, query);
retVal = baseAPI.doIndex_QueryTable(indexURI, query);

Entitlement: /admin/index/read

Query a table

Function Parameters

Parameter Type Description
indexURI String
query TableQuery

Return value

Type Description
List

TableQuery

Describes a query made against a table.

Field Type
fieldTests List(TableSelect)
fieldReturns List(String)
sortFields List(TableColumnSort)
skip int
limit int

findIndex

HttpIndexApi indexApi = new HttpIndexApi(loginApi);
TableQueryResult retVal = indexApi.findIndex(indexUri, query);
retVal = baseAPI.doIndex_FindIndex(indexUri, query);

Entitlement: /admin/index/read

findIndex uses a simple structure of the form SELECT (DISTINCT) field (,field…) WHERE condition (,condition…) (ORDER BY field (DESC) )Example: SELECT DISTINCT foo, bar WHERE baz = “wibble” ORDER BY foo

Function Parameters

Parameter Type Description
indexUri String
query String

Return value

Type Description
TableQueryResult

TableQueryResult

A subsection of a table that matches a given query.

Field Type
columnNames List(String)
columnTypes List(String)
rows List(List(Object))

Jar API

The JAR api is used to manage the storage of Java Archive (JAR) files for use by a Rapture server.

jarExists

HttpJarApi jarApi = new HttpJarApi(loginApi);
boolean retVal = jarApi.jarExists(jarUri);
retVal = baseAPI.doJar_JarExists(jarUri);

Entitlement: /data/list/$f(jarUri)

Indicates whether a given JAR exists.

Function Parameters

Parameter Type Description
jarUri String

Return value

Type Description
boolean

putJar

HttpJarApi jarApi = new HttpJarApi(loginApi);
void retVal = jarApi.putJar(jarUri, jarContent);
retVal = baseAPI.doJar_PutJar(jarUri, jarContent);

Entitlement: /data/write/$f(jarUri)

Stores a JAR.

Function Parameters

Parameter Type Description
jarUri String
jarContent byte[]

Return value

Type Description
void

getJar

HttpJarApi jarApi = new HttpJarApi(loginApi);
BlobContainer retVal = jarApi.getJar(jarUri);
retVal = baseAPI.doJar_GetJar(jarUri);

Entitlement: /data/read/$f(jarUri)

Retrieves a JAR and its metadata. The JAR is represented as a byte array.

Function Parameters

Parameter Type Description
jarUri String

Return value

Type Description
BlobContainer

BlobContainer

Describes a blob repository.

Field Type
headers Map(String, String)
content ByteArray

deleteJar

HttpJarApi jarApi = new HttpJarApi(loginApi);
void retVal = jarApi.deleteJar(jarUri);
retVal = baseAPI.doJar_DeleteJar(jarUri);

Entitlement: /data/write/$f(jarUri)

Removes a JAR from the backing store. There is no undo.

Function Parameters

Parameter Type Description
jarUri String

Return value

Type Description
void

getJarSize

HttpJarApi jarApi = new HttpJarApi(loginApi);
Long retVal = jarApi.getJarSize(jarUri);
retVal = baseAPI.doJar_GetJarSize(jarUri);

Entitlement: /data/list/$f(jarUri)

Retrieves the number of bytes in a JAR.

Function Parameters

Parameter Type Description
jarUri String

Return value

Type Description
Long

getJarMetaData

HttpJarApi jarApi = new HttpJarApi(loginApi);
Map<String,String> retVal = jarApi.getJarMetaData(jarUri);
retVal = baseAPI.doJar_GetJarMetaData(jarUri);

Entitlement: /data/list/$f(jarUri)

Retrieves all metadata associated with a JAR.

Function Parameters

Parameter Type Description
jarUri String

Return value

Type Description
Map

listJarsByUriPrefix

HttpJarApi jarApi = new HttpJarApi(loginApi);
Map<String,RaptureFolderInfo> retVal = jarApi.listJarsByUriPrefix(uriPrefix, depth);
retVal = baseAPI.doJar_ListJarsByUriPrefix(uriPrefix, depth);

Entitlement: /data/list/$f(uriPrefix)

Returns full pathnames for an entire subtree as a map of the path to RFI.

Function Parameters

Parameter Type Description
uriPrefix String
depth int

Return value

Type Description
Map

Lock API

The Lock API contains functionality for working with semaphore locks.

getLockManagerConfigs

HttpLockApi lockApi = new HttpLockApi(loginApi);
List<RaptureLockConfig> retVal = lockApi.getLockManagerConfigs(managerUri);
retVal = baseAPI.doLock_GetLockManagerConfigs(managerUri);

Entitlement: /admin/lock

Retrieves the lock providers for a given authority.

Function Parameters

Parameter Type Description
managerUri String

Return value

Type Description
List

createLockManager

HttpLockApi lockApi = new HttpLockApi(loginApi);
RaptureLockConfig retVal = lockApi.createLockManager(managerUri, config, pathPosition);
retVal = baseAPI.doLock_CreateLockManager(managerUri, config, pathPosition);

Entitlement: /admin/lock

Creates a lock provider with an authority.

Function Parameters

Parameter Type Description
managerUri String
config String
pathPosition String

Return value

Type Description
RaptureLockConfig

RaptureLockConfig

Metadata used by objects in the Lock API.

Field Type
name String
config String
authority String
pathPosition String

lockManagerExists

HttpLockApi lockApi = new HttpLockApi(loginApi);
boolean retVal = lockApi.lockManagerExists(managerUri);
retVal = baseAPI.doLock_LockManagerExists(managerUri);

Entitlement: /admin/lock

Returns true if the lock providers found.

Function Parameters

Parameter Type Description
managerUri String

Return value

Type Description
boolean

getLockManagerConfig

HttpLockApi lockApi = new HttpLockApi(loginApi);
RaptureLockConfig retVal = lockApi.getLockManagerConfig(managerUri);
retVal = baseAPI.doLock_GetLockManagerConfig(managerUri);

Entitlement: /admin/lock/$f(managerUri)

Gets a lock provider by its Uri.

Function Parameters

Parameter Type Description
managerUri String

Return value

Type Description
RaptureLockConfig

RaptureLockConfig

Metadata used by objects in the Lock API.

Field Type
name String
config String
authority String
pathPosition String

deleteLockManager

HttpLockApi lockApi = new HttpLockApi(loginApi);
void retVal = lockApi.deleteLockManager(managerUri);
retVal = baseAPI.doLock_DeleteLockManager(managerUri);

Entitlement: /admin/lock/$f(managerUri)

Intended to delete a lock manager, but in a multi-node environment this would be dangerous. Furthermore LockFactory caches the Lock Handler locally

Function Parameters

Parameter Type Description
managerUri String

Return value

Type Description
void

acquireLock

HttpLockApi lockApi = new HttpLockApi(loginApi);
LockHandle retVal = lockApi.acquireLock(managerUri, lockName, secondsToWait, secondsToKeep);
retVal = baseAPI.doLock_AcquireLock(managerUri, lockName, secondsToWait, secondsToKeep);

Entitlement: /admin/lock/$f(managerUri)

Acquire a lock. Returns a LockHandle, which you need to pass to releaseLock when calling it. Ifunable to acquire the lock, returns null.

Function Parameters

Parameter Type Description
managerUri String
lockName String
secondsToWait long
secondsToKeep long

Return value

Type Description
LockHandle

LockHandle

Handle to a Rapture lock.

Field Type
lockName String
handle String
lockHolder String

releaseLock

HttpLockApi lockApi = new HttpLockApi(loginApi);
boolean retVal = lockApi.releaseLock(managerUri, lockName, lockHandle);
retVal = baseAPI.doLock_ReleaseLock(managerUri, lockName, lockHandle);

Entitlement: /admin/lock/$f(managerUri)

Releases a lock.

Function Parameters

Parameter Type Description
managerUri String
lockName String
lockHandle LockHandle

Return value

Type Description
boolean

LockHandle

Handle to a Rapture lock.

Field Type
lockName String
handle String
lockHolder String

forceReleaseLock

HttpLockApi lockApi = new HttpLockApi(loginApi);
void retVal = lockApi.forceReleaseLock(managerUri, lockName);
retVal = baseAPI.doLock_ForceReleaseLock(managerUri, lockName);

Entitlement: /admin/lock/$f(managerUri)

This is a dangerous variant of release lock that will kick someone else off the lock queue.

Function Parameters

Parameter Type Description
managerUri String
lockName String

Return value

Type Description
void

Notification API

The notification API is used as a means for transferring notifications between interested parties. In most cases a notification provider maintains a list of messages, and each message is associated with an ever increasing ‘epoch number.’ A client can retrieve the latest epoch number from a provider and then poll for changes since that epoch - all updates since that point can be returned.

getNotificationManagerConfigs

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
List<RaptureNotificationConfig> retVal = notificationApi.getNotificationManagerConfigs();
retVal = baseAPI.doNotification_GetNotificationManagerConfigs();

Entitlement: /admin/notification

This method retrieves the notification providers in use at this Rapture system.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

listNotificationsByUriPrefix

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
List<RaptureFolderInfo> retVal = notificationApi.listNotificationsByUriPrefix(uriPrefix);
retVal = baseAPI.doNotification_ListNotificationsByUriPrefix(uriPrefix);

Entitlement: /user/get

Returns a list of full display names of the paths below this one. Ideally optimized depending on the repo.

Function Parameters

Parameter Type Description
uriPrefix String

Return value

Type Description
List

findNotificationManagerConfigsByPurpose

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
List<RaptureNotificationConfig> retVal = notificationApi.findNotificationManagerConfigsByPurpose(purpose);
retVal = baseAPI.doNotification_FindNotificationManagerConfigsByPurpose(purpose);

Entitlement: /admin/notification

Notification providers have an associated purpose - this method returns only those providers that match the given purpose.

Function Parameters

Parameter Type Description
purpose String

Return value

Type Description
List

createNotificationManager

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
RaptureNotificationConfig retVal = notificationApi.createNotificationManager(notificationManagerUri, config, purpose);
retVal = baseAPI.doNotification_CreateNotificationManager(notificationManagerUri, config, purpose);

Entitlement: /admin/notification

This method creates a definition of a notification provider.

Function Parameters

Parameter Type Description
notificationManagerUri String
config String
purpose String

Return value

Type Description
RaptureNotificationConfig

RaptureNotificationConfig

Config info for the main object in the Notification API.

Field Type
name String
config String
purpose String

notificationManagerExists

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
boolean retVal = notificationApi.notificationManagerExists(notificationManagerUri);
retVal = baseAPI.doNotification_NotificationManagerExists(notificationManagerUri);

Entitlement: /admin/notification

Indicates whether a notification provider with notificationName was found.

Function Parameters

Parameter Type Description
notificationManagerUri String

Return value

Type Description
boolean

getNotificationManagerConfig

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
RaptureNotificationConfig retVal = notificationApi.getNotificationManagerConfig(notificationManagerUri);
retVal = baseAPI.doNotification_GetNotificationManagerConfig(notificationManagerUri);

Entitlement: /admin/notification

This method returns the low level config for a given notification provider.

Function Parameters

Parameter Type Description
notificationManagerUri String

Return value

Type Description
RaptureNotificationConfig

RaptureNotificationConfig

Config info for the main object in the Notification API.

Field Type
name String
config String
purpose String

deleteNotificationManager

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
void retVal = notificationApi.deleteNotificationManager(notificationManagerUri);
retVal = baseAPI.doNotification_DeleteNotificationManager(notificationManagerUri);

Entitlement: /admin/notification

This method removes a notification provider and all its content.

Function Parameters

Parameter Type Description
notificationManagerUri String

Return value

Type Description
void

getLatestNotificationEpoch

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
Long retVal = notificationApi.getLatestNotificationEpoch(notificationManagerUri);
retVal = baseAPI.doNotification_GetLatestNotificationEpoch(notificationManagerUri);

Entitlement: /user/notification

This method retrieves the current epoch number for a given notification point.

Function Parameters

Parameter Type Description
notificationManagerUri String

Return value

Type Description
Long

publishNotification

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
String retVal = notificationApi.publishNotification(notificationManagerUri, referenceId, content, contentType);
retVal = baseAPI.doNotification_PublishNotification(notificationManagerUri, referenceId, content, contentType);

Entitlement: /user/notification

This method pushes a notification to a provider.

Function Parameters

Parameter Type Description
notificationManagerUri String
referenceId String
content String
contentType String

Return value

Type Description
String

findNotificationsAfterEpoch

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
NotificationResult retVal = notificationApi.findNotificationsAfterEpoch(notificationManagerUri, epoch);
retVal = baseAPI.doNotification_FindNotificationsAfterEpoch(notificationManagerUri, epoch);

Entitlement: /admin/notification

This method returns the changes seen on a notification since an epoch. A client would then update its latest epoch by using the value in the notification result.

Function Parameters

Parameter Type Description
notificationManagerUri String
epoch Long

Return value

Type Description
NotificationResult

NotificationResult

The object returned by a notification

Field Type
currentEpoch Long
references List(String)

getNotification

HttpNotificationApi notificationApi = new HttpNotificationApi(loginApi);
NotificationInfo retVal = notificationApi.getNotification(notificationUri, id);
retVal = baseAPI.doNotification_GetNotification(notificationUri, id);

Entitlement: /admin/notification

This method returns a notification message given its id.

Function Parameters

Parameter Type Description
notificationUri String
id String

Return value

Type Description
NotificationInfo

NotificationInfo

Contains all relevant data for a notification.

Field Type
id String
content String
reference String
epoch Long
when Date
contentType String
who String

Operation API

The operation API gives you the ability to treat Rapture documents as class objects.

invoke

HttpOperationApi operationApi = new HttpOperationApi(loginApi);
Map<String,Object> retVal = operationApi.invoke(docUri, method, parameters);
retVal = baseAPI.doOperation_Invoke(docUri, method, parameters);

Entitlement: /operation/run

Invoke a method on a Rapture object, returning the response from the function.

Function Parameters

Parameter Type Description
docUri String
method String
parameters Map

Return value

Type Description
Map

invokeAlt

HttpOperationApi operationApi = new HttpOperationApi(loginApi);
Map<String,Object> retVal = operationApi.invokeAlt(docUri, method, parameters, altInterface);
retVal = baseAPI.doOperation_InvokeAlt(docUri, method, parameters, altInterface);

Entitlement: /operation/run

Invoke a method on a Rapture object, returning the response from the function. The function could be available on the passed interface document.

Function Parameters

Parameter Type Description
docUri String
method String
parameters Map
altInterface String

Return value

Type Description
Map

invokeSave

HttpOperationApi operationApi = new HttpOperationApi(loginApi);
Map<String,Object> retVal = operationApi.invokeSave(docUri, method, parameters);
retVal = baseAPI.doOperation_InvokeSave(docUri, method, parameters);

Entitlement: /operation/run

Invoke a method on a Rapture object, returning the response from the function. The document is updated if the this variable is changed.

Function Parameters

Parameter Type Description
docUri String
method String
parameters Map

Return value

Type Description
Map

invokeSaveAlt

HttpOperationApi operationApi = new HttpOperationApi(loginApi);
Map<String,Object> retVal = operationApi.invokeSaveAlt(docUri, method, parameters, altInterface);
retVal = baseAPI.doOperation_InvokeSaveAlt(docUri, method, parameters, altInterface);

Entitlement: /operation/run

Invoke a method on a Rapture object, returning the response from the function. The document is updated if the this variable is changed. The function could be available on the passed interface document.

Function Parameters

Parameter Type Description
docUri String
method String
parameters Map
altInterface String

Return value

Type Description
Map

invokeParallel

HttpOperationApi operationApi = new HttpOperationApi(loginApi);
Map<String,Object> retVal = operationApi.invokeParallel(docUri, methods, params);
retVal = baseAPI.doOperation_InvokeParallel(docUri, methods, params);

Entitlement: /operation/run

Invoke a set of methods in parallel, returning the merged response from the function.

Function Parameters

Parameter Type Description
docUri String
methods List
params Map

Return value

Type Description
Map

Pipeline API

The Pipeline Api is used to configure the Rapture System pipeline for running tasks within a cluster of Rapture Servers.

removeServerCategory

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
void retVal = pipelineApi.removeServerCategory(category);
retVal = baseAPI.doPipeline_RemoveServerCategory(category);

Entitlement: /admin/pipeline

Deletes a given category.

Function Parameters

Parameter Type Description
category String

Return value

Type Description
void

getServerCategories

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
List<String> retVal = pipelineApi.getServerCategories();
retVal = baseAPI.doPipeline_GetServerCategories();

Entitlement: /admin/pipeline

List server categories.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getBoundExchanges

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
List<CategoryQueueBindings> retVal = pipelineApi.getBoundExchanges(category);
retVal = baseAPI.doPipeline_GetBoundExchanges(category);

Entitlement: /admin/pipeline

Get bound exchanges for a category

Function Parameters

Parameter Type Description
category String

Return value

Type Description
List

deregisterPipelineExchange

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
void retVal = pipelineApi.deregisterPipelineExchange(name);
retVal = baseAPI.doPipeline_DeregisterPipelineExchange(name);

Entitlement: /admin/pipeline

Removes an exchange.

Function Parameters

Parameter Type Description
name String

Return value

Type Description
void

getExchanges

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
List<String> retVal = pipelineApi.getExchanges();
retVal = baseAPI.doPipeline_GetExchanges();

Entitlement: /admin/pipeline

Retrieves all registered exchanges.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getExchange

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
RaptureExchange retVal = pipelineApi.getExchange(name);
retVal = baseAPI.doPipeline_GetExchange(name);

Entitlement: /admin/pipeline

Retrieves an exchange object by name.

Function Parameters

Parameter Type Description
name String

Return value

Type Description
RaptureExchange

RaptureExchange

*A RaptureExchange is the coordination point for a task based pipeline.

Clients put RapturePipelineTask instances onto an exchange, which then routes that task to a set of queues that are then consumed.

This class defines the config of an exchange *

Field Type
domain String
name String
exchangeType RaptureExchangeType
queueBindings List(RaptureExchangeQueue)

publishMessageToCategory

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
void retVal = pipelineApi.publishMessageToCategory(task);
retVal = baseAPI.doPipeline_PublishMessageToCategory(task);

Entitlement: /admin/pipeline

Publishes a message. This message will be published to the category specified in the RapturePipelineTask object. If no category is specified, an error is thrown. This type of message should be handled by only one of the servers belonging to this category; in other words, it is not a broadcast.

Function Parameters

Parameter Type Description
task RapturePipelineTask

Return value

Type Description
void

RapturePipelineTask

Represents a task that has been submitted to the Rapture pipeline. Includes the task’s status, type, and categories associated with it.

Field Type
status PipelineTaskStatus
taskType PipelineTaskType
priority int
categoryList List
taskId String
content String
contentType String
epoch Long
statusEnabled Boolean

broadcastMessageToCategory

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
void retVal = pipelineApi.broadcastMessageToCategory(task);
retVal = baseAPI.doPipeline_BroadcastMessageToCategory(task);

Entitlement: /admin/pipeline

This message will be broadcasted to all servers belonging to the category specified in the RapturePipelineTaskobject. If no category is specified, an error is thrown.

Function Parameters

Parameter Type Description
task RapturePipelineTask

Return value

Type Description
void

RapturePipelineTask

Represents a task that has been submitted to the Rapture pipeline. Includes the task’s status, type, and categories associated with it.

Field Type
status PipelineTaskStatus
taskType PipelineTaskType
priority int
categoryList List
taskId String
content String
contentType String
epoch Long
statusEnabled Boolean

broadcastMessageToAll

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
void retVal = pipelineApi.broadcastMessageToAll(task);
retVal = baseAPI.doPipeline_BroadcastMessageToAll(task);

Entitlement: /admin/pipeline

This message will be broadcasted to all servers connected to the pipeline system.

Function Parameters

Parameter Type Description
task RapturePipelineTask

Return value

Type Description
void

RapturePipelineTask

Represents a task that has been submitted to the Rapture pipeline. Includes the task’s status, type, and categories associated with it.

Field Type
status PipelineTaskStatus
taskType PipelineTaskType
priority int
categoryList List
taskId String
content String
contentType String
epoch Long
statusEnabled Boolean

getStatus

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
PipelineTaskStatus retVal = pipelineApi.getStatus(taskId);
retVal = baseAPI.doPipeline_GetStatus(taskId);

Entitlement: /admin/pipeline

Gets the status for a published RapturePipelineTask.

Function Parameters

Parameter Type Description
taskId String

Return value

Type Description
PipelineTaskStatus

PipelineTaskStatus

Contains details about the current tasks on a pipeline.

Field Type
currentState PipelineTaskState
taskId String
relatedTaskId String
creationTime Date
startExecutionTime Date
endExecutionTime Date
suspensionCount int
output List(String)

queryTasks

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
List<RapturePipelineTask> retVal = pipelineApi.queryTasks(query);
retVal = baseAPI.doPipeline_QueryTasks(query);

Entitlement: /admin/pipeline

Queries for pipeline statuses.

Function Parameters

Parameter Type Description
query String

Return value

Type Description
List

queryTasksOld

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
List<RapturePipelineTask> retVal = pipelineApi.queryTasksOld(query);
retVal = baseAPI.doPipeline_QueryTasksOld(query);

Entitlement: /admin/pipeline

Queries for pipeline statuses.

Function Parameters

Parameter Type Description
query TableQuery

Return value

Type Description
List

TableQuery

Describes a query made against a table.

Field Type
fieldTests List(TableSelect)
fieldReturns List(String)
sortFields List(TableColumnSort)
skip int
limit int

getLatestTaskEpoch

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
Long retVal = pipelineApi.getLatestTaskEpoch();
retVal = baseAPI.doPipeline_GetLatestTaskEpoch();

Entitlement: /admin/pipeline

On the task information, get the latest epoch (the maximum message id).

Function Parameters

This function takes no parameters.

Return value

Type Description
Long

drainPipeline

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
void retVal = pipelineApi.drainPipeline(exchange);
retVal = baseAPI.doPipeline_DrainPipeline(exchange);

Entitlement: /admin/pipeline

Drain an exchange - remove all messages.

Function Parameters

Parameter Type Description
exchange String

Return value

Type Description
void

registerExchangeDomain

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
void retVal = pipelineApi.registerExchangeDomain(domainURI, config);
retVal = baseAPI.doPipeline_RegisterExchangeDomain(domainURI, config);

Entitlement: /admin/pipeline

Registers a new exchange domain.

Function Parameters

Parameter Type Description
domainURI String
config String

Return value

Type Description
void

deregisterExchangeDomain

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
void retVal = pipelineApi.deregisterExchangeDomain(domainURI);
retVal = baseAPI.doPipeline_DeregisterExchangeDomain(domainURI);

Entitlement: /admin/pipeline

Removes an exchange domain.

Function Parameters

Parameter Type Description
domainURI String

Return value

Type Description
void

getExchangeDomains

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
List<String> retVal = pipelineApi.getExchangeDomains();
retVal = baseAPI.doPipeline_GetExchangeDomains();

Entitlement: /admin/pipeline

Retrieves all registered exchange domains.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

setupStandardCategory

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
void retVal = pipelineApi.setupStandardCategory(category);
retVal = baseAPI.doPipeline_SetupStandardCategory(category);

Entitlement: /admin/pipeline

Sets up the default queue-exchanges and bindings for a given category.

Function Parameters

Parameter Type Description
category String

Return value

Type Description
void

makeRPC

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
Map<String,Object> retVal = pipelineApi.makeRPC(queueName, fnName, params, timeoutInSeconds);
retVal = baseAPI.doPipeline_MakeRPC(queueName, fnName, params, timeoutInSeconds);

Entitlement: /admin/pipeline

Make an RPC call using a pair of queues on the pipeline of the default exchange. I notice that the exchange is removed from the above call which seems to be a bit of a regression

Function Parameters

Parameter Type Description
queueName String
fnName String
params Map
timeoutInSeconds Long

Return value

Type Description
Map

createTopicExchange

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
void retVal = pipelineApi.createTopicExchange(domain, exchange);
retVal = baseAPI.doPipeline_CreateTopicExchange(domain, exchange);

Entitlement: /admin/pipeline

Create a topic exchange that can be used to pub/sub on

Function Parameters

Parameter Type Description
domain String
exchange String

Return value

Type Description
void

publishTopicMessage

HttpPipelineApi pipelineApi = new HttpPipelineApi(loginApi);
void retVal = pipelineApi.publishTopicMessage(domain, exchange, topic, message);
retVal = baseAPI.doPipeline_PublishTopicMessage(domain, exchange, topic, message);

Entitlement: /admin/pipeline

Publish on topic exchange (Subscription has to go low level)

Function Parameters

Parameter Type Description
domain String
exchange String
topic String
message String

Return value

Type Description
void

Plugin API

The plugin API is used to manipulate information about stored plugins in the system. A plugin is a set of scripts, type and data definitions.

getInstalledPlugins

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
List<PluginConfig> retVal = pluginApi.getInstalledPlugins();
retVal = baseAPI.doPlugin_GetInstalledPlugins();

Entitlement: /admin/main

Lists plugins in the system.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getPluginManifest

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
PluginManifest retVal = pluginApi.getPluginManifest(manifestUri);
retVal = baseAPI.doPlugin_GetPluginManifest(manifestUri);

Entitlement: /admin/main

Retrieves the manifest for a plugin.

Function Parameters

Parameter Type Description
manifestUri String

Return value

Type Description
PluginManifest

PluginManifest

This is a more detailed variant of PluginConfig that details the complete contents of a version of a plugin instance.

Field Type
contents List(PluginManifestItem)
depends Map(String, PluginVersion)
description String
plugin String
version PluginVersion

recordPlugin

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
void retVal = pluginApi.recordPlugin(plugin);
retVal = baseAPI.doPlugin_RecordPlugin(plugin);

Entitlement: /admin/main

Retrieves the manifest for a plugin.

Function Parameters

Parameter Type Description
plugin PluginConfig

Return value

Type Description
void

PluginConfig

Holds config information for the main object used by the Plugin API.

Field Type
depends Map(String, PluginVersion)
description String
plugin String
version PluginVersion

installPlugin

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
void retVal = pluginApi.installPlugin(manifest, payload);
retVal = baseAPI.doPlugin_InstallPlugin(manifest, payload);

Entitlement: /admin/main

Installs the plugin and updates the registry.

Function Parameters

Parameter Type Description
manifest PluginManifest
payload Map

Return value

Type Description
void

PluginManifest

This is a more detailed variant of PluginConfig that details the complete contents of a version of a plugin instance.

Field Type
contents List(PluginManifestItem)
depends Map(String, PluginVersion)
description String
plugin String
version PluginVersion

installPluginItem

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
void retVal = pluginApi.installPluginItem(pluginName, item);
retVal = baseAPI.doPlugin_InstallPluginItem(pluginName, item);

Entitlement: /admin/main

Installs a single item from a plugin to allow clients to operate in a low-memory environment

Function Parameters

Parameter Type Description
pluginName String
item PluginTransportItem

Return value

Type Description
void

PluginTransportItem

The PluginTransportItem is an internal class used by the PluginInstaller. It carries the encoded form of a Rapture object between the PluginInstaller and the Rapture server.

Field Type
uri String
content ByteArray
hash String

uninstallPlugin

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
void retVal = pluginApi.uninstallPlugin(name);
retVal = baseAPI.doPlugin_UninstallPlugin(name);

Entitlement: /admin/main

Removes a plugin.

Function Parameters

Parameter Type Description
name String

Return value

Type Description
void

uninstallPluginItem

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
void retVal = pluginApi.uninstallPluginItem(item);
retVal = baseAPI.doPlugin_UninstallPluginItem(item);

Entitlement: /admin/main

Removes an item from a plugin.

Function Parameters

Parameter Type Description
item PluginTransportItem

Return value

Type Description
void

PluginTransportItem

The PluginTransportItem is an internal class used by the PluginInstaller. It carries the encoded form of a Rapture object between the PluginInstaller and the Rapture server.

Field Type
uri String
content ByteArray
hash String

deletePluginManifest

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
void retVal = pluginApi.deletePluginManifest(manifestUri);
retVal = baseAPI.doPlugin_DeletePluginManifest(manifestUri);

Entitlement: /admin/main

Removes plugin Manifest but does not uninstall any referenced items.

Function Parameters

Parameter Type Description
manifestUri String

Return value

Type Description
void

getPluginItem

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
PluginTransportItem retVal = pluginApi.getPluginItem(uri);
retVal = baseAPI.doPlugin_GetPluginItem(uri);

Entitlement: /admin/main

Gets the encoding for a Rapture object given its URI.

Function Parameters

Parameter Type Description
uri String

Return value

Type Description
PluginTransportItem

PluginTransportItem

The PluginTransportItem is an internal class used by the PluginInstaller. It carries the encoded form of a Rapture object between the PluginInstaller and the Rapture server.

Field Type
uri String
content ByteArray
hash String

verifyPlugin

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
Map<String,String> retVal = pluginApi.verifyPlugin(plugin);
retVal = baseAPI.doPlugin_VerifyPlugin(plugin);

Entitlement: /admin/main

Verifies that the contents of a plugin match the hashes in the manifest.

Function Parameters

Parameter Type Description
plugin String

Return value

Type Description
Map

createManifest

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
void retVal = pluginApi.createManifest(pluginName);
retVal = baseAPI.doPlugin_CreateManifest(pluginName);

Entitlement: /admin/main

create an empty manifest on the server with version 0.0.0

Function Parameters

Parameter Type Description
pluginName String

Return value

Type Description
void

addManifestItem

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
void retVal = pluginApi.addManifestItem(pluginName, uri);
retVal = baseAPI.doPlugin_AddManifestItem(pluginName, uri);

Entitlement: /admin/main

add an object on the server to a plugin manifest on the server

Function Parameters

Parameter Type Description
pluginName String
uri String

Return value

Type Description
void

addManifestDataFolder

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
void retVal = pluginApi.addManifestDataFolder(pluginName, uri);
retVal = baseAPI.doPlugin_AddManifestDataFolder(pluginName, uri);

Entitlement: /admin/main

add uris within the specified docpath root. If no type is specifed in the uri, use all four of doc, blob, series, and sheet. Example1: //myProject/myfolder adds all four types. Example2: blob://myproject/myfolder adds only blobs

Function Parameters

Parameter Type Description
pluginName String
uri String

Return value

Type Description
void

removeManifestDataFolder

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
void retVal = pluginApi.removeManifestDataFolder(pluginName, uri);
retVal = baseAPI.doPlugin_RemoveManifestDataFolder(pluginName, uri);

Entitlement: /admin/main

remove uris within the specified path. If no type is specifed in the uri, use all four of doc, blob, series, and sheet.

Function Parameters

Parameter Type Description
pluginName String
uri String

Return value

Type Description
void

setManifestVersion

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
void retVal = pluginApi.setManifestVersion(pluginName, version);
retVal = baseAPI.doPlugin_SetManifestVersion(pluginName, version);

Entitlement: /admin/main

refresh the MD5 checksums in the manifest and set the version for a manifest on the server

Function Parameters

Parameter Type Description
pluginName String
version String

Return value

Type Description
void

removeItemFromManifest

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
void retVal = pluginApi.removeItemFromManifest(pluginName, uri);
retVal = baseAPI.doPlugin_RemoveItemFromManifest(pluginName, uri);

Entitlement: /admin/main

remove an item from the manifest of a plugin on the server

Function Parameters

Parameter Type Description
pluginName String
uri String

Return value

Type Description
void

exportPlugin

HttpPluginApi pluginApi = new HttpPluginApi(loginApi);
String retVal = pluginApi.exportPlugin(pluginName, path);
retVal = baseAPI.doPlugin_ExportPlugin(pluginName, path);

Entitlement: /admin/main

Export a plugin as a single blob. We pass in a parent path; the blob will be generated somewhere under that path, in a non-predictable location. The location is returned.

Function Parameters

Parameter Type Description
pluginName String
path String

Return value

Type Description
String

Program API

The program api is used to manage structures that are used to manage things that run in Rapture.

getProgram

HttpProgramApi programApi = new HttpProgramApi(loginApi);
RaptureProgram retVal = programApi.getProgram(programUri);
retVal = baseAPI.doProgram_GetProgram(programUri);

Entitlement: /program/read/$f(programUri)

Retrieve a program

Function Parameters

Parameter Type Description
programUri String

Return value

Type Description
RaptureProgram

RaptureProgram

  • A RaptureProgram is the definition of a program *
Field Type
name String
programType String
programUri String

putProgram

HttpProgramApi programApi = new HttpProgramApi(loginApi);
void retVal = programApi.putProgram(programUri, program);
retVal = baseAPI.doProgram_PutProgram(programUri, program);

Entitlement: /program/write/$f(programUri)

Save a program

Function Parameters

Parameter Type Description
programUri String
program RaptureProgram

Return value

Type Description
void

RaptureProgram

  • A RaptureProgram is the definition of a program *
Field Type
name String
programType String
programUri String

deleteProgram

HttpProgramApi programApi = new HttpProgramApi(loginApi);
void retVal = programApi.deleteProgram(programUri);
retVal = baseAPI.doProgram_DeleteProgram(programUri);

Entitlement: /program/write/$f(programUri)

remove a program

Function Parameters

Parameter Type Description
programUri String

Return value

Type Description
void

getChildren

HttpProgramApi programApi = new HttpProgramApi(loginApi);
List<RaptureFolderInfo> retVal = programApi.getChildren(uriPrefix);
retVal = baseAPI.doProgram_GetChildren(uriPrefix);

Entitlement: /program/list/$f(uriPrefix)

Returns full pathnames for an entire subtree as a map of the path to RFI.

Function Parameters

Parameter Type Description
uriPrefix String

Return value

Type Description
List

Runner API

The Runner api is used to manage application definitions for a Rapture environment that will be started and managed by the RaptureRunner application.

createServerGroup

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureServerGroup retVal = runnerApi.createServerGroup(name, description);
retVal = baseAPI.doRunner_CreateServerGroup(name, description);

Entitlement: /admin/main

Creates a new server group.

Function Parameters

Parameter Type Description
name String
description String

Return value

Type Description
RaptureServerGroup

RaptureServerGroup

Metadata for a Rapture server group.

Field Type
name String
description String
jmxPort Integer
inclusions Set(String)
exclusions Set(String)
libraries Set(String)

deleteServerGroup

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
void retVal = runnerApi.deleteServerGroup(name);
retVal = baseAPI.doRunner_DeleteServerGroup(name);

Entitlement: /admin/main

Remove a server group (and all of its application definitions )

Function Parameters

Parameter Type Description
name String

Return value

Type Description
void

getAllServerGroups

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
List<RaptureServerGroup> retVal = runnerApi.getAllServerGroups();
retVal = baseAPI.doRunner_GetAllServerGroups();

Entitlement: /admin/main

Returns all server groups defined in Rapture.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getAllApplicationDefinitions

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
List<RaptureApplicationDefinition> retVal = runnerApi.getAllApplicationDefinitions();
retVal = baseAPI.doRunner_GetAllApplicationDefinitions();

Entitlement: /admin/main

Returns a list of all the applications defined in Rapture, which Rapture Runner knows about, including their versions. This is the list of applications that Rapture is aware of, but it does not necessarily run everything. To get a list of what will be running, look at getAllApplicationInstances.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getAllLibraryDefinitions

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
List<RaptureLibraryDefinition> retVal = runnerApi.getAllLibraryDefinitions();
retVal = baseAPI.doRunner_GetAllLibraryDefinitions();

Entitlement: /admin/main

Get a list of all libraries defined in Rapture. These are also known as Rapture add-ons, or plugins.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getAllApplicationInstances

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
List<RaptureApplicationInstance> retVal = runnerApi.getAllApplicationInstances();
retVal = baseAPI.doRunner_GetAllApplicationInstances();

Entitlement: /admin/main

Retrieves all the application instances defined in Rapture. This is really the list of schedule entries, meaning every application-server group combination that is scheduled to run.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getServerGroup

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureServerGroup retVal = runnerApi.getServerGroup(name);
retVal = baseAPI.doRunner_GetServerGroup(name);

Entitlement: /admin/main

Retrieves a server group object, or null if no such object was found.

Function Parameters

Parameter Type Description
name String

Return value

Type Description
RaptureServerGroup

RaptureServerGroup

Metadata for a Rapture server group.

Field Type
name String
description String
jmxPort Integer
inclusions Set(String)
exclusions Set(String)
libraries Set(String)

addGroupInclusion

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureServerGroup retVal = runnerApi.addGroupInclusion(name, inclusion);
retVal = baseAPI.doRunner_AddGroupInclusion(name, inclusion);

Entitlement: /admin/main

Add a server group inclusion. An inclusion is a hostname where this server group should run. By default, this is set to *, which means run everywhere. Adding an inclusion makes it so that this server group will run only on certain servers.

Function Parameters

Parameter Type Description
name String
inclusion String

Return value

Type Description
RaptureServerGroup

RaptureServerGroup

Metadata for a Rapture server group.

Field Type
name String
description String
jmxPort Integer
inclusions Set(String)
exclusions Set(String)
libraries Set(String)

removeGroupInclusion

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureServerGroup retVal = runnerApi.removeGroupInclusion(name, inclusion);
retVal = baseAPI.doRunner_RemoveGroupInclusion(name, inclusion);

Entitlement: /admin/main

Removes a server group inclusion. Refer to AddGroupInclusion for more details.

Function Parameters

Parameter Type Description
name String
inclusion String

Return value

Type Description
RaptureServerGroup

RaptureServerGroup

Metadata for a Rapture server group.

Field Type
name String
description String
jmxPort Integer
inclusions Set(String)
exclusions Set(String)
libraries Set(String)

addGroupExclusion

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureServerGroup retVal = runnerApi.addGroupExclusion(name, exclusion);
retVal = baseAPI.doRunner_AddGroupExclusion(name, exclusion);

Entitlement: /admin/main

Add a server group exclusion. An exclusion is a hostname where this server group should not run. By default, this is set to empty, which means run on every host specified in inclusions. It makes more sense to add an exclusion if this server group has a wildcard (*) for inclusions. See also addGroupInclusion.

Function Parameters

Parameter Type Description
name String
exclusion String

Return value

Type Description
RaptureServerGroup

RaptureServerGroup

Metadata for a Rapture server group.

Field Type
name String
description String
jmxPort Integer
inclusions Set(String)
exclusions Set(String)
libraries Set(String)

removeGroupExclusion

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureServerGroup retVal = runnerApi.removeGroupExclusion(name, exclusion);
retVal = baseAPI.doRunner_RemoveGroupExclusion(name, exclusion);

Entitlement: /admin/main

Removes a server group exclusion. Refer to AddGroupExclusion for more details.

Function Parameters

Parameter Type Description
name String
exclusion String

Return value

Type Description
RaptureServerGroup

RaptureServerGroup

Metadata for a Rapture server group.

Field Type
name String
description String
jmxPort Integer
inclusions Set(String)
exclusions Set(String)
libraries Set(String)

removeGroupEntry

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureServerGroup retVal = runnerApi.removeGroupEntry(name, entry);
retVal = baseAPI.doRunner_RemoveGroupEntry(name, entry);

Entitlement: /admin/main

Remove an entry from either an exclusion or inclusion

Function Parameters

Parameter Type Description
name String
entry String

Return value

Type Description
RaptureServerGroup

RaptureServerGroup

Metadata for a Rapture server group.

Field Type
name String
description String
jmxPort Integer
inclusions Set(String)
exclusions Set(String)
libraries Set(String)

createApplicationDefinition

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureApplicationDefinition retVal = runnerApi.createApplicationDefinition(name, ver, description);
retVal = baseAPI.doRunner_CreateApplicationDefinition(name, ver, description);

Entitlement: /admin/main

Creates an application definition.

Function Parameters

Parameter Type Description
name String
ver String
description String

Return value

Type Description
RaptureApplicationDefinition

RaptureApplicationDefinition

Describes an application that this Rapture instance recognizes.

Field Type
name String
description String
version String

deleteApplicationDefinition

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
void retVal = runnerApi.deleteApplicationDefinition(name);
retVal = baseAPI.doRunner_DeleteApplicationDefinition(name);

Entitlement: /admin/main

Delete an application definition (and any references in server groups)

Function Parameters

Parameter Type Description
name String

Return value

Type Description
void

updateApplicationVersion

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureApplicationDefinition retVal = runnerApi.updateApplicationVersion(name, ver);
retVal = baseAPI.doRunner_UpdateApplicationVersion(name, ver);

Entitlement: /admin/main

Update a version of an application

Function Parameters

Parameter Type Description
name String
ver String

Return value

Type Description
RaptureApplicationDefinition

RaptureApplicationDefinition

Describes an application that this Rapture instance recognizes.

Field Type
name String
description String
version String

createLibraryDefinition

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureLibraryDefinition retVal = runnerApi.createLibraryDefinition(name, ver, description);
retVal = baseAPI.doRunner_CreateLibraryDefinition(name, ver, description);

Entitlement: /admin/main

Creates an application library. See also getAllLibraryDefinitions.

Function Parameters

Parameter Type Description
name String
ver String
description String

Return value

Type Description
RaptureLibraryDefinition

RaptureLibraryDefinition

Describes a third-party library being used in this Rapture instance.

Field Type
name String
description String
version String

deleteLibraryDefinition

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
void retVal = runnerApi.deleteLibraryDefinition(name);
retVal = baseAPI.doRunner_DeleteLibraryDefinition(name);

Entitlement: /admin/main

Remove a library definition (and any references in server groups)

Function Parameters

Parameter Type Description
name String

Return value

Type Description
void

getLibraryDefinition

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureLibraryDefinition retVal = runnerApi.getLibraryDefinition(name);
retVal = baseAPI.doRunner_GetLibraryDefinition(name);

Entitlement: /admin/main

Retrieve an library definition

Function Parameters

Parameter Type Description
name String

Return value

Type Description
RaptureLibraryDefinition

RaptureLibraryDefinition

Describes a third-party library being used in this Rapture instance.

Field Type
name String
description String
version String

updateLibraryVersion

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureLibraryDefinition retVal = runnerApi.updateLibraryVersion(name, ver);
retVal = baseAPI.doRunner_UpdateLibraryVersion(name, ver);

Entitlement: /admin/main

Update a version of a library

Function Parameters

Parameter Type Description
name String
ver String

Return value

Type Description
RaptureLibraryDefinition

RaptureLibraryDefinition

Describes a third-party library being used in this Rapture instance.

Field Type
name String
description String
version String

addLibraryToGroup

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureServerGroup retVal = runnerApi.addLibraryToGroup(serverGroup, libraryName);
retVal = baseAPI.doRunner_AddLibraryToGroup(serverGroup, libraryName);

Entitlement: /admin/main

Associates a library with a server group.

Function Parameters

Parameter Type Description
serverGroup String
libraryName String

Return value

Type Description
RaptureServerGroup

RaptureServerGroup

Metadata for a Rapture server group.

Field Type
name String
description String
jmxPort Integer
inclusions Set(String)
exclusions Set(String)
libraries Set(String)

removeLibraryFromGroup

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureServerGroup retVal = runnerApi.removeLibraryFromGroup(serverGroup, libraryName);
retVal = baseAPI.doRunner_RemoveLibraryFromGroup(serverGroup, libraryName);

Entitlement: /admin/main

Remove the association between a library and a server group

Function Parameters

Parameter Type Description
serverGroup String
libraryName String

Return value

Type Description
RaptureServerGroup

RaptureServerGroup

Metadata for a Rapture server group.

Field Type
name String
description String
jmxPort Integer
inclusions Set(String)
exclusions Set(String)
libraries Set(String)

createApplicationInstance

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureApplicationInstance retVal = runnerApi.createApplicationInstance(name, description, serverGroup, appName, timeRange, retryCount, parameters, apiUser);
retVal = baseAPI.doRunner_CreateApplicationInstance(name, description, serverGroup, appName, timeRange, retryCount, parameters, apiUser);

Entitlement: /admin/main

Adds an association between an application and a server group. This is the way to tell Rapture that a certain application needs to run (or be scheduled to run at given hours) as part of a server group.

Function Parameters

Parameter Type Description
name String
description String
serverGroup String
appName String
timeRange String
retryCount int
parameters String
apiUser String

Return value

Type Description
RaptureApplicationInstance

RaptureApplicationInstance

Describes an active application.

Field Type
name String
appName String
description String
serverGroup String
timeRangeSpecification String
retryCount Integer
parameters String
apiUser String
lockedBy String
oneShot Boolean
finished Boolean
status String
lastStateChange Date

runApplication

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureApplicationStatus retVal = runnerApi.runApplication(appName, queueName, parameterInput, parameterOutput);
retVal = baseAPI.doRunner_RunApplication(appName, queueName, parameterInput, parameterOutput);

Entitlement: /admin/main

Start a batch/single process (ultimately to replace the oneshot calls).

Function Parameters

Parameter Type Description
appName String
queueName String
parameterInput Map
parameterOutput Map

Return value

Type Description
RaptureApplicationStatus

RaptureApplicationStatus

A complete description of an application’s status.

Field Type
appName String
theDate String
instanceId String
overrideApplicationPath String
status RaptureApplicationStatusStep
lastMessage String
messages List(String)
inputConfig Map(String, String)
outputConfig Map(String, String)

runCustomApplication

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureApplicationStatus retVal = runnerApi.runCustomApplication(appName, queueName, parameterInput, parameterOutput, customApplicationPath);
retVal = baseAPI.doRunner_RunCustomApplication(appName, queueName, parameterInput, parameterOutput, customApplicationPath);

Entitlement: /admin/main

Start a batch/single process (ultimately to replace the oneshot calls)s.

Function Parameters

Parameter Type Description
appName String
queueName String
parameterInput Map
parameterOutput Map
customApplicationPath String

Return value

Type Description
RaptureApplicationStatus

RaptureApplicationStatus

A complete description of an application’s status.

Field Type
appName String
theDate String
instanceId String
overrideApplicationPath String
status RaptureApplicationStatusStep
lastMessage String
messages List(String)
inputConfig Map(String, String)
outputConfig Map(String, String)

getApplicationStatus

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureApplicationStatus retVal = runnerApi.getApplicationStatus(applicationStatusURI);
retVal = baseAPI.doRunner_GetApplicationStatus(applicationStatusURI);

Entitlement: /admin/main

Returns a status object that shows the current state of the app.

Function Parameters

Parameter Type Description
applicationStatusURI String

Return value

Type Description
RaptureApplicationStatus

RaptureApplicationStatus

A complete description of an application’s status.

Field Type
appName String
theDate String
instanceId String
overrideApplicationPath String
status RaptureApplicationStatusStep
lastMessage String
messages List(String)
inputConfig Map(String, String)
outputConfig Map(String, String)

getApplicationStatuses

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
List<RaptureApplicationStatus> retVal = runnerApi.getApplicationStatuses(date);
retVal = baseAPI.doRunner_GetApplicationStatuses(date);

Entitlement: /admin/main

Lists the apps that are interesting, given a QBE template (empty strings have default behavior).

Function Parameters

Parameter Type Description
date String

Return value

Type Description
List

getApplicationStatusDates

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
List<String> retVal = runnerApi.getApplicationStatusDates();
retVal = baseAPI.doRunner_GetApplicationStatusDates();

Entitlement: /admin/main

Lists the dates for which statuses exist.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

archiveApplicationStatuses

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
void retVal = runnerApi.archiveApplicationStatuses();
retVal = baseAPI.doRunner_ArchiveApplicationStatuses();

Entitlement: /admin/main

Tidy up old status invocations

Function Parameters

This function takes no parameters.

Return value

Type Description
void

changeApplicationStatus

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureApplicationStatus retVal = runnerApi.changeApplicationStatus(applicationStatusURI, statusCode, message);
retVal = baseAPI.doRunner_ChangeApplicationStatus(applicationStatusURI, statusCode, message);

Entitlement: /admin/main

Update the status of an application instance.

Function Parameters

Parameter Type Description
applicationStatusURI String
statusCode RaptureApplicationStatusStep
message String

Return value

Type Description
RaptureApplicationStatus

RaptureApplicationStatusStep

Takes one of the values in the strings to describe where an Application is in its execution.

Field Type
INITIATED String
PICKEDUP String
PREPROCESSING String
RUNNING String
POSTPROCESSING String
COMPLETED String
FAILED String

RaptureApplicationStatus

A complete description of an application’s status.

Field Type
appName String
theDate String
instanceId String
overrideApplicationPath String
status RaptureApplicationStatusStep
lastMessage String
messages List(String)
inputConfig Map(String, String)
outputConfig Map(String, String)

recordStatusMessages

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
void retVal = runnerApi.recordStatusMessages(applicationStatusURI, messages);
retVal = baseAPI.doRunner_RecordStatusMessages(applicationStatusURI, messages);

Entitlement: /admin/main

Adds messages to a running application instance.

Function Parameters

Parameter Type Description
applicationStatusURI String
messages List

Return value

Type Description
void

terminateApplication

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureApplicationStatus retVal = runnerApi.terminateApplication(applicationStatusURI, reasonMessage);
retVal = baseAPI.doRunner_TerminateApplication(applicationStatusURI, reasonMessage);

Entitlement: /admin/main

Attempts to cancel the execution of an application.

Function Parameters

Parameter Type Description
applicationStatusURI String
reasonMessage String

Return value

Type Description
RaptureApplicationStatus

RaptureApplicationStatus

A complete description of an application’s status.

Field Type
appName String
theDate String
instanceId String
overrideApplicationPath String
status RaptureApplicationStatusStep
lastMessage String
messages List(String)
inputConfig Map(String, String)
outputConfig Map(String, String)

deleteApplicationInstance

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
void retVal = runnerApi.deleteApplicationInstance(name, serverGroup);
retVal = baseAPI.doRunner_DeleteApplicationInstance(name, serverGroup);

Entitlement: /admin/main

Delete an application instance

Function Parameters

Parameter Type Description
name String
serverGroup String

Return value

Type Description
void

getApplicationInstance

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureApplicationInstance retVal = runnerApi.getApplicationInstance(name, serverGroup);
retVal = baseAPI.doRunner_GetApplicationInstance(name, serverGroup);

Entitlement: /admin/main

Retrieve an application instance

Function Parameters

Parameter Type Description
name String
serverGroup String

Return value

Type Description
RaptureApplicationInstance

RaptureApplicationInstance

Describes an active application.

Field Type
name String
appName String
description String
serverGroup String
timeRangeSpecification String
retryCount Integer
parameters String
apiUser String
lockedBy String
oneShot Boolean
finished Boolean
status String
lastStateChange Date

updateStatus

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
void retVal = runnerApi.updateStatus(name, serverGroup, myServer, status, finished);
retVal = baseAPI.doRunner_UpdateStatus(name, serverGroup, myServer, status, finished);

Entitlement: /admin/main

Update the status of a one shot execution, potentially marking it as finished

Function Parameters

Parameter Type Description
name String
serverGroup String
myServer String
status String
finished boolean

Return value

Type Description
void

getApplicationsForServerGroup

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
List<String> retVal = runnerApi.getApplicationsForServerGroup(serverGroup);
retVal = baseAPI.doRunner_GetApplicationsForServerGroup(serverGroup);

Entitlement: /admin/main

Returns a list of application instance (aka schedule) names that are configured to run as part of a specific server group.

Function Parameters

Parameter Type Description
serverGroup String

Return value

Type Description
List

getApplicationsForServer

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
List<RaptureApplicationInstance> retVal = runnerApi.getApplicationsForServer(serverName);
retVal = baseAPI.doRunner_GetApplicationsForServer(serverName);

Entitlement: /admin/main

Returns a list of applications that should run on a specific host (aka server). Servers are defined in inclusions; see addGroupInclusion for more details. All applications that will run on a given server will be returned. Applications belonging to a server group that includes all servers via the * wildcard will also be returned.

Function Parameters

Parameter Type Description
serverName String

Return value

Type Description
List

getApplicationDefinition

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureApplicationDefinition retVal = runnerApi.getApplicationDefinition(name);
retVal = baseAPI.doRunner_GetApplicationDefinition(name);

Entitlement: /admin/main

Retrieve an application definition

Function Parameters

Parameter Type Description
name String

Return value

Type Description
RaptureApplicationDefinition

RaptureApplicationDefinition

Describes an application that this Rapture instance recognizes.

Field Type
name String
description String
version String

setRunnerConfig

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
void retVal = runnerApi.setRunnerConfig(name, value);
retVal = baseAPI.doRunner_SetRunnerConfig(name, value);

Entitlement: /admin/main

Set a config variable available in RaptureRunner. The config variables understood are APPSOURCE and MODSOURCE, and they specify the location of the apps and libraries controlled by RaptureRunner.

Function Parameters

Parameter Type Description
name String
value String

Return value

Type Description
void

deleteRunnerConfig

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
void retVal = runnerApi.deleteRunnerConfig(name);
retVal = baseAPI.doRunner_DeleteRunnerConfig(name);

Entitlement: /admin/main

Removes a variable from the Runner config.

Function Parameters

Parameter Type Description
name String

Return value

Type Description
void

getRunnerConfig

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureRunnerConfig retVal = runnerApi.getRunnerConfig();
retVal = baseAPI.doRunner_GetRunnerConfig();

Entitlement: /admin/main

Returns the RaptureRunnerConfig object, which contains the values of the variables configured via setRunnerConfig.

Function Parameters

This function takes no parameters.

Return value

Type Description
RaptureRunnerConfig

RaptureRunnerConfig

Config info for the current RaptureRunner implementation.

Field Type
config Map(String, String)

recordRunnerStatus

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
void retVal = runnerApi.recordRunnerStatus(serverName, serverGroup, appInstance, appName, status);
retVal = baseAPI.doRunner_RecordRunnerStatus(serverName, serverGroup, appInstance, appName, status);

Entitlement: /admin/main

Records the status of an application instance by acquiring a lock based on the server name, similar to the behavior of cleanRunnerStatus and markForRestart.

Function Parameters

Parameter Type Description
serverName String
serverGroup String
appInstance String
appName String
status String

Return value

Type Description
void

recordInstanceCapabilities

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
void retVal = runnerApi.recordInstanceCapabilities(serverName, instanceName, capabilities);
retVal = baseAPI.doRunner_RecordInstanceCapabilities(serverName, instanceName, capabilities);

Entitlement: /admin/main

Each RaptureApplicationInstance has certain capabilities associated with it. These could be queried by other apps if necessary (see getCapabilities). For example, the RaptureAPIServer has a capability to handle api calls, and it posts its api uri, including port, as a capability, that other apps can retrieve if they want to contact the api directly. This method will record capabilities for a given instance.

Function Parameters

Parameter Type Description
serverName String
instanceName String
capabilities Map

Return value

Type Description
void

getCapabilities

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
Map<String,RaptureInstanceCapabilities> retVal = runnerApi.getCapabilities(serverName, instanceNames);
retVal = baseAPI.doRunner_GetCapabilities(serverName, instanceNames);

Entitlement: /admin/main

Returns the capabilities for one or more instance running on the specified host. See also recordInstanceCapabilities.

Function Parameters

Parameter Type Description
serverName String
instanceNames List

Return value

Type Description
Map

getRunnerServers

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
List<String> retVal = runnerApi.getRunnerServers();
retVal = baseAPI.doRunner_GetRunnerServers();

Entitlement: /admin/main

Gets a list of all the known server names (aka hostnames). This is determined by finding where a RaptureRunner is currently running or has run in the past and recorded a status (which has not been deleted), whether it be up or down.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getRunnerStatus

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
RaptureRunnerStatus retVal = runnerApi.getRunnerStatus(serverName);
retVal = baseAPI.doRunner_GetRunnerStatus(serverName);

Entitlement: /admin/main

Get a RaptureRunnerStatus object for one specific host, which is a map of the statuses of all instances on a specific host.

Function Parameters

Parameter Type Description
serverName String

Return value

Type Description
RaptureRunnerStatus

RaptureRunnerStatus

Contains status info for all instances of RaptureRunner.

Field Type
serverName String
statusByInstanceName Map

cleanRunnerStatus

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
void retVal = runnerApi.cleanRunnerStatus(ageInMinutes);
retVal = baseAPI.doRunner_CleanRunnerStatus(ageInMinutes);

Entitlement: /admin/main

Cleans out old status information, older than the passed parameter in minutes. It acquires a lock based on the server name, same as recordRunnerStatus and markForRestart.

Function Parameters

Parameter Type Description
ageInMinutes int

Return value

Type Description
void

markForRestart

HttpRunnerApi runnerApi = new HttpRunnerApi(loginApi);
void retVal = runnerApi.markForRestart(serverName, name);
retVal = baseAPI.doRunner_MarkForRestart(serverName, name);

Entitlement: /admin/main

Marks a running instance as needing reboot. If an application is not found as running on the specified server, nothing is done. This will not start a server that is not running. This acquires a lock based on the server name, same as recordRunnerStatus and cleanRunnerStatus.

Function Parameters

Parameter Type Description
serverName String
name String

Return value

Type Description
void

Schedule API

The methods in this API control the scheduler function in a Rapture implementation.

createJob

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
RaptureJob retVal = scheduleApi.createJob(jobURI, description, scriptURI, cronExpression, timeZone, jobParams, autoActivate);
retVal = baseAPI.doSchedule_CreateJob(jobURI, description, scriptURI, cronExpression, timeZone, jobParams, autoActivate);

Entitlement: /admin/schedule

Creates a new job. The executableURI should point to a RaptureScript. A job needs to be activated for it be available for execution. A job can be either auto-activate (i.e. it is activated, then de-activated while it runs, then activated on completion. OR it can be not-auto-activate, whereupon it needs to be activatedmanually, by either a predecessor job (a job that has this job as a dependency) or manually via the activate schedule API call.

Function Parameters

Parameter Type Description
jobURI String
description String
scriptURI String
cronExpression String
timeZone String
jobParams Map
autoActivate boolean

Return value

Type Description
RaptureJob

RaptureJob

Contains info for a script-driven job in Rapture.

Field Type
jobURI JobURI
description String
scriptURI ScriptURI
cronSpec String
timeZone String
params Map
autoActivate Boolean
activated Boolean
jobType JobType
maxRuntimeMinutes Integer
appStatusNamePattern String

createWorkflowJob

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
RaptureJob retVal = scheduleApi.createWorkflowJob(jobURI, description, workflowURI, cronExpression, timeZone, jobParams, autoActivate, maxRuntimeMinutes, appStatusNamePattern);
retVal = baseAPI.doSchedule_CreateWorkflowJob(jobURI, description, workflowURI, cronExpression, timeZone, jobParams, autoActivate, maxRuntimeMinutes, appStatusNamePattern);

Entitlement: /admin/schedule

Creates a new Workflow-based job. The executableURI should point to a Workflow. A WorkOrder will be createdwhen the job is executed. The jobParams will be passed in to the Workflow as the contextMap.The maxRuntimeMinutes will be used to throw alerts when the job runs longer than expected.A job needs to be activated for it be available for execution. A job can be either auto-activate (i.e. it is activated, then de-activated while it runs, then activated on completion. OR it can be not-auto-activate, whereupon it needs to be activatedmanually, by either a predecessor job (a job that has this job as a dependency) or manually via the activate schedule API call.

Function Parameters

Parameter Type Description
jobURI String
description String
workflowURI String
cronExpression String
timeZone String
jobParams Map
autoActivate boolean
maxRuntimeMinutes int
appStatusNamePattern String

Return value

Type Description
RaptureJob

RaptureJob

Contains info for a script-driven job in Rapture.

Field Type
jobURI JobURI
description String
scriptURI ScriptURI
cronSpec String
timeZone String
params Map
autoActivate Boolean
activated Boolean
jobType JobType
maxRuntimeMinutes Integer
appStatusNamePattern String

activateJob

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
void retVal = scheduleApi.activateJob(jobURI, extraParams);
retVal = baseAPI.doSchedule_ActivateJob(jobURI, extraParams);

Entitlement: /admin/schedule

Activate a job (usually that is not auto-activate). This means that the job will now be picked up by the scheduler and executed at whatever time it is configured to run.

Function Parameters

Parameter Type Description
jobURI String
extraParams Map

Return value

Type Description
void

deactivateJob

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
void retVal = scheduleApi.deactivateJob(jobURI);
retVal = baseAPI.doSchedule_DeactivateJob(jobURI);

Entitlement: /admin/schedule

Turns off a job’s schedule-based execution.

Function Parameters

Parameter Type Description
jobURI String

Return value

Type Description
void

retrieveJob

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
RaptureJob retVal = scheduleApi.retrieveJob(jobURI);
retVal = baseAPI.doSchedule_RetrieveJob(jobURI);

Entitlement: /admin/schedule

Retrieve the definition of a job given its URI.

Function Parameters

Parameter Type Description
jobURI String

Return value

Type Description
RaptureJob

RaptureJob

Contains info for a script-driven job in Rapture.

Field Type
jobURI JobURI
description String
scriptURI ScriptURI
cronSpec String
timeZone String
params Map
autoActivate Boolean
activated Boolean
jobType JobType
maxRuntimeMinutes Integer
appStatusNamePattern String

retrieveJobs

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
List<RaptureJob> retVal = scheduleApi.retrieveJobs(uriPrefix);
retVal = baseAPI.doSchedule_RetrieveJobs(uriPrefix);

Entitlement: /admin/schedule

Retrieve the definition of all jobs in the system whose uri starts with a certain prefix (e.g job://my/jobs/date1)

Function Parameters

Parameter Type Description
uriPrefix String

Return value

Type Description
List

runJobNow

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
String retVal = scheduleApi.runJobNow(jobURI, extraParams);
retVal = baseAPI.doSchedule_RunJobNow(jobURI, extraParams);

Entitlement: /admin/schedule

Run this job immediately. If the job has a workflow as an executable, the workOrder URI is returned.

Function Parameters

Parameter Type Description
jobURI String
extraParams Map

Return value

Type Description
String

resetJob

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
void retVal = scheduleApi.resetJob(jobURI);
retVal = baseAPI.doSchedule_ResetJob(jobURI);

Entitlement: /admin/schedule

Removes the upcoming scheduled execution of this job and schedules it to run according to the cron in the job configuration.

Function Parameters

Parameter Type Description
jobURI String

Return value

Type Description
void

retrieveJobExec

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
RaptureJobExec retVal = scheduleApi.retrieveJobExec(jobURI, execTime);
retVal = baseAPI.doSchedule_RetrieveJobExec(jobURI, execTime);

Entitlement: /admin/schedule

Retrieves the execution of a job.

Function Parameters

Parameter Type Description
jobURI String
execTime Long

Return value

Type Description
RaptureJobExec

RaptureJobExec

Contains info about an active or queued job.

Field Type
jobURI JobURI
jobType JobType
status JobExecStatus
execTime Long
passedParams Map
execDetails String

deleteJob

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
void retVal = scheduleApi.deleteJob(jobURI);
retVal = baseAPI.doSchedule_DeleteJob(jobURI);

Entitlement: /admin/schedule

Removes a job from the system.

Function Parameters

Parameter Type Description
jobURI String

Return value

Type Description
void

getJobs

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
List<String> retVal = scheduleApi.getJobs();
retVal = baseAPI.doSchedule_GetJobs();

Entitlement: /admin/schedule

Retrieves all of the JobURI addresses of the jobs in the system.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getRunningWorkflowJobs

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
List<RaptureJobExec> retVal = scheduleApi.getRunningWorkflowJobs();
retVal = baseAPI.doSchedule_GetRunningWorkflowJobs();

Entitlement: /admin/schedule

Retrieves all of the workflow job execs that are currently running.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getUpcomingJobs

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
List<RaptureJobExec> retVal = scheduleApi.getUpcomingJobs();
retVal = baseAPI.doSchedule_GetUpcomingJobs();

Entitlement: /admin/schedule

Retrieves all of the upcoming jobs in the system.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getWorkflowExecsStatus

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
WorkflowExecsStatus retVal = scheduleApi.getWorkflowExecsStatus();
retVal = baseAPI.doSchedule_GetWorkflowExecsStatus();

Entitlement: /admin/schedule

Retrieves the status of all current workflow-based job executions. This looks into the last execution as well as upcoming execution for all scheduled jobs. The return object contains a list of jobs that succeeded, failed, are overrun, or are ok (i.e. either scheduled to start in the future or currently running but not overrun). For failed or overrun jobs, information is also returned as to whether the failure/overrun has been acknowledged. See also ackJobError.

Function Parameters

This function takes no parameters.

Return value

Type Description
WorkflowExecsStatus

WorkflowExecsStatus

The status for a workflow-based job that’s already completed.

Field Type
failed List
ok List
overrun List
success List

ackJobError

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
JobErrorAck retVal = scheduleApi.ackJobError(jobURI, execTime, jobErrorType);
retVal = baseAPI.doSchedule_AckJobError(jobURI, execTime, jobErrorType);

Entitlement: /admin/schedule

Acknowledges a job failure, storing the acknowledgment in Rapture. This information is returned when retrieving job statuses. See also getWorkflowExecsStatus.

Function Parameters

Parameter Type Description
jobURI String
execTime Long
jobErrorType String

Return value

Type Description
JobErrorAck

JobErrorAck

Acknowledgement of a job failure or delay.

Field Type
jobURI JobURI
execTime Long
errorType JobErrorType
timestamp Long
user String

getNextExec

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
RaptureJobExec retVal = scheduleApi.getNextExec(jobURI);
retVal = baseAPI.doSchedule_GetNextExec(jobURI);

Entitlement: /admin/schedule

Gets the next execution time for a given job.

Function Parameters

Parameter Type Description
jobURI String

Return value

Type Description
RaptureJobExec

RaptureJobExec

Contains info about an active or queued job.

Field Type
jobURI JobURI
jobType JobType
status JobExecStatus
execTime Long
passedParams Map
execDetails String

getJobExecs

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
List<RaptureJobExec> retVal = scheduleApi.getJobExecs(jobURI, start, count, reversed);
retVal = baseAPI.doSchedule_GetJobExecs(jobURI, start, count, reversed);

Entitlement: /admin/schedule

Retrieves a list of job executions in a given range.

Function Parameters

Parameter Type Description
jobURI String
start int
count int
reversed boolean

Return value

Type Description
List

batchGetJobExecs

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
List<RaptureJobExec> retVal = scheduleApi.batchGetJobExecs(jobURI, start, count, reversed);
retVal = baseAPI.doSchedule_BatchGetJobExecs(jobURI, start, count, reversed);

Entitlement: /admin/schedule

Retrieve a list of job executions for a list of jobs. This will return the job executions starting at index start (inclusive), and going onfor count. If reverse is true, it starts from the end.

Function Parameters

Parameter Type Description
jobURI List
start int
count int
reversed boolean

Return value

Type Description
List

isJobReadyToRun

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
boolean retVal = scheduleApi.isJobReadyToRun(toJobURI);
retVal = baseAPI.doSchedule_IsJobReadyToRun(toJobURI);

Entitlement: /admin/schedule

Return whether the given job is ready to run.

Function Parameters

Parameter Type Description
toJobURI String

Return value

Type Description
boolean

getCurrentWeekTimeRecords

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
List<TimedEventRecord> retVal = scheduleApi.getCurrentWeekTimeRecords(weekOffsetfromNow);
retVal = baseAPI.doSchedule_GetCurrentWeekTimeRecords(weekOffsetfromNow);

Entitlement: /admin/schedule

For TimeServer, get a list of scheduled events for this week (starts on Sunday, use offset to look at next week)

Function Parameters

Parameter Type Description
weekOffsetfromNow int

Return value

Type Description
List

getCurrentDayJobs

HttpScheduleApi scheduleApi = new HttpScheduleApi(loginApi);
List<TimedEventRecord> retVal = scheduleApi.getCurrentDayJobs();
retVal = baseAPI.doSchedule_GetCurrentDayJobs();

Entitlement: /admin/schedule

For TimeServer, get a list of scheduled jobs for the current day

Function Parameters

This function takes no parameters.

Return value

Type Description
List

Script API

The Scripting API is used to define and manage Reflex scripts that are used within Rapture.

createScript

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
RaptureScript retVal = scriptApi.createScript(scriptURI, language, purpose, script);
retVal = baseAPI.doScript_CreateScript(scriptURI, language, purpose, script);

Entitlement: /script/write/$f(scriptURI)

Creates a script in the system.

Function Parameters

Parameter Type Description
scriptURI String
language RaptureScriptLanguage
purpose RaptureScriptPurpose
script String

Return value

Type Description
RaptureScript

RaptureScriptLanguage

One of the scripting languages compatible with Rapture.

Field Type
REFLEX String

RaptureScriptPurpose

Describes the script’s functionality.

Field Type
INDEXGENERATOR String
MAP String
FILTER String
OPERATION String
PROGRAM String
LINK String

RaptureScript

Defines a script used to run a Rapture job.

Field Type
name String
script String
language RaptureScriptLanguage
purpose RaptureScriptPurpose
authority String
parameters List(RaptureParameter)
HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
void retVal = scriptApi.createScriptLink(fromScriptURI, toScriptURI);
retVal = baseAPI.doScript_CreateScriptLink(fromScriptURI, toScriptURI);

Entitlement: /script/write/$f(fromScriptURI)

Creates a symbolic link to a script in the system.

Function Parameters

Parameter Type Description
fromScriptURI String
toScriptURI String

Return value

Type Description
void
HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
void retVal = scriptApi.removeScriptLink(fromScriptURI);
retVal = baseAPI.doScript_RemoveScriptLink(fromScriptURI);

Entitlement: /script/write/$f(fromScriptURI)

Removes a symbolic link to a script in the system.

Function Parameters

Parameter Type Description
fromScriptURI String

Return value

Type Description
void

doesScriptExist

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
boolean retVal = scriptApi.doesScriptExist(scriptURI);
retVal = baseAPI.doScript_DoesScriptExist(scriptURI);

Entitlement: /script/read/$f(scriptURI)

Returns true the given script was found.

Function Parameters

Parameter Type Description
scriptURI String

Return value

Type Description
boolean

deleteScript

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
void retVal = scriptApi.deleteScript(scriptUri);
retVal = baseAPI.doScript_DeleteScript(scriptUri);

Entitlement: /script/write/$f(scriptUri)

Removes the script from the system.

Function Parameters

Parameter Type Description
scriptUri String

Return value

Type Description
void

getScriptNames

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
List<String> retVal = scriptApi.getScriptNames(scriptURI);
retVal = baseAPI.doScript_GetScriptNames(scriptURI);

Entitlement: /script/read/$f(scriptURI)

Retrieves all of the scripts within a authority.

Function Parameters

Parameter Type Description
scriptURI String

Return value

Type Description
List

getScript

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
RaptureScript retVal = scriptApi.getScript(scriptURI);
retVal = baseAPI.doScript_GetScript(scriptURI);

Entitlement: /script/read/$f(scriptURI)

Retrieves the contents of a script.

Function Parameters

Parameter Type Description
scriptURI String

Return value

Type Description
RaptureScript

RaptureScript

Defines a script used to run a Rapture job.

Field Type
name String
script String
language RaptureScriptLanguage
purpose RaptureScriptPurpose
authority String
parameters List(RaptureParameter)

getInterface

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
ScriptInterface retVal = scriptApi.getInterface(scriptURI);
retVal = baseAPI.doScript_GetInterface(scriptURI);

Entitlement: /script/read/$f(scriptURI)

Retrieves the parameter information for a script.

Function Parameters

Parameter Type Description
scriptURI String

Return value

Type Description
ScriptInterface

ScriptInterface

Script input and output metadata.

Field Type
properties Map
inputs Map
ret ScriptParameter

putScript

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
RaptureScript retVal = scriptApi.putScript(scriptURI, script);
retVal = baseAPI.doScript_PutScript(scriptURI, script);

Entitlement: /script/write/$f(scriptURI)

Stores a script in the system using a RaptureScript object. TODO is there really any point in passing the URI? The storage location is based on RaptureScript.All we do is extract the Authority from the URI; the caller can do that.

Function Parameters

Parameter Type Description
scriptURI String
script RaptureScript

Return value

Type Description
RaptureScript

RaptureScript

Defines a script used to run a Rapture job.

Field Type
name String
script String
language RaptureScriptLanguage
purpose RaptureScriptPurpose
authority String
parameters List(RaptureParameter)

RaptureScript

Defines a script used to run a Rapture job.

Field Type
name String
script String
language RaptureScriptLanguage
purpose RaptureScriptPurpose
authority String
parameters List(RaptureParameter)

putRawScript

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
RaptureScript retVal = scriptApi.putRawScript(scriptURI, content, language, purpose, param_types, param_names);
retVal = baseAPI.doScript_PutRawScript(scriptURI, content, language, purpose, param_types, param_names);

Entitlement: /script/write/$f(scriptURI)

Store a script in the system using raw inputs. Most users will want the value PROGRAM for purpose.

Function Parameters

Parameter Type Description
scriptURI String
content String
language String
purpose String
param_types List
param_names List

Return value

Type Description
RaptureScript

RaptureScript

Defines a script used to run a Rapture job.

Field Type
name String
script String
language RaptureScriptLanguage
purpose RaptureScriptPurpose
authority String
parameters List(RaptureParameter)

runScript

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
String retVal = scriptApi.runScript(scriptURI, parameters);
retVal = baseAPI.doScript_RunScript(scriptURI, parameters);

Entitlement: /script/exec/$f(scriptURI)

Run a script in the Rapture environment.

Function Parameters

Parameter Type Description
scriptURI String
parameters Map

Return value

Type Description
String

runScriptExtended

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
ScriptResult retVal = scriptApi.runScriptExtended(scriptURI, parameters);
retVal = baseAPI.doScript_RunScriptExtended(scriptURI, parameters);

Entitlement: /script/exec/$f(scriptURI)

Runs a script in the Rapture environment.

Function Parameters

Parameter Type Description
scriptURI String
parameters Map

Return value

Type Description
ScriptResult

ScriptResult

Returns the variable name and output of a given script.

Field Type
returnValue String
output List(String)

checkScript

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
String retVal = scriptApi.checkScript(scriptURI);
retVal = baseAPI.doScript_CheckScript(scriptURI);

Entitlement: /script/read/$f(scriptURI)

Parses the script and returns any error messages from the parsing process. If the String returned is empty the script is valid Reflex.

Function Parameters

Parameter Type Description
scriptURI String

Return value

Type Description
String

createREPLSession

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
String retVal = scriptApi.createREPLSession();
retVal = baseAPI.doScript_CreateREPLSession();

Entitlement: /script/exec

Creates a Reflex REPL session that can be written to. These sessions eventually die if not used or killed

Function Parameters

This function takes no parameters.

Return value

Type Description
String

destroyREPLSession

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
void retVal = scriptApi.destroyREPLSession(sessionId);
retVal = baseAPI.doScript_DestroyREPLSession(sessionId);

Entitlement: /script/exec

Kills an existing Reflex REPL session.

Function Parameters

Parameter Type Description
sessionId String

Return value

Type Description
void

evaluateREPL

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
String retVal = scriptApi.evaluateREPL(sessionId, line);
retVal = baseAPI.doScript_EvaluateREPL(sessionId, line);

Entitlement: /script/exec

Adds a line to the current Reflex session, returns back what the parser/evaluator says

Function Parameters

Parameter Type Description
sessionId String
line String

Return value

Type Description
String

archiveOldREPLSessions

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
void retVal = scriptApi.archiveOldREPLSessions(ageInMinutes);
retVal = baseAPI.doScript_ArchiveOldREPLSessions(ageInMinutes);

Entitlement: /admin/script

Archive/delete old REPL sessions

Function Parameters

Parameter Type Description
ageInMinutes Long

Return value

Type Description
void

createSnippet

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
RaptureSnippet retVal = scriptApi.createSnippet(snippetURI, snippet);
retVal = baseAPI.doScript_CreateSnippet(snippetURI, snippet);

Entitlement: /admin/snippet

Creates a code snippet and stores it in Rapture.

Function Parameters

Parameter Type Description
snippetURI String
snippet String

Return value

Type Description
RaptureSnippet

RaptureSnippet

Defines a portion of a Rapture script.

Field Type
name String
authority String
snippet String

getSnippetChildren

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
List<RaptureFolderInfo> retVal = scriptApi.getSnippetChildren(prefix);
retVal = baseAPI.doScript_GetSnippetChildren(prefix);

Entitlement: /admin/snippet

Returns all children snippets with a given prefix.

Function Parameters

Parameter Type Description
prefix String

Return value

Type Description
List

deleteSnippet

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
void retVal = scriptApi.deleteSnippet(snippetURI);
retVal = baseAPI.doScript_DeleteSnippet(snippetURI);

Entitlement: /admin/snippet

Deletes a snippet by its URI.

Function Parameters

Parameter Type Description
snippetURI String

Return value

Type Description
void

getSnippet

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
RaptureSnippet retVal = scriptApi.getSnippet(snippetURI);
retVal = baseAPI.doScript_GetSnippet(snippetURI);

Entitlement: /admin/snippet

Retrieves a snippet by its URI.

Function Parameters

Parameter Type Description
snippetURI String

Return value

Type Description
RaptureSnippet

RaptureSnippet

Defines a portion of a Rapture script.

Field Type
name String
authority String
snippet String

listScriptsByUriPrefix

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
Map<String,RaptureFolderInfo> retVal = scriptApi.listScriptsByUriPrefix(scriptUri, depth);
retVal = baseAPI.doScript_ListScriptsByUriPrefix(scriptUri, depth);

Entitlement: /script/read/$f(scriptUri)

Returns full pathnames for an entire subtree as a map of path to RFI.

Function Parameters

Parameter Type Description
scriptUri String
depth int

Return value

Type Description
Map

deleteScriptsByUriPrefix

HttpScriptApi scriptApi = new HttpScriptApi(loginApi);
List<String> retVal = scriptApi.deleteScriptsByUriPrefix(scriptUri);
retVal = baseAPI.doScript_DeleteScriptsByUriPrefix(scriptUri);

Entitlement: /script/write/$f(scriptUri)

Removes a folder and its contents recursively, including empty subfolders. Returns a list of the scripts and folders removed.

Function Parameters

Parameter Type Description
scriptUri String

Return value

Type Description
List

Search API

Search related functions for indexed data and fast retrieval

HttpSearchApi searchApi = new HttpSearchApi(loginApi);
SearchResponse retVal = searchApi.search(query);
retVal = baseAPI.doSearch_Search(query);

Entitlement: /search/read

Search for data using a Lucene compliant query string query. Default size of result set returned is 10

Function Parameters

Parameter Type Description
query String

Return value

Type Description
SearchResponse

SearchResponse

A SearchResponse object encapsulates the important information returned by using the search api in Rapture

Field Type
total Long
maxScore Double
cursorId String
searchHits List

searchWithCursor

HttpSearchApi searchApi = new HttpSearchApi(loginApi);
SearchResponse retVal = searchApi.searchWithCursor(cursorId, size, query);
retVal = baseAPI.doSearch_SearchWithCursor(cursorId, size, query);

Entitlement: /search/read

Search for data using a Lucene compliant query string query. This will return a cursor for scrolling thru the results. The initial call should pass in the cursor argument as null or empty, but subsequent calls should use the previously returned cursorId. The size parameter specifies how many results should be returned per call

Function Parameters

Parameter Type Description
cursorId String
size int
query String

Return value

Type Description
SearchResponse

SearchResponse

A SearchResponse object encapsulates the important information returned by using the search api in Rapture

Field Type
total Long
maxScore Double
cursorId String
searchHits List

qualifiedSearch

HttpSearchApi searchApi = new HttpSearchApi(loginApi);
SearchResponse retVal = searchApi.qualifiedSearch(searchRepo, types, query);
retVal = baseAPI.doSearch_QualifiedSearch(searchRepo, types, query);

Entitlement: /search/read

Search for data using a Lucene compliant query string query. Default size of result set returned is 10

Function Parameters

Parameter Type Description
searchRepo String
types List
query String

Return value

Type Description
SearchResponse

SearchResponse

A SearchResponse object encapsulates the important information returned by using the search api in Rapture

Field Type
total Long
maxScore Double
cursorId String
searchHits List

qualifiedSearchWithCursor

HttpSearchApi searchApi = new HttpSearchApi(loginApi);
SearchResponse retVal = searchApi.qualifiedSearchWithCursor(searchRepo, types, cursorId, size, query);
retVal = baseAPI.doSearch_QualifiedSearchWithCursor(searchRepo, types, cursorId, size, query);

Entitlement: /search/read

Search for data using a Lucene compliant query string query. This will return a cursor for scrolling thru the results. The initial call should pass in the cursor argument as null or empty, but subsequent calls should use the previously returned cursorId. The size parameter specifies how many results should be returned per call

Function Parameters

Parameter Type Description
searchRepo String
types List
cursorId String
size int
query String

Return value

Type Description
SearchResponse

SearchResponse

A SearchResponse object encapsulates the important information returned by using the search api in Rapture

Field Type
total Long
maxScore Double
cursorId String
searchHits List

validateSearchRepo

HttpSearchApi searchApi = new HttpSearchApi(loginApi);
boolean retVal = searchApi.validateSearchRepo(searchRepoUri);
retVal = baseAPI.doSearch_ValidateSearchRepo(searchRepoUri);

Entitlement: /repo/write

Validates repository; requires write permission because it can cause files/tables to be created on first use.

Function Parameters

Parameter Type Description
searchRepoUri String

Return value

Type Description
boolean

createSearchRepo

HttpSearchApi searchApi = new HttpSearchApi(loginApi);
void retVal = searchApi.createSearchRepo(searchRepoUri, config);
retVal = baseAPI.doSearch_CreateSearchRepo(searchRepoUri, config);

Entitlement: /repo/write

A FTSearchRepository is used to store full text search repos.

Function Parameters

Parameter Type Description
searchRepoUri String
config String

Return value

Type Description
void

searchRepoExists

HttpSearchApi searchApi = new HttpSearchApi(loginApi);
boolean retVal = searchApi.searchRepoExists(searchRepoUri);
retVal = baseAPI.doSearch_SearchRepoExists(searchRepoUri);

Entitlement: /repo/list

This API call can be used to determine whether a given repository exists.

Function Parameters

Parameter Type Description
searchRepoUri String

Return value

Type Description
boolean

getSearchRepoConfig

HttpSearchApi searchApi = new HttpSearchApi(loginApi);
SearchRepoConfig retVal = searchApi.getSearchRepoConfig(searchRepoUri);
retVal = baseAPI.doSearch_GetSearchRepoConfig(searchRepoUri);

Entitlement: /repo/read

Retrieves the configuration string for the given search repository.

Function Parameters

Parameter Type Description
searchRepoUri String

Return value

Type Description
SearchRepoConfig

SearchRepoConfig

Describes config info for a full text search repository.

Field Type
description String
config String
authority String

getSearchRepoConfigs

HttpSearchApi searchApi = new HttpSearchApi(loginApi);
List<SearchRepoConfig> retVal = searchApi.getSearchRepoConfigs();
retVal = baseAPI.doSearch_GetSearchRepoConfigs();

Entitlement: /repo/read

Retrieves search repositories

Function Parameters

This function takes no parameters.

Return value

Type Description
List

deleteSearchRepo

HttpSearchApi searchApi = new HttpSearchApi(loginApi);
void retVal = searchApi.deleteSearchRepo(searchRepoUri);
retVal = baseAPI.doSearch_DeleteSearchRepo(searchRepoUri);

Entitlement: /repo/write

This method removes a search repository and its data from the Rapture system. There is no undo.

Function Parameters

Parameter Type Description
searchRepoUri String

Return value

Type Description
void

rebuildRepoIndex

HttpSearchApi searchApi = new HttpSearchApi(loginApi);
void retVal = searchApi.rebuildRepoIndex(repoUri);
retVal = baseAPI.doSearch_RebuildRepoIndex(repoUri);

Entitlement: /repo/write

This method rebuilds the search index associated with a repo (authority) by dropping it and recreating it (asynchronously). The repoUri passed in must have the scheme as the prefix e.g. document://myrepo or series://myrepo2

Function Parameters

Parameter Type Description
repoUri String

Return value

Type Description
void

dropRepoIndex

HttpSearchApi searchApi = new HttpSearchApi(loginApi);
void retVal = searchApi.dropRepoIndex(repoUri);
retVal = baseAPI.doSearch_DropRepoIndex(repoUri);

Entitlement: /repo/write

This method just drops the search index associated with a repo (authority). The repoUri passed in must have the scheme as the prefix e.g. document://myrepo or series://myrepo2. It is done asynchronously.

Function Parameters

Parameter Type Description
repoUri String

Return value

Type Description
void

startSearchRepos

HttpSearchApi searchApi = new HttpSearchApi(loginApi);
void retVal = searchApi.startSearchRepos();
retVal = baseAPI.doSearch_StartSearchRepos();

Entitlement: /search/admin

Initialize all search repos

Function Parameters

This function takes no parameters.

Return value

Type Description
void

Series API

For manipulating time series objects.

createSeriesRepo

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
void retVal = seriesApi.createSeriesRepo(seriesRepoUri, config);
retVal = baseAPI.doSeries_CreateSeriesRepo(seriesRepoUri, config);

Entitlement: /repo/write

Creates a repository for series data.

Function Parameters

Parameter Type Description
seriesRepoUri String
config String

Return value

Type Description
void

createSeries

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
void retVal = seriesApi.createSeries(seriesUri);
retVal = baseAPI.doSeries_CreateSeries(seriesUri);

Entitlement: /repo/write

Creates an empty series.

Function Parameters

Parameter Type Description
seriesUri String

Return value

Type Description
void

seriesRepoExists

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
boolean retVal = seriesApi.seriesRepoExists(seriesRepoUri);
retVal = baseAPI.doSeries_SeriesRepoExists(seriesRepoUri);

Entitlement: /repo/list

Check for the existence of a given repository

Function Parameters

Parameter Type Description
seriesRepoUri String

Return value

Type Description
boolean

seriesExists

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
boolean retVal = seriesApi.seriesExists(seriesUri);
retVal = baseAPI.doSeries_SeriesExists(seriesUri);

Entitlement: /repo/list

Check for the existence of a given series

Function Parameters

Parameter Type Description
seriesUri String

Return value

Type Description
boolean

getSeriesRepoConfig

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
SeriesRepoConfig retVal = seriesApi.getSeriesRepoConfig(seriesRepoUri);
retVal = baseAPI.doSeries_GetSeriesRepoConfig(seriesRepoUri);

Entitlement: /repo/read

Fetches the series repository config, or null if the repository is not found.

Function Parameters

Parameter Type Description
seriesRepoUri String

Return value

Type Description
SeriesRepoConfig

SeriesRepoConfig

Configuration info for a repository that stores series data.

Field Type
description String
config String
authority String
seriesName String
sampleColumn String

getSeriesRepoConfigs

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
List<SeriesRepoConfig> retVal = seriesApi.getSeriesRepoConfigs();
retVal = baseAPI.doSeries_GetSeriesRepoConfigs();

Entitlement: /repo/read

Fetch a list of all series repositories.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

deleteSeriesRepo

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
void retVal = seriesApi.deleteSeriesRepo(seriesRepoUri);
retVal = baseAPI.doSeries_DeleteSeriesRepo(seriesRepoUri);

Entitlement: /repo/write

This method removes a Series Repository and its data from the Rapture system. There is no undo.

Function Parameters

Parameter Type Description
seriesRepoUri String

Return value

Type Description
void

deleteSeries

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
void retVal = seriesApi.deleteSeries(seriesUri);
retVal = baseAPI.doSeries_DeleteSeries(seriesUri);

Entitlement: /data/write/$f(seriesUri)

This method removes a Series and its data from the Rapture system. There is no undo.

Function Parameters

Parameter Type Description
seriesUri String

Return value

Type Description
void

deleteSeriesByUriPrefix

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
List<String> retVal = seriesApi.deleteSeriesByUriPrefix(seriesUri);
retVal = baseAPI.doSeries_DeleteSeriesByUriPrefix(seriesUri);

Entitlement: /data/write/$f(seriesUri)

Recursively removes all series repositories that are children of the given Uri.

Function Parameters

Parameter Type Description
seriesUri String

Return value

Type Description
List

addDoubleToSeries

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
void retVal = seriesApi.addDoubleToSeries(seriesUri, pointKey, pointValue);
retVal = baseAPI.doSeries_AddDoubleToSeries(seriesUri, pointKey, pointValue);

Entitlement: /data/write/$f(seriesUri)

Adds one point of floating-point data to a given series.

Function Parameters

Parameter Type Description
seriesUri String
pointKey String
pointValue double

Return value

Type Description
void

addLongToSeries

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
void retVal = seriesApi.addLongToSeries(seriesUri, pointKey, pointValue);
retVal = baseAPI.doSeries_AddLongToSeries(seriesUri, pointKey, pointValue);

Entitlement: /data/write/$f(seriesUri)

Adds one point of type long to a given series.

Function Parameters

Parameter Type Description
seriesUri String
pointKey String
pointValue Long

Return value

Type Description
void

addStringToSeries

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
void retVal = seriesApi.addStringToSeries(seriesUri, pointKey, pointValue);
retVal = baseAPI.doSeries_AddStringToSeries(seriesUri, pointKey, pointValue);

Entitlement: /data/write/$f(seriesUri)

Adds one point of string data to a given series.

Function Parameters

Parameter Type Description
seriesUri String
pointKey String
pointValue String

Return value

Type Description
void

addStructureToSeries

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
void retVal = seriesApi.addStructureToSeries(seriesUri, pointKey, pointValue);
retVal = baseAPI.doSeries_AddStructureToSeries(seriesUri, pointKey, pointValue);

Entitlement: /data/write/$f(seriesUri)

Adds one point containing a JSON-encoded structure to a given series.

Function Parameters

Parameter Type Description
seriesUri String
pointKey String
pointValue String

Return value

Type Description
void

addDoublesToSeries

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
void retVal = seriesApi.addDoublesToSeries(seriesUri, pointKeys, pointValues);
retVal = baseAPI.doSeries_AddDoublesToSeries(seriesUri, pointKeys, pointValues);

Entitlement: /data/write/$f(seriesUri)

Adds a list of points of floating-point data to a given series.

Function Parameters

Parameter Type Description
seriesUri String
pointKeys List
pointValues List

Return value

Type Description
void

addLongsToSeries

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
void retVal = seriesApi.addLongsToSeries(seriesUri, pointKeys, pointValues);
retVal = baseAPI.doSeries_AddLongsToSeries(seriesUri, pointKeys, pointValues);

Entitlement: /data/write/$f(seriesUri)

Adds a list of points of type long to a given series.

Function Parameters

Parameter Type Description
seriesUri String
pointKeys List
pointValues List

Return value

Type Description
void

addStringsToSeries

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
void retVal = seriesApi.addStringsToSeries(seriesUri, pointKeys, pointValues);
retVal = baseAPI.doSeries_AddStringsToSeries(seriesUri, pointKeys, pointValues);

Entitlement: /data/write/$f(seriesUri)

Adds a list of string points to a given series.

Function Parameters

Parameter Type Description
seriesUri String
pointKeys List
pointValues List

Return value

Type Description
void

addStructuresToSeries

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
void retVal = seriesApi.addStructuresToSeries(seriesUri, pointKeys, pointValues);
retVal = baseAPI.doSeries_AddStructuresToSeries(seriesUri, pointKeys, pointValues);

Entitlement: /data/write/$f(seriesUri)

Adds a list of points containing JSON-encoded structures to a series.

Function Parameters

Parameter Type Description
seriesUri String
pointKeys List
pointValues List

Return value

Type Description
void

deletePointsFromSeriesByPointKey

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
void retVal = seriesApi.deletePointsFromSeriesByPointKey(seriesUri, pointKeys);
retVal = baseAPI.doSeries_DeletePointsFromSeriesByPointKey(seriesUri, pointKeys);

Entitlement: /data/write/$f(seriesUri)

Delete a list of points from a series.

Function Parameters

Parameter Type Description
seriesUri String
pointKeys List

Return value

Type Description
void

deletePointsFromSeries

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
void retVal = seriesApi.deletePointsFromSeries(seriesUri);
retVal = baseAPI.doSeries_DeletePointsFromSeries(seriesUri);

Entitlement: /data/write/$f(seriesUri)

Removes all points in a series, then removes the series from the directory listing for its parent folder.

Function Parameters

Parameter Type Description
seriesUri String

Return value

Type Description
void

getLastPoint

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
SeriesPoint retVal = seriesApi.getLastPoint(seriesUri);
retVal = baseAPI.doSeries_GetLastPoint(seriesUri);

Entitlement: /data/read/$f(seriesUri)

Retrieves the last point in a series.

Function Parameters

Parameter Type Description
seriesUri String

Return value

Type Description
SeriesPoint

SeriesPoint

*This object holds the data for a series value that was requested, without specifying what type to present data as. *

Field Type
column String
value String

getPoints

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
List<SeriesPoint> retVal = seriesApi.getPoints(seriesUri);
retVal = baseAPI.doSeries_GetPoints(seriesUri);

Entitlement: /data/read/$f(seriesUri)

If the series size is less than the maximum batch size (one million points by default), this returns all points in a list. If the series is larger, an exception is thrown.

Function Parameters

Parameter Type Description
seriesUri String

Return value

Type Description
List

getPointsAfter

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
List<SeriesPoint> retVal = seriesApi.getPointsAfter(seriesUri, startColumn, maxNumber);
retVal = baseAPI.doSeries_GetPointsAfter(seriesUri, startColumn, maxNumber);

Entitlement: /data/read/$f(seriesUri)

Gets one page of data from a series

Function Parameters

Parameter Type Description
seriesUri String
startColumn String
maxNumber int

Return value

Type Description
List

getPointsAfterReverse

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
List<SeriesPoint> retVal = seriesApi.getPointsAfterReverse(seriesUri, startColumn, maxNumber);
retVal = baseAPI.doSeries_GetPointsAfterReverse(seriesUri, startColumn, maxNumber);

Entitlement: /data/read/$f(seriesUri)

Gets one page of data and reverses the normal sort order

Function Parameters

Parameter Type Description
seriesUri String
startColumn String
maxNumber int

Return value

Type Description
List

getPointsInRange

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
List<SeriesPoint> retVal = seriesApi.getPointsInRange(seriesUri, startColumn, endColumn, maxNumber);
retVal = baseAPI.doSeries_GetPointsInRange(seriesUri, startColumn, endColumn, maxNumber);

Entitlement: /data/read/$f(seriesUri)

Gets one page of data from a series range.

Function Parameters

Parameter Type Description
seriesUri String
startColumn String
endColumn String
maxNumber int

Return value

Type Description
List

getPointsAsDoubles

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
List<SeriesDouble> retVal = seriesApi.getPointsAsDoubles(seriesUri);
retVal = baseAPI.doSeries_GetPointsAsDoubles(seriesUri);

Entitlement: /data/read/$f(seriesUri)

Gets the entire contents of a series and casts each value to type Double.

Function Parameters

Parameter Type Description
seriesUri String

Return value

Type Description
List

getPointsAfterAsDoubles

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
List<SeriesDouble> retVal = seriesApi.getPointsAfterAsDoubles(seriesUri, startColumn, maxNumber);
retVal = baseAPI.doSeries_GetPointsAfterAsDoubles(seriesUri, startColumn, maxNumber);

Entitlement: /data/read/$f(seriesUri)

Gets one page of data from a series and casts each value to type Double.

Function Parameters

Parameter Type Description
seriesUri String
startColumn String
maxNumber int

Return value

Type Description
List

getPointsInRangeAsDoubles

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
List<SeriesDouble> retVal = seriesApi.getPointsInRangeAsDoubles(seriesUri, startColumn, endColumn, maxNumber);
retVal = baseAPI.doSeries_GetPointsInRangeAsDoubles(seriesUri, startColumn, endColumn, maxNumber);

Entitlement: /data/read/$f(seriesUri)

Gets one page of data from a series range and casts each value to type Double.

Function Parameters

Parameter Type Description
seriesUri String
startColumn String
endColumn String
maxNumber int

Return value

Type Description
List

getPointsAsStrings

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
List<SeriesString> retVal = seriesApi.getPointsAsStrings(seriesUri);
retVal = baseAPI.doSeries_GetPointsAsStrings(seriesUri);

Entitlement: /data/read/$f(seriesUri)

Gets the entire contents of a series and casts each value to type String.

Function Parameters

Parameter Type Description
seriesUri String

Return value

Type Description
List

getPointsAfterAsStrings

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
List<SeriesString> retVal = seriesApi.getPointsAfterAsStrings(seriesUri, startColumn, maxNumber);
retVal = baseAPI.doSeries_GetPointsAfterAsStrings(seriesUri, startColumn, maxNumber);

Entitlement: /data/read/$f(seriesUri)

Gets one page of data from a series and casts each value to type String.

Function Parameters

Parameter Type Description
seriesUri String
startColumn String
maxNumber int

Return value

Type Description
List

getPointsInRangeAsStrings

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
List<SeriesString> retVal = seriesApi.getPointsInRangeAsStrings(seriesUri, startColumn, endColumn, maxNumber);
retVal = baseAPI.doSeries_GetPointsInRangeAsStrings(seriesUri, startColumn, endColumn, maxNumber);

Entitlement: /data/read/$f(seriesUri)

Gets one page of data from a series range and casts each value to type String.

Function Parameters

Parameter Type Description
seriesUri String
startColumn String
endColumn String
maxNumber int

Return value

Type Description
List

runSeriesScript

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
List<SeriesPoint> retVal = seriesApi.runSeriesScript(scriptContent, arguments);
retVal = baseAPI.doSeries_RunSeriesScript(scriptContent, arguments);

Entitlement: /data/user

Executes a series function program and returns its default output.

Function Parameters

Parameter Type Description
scriptContent String
arguments List

Return value

Type Description
List

runSeriesScriptQuiet

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
void retVal = seriesApi.runSeriesScriptQuiet(scriptContent, arguments);
retVal = baseAPI.doSeries_RunSeriesScriptQuiet(scriptContent, arguments);

Entitlement: /data/user

Executes a series function program and returns success status only.

Function Parameters

Parameter Type Description
scriptContent String
arguments List

Return value

Type Description
void

listSeriesByUriPrefix

HttpSeriesApi seriesApi = new HttpSeriesApi(loginApi);
Map<String,RaptureFolderInfo> retVal = seriesApi.listSeriesByUriPrefix(seriesUri, depth);
retVal = baseAPI.doSeries_ListSeriesByUriPrefix(seriesUri, depth);

Entitlement: /data/read/$f(seriesUri)

Returns full pathnames for an entire subtree as a map of path to RFI.

Function Parameters

Parameter Type Description
seriesUri String
depth int

Return value

Type Description
Map

Structured API

SQL RDBMS support

createStructuredRepo

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.createStructuredRepo(uri, config);
retVal = baseAPI.doStructured_CreateStructuredRepo(uri, config);

Entitlement: /structured/write

Create a repository for structured data

Function Parameters

Parameter Type Description
uri String
config String

Return value

Type Description
void

deleteStructuredRepo

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.deleteStructuredRepo(uri);
retVal = baseAPI.doStructured_DeleteStructuredRepo(uri);

Entitlement: /structured/write

Delete a repository for structured data

Function Parameters

Parameter Type Description
uri String

Return value

Type Description
void

structuredRepoExists

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
boolean retVal = structuredApi.structuredRepoExists(uri);
retVal = baseAPI.doStructured_StructuredRepoExists(uri);

Entitlement: /structured/read

check existence

Function Parameters

Parameter Type Description
uri String

Return value

Type Description
boolean

getStructuredRepoConfig

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
StructuredRepoConfig retVal = structuredApi.getStructuredRepoConfig(uri);
retVal = baseAPI.doStructured_GetStructuredRepoConfig(uri);

Entitlement: /structured/read

get a specific structured repo config given a uri

Function Parameters

Parameter Type Description
uri String

Return value

Type Description
StructuredRepoConfig

StructuredRepoConfig

A structured repository definition

Field Type
description String
config String
authority String

getStructuredRepoConfigs

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
List<StructuredRepoConfig> retVal = structuredApi.getStructuredRepoConfigs();
retVal = baseAPI.doStructured_GetStructuredRepoConfigs();

Entitlement: /structured/read

get list of all configurations

Function Parameters

This function takes no parameters.

Return value

Type Description
List

createTableUsingSql

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.createTableUsingSql(schema, rawSql);
retVal = baseAPI.doStructured_CreateTableUsingSql(schema, rawSql);

Entitlement: /structured/admin/$f(schema)

create a structured table using raw sql

Function Parameters

Parameter Type Description
schema String
rawSql String

Return value

Type Description
void

createTable

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.createTable(tableUri, columns);
retVal = baseAPI.doStructured_CreateTable(tableUri, columns);

Entitlement: /structured/admin/$f(tableUri)

create a structured table using a column name to SQL column type map

Function Parameters

Parameter Type Description
tableUri String
columns Map

Return value

Type Description
void

dropTable

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.dropTable(tableUri);
retVal = baseAPI.doStructured_DropTable(tableUri);

Entitlement: /structured/admin/$f(tableUri)

drop a structured table and all of its data

Function Parameters

Parameter Type Description
tableUri String

Return value

Type Description
void

tableExists

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
boolean retVal = structuredApi.tableExists(tableUri);
retVal = baseAPI.doStructured_TableExists(tableUri);

Entitlement: /structured/read/$f(tableUri)

check if table exists

Function Parameters

Parameter Type Description
tableUri String

Return value

Type Description
boolean

getSchemas

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
List<String> retVal = structuredApi.getSchemas();
retVal = baseAPI.doStructured_GetSchemas();

Entitlement: /structured/read

get all schemas

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getTables

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
List<String> retVal = structuredApi.getTables(repoUri);
retVal = baseAPI.doStructured_GetTables(repoUri);

Entitlement: /structured/read

get all tables of a certain schema

Function Parameters

Parameter Type Description
repoUri String

Return value

Type Description
List

describeTable

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
Map<String,String> retVal = structuredApi.describeTable(tableUri);
retVal = baseAPI.doStructured_DescribeTable(tableUri);

Entitlement: /structured/read/$f(tableUri)

get table description

Function Parameters

Parameter Type Description
tableUri String

Return value

Type Description
Map

addTableColumns

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.addTableColumns(tableUri, columns);
retVal = baseAPI.doStructured_AddTableColumns(tableUri, columns);

Entitlement: /structured/admin/$f(tableUri)

add column(s) to an existing table. Table must exist beforehand

Function Parameters

Parameter Type Description
tableUri String
columns Map

Return value

Type Description
void

deleteTableColumns

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.deleteTableColumns(tableUri, columnNames);
retVal = baseAPI.doStructured_DeleteTableColumns(tableUri, columnNames);

Entitlement: /structured/admin/$f(tableUri)

remove column(s) from an existing table. Table must exist beforehand

Function Parameters

Parameter Type Description
tableUri String
columnNames List

Return value

Type Description
void

updateTableColumns

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.updateTableColumns(tableUri, columns);
retVal = baseAPI.doStructured_UpdateTableColumns(tableUri, columns);

Entitlement: /structured/admin/$f(tableUri)

update column(s) in an existing table. Table must exist beforehand

Function Parameters

Parameter Type Description
tableUri String
columns Map

Return value

Type Description
void

renameTableColumns

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.renameTableColumns(tableUri, columnNames);
retVal = baseAPI.doStructured_RenameTableColumns(tableUri, columnNames);

Entitlement: /structured/admin/$f(tableUri)

rename column(s) in an existing table. Table must exist beforehand

Function Parameters

Parameter Type Description
tableUri String
columnNames Map

Return value

Type Description
void

createIndex

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.createIndex(tableUri, indexName, columnNames);
retVal = baseAPI.doStructured_CreateIndex(tableUri, indexName, columnNames);

Entitlement: /structured/admin/$f(tableUri)

create an index on a structured table

Function Parameters

Parameter Type Description
tableUri String
indexName String
columnNames List

Return value

Type Description
void

dropIndex

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.dropIndex(tableUri, indexName);
retVal = baseAPI.doStructured_DropIndex(tableUri, indexName);

Entitlement: /structured/admin/$f(tableUri)

remove an index that was previously created on a table

Function Parameters

Parameter Type Description
tableUri String
indexName String

Return value

Type Description
void

getIndexes

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
List<TableIndex> retVal = structuredApi.getIndexes(tableUri);
retVal = baseAPI.doStructured_GetIndexes(tableUri);

Entitlement: /structured/read/$f(tableUri)

get all indexes on a structured table

Function Parameters

Parameter Type Description
tableUri String

Return value

Type Description
List

selectJoinedRows

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
List<Map<String,Object>> retVal = structuredApi.selectJoinedRows(tableUris, columnNames, from, where, order, ascending, limit);
retVal = baseAPI.doStructured_SelectJoinedRows(tableUris, columnNames, from, where, order, ascending, limit);

Entitlement: /structured/read

retrieve data from multiple tables

Function Parameters

Parameter Type Description
tableUris List
columnNames List
from String
where String
order List
ascending boolean
limit int

Return value

Type Description
List>

selectUsingSql

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
List<Map<String,Object>> retVal = structuredApi.selectUsingSql(schema, rawSql);
retVal = baseAPI.doStructured_SelectUsingSql(schema, rawSql);

Entitlement: /structured/read/$f(schema)

retrieve data with raw sql

Function Parameters

Parameter Type Description
schema String
rawSql String

Return value

Type Description
List>

selectRows

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
List<Map<String,Object>> retVal = structuredApi.selectRows(tableUri, columnNames, where, order, ascending, limit);
retVal = baseAPI.doStructured_SelectRows(tableUri, columnNames, where, order, ascending, limit);

Entitlement: /structured/read/$f(tableUri)

retrieve data from a single table

Function Parameters

Parameter Type Description
tableUri String
columnNames List
where String
order List
ascending boolean
limit int

Return value

Type Description
List>

insertUsingSql

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.insertUsingSql(schema, rawSql);
retVal = baseAPI.doStructured_InsertUsingSql(schema, rawSql);

Entitlement: /structured/write/$f(schema)

insert new data with raw sql

Function Parameters

Parameter Type Description
schema String
rawSql String

Return value

Type Description
void

insertRow

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.insertRow(tableUri, values);
retVal = baseAPI.doStructured_InsertRow(tableUri, values);

Entitlement: /structured/write/$f(tableUri)

insert new data into a single table

Function Parameters

Parameter Type Description
tableUri String
values Map

Return value

Type Description
void

insertRows

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.insertRows(tableUri, values);
retVal = baseAPI.doStructured_InsertRows(tableUri, values);

Entitlement: /structured/write/$f(tableUri)

insert one or more rows of data into a single table

Function Parameters

Parameter Type Description
tableUri String
values List>

Return value

Type Description
void

deleteUsingSql

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.deleteUsingSql(schema, rawSql);
retVal = baseAPI.doStructured_DeleteUsingSql(schema, rawSql);

Entitlement: /structured/write/$f(schema)

delete data with raw sql

Function Parameters

Parameter Type Description
schema String
rawSql String

Return value

Type Description
void

deleteRows

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.deleteRows(tableUri, where);
retVal = baseAPI.doStructured_DeleteRows(tableUri, where);

Entitlement: /structured/write/$f(tableUri)

delete data from a single table

Function Parameters

Parameter Type Description
tableUri String
where String

Return value

Type Description
void

updateUsingSql

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.updateUsingSql(schema, rawSql);
retVal = baseAPI.doStructured_UpdateUsingSql(schema, rawSql);

Entitlement: /structured/write/$f(schema)

update existing data with raw sql

Function Parameters

Parameter Type Description
schema String
rawSql String

Return value

Type Description
void

updateRows

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.updateRows(tableUri, values, where);
retVal = baseAPI.doStructured_UpdateRows(tableUri, values, where);

Entitlement: /structured/write/$f(tableUri)

update existing data from a single table

Function Parameters

Parameter Type Description
tableUri String
values Map
where String

Return value

Type Description
void

begin

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
boolean retVal = structuredApi.begin();
retVal = baseAPI.doStructured_Begin();

Entitlement: /structured/write

start a transaction

Function Parameters

This function takes no parameters.

Return value

Type Description
boolean

commit

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
boolean retVal = structuredApi.commit();
retVal = baseAPI.doStructured_Commit();

Entitlement: /structured/write

commit a transaction

Function Parameters

This function takes no parameters.

Return value

Type Description
boolean

rollback

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
boolean retVal = structuredApi.rollback();
retVal = baseAPI.doStructured_Rollback();

Entitlement: /structured/write

rollback a transaction

Function Parameters

This function takes no parameters.

Return value

Type Description
boolean

abort

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
boolean retVal = structuredApi.abort(transactionId);
retVal = baseAPI.doStructured_Abort(transactionId);

Entitlement: /structured/admin

abort a transaction of given id

Function Parameters

Parameter Type Description
transactionId String

Return value

Type Description
boolean

getTransactions

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
List<String> retVal = structuredApi.getTransactions();
retVal = baseAPI.doStructured_GetTransactions();

Entitlement: /structured/admin

get active transactions

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getDdl

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
String retVal = structuredApi.getDdl(uri, includeTableData);
retVal = baseAPI.doStructured_GetDdl(uri, includeTableData);

Entitlement: /structured/read/$f(uri)

generate the DDL sql that represents an entire schema or an individual table in the schema

Function Parameters

Parameter Type Description
uri String
includeTableData boolean

Return value

Type Description
String

getCursorUsingSql

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
String retVal = structuredApi.getCursorUsingSql(schema, rawSql);
retVal = baseAPI.doStructured_GetCursorUsingSql(schema, rawSql);

Entitlement: /structured/read/$f(schema)

retrieve a cursor for row-by-row access to data using raw sql

Function Parameters

Parameter Type Description
schema String
rawSql String

Return value

Type Description
String

getCursor

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
String retVal = structuredApi.getCursor(tableUri, columnNames, where, order, ascending, limit);
retVal = baseAPI.doStructured_GetCursor(tableUri, columnNames, where, order, ascending, limit);

Entitlement: /structured/read/$f(tableUri)

retrieve a cursor for row-by-row access to data

Function Parameters

Parameter Type Description
tableUri String
columnNames List
where String
order List
ascending boolean
limit int

Return value

Type Description
String

getCursorForJoin

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
String retVal = structuredApi.getCursorForJoin(tableUris, columnNames, from, where, order, ascending, limit);
retVal = baseAPI.doStructured_GetCursorForJoin(tableUris, columnNames, from, where, order, ascending, limit);

Entitlement: /structured/read

retrieve a cursor for data from multiple tables

Function Parameters

Parameter Type Description
tableUris List
columnNames List
from String
where String
order List
ascending boolean
limit int

Return value

Type Description
String

next

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
List<Map<String,Object>> retVal = structuredApi.next(tableUri, cursorId, count);
retVal = baseAPI.doStructured_Next(tableUri, cursorId, count);

Entitlement: /structured/read/$f(tableUri)

given a cursor id, get the next row in the result set

Function Parameters

Parameter Type Description
tableUri String
cursorId String
count int

Return value

Type Description
List>

previous

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
List<Map<String,Object>> retVal = structuredApi.previous(tableUri, cursorId, count);
retVal = baseAPI.doStructured_Previous(tableUri, cursorId, count);

Entitlement: /structured/read/$f(tableUri)

given a cursor id, get the next row in the result set

Function Parameters

Parameter Type Description
tableUri String
cursorId String
count int

Return value

Type Description
List>

closeCursor

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.closeCursor(tableUri, cursorId);
retVal = baseAPI.doStructured_CloseCursor(tableUri, cursorId);

Entitlement: /structured/read/$f(tableUri)

close a cursor once done with it

Function Parameters

Parameter Type Description
tableUri String
cursorId String

Return value

Type Description
void

createStoredProcedure

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.createStoredProcedure(procUri, rawSql, arguments);
retVal = baseAPI.doStructured_CreateStoredProcedure(procUri, rawSql, arguments);

Entitlement: /structured/admin/$f(procUri)

Create a stored procedure with raw SQL

Function Parameters

Parameter Type Description
procUri String
rawSql String
arguments Map

Return value

Type Description
void

callProcedure

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
StoredProcedureResponse retVal = structuredApi.callProcedure(procUri, params);
retVal = baseAPI.doStructured_CallProcedure(procUri, params);

Entitlement: /structured/admin/$f(procUri)

Call a stored procedure a value

Function Parameters

Parameter Type Description
procUri String
params StoredProcedureParams

Return value

Type Description
StoredProcedureResponse

StoredProcedureParams

Container for params for SQL procedure call: inParams(paramName->paramObject), outParams(paramName->java.sql.Types)

Field Type
inParams Map
outParams Map
inOutParams Map

StoredProcedureResponse

Container for return types for SQL procedure calls

Field Type
callSuccessful Boolean
singleValueReturn Map

dropProcedureUsingSql

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
void retVal = structuredApi.dropProcedureUsingSql(procUri, rawSql);
retVal = baseAPI.doStructured_DropProcedureUsingSql(procUri, rawSql);

Entitlement: /structured/admin/$f(procUri)

Delete a stored procedure with raw SQL

Function Parameters

Parameter Type Description
procUri String
rawSql String

Return value

Type Description
void

getPrimaryKey

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
String retVal = structuredApi.getPrimaryKey(tableUri);
retVal = baseAPI.doStructured_GetPrimaryKey(tableUri);

Entitlement: /structured/read/$f(tableUri)

Get primary key of a table

Function Parameters

Parameter Type Description
tableUri String

Return value

Type Description
String

getForeignKeys

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
List<ForeignKey> retVal = structuredApi.getForeignKeys(tableUri);
retVal = baseAPI.doStructured_GetForeignKeys(tableUri);

Entitlement: /structured/read/$f(tableUri)

Get foreign keys of a table

Function Parameters

Parameter Type Description
tableUri String

Return value

Type Description
List

createSequence

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
String retVal = structuredApi.createSequence(tableUri, column, arguments);
retVal = baseAPI.doStructured_CreateSequence(tableUri, column, arguments);

Entitlement: /structured/admin/$f(tableUri)

Create a named sequence

Function Parameters

Parameter Type Description
tableUri String
column String
arguments Map

Return value

Type Description
String

dropSequence

HttpStructuredApi structuredApi = new HttpStructuredApi(loginApi);
boolean retVal = structuredApi.dropSequence(tableUri, column, cascade);
retVal = baseAPI.doStructured_DropSequence(tableUri, column, cascade);

Entitlement: /structured/admin/$f(tableUri)

Delete a named sequence

Function Parameters

Parameter Type Description
tableUri String
column String
cascade boolean

Return value

Type Description
boolean

Sys API

The sys api is used to modify System config at the low level, bypassing the normal api calls. To be used with great care as incorrect usage can disable an environment.

retrieveSystemConfig

HttpSysApi sysApi = new HttpSysApi(loginApi);
String retVal = sysApi.retrieveSystemConfig(area, path);
retVal = baseAPI.doSys_RetrieveSystemConfig(area, path);

Entitlement: /admin/root

Retrieve a system config

Function Parameters

Parameter Type Description
area String
path String

Return value

Type Description
String

writeSystemConfig

HttpSysApi sysApi = new HttpSysApi(loginApi);
String retVal = sysApi.writeSystemConfig(area, path, content);
retVal = baseAPI.doSys_WriteSystemConfig(area, path, content);

Entitlement: /admin/root

Write a system config

Function Parameters

Parameter Type Description
area String
path String
content String

Return value

Type Description
String

removeSystemConfig

HttpSysApi sysApi = new HttpSysApi(loginApi);
void retVal = sysApi.removeSystemConfig(area, path);
retVal = baseAPI.doSys_RemoveSystemConfig(area, path);

Entitlement: /admin/root

Remove a system document

Function Parameters

Parameter Type Description
area String
path String

Return value

Type Description
void

getSystemFolders

HttpSysApi sysApi = new HttpSysApi(loginApi);
List<RaptureFolderInfo> retVal = sysApi.getSystemFolders(area, path);
retVal = baseAPI.doSys_GetSystemFolders(area, path);

Entitlement: /admin/root

Gets the hiearchy (the documents below this point, like with user.getChildren)

Function Parameters

Parameter Type Description
area String
path String

Return value

Type Description
List

getAllTopLevelRepos

HttpSysApi sysApi = new HttpSysApi(loginApi);
List<String> retVal = sysApi.getAllTopLevelRepos();
retVal = baseAPI.doSys_GetAllTopLevelRepos();

Entitlement: /repo/read

Retrieve all top level repos

Function Parameters

This function takes no parameters.

Return value

Type Description
List

listByUriPrefix

HttpSysApi sysApi = new HttpSysApi(loginApi);
ChildrenTransferObject retVal = sysApi.listByUriPrefix(raptureURI, marker, depth, maximum, millisUntilCacheExpiry);
retVal = baseAPI.doSys_ListByUriPrefix(raptureURI, marker, depth, maximum, millisUntilCacheExpiry);

Entitlement: /repo/read

Get children from the specified point.URI Cannot be null, but it can be the IndexMark from the ChildrenTransferObject returned by a previous call.depth indicates the number of levels to retrieve data for.If maximum > 0 then cap the number of entries returnedif there are more results than the defined maximum then store the remainder in the cache for quick access next time.The cache will expire after timeToLive milliseconds. If a zero or negative value is supplied then the configured default will be used. If refresh is true and there are more results than the defined maximum then keep track of the values that have been returned. On the next call re-read the tree and return only new entries. This is much slower than without refresh because the tree is re-read each time.

Function Parameters

Parameter Type Description
raptureURI String
marker String
depth int
maximum Long
millisUntilCacheExpiry Long

Return value

Type Description
ChildrenTransferObject

ChildrenTransferObject

Transfer Object to pass back children of URI.

Field Type
parentURI String
children Map
deleted Map
indexMark String
remainder Long

getChildren

HttpSysApi sysApi = new HttpSysApi(loginApi);
ChildrenTransferObject retVal = sysApi.getChildren(raptureURI);
retVal = baseAPI.doSys_GetChildren(raptureURI);

Entitlement: /repo/read

Retrieve all the immediate children of a URI

Function Parameters

Parameter Type Description
raptureURI String

Return value

Type Description
ChildrenTransferObject

ChildrenTransferObject

Transfer Object to pass back children of URI.

Field Type
parentURI String
children Map
deleted Map
indexMark String
remainder Long

getAllChildren

HttpSysApi sysApi = new HttpSysApi(loginApi);
ChildrenTransferObject retVal = sysApi.getAllChildren(raptureURI, marker, maximum);
retVal = baseAPI.doSys_GetAllChildren(raptureURI, marker, maximum);

Entitlement: /repo/read

Retrieve all the children of a URI, spanning multiple levels. The page size must be specified. If refresh is false and there are more results than the defined page size then store the remainder in the cache for quick access next time If refresh is true and there are more results than the defined maximum then keep track of the values that have been returned. On the next call re-read the tree and return only new entries. This is slower than without refresh because the tree is re-read each time.

Function Parameters

Parameter Type Description
raptureURI String
marker String
maximum Long

Return value

Type Description
ChildrenTransferObject

ChildrenTransferObject

Transfer Object to pass back children of URI.

Field Type
parentURI String
children Map
deleted Map
indexMark String
remainder Long

getFolderInfo

HttpSysApi sysApi = new HttpSysApi(loginApi);
NodeEnum retVal = sysApi.getFolderInfo(raptureURI);
retVal = baseAPI.doSys_GetFolderInfo(raptureURI);

Entitlement: /repo/read

Determine whether the URI references an object, a folder, both or neither

Function Parameters

Parameter Type Description
raptureURI String

Return value

Type Description
NodeEnum

getConnectionInfo

HttpSysApi sysApi = new HttpSysApi(loginApi);
Map<String,ConnectionInfo> retVal = sysApi.getConnectionInfo(connectionType);
retVal = baseAPI.doSys_GetConnectionInfo(connectionType);

Entitlement: /repo/read

Gets connection info of given connection type.

Function Parameters

Parameter Type Description
connectionType String

Return value

Type Description
Map

deleteConnectionInfo

HttpSysApi sysApi = new HttpSysApi(loginApi);
void retVal = sysApi.deleteConnectionInfo(connectionType, instanceName);
retVal = baseAPI.doSys_DeleteConnectionInfo(connectionType, instanceName);

Entitlement: /repo/write

Delete connection info

Function Parameters

Parameter Type Description
connectionType String
instanceName String

Return value

Type Description
void

setConnectionInfo

HttpSysApi sysApi = new HttpSysApi(loginApi);
void retVal = sysApi.setConnectionInfo(connectionType, instanceName, connectionInfo);
retVal = baseAPI.doSys_SetConnectionInfo(connectionType, instanceName, connectionInfo);

Entitlement: /repo/write

Sets connection info of an instance.

Function Parameters

Parameter Type Description
connectionType String
instanceName String
connectionInfo ConnectionInfo

Return value

Type Description
void

ConnectionInfo

Defines a connection info

Field Type
host String
port int
username String
password String
dbName String
instanceName String
options Map(String, Object)

getSysDocumentMeta

HttpSysApi sysApi = new HttpSysApi(loginApi);
DocumentWithMeta retVal = sysApi.getSysDocumentMeta(raptureURI);
retVal = baseAPI.doSys_GetSysDocumentMeta(raptureURI);

Entitlement: /repo/read

Retrieves the metadata for a storable object. e.g. script, workflow, workorder

Function Parameters

Parameter Type Description
raptureURI String

Return value

Type Description
DocumentWithMeta

DocumentWithMeta

Contains a Rapture document and its metadata.

Field Type
displayName String
metaData DocumentMetadata
content String

Tag API

Tagging functions for annotating data with meta information

getChildren

HttpTagApi tagApi = new HttpTagApi(loginApi);
List<RaptureFolderInfo> retVal = tagApi.getChildren(tagUri);
retVal = baseAPI.doTag_GetChildren(tagUri);

Entitlement: /tag/read/$f(tagUri)

Returns full pathnames for an entire subtree as a map of path to RFI.

Function Parameters

Parameter Type Description
tagUri String

Return value

Type Description
List

createTagDescription

HttpTagApi tagApi = new HttpTagApi(loginApi);
TagDescription retVal = tagApi.createTagDescription(tagUri, description, valueType, valueSet);
retVal = baseAPI.doTag_CreateTagDescription(tagUri, description, valueType, valueSet);

Entitlement: /tag/write/$f(tagUri)

Create a tag description - information about a tag.

Function Parameters

Parameter Type Description
tagUri String
description String
valueType String
valueSet String

Return value

Type Description
TagDescription

TagDescription

Defines a Tag Description.

Field Type
name String
description String
valueType TagValueType
valueSet String

deleteTagDescription

HttpTagApi tagApi = new HttpTagApi(loginApi);
boolean retVal = tagApi.deleteTagDescription(tagUri);
retVal = baseAPI.doTag_DeleteTagDescription(tagUri);

Entitlement: /tag/write/$f(tagUri)

Remove a tag description

Function Parameters

Parameter Type Description
tagUri String

Return value

Type Description
boolean

getTagDescription

HttpTagApi tagApi = new HttpTagApi(loginApi);
TagDescription retVal = tagApi.getTagDescription(tagUri);
retVal = baseAPI.doTag_GetTagDescription(tagUri);

Entitlement: /tag/read/$f(tagUri)

Retrieve a tag description

Function Parameters

Parameter Type Description
tagUri String

Return value

Type Description
TagDescription

TagDescription

Defines a Tag Description.

Field Type
name String
description String
valueType TagValueType
valueSet String

applyTag

HttpTagApi tagApi = new HttpTagApi(loginApi);
DocumentMetadata retVal = tagApi.applyTag(uri, tagUri, value);
retVal = baseAPI.doTag_ApplyTag(uri, tagUri, value);

Entitlement: /tag/add/$f(uri)

Apply a tag to an entity

Function Parameters

Parameter Type Description
uri String
tagUri String
value String

Return value

Type Description
DocumentMetadata

DocumentMetadata

Contains the metadata, if any, in a Rapture document.

Field Type
version Integer
writeTime Date
createdTimestamp Long
modifiedTimestamp Long
user String
comment String
deleted Boolean
tags Map
semanticUri String

applyTags

HttpTagApi tagApi = new HttpTagApi(loginApi);
DocumentMetadata retVal = tagApi.applyTags(uri, tagMap);
retVal = baseAPI.doTag_ApplyTags(uri, tagMap);

Entitlement: /tag/add/$f(uri)

Apply a set of tags to an entity (in one go)

Function Parameters

Parameter Type Description
uri String
tagMap Map

Return value

Type Description
DocumentMetadata

DocumentMetadata

Contains the metadata, if any, in a Rapture document.

Field Type
version Integer
writeTime Date
createdTimestamp Long
modifiedTimestamp Long
user String
comment String
deleted Boolean
tags Map
semanticUri String

removeTag

HttpTagApi tagApi = new HttpTagApi(loginApi);
DocumentMetadata retVal = tagApi.removeTag(uri, tagUri);
retVal = baseAPI.doTag_RemoveTag(uri, tagUri);

Entitlement: /tag/add/$f(uri)

Remove a tag

Function Parameters

Parameter Type Description
uri String
tagUri String

Return value

Type Description
DocumentMetadata

DocumentMetadata

Contains the metadata, if any, in a Rapture document.

Field Type
version Integer
writeTime Date
createdTimestamp Long
modifiedTimestamp Long
user String
comment String
deleted Boolean
tags Map
semanticUri String

removeTags

HttpTagApi tagApi = new HttpTagApi(loginApi);
DocumentMetadata retVal = tagApi.removeTags(uri, tags);
retVal = baseAPI.doTag_RemoveTags(uri, tags);

Entitlement: /tag/add/$f(uri)

Remove a set of tags

Function Parameters

Parameter Type Description
uri String
tags List

Return value

Type Description
DocumentMetadata

DocumentMetadata

Contains the metadata, if any, in a Rapture document.

Field Type
version Integer
writeTime Date
createdTimestamp Long
modifiedTimestamp Long
user String
comment String
deleted Boolean
tags Map
semanticUri String

Transform API

The transform api manages transforms, fields and structures.

getField

HttpTransformApi transformApi = new HttpTransformApi(loginApi);
RaptureField retVal = transformApi.getField(fieldUri);
retVal = baseAPI.doTransform_GetField(fieldUri);

Entitlement: /field/read/$f(fieldUri)

Retrieve a field

Function Parameters

Parameter Type Description
fieldUri String

Return value

Type Description
RaptureField

RaptureField

  • A RaptureField is the definition of a concept in Rapture, referenced within a type or a series of types.*
Field Type
name String
description String
validationScript String
fieldTypeExtra String
fieldType FieldType
associatedEntity String

putField

HttpTransformApi transformApi = new HttpTransformApi(loginApi);
void retVal = transformApi.putField(fieldUri, field);
retVal = baseAPI.doTransform_PutField(fieldUri, field);

Entitlement: /field/write/$f(fieldUri)

Save a field

Function Parameters

Parameter Type Description
fieldUri String
field RaptureField

Return value

Type Description
void

RaptureField

  • A RaptureField is the definition of a concept in Rapture, referenced within a type or a series of types.*
Field Type
name String
description String
validationScript String
fieldTypeExtra String
fieldType FieldType
associatedEntity String

deleteField

HttpTransformApi transformApi = new HttpTransformApi(loginApi);
void retVal = transformApi.deleteField(fieldUri);
retVal = baseAPI.doTransform_DeleteField(fieldUri);

Entitlement: /field/read/$f(fieldUri)

remove a field

Function Parameters

Parameter Type Description
fieldUri String

Return value

Type Description
void

getFieldChildren

HttpTransformApi transformApi = new HttpTransformApi(loginApi);
List<RaptureFolderInfo> retVal = transformApi.getFieldChildren(uriPrefix);
retVal = baseAPI.doTransform_GetFieldChildren(uriPrefix);

Entitlement: /field/list/$f(uriPrefix)

Returns full pathnames for an entire subtree as a map of the path to RFI.

Function Parameters

Parameter Type Description
uriPrefix String

Return value

Type Description
List

getStructure

HttpTransformApi transformApi = new HttpTransformApi(loginApi);
RaptureStructure retVal = transformApi.getStructure(structureUri);
retVal = baseAPI.doTransform_GetStructure(structureUri);

Entitlement: /structure/read/$f(structureUri)

Retrieve a structure

Function Parameters

Parameter Type Description
structureUri String

Return value

Type Description
RaptureStructure

RaptureStructure

  • A RaptureStructure is like a schema*
Field Type
name String
description String
fields List
transformPaths Map>

putStructure

HttpTransformApi transformApi = new HttpTransformApi(loginApi);
void retVal = transformApi.putStructure(structureUri, structure);
retVal = baseAPI.doTransform_PutStructure(structureUri, structure);

Entitlement: /structure/write/$f(structureUri)

Save a structure

Function Parameters

Parameter Type Description
structureUri String
structure RaptureStructure

Return value

Type Description
void

RaptureStructure

  • A RaptureStructure is like a schema*
Field Type
name String
description String
fields List
transformPaths Map>

deleteStructure

HttpTransformApi transformApi = new HttpTransformApi(loginApi);
void retVal = transformApi.deleteStructure(structureUri);
retVal = baseAPI.doTransform_DeleteStructure(structureUri);

Entitlement: /structure/read/$f(structureUri)

remove a structure

Function Parameters

Parameter Type Description
structureUri String

Return value

Type Description
void

getStructureChildren

HttpTransformApi transformApi = new HttpTransformApi(loginApi);
List<RaptureFolderInfo> retVal = transformApi.getStructureChildren(uriPrefix);
retVal = baseAPI.doTransform_GetStructureChildren(uriPrefix);

Entitlement: /structure/list/$f(uriPrefix)

Returns full pathnames for an entire subtree as a map of the path to RFI.

Function Parameters

Parameter Type Description
uriPrefix String

Return value

Type Description
List

getFieldTransform

HttpTransformApi transformApi = new HttpTransformApi(loginApi);
RaptureFieldTransform retVal = transformApi.getFieldTransform(transformUri);
retVal = baseAPI.doTransform_GetFieldTransform(transformUri);

Entitlement: /transform/read/$f(transformUri)

Retrieve a transform

Function Parameters

Parameter Type Description
transformUri String

Return value

Type Description
RaptureFieldTransform

RaptureFieldTransform

  • A RaptureTransform is a way of converting one set of fields to another*
Field Type
name String
description String
sourceFields List
targetFields List
transformScript String

putFieldTransform

HttpTransformApi transformApi = new HttpTransformApi(loginApi);
void retVal = transformApi.putFieldTransform(transformUri, transform);
retVal = baseAPI.doTransform_PutFieldTransform(transformUri, transform);

Entitlement: /transform/write/$f(transformUri)

Save a transform

Function Parameters

Parameter Type Description
transformUri String
transform RaptureFieldTransform

Return value

Type Description
void

RaptureFieldTransform

  • A RaptureTransform is a way of converting one set of fields to another*
Field Type
name String
description String
sourceFields List
targetFields List
transformScript String

deleteFieldTransform

HttpTransformApi transformApi = new HttpTransformApi(loginApi);
void retVal = transformApi.deleteFieldTransform(transformUri);
retVal = baseAPI.doTransform_DeleteFieldTransform(transformUri);

Entitlement: /transform/read/$f(transformUri)

remove a transform

Function Parameters

Parameter Type Description
transformUri String

Return value

Type Description
void

getFieldTransformChildren

HttpTransformApi transformApi = new HttpTransformApi(loginApi);
List<RaptureFolderInfo> retVal = transformApi.getFieldTransformChildren(uriPrefix);
retVal = baseAPI.doTransform_GetFieldTransformChildren(uriPrefix);

Entitlement: /transform/list/$f(uriPrefix)

Returns full pathnames for an entire subtree as a map of the path to RFI.

Function Parameters

Parameter Type Description
uriPrefix String

Return value

Type Description
List

validateDocument

HttpTransformApi transformApi = new HttpTransformApi(loginApi);
List<String> retVal = transformApi.validateDocument(content, transformUri);
retVal = baseAPI.doTransform_ValidateDocument(content, transformUri);

Entitlement: /transform/read/$f(transformUri)

Validates a document (content) against a structure

Function Parameters

Parameter Type Description
content String
transformUri String

Return value

Type Description
List

transformDocument

HttpTransformApi transformApi = new HttpTransformApi(loginApi);
String retVal = transformApi.transformDocument(content, sourceUri, targUri);
retVal = baseAPI.doTransform_TransformDocument(content, sourceUri, targUri);

Entitlement: /transform/read/$f(sourceUri)

Transforms a document (content) from one structure to another

Function Parameters

Parameter Type Description
content String
sourceUri String
targUri String

Return value

Type Description
String

User API

The user API contains methods for users to query and manipulate their own accounts and sessions.

getWhoAmI

HttpUserApi userApi = new HttpUserApi(loginApi);
RaptureUser retVal = userApi.getWhoAmI();
retVal = baseAPI.doUser_GetWhoAmI();

Entitlement: /everyone

Returns account information for the current user.

Function Parameters

This function takes no parameters.

Return value

Type Description
RaptureUser

RaptureUser

Defines a user account for the Rapture system.

Field Type
username String
userId String
emailAddress String
salt String
hashPassword String
description String
inactive Boolean
apiKey Boolean
hasRoot Boolean
passwordResetToken String
tokenExpirationTime Long
registrationToken String
verified Boolean
apiKeys List

logoutUser

HttpUserApi userApi = new HttpUserApi(loginApi);
void retVal = userApi.logoutUser();
retVal = baseAPI.doUser_LogoutUser();

Entitlement: /everyone

Logs out the active user and terminates the current session.

Function Parameters

This function takes no parameters.

Return value

Type Description
void

storePreference

HttpUserApi userApi = new HttpUserApi(loginApi);
void retVal = userApi.storePreference(category, name, content);
retVal = baseAPI.doUser_StorePreference(category, name, content);

Entitlement: /user/preferences

Stores application preferences for the current user.

Function Parameters

Parameter Type Description
category String
name String
content String

Return value

Type Description
void

getPreference

HttpUserApi userApi = new HttpUserApi(loginApi);
String retVal = userApi.getPreference(category, name);
retVal = baseAPI.doUser_GetPreference(category, name);

Entitlement: /user/preferences

Retrieves application preferences for the current user.

Function Parameters

Parameter Type Description
category String
name String

Return value

Type Description
String

removePreference

HttpUserApi userApi = new HttpUserApi(loginApi);
void retVal = userApi.removePreference(category, name);
retVal = baseAPI.doUser_RemovePreference(category, name);

Entitlement: /user/preferences

Removes a previously stored preference.

Function Parameters

Parameter Type Description
category String
name String

Return value

Type Description
void

getPreferenceCategories

HttpUserApi userApi = new HttpUserApi(loginApi);
List<String> retVal = userApi.getPreferenceCategories();
retVal = baseAPI.doUser_GetPreferenceCategories();

Entitlement: /user/preferences

This method will list the categories of preferences available for a user.

Function Parameters

This function takes no parameters.

Return value

Type Description
List

getPreferencesInCategory

HttpUserApi userApi = new HttpUserApi(loginApi);
List<String> retVal = userApi.getPreferencesInCategory(category);
retVal = baseAPI.doUser_GetPreferencesInCategory(category);

Entitlement: /user/preferences

This method will list the preference documents in a category.

Function Parameters

Parameter Type Description
category String

Return value

Type Description
List

updateMyDescription

HttpUserApi userApi = new HttpUserApi(loginApi);
RaptureUser retVal = userApi.updateMyDescription(description);
retVal = baseAPI.doUser_UpdateMyDescription(description);

Entitlement: /everyone

Updates the description for the current user.

Function Parameters

Parameter Type Description
description String

Return value

Type Description
RaptureUser

RaptureUser

Defines a user account for the Rapture system.

Field Type
username String
userId String
emailAddress String
salt String
hashPassword String
description String
inactive Boolean
apiKey Boolean
hasRoot Boolean
passwordResetToken String
tokenExpirationTime Long
registrationToken String
verified Boolean
apiKeys List

changeMyPassword

HttpUserApi userApi = new HttpUserApi(loginApi);
RaptureUser retVal = userApi.changeMyPassword(oldHashPassword, newHashPassword);
retVal = baseAPI.doUser_ChangeMyPassword(oldHashPassword, newHashPassword);

Entitlement: /everyone

Changes the password for the current user.

Function Parameters

Parameter Type Description
oldHashPassword String
newHashPassword String

Return value

Type Description
RaptureUser

RaptureUser

Defines a user account for the Rapture system.

Field Type
username String
userId String
emailAddress String
salt String
hashPassword String
description String
inactive Boolean
apiKey Boolean
hasRoot Boolean
passwordResetToken String
tokenExpirationTime Long
registrationToken String
verified Boolean
apiKeys List

changeMyEmail

HttpUserApi userApi = new HttpUserApi(loginApi);
RaptureUser retVal = userApi.changeMyEmail(newAddress);
retVal = baseAPI.doUser_ChangeMyEmail(newAddress);

Entitlement: /everyone

Changes the email for the current user.

Function Parameters

Parameter Type Description
newAddress String

Return value

Type Description
RaptureUser

RaptureUser

Defines a user account for the Rapture system.

Field Type
username String
userId String
emailAddress String
salt String
hashPassword String
description String
inactive Boolean
apiKey Boolean
hasRoot Boolean
passwordResetToken String
tokenExpirationTime Long
registrationToken String
verified Boolean
apiKeys List

addApiKey

HttpUserApi userApi = new HttpUserApi(loginApi);
String retVal = userApi.addApiKey(appKey);
retVal = baseAPI.doUser_AddApiKey(appKey);

Entitlement: /everyone

Register an api key

Function Parameters

Parameter Type Description
appKey String

Return value

Type Description
String

getApiKeyPairs

HttpUserApi userApi = new HttpUserApi(loginApi);
List<String> retVal = userApi.getApiKeyPairs();
retVal = baseAPI.doUser_GetApiKeyPairs();

Entitlement: /everyone

Get api keys

Function Parameters

This function takes no parameters.

Return value

Type Description
List

revokeApiKey

HttpUserApi userApi = new HttpUserApi(loginApi);
void retVal = userApi.revokeApiKey(appKey, apiKey);
retVal = baseAPI.doUser_RevokeApiKey(appKey, apiKey);

Entitlement: /everyone

Revoke an api key

Function Parameters

Parameter Type Description
appKey String
apiKey String

Return value

Type Description
void

getServerApiVersion

HttpUserApi userApi = new HttpUserApi(loginApi);
ApiVersion retVal = userApi.getServerApiVersion();
retVal = baseAPI.doUser_GetServerApiVersion();

Entitlement: /everyone

Retrieves the API version currently in use.

Function Parameters

This function takes no parameters.

Return value

Type Description
ApiVersion

ApiVersion

The ApiVersion

Field Type
major String
minor String
micro String

isPermitted

HttpUserApi userApi = new HttpUserApi(loginApi);
boolean retVal = userApi.isPermitted(apiCall, callParam);
retVal = baseAPI.doUser_IsPermitted(apiCall, callParam);

Entitlement: /everyone

A method to check whether the current user is allowed to make the API call. Useful for the UI so that it can determine whether or not to show a particular item.

Function Parameters

Parameter Type Description
apiCall String
callParam String

Return value

Type Description
boolean

Widget API

The widget api is used to manage structures that are used to build User Interfaces.

getWidget

HttpWidgetApi widgetApi = new HttpWidgetApi(loginApi);
RaptureWidget retVal = widgetApi.getWidget(widgetUri);
retVal = baseAPI.doWidget_GetWidget(widgetUri);

Entitlement: /widget/read/$f(widgetUri)

Retrieve a widget

Function Parameters

Parameter Type Description
widgetUri String

Return value

Type Description
RaptureWidget

RaptureWidget

  • A RaptureWidget is a definition of a UI entity*
Field Type
name String
menuPath List
title String
paneType String
parameterNames List
actions Map

putWidget

HttpWidgetApi widgetApi = new HttpWidgetApi(loginApi);
void retVal = widgetApi.putWidget(widgetUri, widget);
retVal = baseAPI.doWidget_PutWidget(widgetUri, widget);

Entitlement: /widget/write/$f(widgetUri)

Save a widget

Function Parameters

Parameter Type Description
widgetUri String
widget RaptureWidget

Return value

Type Description
void

RaptureWidget

  • A RaptureWidget is a definition of a UI entity*
Field Type
name String
menuPath List
title String
paneType String
parameterNames List
actions Map

deleteWidget

HttpWidgetApi widgetApi = new HttpWidgetApi(loginApi);
void retVal = widgetApi.deleteWidget(widgetUri);
retVal = baseAPI.doWidget_DeleteWidget(widgetUri);

Entitlement: /widget/write/$f(widgetUri)

remove a widget

Function Parameters

Parameter Type Description
widgetUri String

Return value

Type Description
void

getChildren

HttpWidgetApi widgetApi = new HttpWidgetApi(loginApi);
List<RaptureFolderInfo> retVal = widgetApi.getChildren(uriPrefix);
retVal = baseAPI.doWidget_GetChildren(uriPrefix);

Entitlement: /widget/list/$f(uriPrefix)

Returns full pathnames for an entire subtree as a map of the path to RFI.

Function Parameters

Parameter Type Description
uriPrefix String

Return value

Type Description
List