Package | Description |
---|---|
com.platform.api | |
com.platform.api.scripting | |
com.platform.api.workflow |
Modifier and Type | Method and Description |
---|---|
Parameters |
Result.getParameters()
For an API like Functions.getRecord() that returns exactly one record,
use this to get the Parameters object that has the record data.
|
static Parameters |
Functions.getParametersInstance()
This method Gets an instance of the Parameters class
|
Parameters |
Parameters.getPriorParams() |
Parameters |
ParametersIterator.next() |
Modifier and Type | Method and Description |
---|---|
static Result |
Functions.addAuditLog(String referenceId,
String descriptionKey,
String typeCode,
String operationCode,
String objectKey,
String oldName,
String newName,
Parameters params)
Adding audit log entry
|
static Result |
Functions.addEvent(String subject,
String ownerID,
Date startDate,
int hour,
int min,
int duration,
Parameters params)
This method Adds an event with specified values.
|
static Result |
Functions.addRecord(String objectId,
Parameters params)
This method Adds a new record of type objectId with values from params.
|
static Result |
Functions.addRecord(String objectId,
Parameters params,
TenantContext tenantContext)
This method Adds a new record of type objectId with values from params in specified Tenant.
|
static Result |
Functions.addTask(String subject,
Date dueDate,
String ownerId,
Parameters params)
Deprecated.
Use addRecord("tasks",...) instead.
|
static Result |
Functions.deleteRecord(String objectId,
String id,
Parameters params)
This Method deletes the specified Record, This is a overloaded method which takes Parameters Instance also,
This method is useful if user would like to skip the data policy on delete or use the parameters to other data policies,
all these can be possible through the params.
|
static Object |
Functions.exec(String functionName,
Parameters params)
This method Executes sepecified function.
|
static Result |
Functions.getRecord(String objectId,
String columns,
String recordId,
Parameters scriptingParams)
This method gets the record with specified fields.
|
static Result |
Functions.getRecord(String objectId,
String columns,
String recordId,
TenantContext tenantContext,
Parameters scriptingParams)
This method gets the record with specified fields for a specified Tenant.
|
static Result |
Functions.logActivity(String subject,
String objectId,
String id,
String activityByID,
Parameters params)
This method Logs an activity in a record; Logged activities appear in the Activity History section of Related Information.
|
static Result |
Functions.searchRecords(String objectId,
String fields,
String criteria,
Parameters params)
This method Search and retrieve the records for an object.
|
static Result |
Functions.searchRecords(String objectId,
String fields,
String criteria,
String sortBy,
String sortOrder,
String sortBy2,
String sortOrder2,
int offset,
int numberOfRows,
Parameters params)
This method Search and retrieve the records for an object.
|
static Result |
Functions.searchRecords(String objectId,
String fields,
String criteria,
String sortBy,
String sortOrder,
String sortBy2,
String sortOrder2,
int offset,
int numberOfRows,
TenantContext tenantContext,
Parameters params)
This method Search and retrieve the records for an object for a specified Tenant.
|
static Result |
Functions.searchRecords(String objectId,
String columns,
String criteria,
TenantContext tenantContext,
Parameters params)
This method Search and retrieve the records for an object in specified Tenant.
|
static Result |
Functions.updateEvent(String eventId,
Parameters params)
This method Updates an event with values in params.
|
static Result |
Functions.updateRecord(String objectId,
String id,
Parameters params)
This method Updates record of type objectId with values params.
|
static Result |
Functions.updateRecord(String objectId,
String id,
Parameters params,
TenantContext tenantContext)
This method Updates record of type objectId with values params in specified tenant.
|
static Result |
Functions.updateTask(String taskId,
Parameters params)
Deprecated.
- Use updateRecord("tasks",...) instead.
|
Constructor and Description |
---|
Result(int code,
String id,
String message,
Parameters params) |
Modifier and Type | Method and Description |
---|---|
Object |
ScriptExecutor.execute(Parameters requestParams) |
Object |
ScriptExecutor.execute(Parameters requestParams,
Parameters functionParams) |
Modifier and Type | Method and Description |
---|---|
String[] |
WorkflowTaskOwner.getTaskOwners(Parameters params)
Return a list of task owners.
|