public interface IRestApiClient
RestApiException
RestApiException
.
This exception has a) The HTTP status code, b) An integer exception code for the specific error,
and c) a human readable exception messageModifier and Type | Method and Description |
---|---|
Handle |
addInvoiceLineItem(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap)
API to add new line item in invoice
|
Handle |
addProjectBudgetLineItem(ExecutionContextToken executionContextToken,
Handle hProject,
AttributeMap attributeMap)
Use this API to add new project budget line item
|
Handle |
appendAttachment(ExecutionContextToken executionContextToken,
Handle hParent,
AttributeMap attachmentAttributes) |
Handle |
appendGridRow(ExecutionContextToken executionContextToken,
Handle hGrid,
AttributeMap rowAttributeMap)
Append a new grid row to the specified object, applying the supplied grid row attributes.
|
Handle |
copyProject(ExecutionContextToken executionContextToken,
Handle hProject,
ProjectCopyTypeEnum copyEnum,
boolean copyParentLink)
Use this API to copy existing project instance and to create new project.
|
void |
copyProjectResources(ExecutionContextToken executionContextToken,
Handle hProjectSource,
Handle hProjectDestination)
API to copy resource (People tab of project) from source project to
destination project.
|
Handle |
createApproval(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
Create a new approval component with specified attributes and user
information from the execution context.
|
Handle |
createAsset(ExecutionContextToken executionContextToken,
Handle hAssetLibrary,
AttributeMap attributes) |
Handle |
createAssetFolder(ExecutionContextToken executionContextToken,
Handle parentHandle,
AttributeMap attributeMap) |
Handle |
createFinancialAccount(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
API to create new financial account.
|
Handle |
createFolder(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
Create a new folder applying the specified attributes and user information
from the execution context.
|
Handle |
createInvoice(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
API to create new Invoice in Plan
|
Handle |
createMarketingObject(ExecutionContextToken executionContextToken,
java.lang.String templateType,
java.lang.String templateName,
AttributeMap attributeMap)
Create a new marketing object component from the named template, applying the specified
attributes and user information from the execution context.
|
Handle |
createOffer(ExecutionContextToken executionContextToken,
java.lang.String templateName,
AttributeMap attributeMap)
Create a new offer component from the named template, applying the specified
attributes and user information from the execution context.
|
Handle |
createProgram(ExecutionContextToken executionContextToken,
java.lang.String templateName,
AttributeMap attributeMap)
Create a new program component from the named template, applying the specified
attributes and user information from the execution context.
|
Handle |
createProject(ExecutionContextToken executionContextToken,
java.lang.String templateName,
AttributeMap attributeMap)
Create a new project component from the named template, applying the specified
attributes and user information from the execution context.
|
Handle |
createProjectRequest(ExecutionContextToken executionContextToken,
java.lang.String templateName,
AttributeMap attributeMap)
Create a new project request instance from the named template, applying the specified
attributes and user information from the execution context. |
void |
dateRipplingForWorkflowTasks(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap)
Do date rippling for the Project Workflow.
|
void |
deleteApprovalItemByName(ExecutionContextToken executionContextToken,
Handle hApproval,
java.lang.String itemName)
Delete a single approval item within an Approval process.
|
void |
deleteAsset(ExecutionContextToken executionContextToken,
Handle hAsset) |
void |
deleteGridRow(ExecutionContextToken executionContextToken,
Handle hGridRow)
Delete an existing grid row.
|
void |
deleteInvoiceLineItem(ExecutionContextToken executionContextToken,
Handle hInvoiceLineItem)
Use this API to delete a invoice line item
|
void |
deleteProjectLineItem(ExecutionContextToken executionContextToken,
Handle hProjectLineItem)
Use this API to delete a project line item
|
void |
disableFinancialAccount(ExecutionContextToken executionContextToken,
Handle handle)
API to disable financial account
|
void |
discardProjectBudgetChanges(ExecutionContextToken executionContextToken,
Handle handle)
Use this API to discard changes done in project budget
|
void |
enableFinancialAccount(ExecutionContextToken executionContextToken,
Handle handle)
API to enable financial account
|
void |
finalizeProjectBudgetChanges(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attrMap)
Use this API to finalize changes done in project budget
|
Handle |
findApprovalByAttribute(ExecutionContextToken executionContextToken,
java.lang.String ApprovalAttributeName,
java.lang.Object[] ApprovalAttributeValues)
Find the Approval object that matches the supplied attributes.
|
Handle |
findAssetByAttribute(ExecutionContextToken executionContextToken,
Handle hAssetLibrary,
java.lang.String attributeName,
java.lang.Object attributeValue) |
Handle |
findAssetLibraryByAttribute(ExecutionContextToken executionContextToken,
java.lang.String attributeName,
java.lang.Object attributeValue)
Finds an asset library that matches the supplied attribute.
|
Handle |
findFinancialAccountByNumber(ExecutionContextToken executionContextToken,
java.lang.String accountNumber)
API to find financial account by account number
|
Handle |
findFolderByAttributes(ExecutionContextToken executionContextToken,
java.lang.String name,
java.lang.Object[] values)
Finds the folder that matches the either of supplied folder name/description.
|
Handle |
findInvoiceByNumberAndVendor(ExecutionContextToken executionContextToken,
java.lang.String invoiceNumber,
java.lang.String vendorCode)
API to find invoice by number and vendor code
|
Handle |
findMarketingObjectByAttribute(ExecutionContextToken executionContextToken,
java.lang.String type,
java.lang.String moAttributeName,
java.lang.Object[] moAttributeValues)
Finds the marketing object that matches the supplied attribute.
|
Handle |
findOfferOrOfferListByAttributes(ExecutionContextToken executionContextToken,
java.lang.String name,
java.lang.Object[] values)
Finds the offer or offer list that matches the supplied attribute.
|
Handle |
findProgramByAttribute(ExecutionContextToken executionContextToken,
java.lang.String name,
java.lang.Object[] values)
Find a single programs whose attributes match those specified; only programs
that the client has read permissions for are considered.
|
Handle |
findProjectByAttribute(ExecutionContextToken executionContextToken,
java.lang.String name,
java.lang.Object[] values)
Finds the project that matches the supplied attribute.
|
Handle |
findProjectRequestByAttribute(ExecutionContextToken executionContextToken,
java.lang.String name,
java.lang.Object[] values)
Finds the project request that matches the supplied attribute.
|
Handle |
findSubProjectParent(ExecutionContextToken executionContextToken,
Handle hProject)
Find the parent project of an existing project, if defined.
|
Handle |
findSubProjectRoot(ExecutionContextToken executionContextToken,
Handle hProject)
Find the root project of an existing project, if defined.
|
Handle |
findTeamByAttribute(ExecutionContextToken executionContextToken,
java.lang.String attributeName,
java.lang.Object attributeValue) |
Handle |
findUserByAttribute(ExecutionContextToken executionContextToken,
java.lang.String attributeName,
java.lang.Object[] attributeValues) |
Handle |
findWorkflowTaskByAttribute(ExecutionContextToken executionContextToken,
Handle hProject,
java.lang.String taskAttributeName,
java.lang.Object[] taskAttributeValues)
Finds the workflow task that matches the supplied attribute.
|
java.lang.Object[] |
getApprovalItems(ExecutionContextToken executionContextToken,
Handle hApproval)
Get all of the ordered approval items within an Approval object.
|
AttributeMap |
getAttributes(ExecutionContextToken executionContextToken,
Handle handle)
Fetches the attribute map of the object instance given by the specified
handle.
|
AttributeMap |
getCampaignSecurityPolicies(ExecutionContextToken executionContextToken)
Utility API to get information about campaign security policies
|
AttributeMap |
getFinancialAccountBudget(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap)
Use this API to get financial account budget information
|
java.util.List<java.lang.String> |
getMemberRoles(ExecutionContextToken executionContextToken,
Handle hProject)
Find the member roles for an existing project, if defined.
|
java.util.List<Handle> |
getMembersByParticipationLevel(ExecutionContextToken executionContextToken,
Handle hProject,
ProjectParticipantLevelEnum participantLevel)
Return members for a specific participation level for an existing project.
|
java.util.List<Handle> |
getMembersByRole(ExecutionContextToken executionContextToken,
Handle handle,
java.lang.String roleName)
Return a list of members for a specific member role for an existing object.
|
java.util.List<Handle> |
getMembersByRoleType(ExecutionContextToken executionContextToken,
Handle handle,
java.lang.String roleType) |
Handle |
getParentHandle(ExecutionContextToken executionContextToken,
Handle childHandle)
Returns the parent handle for a particular child handle.
|
AttributeMap |
getProjectBudget(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap) |
AttributeMap |
getProjectBudgetLineItemAllocation(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap)
Allocations (total, yearly, quarterly) of project line items is returned by the parameters passed in attributeMap Parameter
|
AttributeMap |
getProjectBudgetLineItemSummary(ExecutionContextToken executionContextToken,
Handle hProject,
boolean getLastVersion)
Use this API to get project line item summary information i.e.
|
java.util.List<java.lang.String> |
getReviewerRoles(ExecutionContextToken executionContextToken,
Handle hProject)
Find the reviewer roles for an existing project, if defined.
|
java.util.List<Handle> |
getReviewersByRole(ExecutionContextToken executionContextToken,
Handle hProject,
java.lang.String roleName)
Return a list of reviewers for a specific reviewer role for an existing project.
|
AttributeMap |
getSubProjectAllocation(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap)
Allocations (total, yearly, quarterly) of sub project is returned by the parameters passed in attributeMap Parameter
|
AttributeMap |
getSubProjectBudgetSummary(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap)
Use this API function to extract Sub Project Budget information.
|
Handle |
getWorkflowTaskParentProject(ExecutionContextToken executionContextToken,
Handle hTask)
Returns the parent project for a particular task.
|
boolean |
init(java.lang.String loginUrl,
java.lang.String restAPIUrl)
Initialization method to provide the URLs for performing login and calling MO REST API.
|
void |
linkProgramChildren(ExecutionContextToken executionContextToken,
Handle hParent,
Handle[] hChildren)
Links (adds) one or more projects to a common parent program; all projects must already exist.
|
void |
linkProgramPlan(ExecutionContextToken executionContextToken,
Handle pgmHandle,
int planID,
java.lang.String programArea)
Link existing Plan object with Program
|
void |
linkProjectChildren(ExecutionContextToken executionContextToken,
Handle hParent,
Handle[] hChildren)
Links (adds) one or more projects to a common parent project; all projects must already exist.
|
java.util.List<Handle> |
listAllProjectChildren(ExecutionContextToken executionContextToken,
Handle hParent)
Lists the all child projects of an existing parent project, if defined.
|
java.util.List<Handle> |
listApprovals(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
Lists all approvals whose attributes match those specified.
|
java.util.List<Handle> |
listAssetFolders(ExecutionContextToken executionContextToken,
Handle hAssetLibrary,
AttributeMap attributes) |
java.util.List<Handle> |
listAssetLibraries(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
Lists all asset libraries whose attributes match those specified; only asset libraries
that the client has read permissions are considered.
|
java.util.List<Handle> |
listAssets(ExecutionContextToken executionContextToken,
Handle hAssetLibrary,
AttributeMap attributes) |
java.util.List<Handle> |
listFinancialAccounts(ExecutionContextToken executionContextToken,
boolean includeDisabled)
API to list financial Account
|
java.util.List<Handle> |
listFolders(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
Lists all the folders matching to either folder name/description specified;
only folders that the client has read permissions for are considered.
|
java.util.List<Handle> |
listGridRows(ExecutionContextToken executionContextToken,
Handle hGrid,
AttributeMap rowAttributeMap)
Lists all the grid rows whose attributes match those specified for the object;
only grids that the client has read permissions for are considered.
|
java.util.List<Handle> |
listInvoiceLineItems(ExecutionContextToken executionContextToken,
Handle handle)
API to list all line items of an Invoice
|
java.util.List<Handle> |
listInvoices(ExecutionContextToken executionContextToken)
API to list all available invoices
|
java.util.List<Handle> |
listMarketingObjectGrids(ExecutionContextToken executionContextToken,
Handle hMarketingObject)
Lists the grids bound to the specified marketing object, if defined.
|
java.util.List<Handle> |
listMarketingObjects(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
Lists all the marketing objects whose attributes match those specified; only marketing
objects that the client has read permissions for are considered.
|
java.util.List<Handle> |
listOffersAndOfferLists(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
Lists all the offers and offer lists whose attributes match those specified; only
offers that the client has read permissions for are considered.
|
java.util.List<Handle> |
listPossibleMemberRolesForTask(ExecutionContextToken executionContextToken,
Handle hTask) |
java.util.List<Handle> |
listPossibleMembersForTask(ExecutionContextToken executionContextToken,
Handle hTask) |
java.util.List<Handle> |
listPossibleReviewerRolesForTask(ExecutionContextToken executionContextToken,
Handle hTask) |
java.util.List<Handle> |
listPossibleReviewersForTask(ExecutionContextToken executionContextToken,
Handle hTask) |
java.util.List<Handle> |
listPrograms(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
Lists all programs whose attributes match those specified; only programs
that the client has read permissions for are considered.
|
java.util.List<Handle> |
listProjectChildren(ExecutionContextToken executionContextToken,
Handle hParent)
Lists the child projects of an existing parent project, if defined.
|
java.util.List<Handle> |
listProjectGrids(ExecutionContextToken executionContextToken,
Handle hProject)
Lists the grids bound to the supplied project, if defined.
|
java.util.List<Handle> |
listProjectLineItems(ExecutionContextToken executionContextToken,
Handle hProject,
boolean getLastVersion)
Use this API to get list of all project line item handles
|
java.util.List<Handle> |
listProjectRequests(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
Lists all projects request whose attributes match those specified; only project requests
that the client has read permissions for are considered.
|
java.util.List<Handle> |
listProjects(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
Lists all projects whose attributes match those specified; only projects
that the client has read permissions for are considered.
|
java.util.List<Handle> |
listRequestGrids(ExecutionContextToken executionContextToken,
Handle hRequest)
Lists the grids bound to the supplied project request, if defined.
|
java.util.List<Handle> |
listTeams(ExecutionContextToken executionContextToken,
AttributeMap attributes) |
java.util.List<Handle> |
listUsers(ExecutionContextToken executionContextToken,
AttributeMap attributes) |
java.util.List<Handle> |
listWorkflowTasks(ExecutionContextToken executionContextToken,
Handle hProject,
AttributeMap taskAttributeMap)
Lists all the workflow tasks whose attributes match those specified; only tasks that
the client has read permissions for are considered.
|
java.util.List<Handle> |
listWorkflowTasksForProject(ExecutionContextToken executionContextToken,
Handle hProject) |
java.util.List<Handle> |
listWorkflowTasksForUser(ExecutionContextToken executionContextToken,
Handle hUser) |
java.lang.String |
login(java.lang.String username,
java.lang.String passWord)
This is the login API method.
|
boolean |
logout()
This is the logout API method.
|
void |
publishFolder(ExecutionContextToken executionContextToken,
Handle handle)
Transition state of folder represented by supplied handle to PUBLISHED state
This API will publish given folder and all its parent folders if not published.
|
void |
publishOffer(ExecutionContextToken executionContextToken,
Handle handle,
java.lang.String comments)
Transition state of offer represented by supplied handle to PUBLISHED state
|
void |
redraftOffer(ExecutionContextToken executionContextToken,
Handle handle,
java.lang.String comments)
Transition state of offer represented by supplied handle to DRAFT state
|
void |
retireOffer(ExecutionContextToken executionContextToken,
Handle handle,
java.lang.String comments)
Transition state of offer represented by supplied handle to RETIRED state
|
void |
setMembersByParticipationLevel(ExecutionContextToken executionContextToken,
Handle hProject,
Handle[] users,
ProjectParticipantLevelEnum participantLevel,
boolean appendOrReplace)
Update members for a specific participation level for an existing project.
|
void |
setMembersByRole(ExecutionContextToken executionContextToken,
Handle hProject,
Handle[] users,
java.lang.String roleName,
boolean appendOrReplace)
Update members for a specific member role for an existing Plan objects.
|
void |
setReviewersByRole(ExecutionContextToken executionContextToken,
Handle hProject,
Handle[] users,
java.lang.String roleName,
boolean appendOrReplace)
Update reviewers for a specific reviewer role for an existing project.
|
void |
transitionApprovalStateByHandle(ExecutionContextToken executionContextToken,
Handle hApproval,
ApprovalStateEnum stateEnum,
java.lang.String comments)
Change the approval state of an existing approval to a new state.
|
void |
transitionAssetStateByCode(ExecutionContextToken executionContextToken,
java.lang.String code,
AssetStateEnum stateEnum,
java.lang.String comments) |
void |
transitionInvoiceState(ExecutionContextToken executionContextToken,
Handle handle,
InvoiceStateEnum stateEnum,
AttributeMap attributeMap)
API to update state of the Invoice
|
void |
transitionMarketingObjectStateByHandle(ExecutionContextToken executionContextToken,
Handle hMarketingObject,
java.lang.String state,
java.lang.String comments)
Transition a supplied Marketing Object's state to the new state.
|
void |
transitionProgramState(ExecutionContextToken executionContextToken,
Handle hProgram,
ProgramState stateEnum,
java.lang.String comments)
Finds the program assigned the supplied unique program handle and transition its state
to the new state.
|
void |
transitionProjectRequestStateByHandle(ExecutionContextToken executionContextToken,
Handle hProjectRequest,
ProjectStateEnum stateEnum,
java.lang.String comments)
Finds the project request and transition its state to the new state.
On resubmitting returned request, request 'Re-approval Rule' would be: If project request returned and then resubmitted, request is processed by all recipients again To accept request by recipient, "onBehalfOfUserID" user id should be valid recipinet's id. |
void |
transitionProjectStateByCode(ExecutionContextToken executionContextToken,
java.lang.String code,
ProjectStateEnum stateEnum)
Deprecated.
|
void |
transitionProjectStateByHandle(ExecutionContextToken executionContextToken,
Handle hProject,
ProjectStateEnum stateEnum,
java.lang.String comments)
Overloaded API with comments parameters.
|
void |
transitionWorkflowTaskStateByHandle(ExecutionContextToken executionContextToken,
Handle hTask,
TaskStateEnum taskStateEnum,
java.lang.String comments)
Overloaded API with comments parameters.
|
void |
transitionWorkflowTaskStateByName(ExecutionContextToken executionContextToken,
java.lang.String projectCode,
java.lang.String taskName,
TaskStateEnum taskStateEnum)
Deprecated.
use
transitionWorkflowTaskStateByHandle
Finds the workflow task that has the specified project code and task name and
transitions its state to the new state. |
void |
triggerAcknowledgementNotification(ExecutionContextToken executionContextToken,
TriggerReturnObject triggerReturnObject)
Acknowledgment that this client will handle a given triggered event.
|
void |
triggerCompleteNotification(ExecutionContextToken executionContextToken,
TriggerReturnObject triggerReturnObject)
A notification that the processing for the given triggered event is complete.
|
void |
unlinkProgramChildren(ExecutionContextToken executionContextToken,
Handle hParent,
Handle[] hChildren)
Unlinks one or more child projects from their common parent program; all projects
must already exist.
|
void |
unlinkProgramPlan(ExecutionContextToken executionContextToken,
Handle handle)
UnLink existing Plan object from Program
|
void |
unlinkProjectChildren(ExecutionContextToken executionContextToken,
Handle hParent,
Handle[] hChildren)
Unlinks one or more child projects from their common parent project; all projects
must already exist.
|
void |
updateApprovalItems(ExecutionContextToken executionContextToken,
Handle hApproval,
java.lang.Object[] approvalItems,
java.lang.String[] instructions)
This method updates one or more approval item(s) within a single
Approval object.
|
void |
updateAttribute(ExecutionContextToken executionContextToken,
Handle handle,
java.lang.String attributeName,
java.lang.Object[] attributeValues)
Update the attribute of the object instance given by the specified handle.
|
void |
updateAttributes(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap)
Update one or more attributes of the object instance given by the specified handle.
|
void |
updateFinancialAccountBudget(ExecutionContextToken executionContextToken,
Handle sourceAccount,
int fiscalYear,
AttributeMap attributeMap)
API to update account budget information in one call you can update
budget information for one financial year
|
void |
updateMembersByRoleType(ExecutionContextToken executionContextToken,
Handle handle,
java.lang.String roleType,
Handle[] hUser) |
void |
updateProjectLineItemAllocation(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap)
Use this API function to update project line item allocation
|
void |
updateProjectRequestRecepient(ExecutionContextToken executionContextToken,
Handle hProjectRequest,
Handle userHandle,
AttributeMap attributeMap)
Update project request recipients.
|
void |
updateSubProjectAllocation(ExecutionContextToken executionContextToken,
Handle handle,
Handle hSubProject,
AttributeMap attributeMap)
Use this API function to update sub project allocation
|
boolean init(java.lang.String loginUrl, java.lang.String restAPIUrl) throws RestApiException
loginUrl
- The URL to perform loginrestAPIUrl
- The URL to call MO REST APIsRestApiException
- Initialization failed. This could happen because of incorrect URLsjava.lang.String login(java.lang.String username, java.lang.String passWord) throws RestApiException
username
- The user ID for the login being attempted. This parameter will be sent in the HTTP headerpassWord
- The password for the login being attempted. This parameter will be sent in the HTTP headerRestApiException
- Incorrect authentication. This could happen because of incorrect username or passwordboolean logout() throws RestApiException
username
- The user ID for the logout being attempted. This parameter will be sent in the HTTP header internallyloginTokenString
- The token string that was password for the login being attempted. This parameter will be sent in the HTTP header internallyRestApiException
- Incorrect authentication. This could happen because of incorrect username or token stringvoid triggerAcknowledgementNotification(ExecutionContextToken executionContextToken, TriggerReturnObject triggerReturnObject) throws RestApiException
executionContextToken
- The execution context token provided by a triggered event notification.triggerReturnObject
- An object informing the status of handling this callRestApiException
- Either of the executionContextToken or triggerReturnObject have incorrect data, or the
event has not been subscribed by this client, or if the client fails to call this API within the set time limitvoid triggerCompleteNotification(ExecutionContextToken executionContextToken, TriggerReturnObject triggerReturnObject) throws RestApiException
executionContextToken
- The execution context token provided by a triggered event notification.triggerReturnObject
- An object informing the status of handling this callRestApiException
- Either of the executionContextToken or triggerReturnObject have incorrect data, or the
event has not been subscribed by this client, or if the client fails to call this API within the set time limit,
or if acknowledgment to the triggered event notification has not been done with triggerAcknowledgementNotificationAttributeMap getAttributes(ExecutionContextToken executionContextToken, Handle handle) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- handle of the object instance containing the desired attributesRestApiException
- the specified handle is invalidRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to read the object attributes (unchecked)void updateAttribute(ExecutionContextToken executionContextToken, Handle handle, java.lang.String attributeName, java.lang.Object[] attributeValues) throws RestApiException
Convenience API--see updateAttributes() below.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- handle of the object instance to be updatedattributeName
- the name of the attribute to updateattributeValues
- an array of zero or more attribute values;
this array will overwrite the matched attribute's existing valuesRestApiException
- the specified handle is invalidRestApiException
- one or more specified attributes do
not exist for the object instanceRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
object (unchecked)java.util.List<Handle> getMembersByRoleType(ExecutionContextToken executionContextToken, Handle handle, java.lang.String roleType) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- handle of the object instanceroleType
- a role type for the given object instance.PlanUserHandle
or PlanTeamHandle
handles will be return if the object instance has members associated with it.
Each list element will be of type Handle.RestApiException
- the specified handle is invalidRestApiException
- roleType is invalid, e.g., roleType doesn't exist, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to read the object attributes (unchecked)void updateMembersByRoleType(ExecutionContextToken executionContextToken, Handle handle, java.lang.String roleType, Handle[] hUser) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- handle of the object instanceroleType
- a role type for the given object instance.hUser
- a list of PlanUser or PlanTeam handles to be updated.RestApiException
- the specified handle is invalidRestApiException
- either roleType or hUser is invalid, e.g., roleType doesn't exist or
or hUser handle is not instance of PlanUser nor PlanTeam, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to read the object attributes (unchecked)void updateAttributes(ExecutionContextToken executionContextToken, Handle handle, AttributeMap attributeMap) throws RestApiException
The update logic is as follows; for each attribute contained in the supplied attributeMap:
Note, this API does not support adding new attributes.
In all cases, the attribute update is subject to the usual security constraints and validation. Its the clients responsibility to determine which standard and custom attributes are required by a particular object instance, the correct types, etc.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- handle of the object instance to be updatedattributeMap
- map of attributes to be updatedRestApiException
- the specified handle is invalidRestApiException
- one or more specified attributes do
not exist for the object instanceRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update one or more object attributes (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
object (unchecked)java.util.List<Handle> getMembersByRole(ExecutionContextToken executionContextToken, Handle handle, java.lang.String roleName) throws RestApiException
PlanUserHandle
or PlanTeamHandle
.
Supported Plan objects:
1. Project - work roles of the Project people tab. Possible roles:executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- of an existing Plan object.
Throws RestApiException if the Plan object does not exist.roleName
- a role name
Throws RestApiException if the role does not exist.PlanUserHandle
or PlanTeamHandle
.RestApiException
- the specified handle does not refer to a Plan object
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorizedRestApiException
- problems encountered accessing data (unchecked)2. Asset (Asset owners) Possible roles: @link #ASSET_OWNER_ROLE
void setMembersByRole(ExecutionContextToken executionContextToken, Handle hProject, Handle[] users, java.lang.String roleName, boolean appendOrReplace) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- of an existing Plan object.
Throws RestApiException if the Plan object does not exist.users
- that will be append to the member role or replace existing members
with the new members.
The data type is either PlanUserHandle
or PlanTeamHandle
.
To delete all members for a specific member role, pass in null.
Throws RestApiException if the role does not exist.roleName
- a role name from @see #getReviewersByRole(IExecutionContext, Handle, String);
Throws RestApiException if the role does not exist.appendOrReplace
- true - append new members to existing members for the given role
false - replace existing members with new members.RestApiException
- the specified handle does not refer to a Plan object
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized (unchecked)RestApiException
- problems encountered accessing data (unchecked)Handle createProject(ExecutionContextToken executionContextToken, java.lang.String templateName, AttributeMap attributeMap) throws RestApiException
Child projects can be linked to the created parent project as needed; see linkProjectChildren().
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here..templateName
- the name of the template to use to create this project.
The named template must exist on the Plan server and the client must have
read permissions for that instance. The template provides, among other
things, the definition of required and optional attributes, default values, etc.attributeMap
- optional map of attributes to update and/or add. Any
supplied attributes will overwrite the default values derived from the
projects template; others are left untouched. Its up to the client to
determine the attributes required by the project, their types, etc.RestApiException
- the specified template doesn't existRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to create projects or read their templates (unchecked)RestApiException
- problems encountered accessing data (unchecked)Handle createProjectRequest(ExecutionContextToken executionContextToken, java.lang.String templateName, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here..templateName
- the name of the template to use to create this project request.attributeMap
- attribute map must contain following parameters:RestApiException
- the specified template doesn't existRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.java.util.List<Handle> listProjects(ExecutionContextToken executionContextToken, AttributeMap attributeMap) throws RestApiException
Note, this API is intended as a simple way for a client to use server-side discovery to identify projects of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeMap
- optional map of attributes to match. The implied boolean
operator is AND. The match algorithm works as follows:
If the attributeMap parameter is not specified, all current projects that the client has read security permissions for are returned. Throws RestApiException if one or more of the query attributes is invalid (e.g., empty map, an attribute has the wrong type, etc.).
RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list projects (unchecked)RestApiException
- problems encountered accessing data (unchecked)#getAttributes(IExecutionContext, Handle)
,
updateAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle, AttributeMap)
,
findProjectByAttribute(com.unica.uap.restapi.ExecutionContextToken, java.lang.String, java.lang.Object[])
java.util.List<Handle> listProjectRequests(ExecutionContextToken executionContextToken, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeMap
- Optional map of attributes to match. This attribute map contains following parameters: RestApiException
- one or more specified attributes is invalid, e.g., incorrect type, not multi-valued, etc.Handle findProjectByAttribute(ExecutionContextToken executionContextToken, java.lang.String name, java.lang.Object[] values) throws RestApiException
Convenience API; similar to listProjects(), using a single attribute whose name and value are the same as the parameters above, except only one project is returned.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.name
- name of attribute to match againstvalues
- array of attribute values to match against (all specified
values must match)RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- more than one project matched the attribute(s)
specifiedRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list projects (unchecked)RestApiException
- problems encountered accessing data (unchecked)listProjects(com.unica.uap.restapi.ExecutionContextToken, AttributeMap)
Handle findProjectRequestByAttribute(ExecutionContextToken executionContextToken, java.lang.String name, java.lang.Object[] values) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.name
- name of attribute to match againstvalues
- array of attribute values to match against (all specified values must match)RestApiException
- one or more specified attributes is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- more than one project matched the attribute(s) specifiedvoid updateProjectRequestRecepient(ExecutionContextToken executionContextToken, Handle hProjectRequest, Handle userHandle, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProjectRequest
- Must be a valid project request handleuserHandle
- user handle (recipient) to update recipientattributeMap
- Attribute map must contain attributes of recipients to update.
This attribute must contain following parameters: RestApiException
- the specified project request and/or user handle is invalidRestApiException
- one or more specified attributes is invalid, e.g., incorrect type, not multi-values, etc.void transitionProjectStateByCode(ExecutionContextToken executionContextToken, java.lang.String code, ProjectStateEnum stateEnum) throws RestApiException
Convenience API; identical to making the following API calls:
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.code
- unique project code to match against (equivalent to value
of code project attribute). A RestApiException is thrown
if no project exists with that code. If more than one project matches, i.e.,
the attribute is not unique, a RestApiException is thrown.stateEnum
- a ProjectStateEnum enumerated type of the new project
state to transition to (see uapStateEnum attribute definition). An
RestApiException is thrown if the state transition
is not allowed.RestApiException
- no project was found for the specified codeRestApiException
- more than one project matched the code
specifiedRestApiException
- the specified state transition is
invalid given the current project stateRestApiException
- one or more specified attributes do
not exist for the object instanceRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
object (unchecked)findProjectByAttribute(com.unica.uap.restapi.ExecutionContextToken, java.lang.String, java.lang.Object[])
,
updateAttribute(com.unica.uap.restapi.ExecutionContextToken, Handle, java.lang.String, java.lang.Object[])
void transitionProjectStateByHandle(ExecutionContextToken executionContextToken, Handle hProject, ProjectStateEnum stateEnum, java.lang.String comments) throws RestApiException
Finds the project assigned the supplied unique project code and transition its state to the new state.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- Must be a valid project handlestateEnum
- a ProjectStateEnum enumerated type of the new project
state to transition to (see uapStateEnum attribute definition). An
RestApiException is thrown if the state transition
is not allowed.comments
- the comments for the state transition which are sent
by Notification ServiceRestApiException
- no project was found for the specified codeRestApiException
- more than one project matched the code
specifiedRestApiException
- the specified state transition is
invalid given the current project stateRestApiException
- one or more specified attributes do
not exist for the object instanceRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
object (unchecked)findProjectByAttribute(com.unica.uap.restapi.ExecutionContextToken, java.lang.String, java.lang.Object[])
,
updateAttribute(com.unica.uap.restapi.ExecutionContextToken, Handle, java.lang.String, java.lang.Object[])
void transitionProjectRequestStateByHandle(ExecutionContextToken executionContextToken, Handle hProjectRequest, ProjectStateEnum stateEnum, java.lang.String comments) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProjectRequest
- Must be a valid project request handlestateEnum
- a ProjectStateEnum enumerated type of the new project request
state to transition to (see uapStateEnum attribute definition). An
RestApiException is thrown if the state transition
is not allowed.comments
- the comments for the state transition which are sent
by Notification ServiceRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.RestApiException
- no project request was found for the specified codeRestApiException
- the specified state transition is
invalid given the current project statevoid linkProjectChildren(ExecutionContextToken executionContextToken, Handle hParent, Handle[] hChildren) throws RestApiException
Child projects may in turn have their own children--or have this done by later use of this API. The API will detect circular references, i.e., A => B => C => A, and return a RestApiException.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hParent
- handle of an existing parent project to link children to. Throws
RestApiException if the parent project does not exist; throws
RestApiException if the client does not hold an edit lock for the
referenced project.hChildren
- array of one or more handles of existing projects to link as
children. Throws RestApiException if one or more of the child
projects does not exist; ; throws a RestApiException if the server
cannot process the number of children specified in one request (because of circularity
detection). In this case, the client should break up the request into multiple calls,
e.g., less than 500.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- linking one or more of the specified children
would cause a circular referenceRestApiException
- the server cannot process the number of children
specified in one requestRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update a project's list of children (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
the parent project (unchecked)unlinkProjectChildren(com.unica.uap.restapi.ExecutionContextToken, Handle, Handle[])
void unlinkProjectChildren(ExecutionContextToken executionContextToken, Handle hParent, Handle[] hChildren) throws RestApiException
All children must in fact be linked to the specified parent, otherwise RestApiException is thrown. Note that this API does not affect nested children, i.e., if A => B => C, then unlinking B from A will not affect the B => C link.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hParent
- handle of an existing parent project. Throws RestApiException
if the parent project does not exist; throws RestApiException if the client
does not hold an edit lock for the referenced project.hChildren
- array of handles of existing child projects to unlink from the parent.
Throws RestApiException if one or more of the child projects is not
currently linked to the specified parent.RestApiException
- the specified handle(s) does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update a project's list of children (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
the parent project (unchecked)linkProjectChildren(com.unica.uap.restapi.ExecutionContextToken, Handle, Handle[])
java.util.List<Handle> listProjectChildren(ExecutionContextToken executionContextToken, Handle hParent) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hParent
- handle of an existing parent project containing desired children.
Throws RestApiException if the parent project does not exist.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list project children (unchecked)RestApiException
- problems encountered accessing data (unchecked)linkProjectChildren(com.unica.uap.restapi.ExecutionContextToken, Handle, Handle[])
,
getAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle)
java.util.List<Handle> listAllProjectChildren(ExecutionContextToken executionContextToken, Handle hParent) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hParent
- handle of an existing parent project containing desired children.
Throws RestApiException if the parent project does not exist.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list project children (unchecked)RestApiException
- problems encountered accessing data (unchecked)listProjectChildren(com.unica.uap.restapi.ExecutionContextToken, Handle)
,
linkProjectChildren(com.unica.uap.restapi.ExecutionContextToken, Handle, Handle[])
,
getAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle)
java.util.List<Handle> listProjectGrids(ExecutionContextToken executionContextToken, Handle hProject) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- handle of an existing project containing desired grid(s).
Throws RestApiException if the project does not exist or
the handle is invalid.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list project grids (unchecked)RestApiException
- problems encountered accessing data (unchecked)getAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle)
,
listGridRows(com.unica.uap.restapi.ExecutionContextToken, Handle, AttributeMap)
java.util.List<Handle> listRequestGrids(ExecutionContextToken executionContextToken, Handle hRequest) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hRequest
- handle of an existing project request containing desired grid(s).
Throws RestApiException if the project request does not exist or
the handle is invalid.RestApiException
- the specified handle does not refer to a project request
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list project request grids (unchecked)RestApiException
- problems encountered accessing data (unchecked)getAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle)
,
listGridRows(com.unica.uap.restapi.ExecutionContextToken, Handle, AttributeMap)
Handle findSubProjectParent(ExecutionContextToken executionContextToken, Handle hProject) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- handle of an existing project.
Throws RestApiException if the project does not exist.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list project children (unchecked)RestApiException
- problems encountered accessing data (unchecked)linkProjectChildren(com.unica.uap.restapi.ExecutionContextToken, Handle, Handle[])
,
findSubProjectRoot(com.unica.uap.restapi.ExecutionContextToken, Handle)
Handle findSubProjectRoot(ExecutionContextToken executionContextToken, Handle hProject) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- handle of an existing project.
Throws RestApiException if the project does not exist.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list project children (unchecked)RestApiException
- problems encountered accessing data (unchecked)linkProjectChildren(com.unica.uap.restapi.ExecutionContextToken, Handle, Handle[])
,
findSubProjectParent(com.unica.uap.restapi.ExecutionContextToken, Handle)
java.util.List<java.lang.String> getMemberRoles(ExecutionContextToken executionContextToken, Handle hProject) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- handle of an existing project.
Return an empty list if the project does not exist.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list project children (unchecked)RestApiException
- problems encountered accessing data (unchecked)java.util.List<java.lang.String> getReviewerRoles(ExecutionContextToken executionContextToken, Handle hProject) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- handle of an existing project.
Return an empty list if the project does not exist.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list project children (unchecked)RestApiException
- problems encountered accessing data (unchecked)java.util.List<Handle> getReviewersByRole(ExecutionContextToken executionContextToken, Handle hProject, java.lang.String roleName) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- handle of an existing project.
Throws RestApiException if the project does not exist.roleName
- a role name from @see #getReviewersByRole(IExecutionContext, Handle, String);
Throws RestApiException if the role does not exist.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list project children (unchecked)RestApiException
- problems encountered accessing data (unchecked)void setReviewersByRole(ExecutionContextToken executionContextToken, Handle hProject, Handle[] users, java.lang.String roleName, boolean appendOrReplace) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- handle of an existing project.
Throws RestApiException if the project does not exist.users
- that will be append to the reviewer role or replace existing reviewers
with the new reviewers.
The data type is either @see PlanUserHandle or @see PlanTeamHandle.
To delete all reviewers for a specific reviewer role, pass in null.
Throws RestApiException if the role does not exist.roleName
- a role name from @see #getReviewersByRole(IExecutionContext, Handle, String);
Throws RestApiException if the role does not exist.appendOrReplace
- true - append new reviewers to existing reviewers for the given role
false - replace existing reviewers with new reviewers.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list project children (unchecked)RestApiException
- problems encountered accessing data (unchecked)java.util.List<Handle> getMembersByParticipationLevel(ExecutionContextToken executionContextToken, Handle hProject, ProjectParticipantLevelEnum participantLevel) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- handle of an existing project.
Throws RestApiException if the project does not exist.participantLevel
- an enum indicates different participation levels.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list project children (unchecked)RestApiException
- problems encountered accessing data (unchecked)void setMembersByParticipationLevel(ExecutionContextToken executionContextToken, Handle hProject, Handle[] users, ProjectParticipantLevelEnum participantLevel, boolean appendOrReplace) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- handle of an existing project.
Throws RestApiException if the project does not exist.users
- that will be append to the member role or replace existing members
with the new members.
The data type is either @see PlanUserHandle or @see PlanTeamHandle.
To delete all reviewers for a specific reviewer role, pass in null.
Throws RestApiException if the role does not exist.participantLevel
- an enum indicates different participation levels.appendOrReplace
- true - append new members to existing members for the given participation level
false - replace existing members with new members.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list project children (unchecked)RestApiException
- problems encountered accessing data (unchecked)java.util.List<Handle> listWorkflowTasks(ExecutionContextToken executionContextToken, Handle hProject, AttributeMap taskAttributeMap) throws RestApiException
Note, this API is intended as a simple way for a client to use server-side discovery to identify projects of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- handle of the parent project. Throws RestApiException if
the handle doesn't refer to a project or the project does not exist.taskAttributeMap
- optional map of task attributes to match. Match logic is similar to the
ListProjects() API, above. If the attributeMap parameter is not specified,
all current workflow tasks associated with the parent project are returned. Throws
RestApiException if one or more of the specified attributes is invalid.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list workflow tasks (unchecked)RestApiException
- problems encountered accessing data (unchecked)getAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle)
,
updateAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle, AttributeMap)
Handle findWorkflowTaskByAttribute(ExecutionContextToken executionContextToken, Handle hProject, java.lang.String taskAttributeName, java.lang.Object[] taskAttributeValues) throws RestApiException
Convenience API; similar to listWorkflowTasks() using a single attribute whose name and value are the same as the parameters above, except only one task is returned.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- handle of the parent project. Throws RestApiException if
the handle doesn't refer to a project or the project does not exist.taskAttributeName
- name of task attribute to match against.taskAttributeValues
- array of task attribute values to match against (all must match)RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- more than one task matched the attribute(s)
specifiedRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list projects (unchecked)RestApiException
- problems encountered accessing data (unchecked)listWorkflowTasks(com.unica.uap.restapi.ExecutionContextToken, Handle, AttributeMap)
void transitionWorkflowTaskStateByName(ExecutionContextToken executionContextToken, java.lang.String projectCode, java.lang.String taskName, TaskStateEnum taskStateEnum) throws RestApiException
transitionWorkflowTaskStateByHandle
Finds the workflow task that has the specified project code and task name and
transitions its state to the new state.executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.projectCode
- unique project code to match against (equivalent to
value of the code project attribute). Throws RestApiException
if more than one project matched specified code.taskName
- the task name to match against. Throws RestApiException
if more than one task matched specified name.taskStateEnum
- a TaskStateEnum enumerated type defining the new
task state to transition to. Throws IllegalStateTransitionException if
the state transition is not allowed by the task.RestApiException
- a project was not found for the specified
project codeRestApiException
- a workflow task was not found for the specified
task nameRestApiException
- more than one project or task matchedRestApiException
- the specified state transition is
invalid given the current task stateRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update a workflow task (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
the workflow task (unchecked)void transitionWorkflowTaskStateByHandle(ExecutionContextToken executionContextToken, Handle hTask, TaskStateEnum taskStateEnum, java.lang.String comments) throws RestApiException
Finds the workflow task that has the specified project code and task name and transitions its state to the new state.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hTask
- handle of the task. Throws RestApiException if
the handle doesn't refer to a task or the task does not exist.taskStateEnum
- a TaskStateEnum enumerated type defining the new
task state to transition to. Throw IllegalStateTransitionException if
the state transition is not allowed by the task.comments
- the comments for the state transition which are sent
by Notification ServiceRestApiException
- a project was not found for the specified
project codeRestApiException
- a workflow task was not found for the specified
task nameRestApiException
- more than one project or task matchedRestApiException
- the specified state transition is
invalid given the current task stateRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update a workflow task (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
the workflow task (unchecked)Handle getWorkflowTaskParentProject(ExecutionContextToken executionContextToken, Handle hTask) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hTask
- handle of the taskRestApiException
- the specified task handle is invalidRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update a workflow task (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
the workflow task (unchecked)java.util.List<Handle> listPossibleMemberRolesForTask(ExecutionContextToken executionContextToken, Handle hTask) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hTask
- handle of the task. Throws RestApiException if
the handle doesn't refer to a task or the task does not exist.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list workflow tasks (unchecked)RestApiException
- problems encountered accessing data (unchecked)java.util.List<Handle> listPossibleMembersForTask(ExecutionContextToken executionContextToken, Handle hTask) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hTask
- handle of the task. Throws RestApiException if
the handle doesn't refer to a task or the task does not exist.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list workflow tasks (unchecked)RestApiException
- problems encountered accessing data (unchecked)java.util.List<Handle> listPossibleReviewerRolesForTask(ExecutionContextToken executionContextToken, Handle hTask) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hTask
- handle of the task. Throws RestApiException if
the handle doesn't refer to a task or the task does not exist.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list workflow tasks (unchecked)RestApiException
- problems encountered accessing data (unchecked)java.util.List<Handle> listPossibleReviewersForTask(ExecutionContextToken executionContextToken, Handle hTask) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hTask
- handle of the task. Throws RestApiException if
the handle doesn't refer to a task or the task does not exist.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list workflow tasks (unchecked)RestApiException
- problems encountered accessing data (unchecked)java.util.List<Handle> listWorkflowTasksForUser(ExecutionContextToken executionContextToken, Handle hUser) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hUser
- handle of the user. Throws RestApiException if
the handle doesn't refer to a user or a team.RestApiException
- the specified handle does not refer to a user or team
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list workflow tasks (unchecked)RestApiException
- problems encountered accessing data (unchecked)Note, this API is intended as a simple way for a client to use server-side discovery to identify projects of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
java.util.List<Handle> listWorkflowTasksForProject(ExecutionContextToken executionContextToken, Handle hProject) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- handle of the project. Throws RestApiException if
the handle doesn't refer to a project or the project doesn't exist.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list workflow tasks (unchecked)RestApiException
- problems encountered accessing data (unchecked)Note, this API is intended as a simple way for a client to use server-side discovery to identify projects of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
void dateRipplingForWorkflowTasks(ExecutionContextToken executionContextToken, Handle handle, AttributeMap attributeMap) throws RestApiException
In all cases, the attribute update is subject to the usual security constraints and validation. Its the clients responsibility to determine which standard and custom attributes are required by a particular object instance, the correct types, etc.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- handle of a Workflow TaskattributeMap
- map of attributes to be updated. Either @see IPlanAPI.DATE_RIPPLING_ATTRIBUTE_ACTUAL_DATESRestApiException
- the specified handle is invalidRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update one or more object attributes (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
object (unchecked)Handle createMarketingObject(ExecutionContextToken executionContextToken, java.lang.String templateType, java.lang.String templateName, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.templateType
- the name of the template type to use to create this marketing
object.templateName
- the name of the template to use to create this marketing object.
The named template must exist on the server and the client must have read permissions
for that instance. The template provides, among other things, the definition of
required and optional attributes. Throws RestApiException if the
named template could not be found.attributeMap
- map of attributes to update and/or add. Any supplied attributes
will overwrite the default values derived from the marketing objects template;
others are left untouched. Its up to the client to determine the attributes
required by the template, their types, etc.RestApiException
- the specified template type doesn't existRestApiException
- the specified template doesn't existRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to create marketing objects or read their
templates (unchecked)RestApiException
- problems encountered accessing data (unchecked)java.util.List<Handle> listMarketingObjects(ExecutionContextToken executionContextToken, AttributeMap attributeMap) throws RestApiException
Once retrieved, each handle can be used to interrogate the marketing object further, e.g., read or update its attributes via the attribute APIs, link to a project or other marketing object, etc.
Note, this API is intended as a simple way for a client to use server-side discovery to identify marketing objects of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeMap
- optional map of attributes to match. Match logic is similar to
the ListProjects() API, above. If the attributeMap parameter is not specified,
all current marketing objects are returned. WARNING: this list could be very large.RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list marketing objects (unchecked)RestApiException
- problems encountered accessing data (unchecked)getAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle)
,
updateAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle, AttributeMap)
,
findMarketingObjectByAttribute(com.unica.uap.restapi.ExecutionContextToken, java.lang.String, java.lang.String, java.lang.Object[])
Handle findMarketingObjectByAttribute(ExecutionContextToken executionContextToken, java.lang.String type, java.lang.String moAttributeName, java.lang.Object[] moAttributeValues) throws RestApiException
Convenience API; similar to listMarketingObjects() using a single attribute whose name and value are the same as the parameters above, except only one marketing object is returned.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.type
- a string defining the type of marketing object, e.g., "creatives"moAttributeName
- name of marketing object attribute to match againstmoAttributeValues
- array of marketing object attribute values to match
against (all must match).RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- more than one marketing object
matched the attribute(s) specifiedRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list marketing object (unchecked)RestApiException
- problems encountered accessing data (unchecked)listMarketingObjects(com.unica.uap.restapi.ExecutionContextToken, AttributeMap)
java.util.List<Handle> listMarketingObjectGrids(ExecutionContextToken executionContextToken, Handle hMarketingObject) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hMarketingObject
- handle of an existing marketing object containing desired grid(s).
Throws RestApiException if the marketing object does not exist or
the handle is invalid.RestApiException
- the specified handle does not refer to a
marketing object or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list marketing object grids (unchecked)RestApiException
- problems encountered accessing data (unchecked)getAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle)
,
listGridRows(com.unica.uap.restapi.ExecutionContextToken, Handle, AttributeMap)
void transitionMarketingObjectStateByHandle(ExecutionContextToken executionContextToken, Handle hMarketingObject, java.lang.String state, java.lang.String comments) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hMarketingObject
- a valid Marketing Object handlestate
- the new marketing object state to transition to. An
RestApiException is thrown if the state transition
is not allowed or the state is not a valid statecomments
- the comments for the state transition which are sent
by Notification ServiceRestApiException
- the specified state transition is
invalid given the current marketing object stateRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified handle is invalidRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
object (unchecked)Handle appendGridRow(ExecutionContextToken executionContextToken, Handle hGrid, AttributeMap rowAttributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hGrid
- handle to an existing grid object to be updatedrowAttributeMap
- map of attributes (columns) to update and/or add to the new
grid row. These attributes will overwrite any default values derived from the
grid's template. Note, there are no standard grid row attributes--it's the
clients responsibility to determine which attributes are required, proper
date types, etc.RestApiException
- the specified grid handle is invalidRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update one or more object attributes (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
the parent grid object (unchecked)void deleteGridRow(ExecutionContextToken executionContextToken, Handle hGridRow) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hGridRow
- handle to an existing grid row to be updatedRestApiException
- the specified grid row handle is invalidRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update one or more object attributes (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
the parent grid object (unchecked)java.util.List<Handle> listGridRows(ExecutionContextToken executionContextToken, Handle hGrid, AttributeMap rowAttributeMap) throws RestApiException
Note, this API is intended as a simple way for a client to use server-side discovery to identify grid data of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hGrid
- handle of the parent grid object. Throws RestApiException
if the handle doesn't refer to a grid object or the grid doesn't exist.rowAttributeMap
- optional map of grid row attributes to match. If this parameter
is not specified, all rows currently bound to the parent grid object are returned.RestApiException
- the specified handle does not refer to a
grid, the grid does not exist, or the handle is corruptRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list grid rows (unchecked)RestApiException
- problems encountered accessing data (unchecked)getAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle)
,
updateAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle, AttributeMap)
Handle createOffer(ExecutionContextToken executionContextToken, java.lang.String templateName, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.templateName
- the name of the template to use to create this offer (marketing object).
The named template must exist on the server and the client must have read permissions
for that instance. The template provides, among other things, the definition of
required and optional attributes. Throws RestApiException if the
named template could not be found.attributeMap
- map of attributes to update and/or add. Any supplied attributes
will overwrite the default values derived from the offer (marketing objects) template;
others are left untouched. Its up to the client to determine the attributes
required by the template, their types, etc.RestApiException
- the specified template type doesn't existRestApiException
- the specified template doesn't existRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to create marketing objects or read their
templates (unchecked)RestApiException
- problems encountered accessing data (unchecked)java.util.List<Handle> listOffersAndOfferLists(ExecutionContextToken executionContextToken, AttributeMap attributeMap) throws RestApiException
Once retrieved, each handle can be used to interrogate the offer (marketing object) further, e.g., read or update its attributes via the attribute APIs, link to a project or other marketing object, etc.
Note, this API is intended as a simple way for a client to use server-side discovery to identify offers (marketing objects) of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeMap
- optional map of attributes to match. Match logic is similar to
the ListProjects() API, above. If the attributeMap parameter is not specified,
all current marketing objects are returned. WARNING: this list could be very large.RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list marketing objects (unchecked)RestApiException
- problems encountered accessing data (unchecked)getAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle)
,
updateAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle, AttributeMap)
,
findMarketingObjectByAttribute(com.unica.uap.restapi.ExecutionContextToken, java.lang.String, java.lang.String, java.lang.Object[])
Handle findOfferOrOfferListByAttributes(ExecutionContextToken executionContextToken, java.lang.String name, java.lang.Object[] values) throws RestApiException
Convenience API; similar to listOffersAndOfferLists(), using a single attribute whose name and value are the same as the parameters above, except only one offer is returned.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.name
- name of attribute to match againstvalues
- array of attribute values to match against (all specified
values must match)RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- more than one project matched the attribute(s)
specifiedRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list projects (unchecked)RestApiException
- problems encountered accessing data (unchecked)listOffersAndOfferLists(com.unica.uap.restapi.ExecutionContextToken, AttributeMap)
void publishOffer(ExecutionContextToken executionContextToken, Handle handle, java.lang.String comments) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- unique handle of offer instance to match against.
A RestApiException is thrown if supplied handle
does not represent a valid offer handle.comments
- the comments for the state transition which are sent
to Offer History and Notification ServiceRestApiException
- the specified state transition
is invalid given the current offer state
(i.e. supplied offer is not in DRAFT state)RestApiException
RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)void retireOffer(ExecutionContextToken executionContextToken, Handle handle, java.lang.String comments) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- unique handle of offer instance to match against.
A RestApiException is thrown if supplied handle
does not represent a valid offer handle.comments
- the comments for the state transition which are sent
to Offer History and Notification ServiceRestApiException
- the specified state transition
is invalid given the current offer state
(i.e. supplied offer is not in PUBLISHED state)RestApiException
RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)void redraftOffer(ExecutionContextToken executionContextToken, Handle handle, java.lang.String comments) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- unique handle of offer instance to match against.
A RestApiException is thrown if supplied handle
does not represent a valid offer handle.comments
- the comments for the state transition which are sent
to Offer History and Notification ServiceRestApiException
- the specified state transition
is invalid given the current offer state
(i.e. supplied offer is not in PUBLISHED state)RestApiException
RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)AttributeMap getCampaignSecurityPolicies(ExecutionContextToken executionContextToken) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.AttributeMap
which contains
Campaign Security Policy ID - Name as key value pairRestApiException
Handle createFolder(ExecutionContextToken executionContextToken, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeMap
- map of attributes to update and/or add. Any supplied attributes
will overwrite the default values for folders;
others are left untouched. Its up to the client to
determine the required attributes, their types, etc.RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to create marketing objects or read their
templates (unchecked)RestApiException
- problems encountered accessing data (unchecked)java.util.List<Handle> listFolders(ExecutionContextToken executionContextToken, AttributeMap attributeMap) throws RestApiException
Once retrieved, each handle can be used to interrogate the folder further, e.g., read or update its attributes via the attribute APIs, etc.
Note, this API is intended as a simple way for a client to use server-side discovery to identify folders of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeMap
- optional map of attributes to match. If the attributeMap
parameter is not specified, all current folders are returned.
WARNING: this list could be very large.RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list marketing objects (unchecked)RestApiException
- problems encountered accessing data (unchecked)getAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle)
,
updateAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle, AttributeMap)
,
findMarketingObjectByAttribute(com.unica.uap.restapi.ExecutionContextToken, java.lang.String, java.lang.String, java.lang.Object[])
Handle findFolderByAttributes(ExecutionContextToken executionContextToken, java.lang.String name, java.lang.Object[] values) throws RestApiException
Convenience API; similar to listFolders(), using a single attribute whose name and value are the same as the parameters above, except only one folder is returned.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.name
- name of attribute to match againstvalues
- array of attribute values to match against (all specified
values must match)RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- more than one project matched the attribute(s)
specifiedRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list projects (unchecked)RestApiException
- problems encountered accessing data (unchecked)listOffersAndOfferLists(com.unica.uap.restapi.ExecutionContextToken, AttributeMap)
void publishFolder(ExecutionContextToken executionContextToken, Handle handle) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- unique handle of folder instance to match against.
A RestApiException is thrown if supplied handle
does not represent a valid folder handle.RestApiException
- the specified state transition
is invalid given the current offer state
(i.e. supplied offer is not in DRAFT state)RestApiException
RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)java.util.List<Handle> listApprovals(ExecutionContextToken executionContextToken, AttributeMap attributeMap) throws RestApiException
Note, this API is intended as a simple way for a client to use server-side discovery to identify approvals of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeMap
- optional map of attributes to match. The implied boolean
operator is AND. The match algorithm works as follows:
If the attributeMap parameter is not specified, all current approvals that the client has read security permissions for are returned. Throws RestApiException if one or more of the query attributes is invalid (e.g., empty map, an attribute has the wrong type, etc.).
RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list approvals (unchecked)RestApiException
- problems encountered accessing data (unchecked)getAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle)
,
updateAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle, AttributeMap)
,
findApprovalByAttribute(com.unica.uap.restapi.ExecutionContextToken, java.lang.String, java.lang.Object[])
Handle findApprovalByAttribute(ExecutionContextToken executionContextToken, java.lang.String ApprovalAttributeName, java.lang.Object[] ApprovalAttributeValues) throws RestApiException
Convenience API; similar to listApprovals() using a single attribute whose name and value are the same as the parameters above, except only one marketing object is returned.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.ApprovalAttributeName
- name of approval attribute to match againstApprovalAttributeValues
- array of approval attribute values to match
against (all must match).RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- more than one approvals
matched the attribute(s) specifiedRestApiException
- the specified execution context
is invalid (unchecked exception)RestApiException
- the user bound to the client execution
context is not authorized to list approvals (unchecked exception)RestApiException
- problems encountered accessing data (unchecked exception)listApprovals(com.unica.uap.restapi.ExecutionContextToken, AttributeMap)
Handle createApproval(ExecutionContextToken executionContextToken, AttributeMap attributeMap) throws RestApiException
This method does not add the approval items. To add approval items,
please use #updateApprovalItems(IExecutionContext, Handle, Object[], String[])
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here..attributeMap
- optional map of attributes to update and/or add. Any
supplied attributes will overwrite the default values derived from the
approvals template; others are left untouched. Its up to the client to
determine the attributes required by the approval, their types, etc.RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to create approvals or read their templates (unchecked)RestApiException
- problems encountered accessing data (unchecked)#updateApprovalItems(IExecutionContext, Handle, Object[], String[])
void transitionApprovalStateByHandle(ExecutionContextToken executionContextToken, Handle hApproval, ApprovalStateEnum stateEnum, java.lang.String comments) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hApproval
- the handle of existing approval that is desired to change statestateEnum
- a ApprovalStateEnum enumerated type of the new approval
state to transition to (see uapStateEnum attribute definition). An
RestApiException is thrown if the state transition
is not allowed.comments
- the comments for the state transition which are sent
by Notification ServiceRestApiException
- the specified handle does not refer to a approval
or is corruptRestApiException
- the specified state transition is
invalid given the current approval stateRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
object (unchecked)findApprovalByAttribute(com.unica.uap.restapi.ExecutionContextToken, java.lang.String, java.lang.Object[])
,
updateAttribute(com.unica.uap.restapi.ExecutionContextToken, Handle, java.lang.String, java.lang.Object[])
void updateApprovalItems(ExecutionContextToken executionContextToken, Handle hApproval, java.lang.Object[] approvalItems, java.lang.String[] instructions) throws RestApiException
The item instructions are passed as instructions parameter. The order of the instructions String array is consisting with the order of approvalItems Object array.
Update the exiting items
Since each approval item within an Approval object has item sequence, if one want to update particular approval items, one need to put the right item in the right place of the item array. For example, there is an Approval containing 3 items and the items are order as "MO1", "MO2", "File1". If one only wants to update item "File1", one needs to constructed an array as
The same manner applies when updating item instructions. if one want to update particular item instructions, one need to put right instructions in the right place of the instruction array. If there is no need to update items, one needs to provide an empty Object array with number of the items in size. For example, there is an Approval containing 3 items, one want to update the comments of the last 2 items, on needs to constructed the array asObject [] items = Object [] {null, null, new File("myFile.txt")}; String [] instructions = new String [3]; try { IPlanAPI.updateApprovalItems(context, hApproval, approvalItems, instructions); }catch(Exception e) { ... }
Object [] approvalItems = new Object [3]; String [] instructions = new String [] {null, "comment2", "comment3"}; ...
Append additional items
If one want to append new items in addition to the existing approval items, one need to provide the padding object in the item array. For example,
By doing that, moHandle1 and file1 items are appended to the end of the exiting items.File file1 = new File(myFile.txt); Object [] approvalItems = new Object [] {null, null, null, moHandle1, file1}; ...
Update existing and append additional items
If one want to update the exiting as well as append new items, one need to put updating items in the right order and put the new items at the end. Padding object is used if necessary. For example, there is 3 items Approval object. One want to update the first items and append two new items, one need to construct the array as
File file1 = new File(myFile.txt); File newFile = new File("newFile.txt"); Object [] approvalItems = new Object [] {newFile, null, null, moHandle, file1}; String [] instructions = new String [] {"updated file", null, null, "new MO", "new file"};
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hApproval
- handle the handle of existing approval that is desired to
update its approval itemsapprovalItems
- any combination of Marketing Object handle, java.io.File object.instructions
- the items instructions that corresponding to approval items.RestApiException
- the desired approval object is not foundRestApiException
- - invalid item or invalid item typeRestApiException
- the specified Approval handle is invalidjava.io.IOException
- - Approval items have file I/O exceptionsRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
object (unchecked)#getApprovalItems(IExecutionContext, Handle)
,
#deleteApprovalItemByName(IExecutionContext, Handle, String)
void deleteApprovalItemByName(ExecutionContextToken executionContextToken, Handle hApproval, java.lang.String itemName) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hApproval
- the handle of existing approval that is desired to
delete its approval itemsitemName
- - that name of an approval item that is desired to be deleted.
If the item is Marketing object, it is the name of the Marketing Object.
If the item is a file, it is the name of the file include the file extension name.RestApiException
- - the desired approval object is not foundRestApiException
- - the desired item is not foundRestApiException
- the specified Approval handle is invalidRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
object (unchecked)#getApprovalItems(IExecutionContext, Handle)
,
#updateApprovalItems(IExecutionContext, Handle, Object[], String[])
java.lang.Object[] getApprovalItems(ExecutionContextToken executionContextToken, Handle hApproval) throws RestApiException
If the return is null, it means the Approval object doesn't have any items.Object [] items = getApprovalItems(context, approval); for(int i = 0; i < items; i ++) { if(items[i] instanceof MarketingObjectHandle) { //do something... }else if(items[i] instanceof java.io.File) { //do something... } }
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hApproval
- handle the handle of existing approval that is desired to
delete its approval itemsRestApiException
- the desired approval object is not foundRestApiException
- the specified Approval handle is invalidRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- problems encountered accessing data (unchecked)updateApprovalItems(com.unica.uap.restapi.ExecutionContextToken, Handle, java.lang.Object[], java.lang.String[])
,
#deleteApprovalItemByName(IExecutionContext, Handle, String)
Handle appendAttachment(ExecutionContextToken executionContextToken, Handle hParent, AttributeMap attachmentAttributes) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hParent
- handle to an existing project or marketing object to be updatedattachmentAttributes
- map of attributes to update and/or add to the new
attachment.RestApiException
- the specified handle is invalidRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update one or more object attributes (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
the parent object (unchecked)java.util.List<Handle> listUsers(ExecutionContextToken executionContextToken, AttributeMap attributes) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributes
- optional map of attributes to match. The implied boolean
operator is AND. The match algorithm works as follows:
If the attributeMap parameter is not specified, all current users that have read security permissions for are returned. Throws RestApiException if one or more of the query attributes is invalid (e.g., empty map, an attribute has the wrong type, etc.).
RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list projects (unchecked)RestApiException
- problems encountered accessing data (unchecked)Note, this API is intended as a simple way for a client to use server-side discovery to identify user of interest; more complicated discovery can be done by combining this API with client-side attribute processing. The only Security Policy supported is the Plan Default Global Security Policy. The search functions will NOT support other Security Policies, and will assume all operations are within the Default Security Policy.
getAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle)
,
updateAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle, AttributeMap)
,
findUserByAttribute(com.unica.uap.restapi.ExecutionContextToken, java.lang.String, java.lang.Object[])
Handle findUserByAttribute(ExecutionContextToken executionContextToken, java.lang.String attributeName, java.lang.Object[] attributeValues) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeName
- name of attribute to match againstattributeValues
- array of attribute values to match against (all specified
values must match)RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- more than one user matched the attribute(s)
specifiedRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list users (unchecked)RestApiException
- problems encountered accessing data (unchecked)Convenience API; similar to listUsers(), using a single attribute whose name and value are the same as the parameters above, except only one user is returned.
#listUsers(IExecutionContext, AttributeMap)
java.util.List<Handle> listTeams(ExecutionContextToken executionContextToken, AttributeMap attributes) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributes
- optional map of attributes to match. The implied boolean
operator is AND. The match algorithm works as follows:
If the attributeMap parameter is not specified, all current teams that have read security permissions for are returned. Throws RestApiException if one or more of the query attributes is invalid (e.g., empty map, an attribute has the wrong type, etc.).
RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the team bound to the client execution
context is not authorized to list projects (unchecked)RestApiException
- problems encountered accessing data (unchecked)Note, this API is intended as a simple way for a client to use server-side discovery to identify team of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
getAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle)
,
updateAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle, AttributeMap)
,
#findTeamByAttribute(IExecutionContext, String, Object)
Handle findTeamByAttribute(ExecutionContextToken executionContextToken, java.lang.String attributeName, java.lang.Object attributeValue) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeName
- name of attribute to match againstattributeValue
- array of attribute values to match against (all specified
values must match)RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
RestApiException
- more than one team matched the attribute(s)
specifiedRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the team bound to the client execution
context is not authorized to list teams (unchecked)RestApiException
- problems encountered accessing data (unchecked)Convenience API; similar to listTeams(), using a single attribute whose name and value are the same as the parameters above, except only one team is returned.
#listTeams(IExecutionContext, AttributeMap)
Handle getParentHandle(ExecutionContextToken executionContextToken, Handle childHandle) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.childHandle
- handle of the childRestApiException
- the specified child handle is invalidRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update a workflow task (unchecked)RestApiException
- problems encountered accessing data (unchecked)Handle createAsset(ExecutionContextToken executionContextToken, Handle hAssetLibrary, AttributeMap attributes) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hAssetLibrary
- a handle of an asset library or an asset folder. A new Asset will be created within the asset libraryattributes
- map of attributes to update and/or add. Any supplied attributes
will overwrite the default values;
others are left untouched. Its up to the client to determine the attributesRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified asset library handle is invalidRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to create marketing objects or read their
templates (unchecked)RestApiException
- problems encountered accessing data (unchecked)java.util.List<Handle> listAssets(ExecutionContextToken executionContextToken, Handle hAssetLibrary, AttributeMap attributes) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hAssetLibrary
- a handle of an asset library or an asset folder. All returning assets will be within the asset library.attributes
- optional map of attributes to match. The implied boolean
operator is AND. The match algorithm works as follows:
If the attributeMap parameter is not specified, all current assets that are in the given asset library and the client has read security permissions for are returned. Throws RestApiException if one or more of the query attributes is invalid (e.g., empty map, an attribute has the wrong type, etc.).
RestApiException
- the specified asset library handle is invalidRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list projects (unchecked)RestApiException
- problems encountered accessing data (unchecked)Note, this API is intended as a simple way for a client to use server-side discovery to identify asset of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
getAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle)
,
updateAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle, AttributeMap)
,
#findAssetByAttribute(IExecutionContext, Handle, String, Object)
java.util.List<Handle> listAssetFolders(ExecutionContextToken executionContextToken, Handle hAssetLibrary, AttributeMap attributes) throws RestApiException
RestApiException
Handle findAssetByAttribute(ExecutionContextToken executionContextToken, Handle hAssetLibrary, java.lang.String attributeName, java.lang.Object attributeValue) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeName
- name of attribute to match againstattributeValue
- array of attribute values to match against (all specified
values must match)RestApiException
- the specified asset library handle is invalidRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- more than one asset matched the attribute(s)
specifiedRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list assets (unchecked)RestApiException
- problems encountered accessing data (unchecked)Convenience API; similar to listAssets(), using a single attribute whose name and value are the same as the parameters above, except only one asset is returned.
#listAssets(IExecutionContext, Handle, AttributeMap)
void deleteAsset(ExecutionContextToken executionContextToken, Handle hAsset) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hAsset
- handle to an existing asset to be updatedRestApiException
- the specified asset handle is invalidRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update one or more object attributes (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
the asset object (unchecked)void transitionAssetStateByCode(ExecutionContextToken executionContextToken, java.lang.String code, AssetStateEnum stateEnum, java.lang.String comments) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.code
- unique asset code to match against (equivalent to value
of code asset attribute). A RestApiException is thrown
if no asset exists with that code. If more than one asset matches, i.e.,
the attribute is not unique, a RestApiException is thrown.stateEnum
- a AssetStateEnum enumerated type of the new asset
state to transition to (see uapStateEnum attribute definition). An
RestApiException is thrown if the state transition
is not allowed.comments
- comments for this transitionRestApiException
- no asset was found for the specified codeRestApiException
- more than one asset matched the code
specifiedRestApiException
- the specified state transition is
invalid given the current asset stateRestApiException
- one or more specified attributes do
not exist for the object instanceRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
object (unchecked)Convenience API; identical to making the following API calls:
findAssetByAttribute(com.unica.uap.restapi.ExecutionContextToken, Handle, java.lang.String, java.lang.Object)
,
updateAttribute(com.unica.uap.restapi.ExecutionContextToken, Handle, java.lang.String, java.lang.Object[])
java.util.List<Handle> listAssetLibraries(ExecutionContextToken executionContextToken, AttributeMap attributeMap) throws RestApiException
Note, this API is intended as a simple way for a client to use server-side discovery to identify asset library of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeMap
- optional map of attributes to match. The implied boolean
operator is AND. The match algorithm works as follows:
If the attributeMap parameter is not specified, all current asset libraries that have read security permissions for are returned. Throws RestApiException if one or more of the query attributes is invalid (e.g., empty map, an attribute has the wrong type, etc.).
RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list projects (unchecked)RestApiException
- problems encountered accessing data (unchecked)getAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle)
,
updateAttributes(com.unica.uap.restapi.ExecutionContextToken, Handle, AttributeMap)
,
#findAssetLibraryByAttribute(IExecutionContext, String, Object)
Handle findAssetLibraryByAttribute(ExecutionContextToken executionContextToken, java.lang.String attributeName, java.lang.Object attributeValue) throws RestApiException
Convenience API; similar to listAssetLibraries(), using a single attribute whose name and value are the same as the parameters above, except only one asset is returned.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeName
- name of attribute to match againstattributeValue
- array of attribute values to match against (all specified
values must match)RestApiException
RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- more than one asset libraries matched the attribute(s)
specifiedRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list asset libraries (unchecked)RestApiException
- problems encountered accessing data (unchecked)#listAssetLibraries(IExecutionContext, AttributeMap)
Handle createAssetFolder(ExecutionContextToken executionContextToken, Handle parentHandle, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.parentHandle
- the folder's parent handle. It could be an @link AssetLibraryHandle or @link AssetFolderHandleattributeMap
- map of attributes to update and/or add. Any supplied attributes
will overwrite the default values; others are left untouched.
Its up to the client to determine the attributes.RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to create marketing objects or read their
templates (unchecked)RestApiException
- problems encountered accessing data (unchecked)AttributeMap getProjectBudget(ExecutionContextToken executionContextToken, Handle handle, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- Must be a valid project handleattributeMap
- Parameter to determine type of budget
attributeMap must contain key IPlanAPI.PROJECT_BUDGET_TYPE. Value for this key should be one of the following:
attributeMap must contain key IPlanAPI.PROJECT_BUDGET_PERIOD Parameter to determine period of budget total. Value for this key should be one of the following:
For budget period BudgetPeriodEnum.QUARTERLY, user may provide optional quarter value with IPlanAPI.PROJECT_BUDGET_QUARTER key in attributeMap and QuarterEnum instance for required quarter as the value. e.g. QuarterEnum.Q1, QuarterEnum.Q2, etc. If IPlanAPI.PROJECT_BUDGET_QUARTER is not specified then returned attribute map will contain all four quarter's information as specified in Returns section.
For budget period BudgetPeriodEnum.MONTHLY, user may provide optional month value with IPlanAPI.PROJECT_BUDGET_MONTH key in attributeMap and MonthEnum instance for required month as the value. e.g. MonthEnum.JANUARY, MonthEnum.FEBRUARY, etc. If IPlanAPI.PROJECT_BUDGET_MONTH is not specified then returned attribute map will contain all twelve month's information as specified in Returns section.
For budget period BudgetPeriodEnum.WEEKLY, user may provide optional week value with IPlanAPI.PROJECT_BUDGET_WEEK key in attributeMap and WeekEnum instance for required week as the value. e.g. WeekEnum.WEEK_1, WeekEnum.WEEK_2, etc. If IPlanAPI.PROJECT_BUDGET_WEEK is not specified then returned attribute map will contain all 53 week's information as specified in Returns section.
For budget period BudgetPeriodEnum.QUARTERLY, BudgetPeriodEnum.MONTHLY or BudgetPeriodEnum.WEEKLY, if no appropriate period value is specified then returned attribute map will contain all entries as applicable for specified budget period with key as follows
RestApiException:
- if handle provided is not a valid project handleRestApiException:
- If parameters in attributeMap are invalid or budget period specified do not matches project budget granularityRestApiException
Handle createInvoice(ExecutionContextToken executionContextToken, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeMap
- attribute map must contain following parameters
attributeMap can contain following optional parameters
RestApiException
- If parameters specified in attributeMap are not validRestApiException
- the user bound to the client execution context is not authorized to create invoiceHandle findInvoiceByNumberAndVendor(ExecutionContextToken executionContextToken, java.lang.String invoiceNumber, java.lang.String vendorCode) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.invoiceNumber
- Invoice number to findvendorCode
- vendor Code to findRestApiException
- if invalid invoice number or vendor code is specifiedjava.util.List<Handle> listInvoices(ExecutionContextToken executionContextToken) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.RestApiException
Handle addInvoiceLineItem(ExecutionContextToken executionContextToken, Handle handle, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- Must be a valid invoice handleattributeMap
- attribute map must contain following parameters
Integer
array formatRestApiException:
- if handle provided is not a valid invoice handleRestApiException:
- If parameters specified are not validRestApiException
void deleteInvoiceLineItem(ExecutionContextToken executionContextToken, Handle hInvoiceLineItem) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hInvoiceLineItem
- Must be a valid invoice line item handleRestApiException
- If handle provided is not a valid invoice line item handle or parent invoice is not in draft stateRestApiException
- If line item is linked to any rule driven approval in In Progress statejava.util.List<Handle> listInvoiceLineItems(ExecutionContextToken executionContextToken, Handle handle) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- Must be a valid invoice handleRestApiException,
- if handle is invalidRestApiException
void transitionInvoiceState(ExecutionContextToken executionContextToken, Handle handle, InvoiceStateEnum stateEnum, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- Must be a valid invoice handlestateEnum
- InvoiceStateEnum enumerated type of the new invoice state to
transition to. An RestApiException is thrown if
the state transition is not allowed.attributeMap
- must contain following key with string array as value
IPlanAPI.INVOICE_STATE_TRANSITION_COMMENT
If state is changed to PAID then attributeMap must contain following key with Calendar array
IPLANAPI.INVOICE_PAID_DATERestApiException
- if handle is not a valid invoice handleRestApiException
- the specified state transition is invalid given the
current project stateHandle createFinancialAccount(ExecutionContextToken executionContextToken, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeMap
- attributeMap must contain following key value pair
RestApiException,
- if sourceAccount handle is specified and not a valid
financial accountRestApiException
- if attributes specified in attributeMap is/are invalidvoid enableFinancialAccount(ExecutionContextToken executionContextToken, Handle handle) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- Must be a valid account handle.RestApiException
- if handle is not a valid account handleRestApiException
- the enabling account is not validvoid disableFinancialAccount(ExecutionContextToken executionContextToken, Handle handle) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- Must be a valid account handle.RestApiException
- if handle is not a valid account handleRestApiException
- the disabling account is not validjava.util.List<Handle> listFinancialAccounts(ExecutionContextToken executionContextToken, boolean includeDisabled) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.includeDisabled
- set this flag to get disabled accounts in listRestApiException
Handle findFinancialAccountByNumber(ExecutionContextToken executionContextToken, java.lang.String accountNumber) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.accountNumber
- account numberRestApiException
- if invalid account number is specifiedvoid updateFinancialAccountBudget(ExecutionContextToken executionContextToken, Handle sourceAccount, int fiscalYear, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.sourceAccount
- Must be a valid account handle.fiscalYear
- Financial year (in yyyy format) for which budget needs to be
updatedattributeMap
- AttributeMap must contain at least one key from the following
list and value must be valid double value
RestApiException
- if handle is not a valid account handleRestApiException
- the specified attributes are not validAttributeMap getFinancialAccountBudget(ExecutionContextToken executionContextToken, Handle handle, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- handle of financial accountattributeMap
- attribute Map must contain following key values
If IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_ALLOTTED was selected while calling this API then returned attributeMap will contain IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_ALLOTTED as key and attributemap as value. AttributeMap returned in value will have following keys with values in double format representing allotted budget
If IPLANAPI.FINANCIAL_ACCOUNT_BUDGET_ FORECAST was selected while calling this API then returned attributeMap will contain IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_ FORECAST as key and attributemap as value. AttributeMap returned in value will have following keys with values in double format representing allotted budget
If IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_ AVAILABLE was selected while calling this API then returned attributeMap will contain IPLANAPI.FINANCIAL_ACCOUNT_BUDGET_ AVAILABLE as key and attributemap as value. AttributeMap returned in value will have following keys with values in double format representing allotted budget
If IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_COMMITTED was selected while calling this API then returned attributeMap will contain IPLANAPI.FINANCIAL_ACCOUNT_BUDGET_COMMITTED as key and attributemap as value. AttributeMap returned in value will have following keys with values in double format representing allotted budget
If IPLANAPI.FINANCIAL_ACCOUNT_BUDGET_ UNCOMMITTED was selected while calling this API then returned attributeMap will contain IPLANAPI.FINANCIAL_ACCOUNT_BUDGET_ UNCOMMITTED as key and attributemap as value. AttributeMap returned in value will have following keys with values in double format representing allotted budget
If IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_ACTUAL was selected while calling this API then returned attributeMap will contain IPLANAPI.FINANCIAL_ACCOUNT_BUDGET_ACTUAL as key and attributemap as value. AttributeMap returned in value will have following keys with values in double format representing allotted budget
If IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_ REMAINING was selected while calling this API then returned attributeMap will contain IPLANAPI.FINANCIAL_ACCOUNT_BUDGET_ REMAINING as key and attributemap as value. AttributeMap returned in value will have following keys with values in double format representing allotted budget
If IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_ALL was selected while calling this API then returned attributeMap will contain all the keys defined above with attributemap as value.
RestApiException
- if handle is not a valid account handleRestApiException
- the specified attributes are not validHandle copyProject(ExecutionContextToken executionContextToken, Handle hProject, ProjectCopyTypeEnum copyEnum, boolean copyParentLink) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- Must be a valid project handlecopyEnum
- Type of metrics to copy project
copyParentLink
- if true and if source project has parent then link to parent will be copiedHandle
of the copied new project objectRestApiException
- if handle provided is not a valid project handleRestApiException
- if template of source project not foundvoid copyProjectResources(ExecutionContextToken executionContextToken, Handle hProjectSource, Handle hProjectDestination) throws RestApiException
RestApiException
and no resources will be copied to the destination project.executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProjectSource
- Must be a valid project handle and source projecthProjectDestination
- Must be a valid project handle and destination projectRestApiException
- if handle provided is not a valid project handle OR template
of source and destination project are different OR source and
destination project handle points to same projectRestApiException
- If source project contains disabled teamHandle addProjectBudgetLineItem(ExecutionContextToken executionContextToken, Handle hProject, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- Must be a valid project handleattributeMap
- Attribute map must contain following parameters:RestApiException
- if handle provided is not a valid project handleRestApiException
- If parameters specified in attributeMap are not validvoid deleteProjectLineItem(ExecutionContextToken executionContextToken, Handle hProjectLineItem) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProjectLineItem
- Must be a valid project line item handleRestApiException
- If handle provided is not a valid project line item handle or project is not in active stateRestApiException
java.util.List<Handle> listProjectLineItems(ExecutionContextToken executionContextToken, Handle hProject, boolean getLastVersion) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- Must be a valid project handlegetLastVersion
- if specified as true then return values will be last version otherwise values
returned will be current values. If specified as true and last version is not available
then API will return current values.RestApiException
- If handle provided is not a valid project handleRestApiException
- If parameters getLastVersion is specified as true and last version is not availableAttributeMap getProjectBudgetLineItemSummary(ExecutionContextToken executionContextToken, Handle hProject, boolean getLastVersion) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProject
- Must be a valid project handlegetLastVersion
- if specified as true then return values will be last version otherwise
values returned will be current values. If specified as true and last version is
not available then API will return current values.RestApiException
- if handle provided is not a valid project handleRestApiException
- If parameters getLastVersion is specified as true and last version is not availableAttributeMap getSubProjectBudgetSummary(ExecutionContextToken executionContextToken, Handle handle, AttributeMap attributeMap) throws RestApiException
context
- API execution contexthandle
- Must be a valid parent project handleattributeMap
- Parameter to determine type of budget
attributeMap must contain key IPlanAPI.PROJECT_BUDGET_TYPE.
Value for this key should be one of the following:RestApiException:
- if handle provided is not a valid project handleRestApiException:
- If parameters in attributeMap are invalidRestApiException
void finalizeProjectBudgetChanges(ExecutionContextToken executionContextToken, Handle handle, AttributeMap attrMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- Must be a valid project handleattrMap
- Should have target due date (IPLANAPI.APPROVAL_ATTRIBUTE_TARGETDUEDATE)
and optional description (IPLANAPI.APPROVAL_ATTRIBUTE_DESCRIPTION) attributes if approval is required for finalizationRestApiException
- if handle provided is not a valid project handle or project is not in active stateRestApiException
- If no changes available in project budget to finalizevoid discardProjectBudgetChanges(ExecutionContextToken executionContextToken, Handle handle) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- Must be a valid project handleRestApiException
- if handle provided is not a valid project handle or project is not in active stateRestApiException
- If no changes available in project budget to discardAttributeMap getProjectBudgetLineItemAllocation(ExecutionContextToken executionContextToken, Handle handle, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- Must be a valid project handleattributeMap
- Parameters to determine period of allocation attributeMap must contain key IPlanAPI.PROJECT_BUDGET_ALLOCATION_PERIOD. RestApiException
- If handle provided is not a valid project handleRestApiException
- If parameters in attributeMap are invalid or budget period does not matches budget granularity of projectAttributeMap getSubProjectAllocation(ExecutionContextToken executionContextToken, Handle handle, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- Must be a valid parent project handleattributeMap
- Parameters to determine period of allocation attributeMap must contain key IPlanAPI.PROJECT_BUDGET_ALLOCATION_PERIOD. RestApiException
- If handle provided is not a valid project handleRestApiException
- If parameters in attributeMap are invalid or budget period does not matches budget granularity of projectvoid updateProjectLineItemAllocation(ExecutionContextToken executionContextToken, Handle handle, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- Must be a valid project handle for which allocation needs to updateattributeMap
- To update project total allocation provide following keys with allocation as value in double format:RestApiException
- if handle provided is not a valid project handleRestApiException
- If parameters in attributeMap are invalidvoid updateSubProjectAllocation(ExecutionContextToken executionContextToken, Handle handle, Handle hSubProject, AttributeMap attributeMap) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- Must be a valid parent project handle for which allocation needs to updatehSubProject
- Must be a valid sub project handle for which allocation needs to updateattributeMap
- To update project total allocation provide following keys with allocation as value in double format:RestApiException
- if handle provided is not a valid project handleRestApiException
- If parameters in attributeMap are invalidHandle createProgram(ExecutionContextToken executionContextToken, java.lang.String templateName, AttributeMap attributeMap) throws RestApiException
Child projects can be linked to the created parent project as needed; see linkProjectChildren().
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here..templateName
- the name of the template to use to create this program.
The named template must exist on the Plan server and the client must have
read permissions for that instance. The template provides, among other
things, the definition of required and optional attributes, default values, etc.attributeMap
- optional map of attributes to update and/or add. Any
supplied attributes will overwrite the default values derived from the
program template; others are left untouched. Its up to the client to
determine the attributes required by the program, their types, etc.RestApiException
- the specified template doesn't existRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to create program or read their templates (unchecked)RestApiException
- problems encountered accessing data (unchecked)java.util.List<Handle> listPrograms(ExecutionContextToken executionContextToken, AttributeMap attributeMap) throws RestApiException
Note, this API is intended as a simple way for a client to use server-side discovery to identify projects of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeMap
- optional map of attributes to match. The implied boolean
operator is AND. The match algorithm works as follows:
If the attributeMap parameter is not specified, all current programs that the client has read security permissions for are returned. Throws RestApiException if one or more of the query attributes is invalid (e.g., empty map, an attribute has the wrong type, etc.).
RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list programs (unchecked)RestApiException
- problems encountered accessing data (unchecked)Handle findProgramByAttribute(ExecutionContextToken executionContextToken, java.lang.String name, java.lang.Object[] values) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.attributeMap
- is required map of attributes to match. The implied boolean
operator is AND. The match algorithm works as follows:
if attributeMap is null throws invalidattributexception if one or more of the query attributes is invalid (e.g., empty map, an attribute has the wrong type, etc.).
RestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to list programs (unchecked)RestApiException
- problems encountered accessing data (unchecked)void linkProgramPlan(ExecutionContextToken executionContextToken, Handle pgmHandle, int planID, java.lang.String programArea) throws RestApiException
This API is used to link Plan to Program.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- of the ProgramplanID
- of the Plan to linkRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.RestApiException
- problems encountered accessing data (unchecked)void unlinkProgramPlan(ExecutionContextToken executionContextToken, Handle handle) throws RestApiException
This API is used to unlink Plan from Program.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.handle
- Program Handle
* @throws RestApiExceptionRestApiException
RestApiException
com.unica.publicapi.plan.api.IPlanAPI#delinkProgramPlan(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.Handle[])
void transitionProgramState(ExecutionContextToken executionContextToken, Handle hProgram, ProgramState stateEnum, java.lang.String comments) throws RestApiException
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hProgram
- Must be a valid program handlestateEnum
- a ProgramState enumerated type of the new program
state to transition to (see uapStateEnum attribute definition). An
RestApiException is thrown if the state transition
is not allowed.comments
- the comments for the state transition which are sent
by Notification ServiceRestApiException
- no program was found for the specified codeRestApiException
- more than one project matched the code
specifiedRestApiException
- the specified state transition is
invalid given the current program stateRestApiException
- one or more specified attributes do
not exist for the object instanceRestApiException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.RestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
object (unchecked)void linkProgramChildren(ExecutionContextToken executionContextToken, Handle hParent, Handle[] hChildren) throws RestApiException
Child projects may in turn have their own children--or have this done by later use of this API. The API will detect circular references, i.e., A => B => C => A, and return a RestApiException.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hParent
- handle of an existing program to link children to. Throws
RestApiException if the parent program does not exist; throws
RestApiException if the client does not hold an edit lock for the
referenced program.hChildren
- array of one or more handles of existing projects to link as
children. Throws RestApiException if one or more of the child
projects does not exist; ; throws a RestApiException if the server
cannot process the number of children specified in one request (because of circularity
detection). In this case, the client should break up the request into multiple calls,
e.g., less than 500.RestApiException
- the specified handle does not refer to a project
or is corruptRestApiException
- linking one or more of the specified children
would cause a circular referenceRestApiException
- the server cannot process the number of children
specified in one requestRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update a project's list of children (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
the parent program (unchecked)unlinkProgramChildren(com.unica.uap.restapi.ExecutionContextToken, Handle, Handle[])
void unlinkProgramChildren(ExecutionContextToken executionContextToken, Handle hParent, Handle[] hChildren) throws RestApiException
All children must in fact be linked to the specified parent, otherwise RestApiException is thrown. Note that this API does not affect nested children, i.e., if A => B => C, then unlinking B from A will not affect the B => C link.
executionContextToken
- the client execution context token. For regular API calls, this parameter should be null, for API calls related to Triggered events, the execution context token provided by a triggered event should be provided here.hParent
- handle of an existing parent program. Throws RestApiException
if the parent project does not exist; throws RestApiException if the client
does not hold an edit lock for the referenced program.hChildren
- array of handles of existing child projects to unlink from the parent.
Throws RestApiException if one or more of the child projects is not
currently linked to the specified parent.RestApiException
- the specified handle(s) does not refer to a project
or is corruptRestApiException
- the specified execution context
is invalid (unchecked)RestApiException
- the user bound to the client execution
context is not authorized to update a project's list of children (unchecked)RestApiException
- problems encountered accessing data (unchecked)RestApiException
- client did not acquire proper write locks for
the parent program (unchecked)linkProgramChildren(com.unica.uap.restapi.ExecutionContextToken, Handle, Handle[])