Package | Description |
---|---|
com.unica.uap.restapi.interfaces |
Modifier and Type | Method and Description |
---|---|
Handle |
IRestApiClient.addInvoiceLineItem(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap)
API to add new line item in invoice
|
Handle |
IRestApiClient.addProjectBudgetLineItem(ExecutionContextToken executionContextToken,
Handle hProject,
AttributeMap attributeMap)
Use this API to add new project budget line item
|
Handle |
IRestApiClient.appendAttachment(ExecutionContextToken executionContextToken,
Handle hParent,
AttributeMap attachmentAttributes) |
Handle |
IRestApiClient.appendGridRow(ExecutionContextToken executionContextToken,
Handle hGrid,
AttributeMap rowAttributeMap)
Append a new grid row to the specified object, applying the supplied grid row attributes.
|
Handle |
IRestApiClient.copyProject(ExecutionContextToken executionContextToken,
Handle hProject,
ProjectCopyTypeEnum copyEnum,
boolean copyParentLink)
Use this API to copy existing project instance and to create new project.
|
void |
IRestApiClient.copyProjectResources(ExecutionContextToken executionContextToken,
Handle hProjectSource,
Handle hProjectDestination)
API to copy resource (People tab of project) from source project to
destination project.
|
Handle |
IRestApiClient.createApproval(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
Create a new approval component with specified attributes and user
information from the execution context.
|
Handle |
IRestApiClient.createAsset(ExecutionContextToken executionContextToken,
Handle hAssetLibrary,
AttributeMap attributes) |
Handle |
IRestApiClient.createAssetFolder(ExecutionContextToken executionContextToken,
Handle parentHandle,
AttributeMap attributeMap) |
Handle |
IRestApiClient.createFinancialAccount(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
API to create new financial account.
|
Handle |
IRestApiClient.createFolder(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
Create a new folder applying the specified attributes and user information
from the execution context.
|
Handle |
IRestApiClient.createInvoice(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
API to create new Invoice in Plan
|
Handle |
IRestApiClient.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 |
IRestApiClient.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 |
IRestApiClient.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 |
IRestApiClient.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 |
IRestApiClient.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 |
IRestApiClient.dateRipplingForWorkflowTasks(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap)
Do date rippling for the Project Workflow.
|
void |
IRestApiClient.deleteApprovalItemByName(ExecutionContextToken executionContextToken,
Handle hApproval,
java.lang.String itemName)
Delete a single approval item within an Approval process.
|
void |
IRestApiClient.deleteAsset(ExecutionContextToken executionContextToken,
Handle hAsset) |
void |
IRestApiClient.deleteGridRow(ExecutionContextToken executionContextToken,
Handle hGridRow)
Delete an existing grid row.
|
void |
IRestApiClient.deleteInvoiceLineItem(ExecutionContextToken executionContextToken,
Handle hInvoiceLineItem)
Use this API to delete a invoice line item
|
void |
IRestApiClient.deleteProjectLineItem(ExecutionContextToken executionContextToken,
Handle hProjectLineItem)
Use this API to delete a project line item
|
void |
IRestApiClient.disableFinancialAccount(ExecutionContextToken executionContextToken,
Handle handle)
API to disable financial account
|
void |
IRestApiClient.discardProjectBudgetChanges(ExecutionContextToken executionContextToken,
Handle handle)
Use this API to discard changes done in project budget
|
void |
IRestApiClient.enableFinancialAccount(ExecutionContextToken executionContextToken,
Handle handle)
API to enable financial account
|
void |
IRestApiClient.finalizeProjectBudgetChanges(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attrMap)
Use this API to finalize changes done in project budget
|
Handle |
IRestApiClient.findApprovalByAttribute(ExecutionContextToken executionContextToken,
java.lang.String ApprovalAttributeName,
java.lang.Object[] ApprovalAttributeValues)
Find the Approval object that matches the supplied attributes.
|
Handle |
IRestApiClient.findAssetByAttribute(ExecutionContextToken executionContextToken,
Handle hAssetLibrary,
java.lang.String attributeName,
java.lang.Object attributeValue) |
Handle |
IRestApiClient.findAssetLibraryByAttribute(ExecutionContextToken executionContextToken,
java.lang.String attributeName,
java.lang.Object attributeValue)
Finds an asset library that matches the supplied attribute.
|
Handle |
IRestApiClient.findFinancialAccountByNumber(ExecutionContextToken executionContextToken,
java.lang.String accountNumber)
API to find financial account by account number
|
Handle |
IRestApiClient.findFolderByAttributes(ExecutionContextToken executionContextToken,
java.lang.String name,
java.lang.Object[] values)
Finds the folder that matches the either of supplied folder name/description.
|
Handle |
IRestApiClient.findInvoiceByNumberAndVendor(ExecutionContextToken executionContextToken,
java.lang.String invoiceNumber,
java.lang.String vendorCode)
API to find invoice by number and vendor code
|
Handle |
IRestApiClient.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 |
IRestApiClient.findOfferOrOfferListByAttributes(ExecutionContextToken executionContextToken,
java.lang.String name,
java.lang.Object[] values)
Finds the offer or offer list that matches the supplied attribute.
|
Handle |
IRestApiClient.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 |
IRestApiClient.findProjectByAttribute(ExecutionContextToken executionContextToken,
java.lang.String name,
java.lang.Object[] values)
Finds the project that matches the supplied attribute.
|
Handle |
IRestApiClient.findProjectRequestByAttribute(ExecutionContextToken executionContextToken,
java.lang.String name,
java.lang.Object[] values)
Finds the project request that matches the supplied attribute.
|
Handle |
IRestApiClient.findSubProjectParent(ExecutionContextToken executionContextToken,
Handle hProject)
Find the parent project of an existing project, if defined.
|
Handle |
IRestApiClient.findSubProjectRoot(ExecutionContextToken executionContextToken,
Handle hProject)
Find the root project of an existing project, if defined.
|
Handle |
IRestApiClient.findTeamByAttribute(ExecutionContextToken executionContextToken,
java.lang.String attributeName,
java.lang.Object attributeValue) |
Handle |
IRestApiClient.findUserByAttribute(ExecutionContextToken executionContextToken,
java.lang.String attributeName,
java.lang.Object[] attributeValues) |
Handle |
IRestApiClient.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[] |
IRestApiClient.getApprovalItems(ExecutionContextToken executionContextToken,
Handle hApproval)
Get all of the ordered approval items within an Approval object.
|
AttributeMap |
IRestApiClient.getAttributes(ExecutionContextToken executionContextToken,
Handle handle)
Fetches the attribute map of the object instance given by the specified
handle.
|
AttributeMap |
IRestApiClient.getCampaignSecurityPolicies(ExecutionContextToken executionContextToken)
Utility API to get information about campaign security policies
|
AttributeMap |
IRestApiClient.getFinancialAccountBudget(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap)
Use this API to get financial account budget information
|
java.util.List<java.lang.String> |
IRestApiClient.getMemberRoles(ExecutionContextToken executionContextToken,
Handle hProject)
Find the member roles for an existing project, if defined.
|
java.util.List<Handle> |
IRestApiClient.getMembersByParticipationLevel(ExecutionContextToken executionContextToken,
Handle hProject,
ProjectParticipantLevelEnum participantLevel)
Return members for a specific participation level for an existing project.
|
java.util.List<Handle> |
IRestApiClient.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> |
IRestApiClient.getMembersByRoleType(ExecutionContextToken executionContextToken,
Handle handle,
java.lang.String roleType) |
Handle |
IRestApiClient.getParentHandle(ExecutionContextToken executionContextToken,
Handle childHandle)
Returns the parent handle for a particular child handle.
|
AttributeMap |
IRestApiClient.getProjectBudget(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap) |
AttributeMap |
IRestApiClient.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 |
IRestApiClient.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> |
IRestApiClient.getReviewerRoles(ExecutionContextToken executionContextToken,
Handle hProject)
Find the reviewer roles for an existing project, if defined.
|
java.util.List<Handle> |
IRestApiClient.getReviewersByRole(ExecutionContextToken executionContextToken,
Handle hProject,
java.lang.String roleName)
Return a list of reviewers for a specific reviewer role for an existing project.
|
AttributeMap |
IRestApiClient.getSubProjectAllocation(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap)
Allocations (total, yearly, quarterly) of sub project is returned by the parameters passed in attributeMap Parameter
|
AttributeMap |
IRestApiClient.getSubProjectBudgetSummary(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap)
Use this API function to extract Sub Project Budget information.
|
Handle |
IRestApiClient.getWorkflowTaskParentProject(ExecutionContextToken executionContextToken,
Handle hTask)
Returns the parent project for a particular task.
|
boolean |
IRestApiClient.init(java.lang.String loginUrl,
java.lang.String restAPIUrl)
Initialization method to provide the URLs for performing login and calling MO REST API.
|
void |
IRestApiClient.linkProgramChildren(ExecutionContextToken executionContextToken,
Handle hParent,
Handle[] hChildren)
Links (adds) one or more projects to a common parent program; all projects must already exist.
|
void |
IRestApiClient.linkProgramPlan(ExecutionContextToken executionContextToken,
Handle pgmHandle,
int planID,
java.lang.String programArea)
Link existing Plan object with Program
|
void |
IRestApiClient.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> |
IRestApiClient.listAllProjectChildren(ExecutionContextToken executionContextToken,
Handle hParent)
Lists the all child projects of an existing parent project, if defined.
|
java.util.List<Handle> |
IRestApiClient.listApprovals(ExecutionContextToken executionContextToken,
AttributeMap attributeMap)
Lists all approvals whose attributes match those specified.
|
java.util.List<Handle> |
IRestApiClient.listAssetFolders(ExecutionContextToken executionContextToken,
Handle hAssetLibrary,
AttributeMap attributes) |
java.util.List<Handle> |
IRestApiClient.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> |
IRestApiClient.listAssets(ExecutionContextToken executionContextToken,
Handle hAssetLibrary,
AttributeMap attributes) |
java.util.List<Handle> |
IRestApiClient.listFinancialAccounts(ExecutionContextToken executionContextToken,
boolean includeDisabled)
API to list financial Account
|
java.util.List<Handle> |
IRestApiClient.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> |
IRestApiClient.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> |
IRestApiClient.listInvoiceLineItems(ExecutionContextToken executionContextToken,
Handle handle)
API to list all line items of an Invoice
|
java.util.List<Handle> |
IRestApiClient.listInvoices(ExecutionContextToken executionContextToken)
API to list all available invoices
|
java.util.List<Handle> |
IRestApiClient.listMarketingObjectGrids(ExecutionContextToken executionContextToken,
Handle hMarketingObject)
Lists the grids bound to the specified marketing object, if defined.
|
java.util.List<Handle> |
IRestApiClient.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> |
IRestApiClient.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> |
IRestApiClient.listPossibleMemberRolesForTask(ExecutionContextToken executionContextToken,
Handle hTask) |
java.util.List<Handle> |
IRestApiClient.listPossibleMembersForTask(ExecutionContextToken executionContextToken,
Handle hTask) |
java.util.List<Handle> |
IRestApiClient.listPossibleReviewerRolesForTask(ExecutionContextToken executionContextToken,
Handle hTask) |
java.util.List<Handle> |
IRestApiClient.listPossibleReviewersForTask(ExecutionContextToken executionContextToken,
Handle hTask) |
java.util.List<Handle> |
IRestApiClient.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> |
IRestApiClient.listProjectChildren(ExecutionContextToken executionContextToken,
Handle hParent)
Lists the child projects of an existing parent project, if defined.
|
java.util.List<Handle> |
IRestApiClient.listProjectGrids(ExecutionContextToken executionContextToken,
Handle hProject)
Lists the grids bound to the supplied project, if defined.
|
java.util.List<Handle> |
IRestApiClient.listProjectLineItems(ExecutionContextToken executionContextToken,
Handle hProject,
boolean getLastVersion)
Use this API to get list of all project line item handles
|
java.util.List<Handle> |
IRestApiClient.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> |
IRestApiClient.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> |
IRestApiClient.listRequestGrids(ExecutionContextToken executionContextToken,
Handle hRequest)
Lists the grids bound to the supplied project request, if defined.
|
java.util.List<Handle> |
IRestApiClient.listTeams(ExecutionContextToken executionContextToken,
AttributeMap attributes) |
java.util.List<Handle> |
IRestApiClient.listUsers(ExecutionContextToken executionContextToken,
AttributeMap attributes) |
java.util.List<Handle> |
IRestApiClient.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> |
IRestApiClient.listWorkflowTasksForProject(ExecutionContextToken executionContextToken,
Handle hProject) |
java.util.List<Handle> |
IRestApiClient.listWorkflowTasksForUser(ExecutionContextToken executionContextToken,
Handle hUser) |
java.lang.String |
IRestApiClient.login(java.lang.String username,
java.lang.String passWord)
This is the login API method.
|
boolean |
IRestApiClient.logout()
This is the logout API method.
|
void |
IRestApiClient.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 |
IRestApiClient.publishOffer(ExecutionContextToken executionContextToken,
Handle handle,
java.lang.String comments)
Transition state of offer represented by supplied handle to PUBLISHED state
|
void |
IRestApiClient.redraftOffer(ExecutionContextToken executionContextToken,
Handle handle,
java.lang.String comments)
Transition state of offer represented by supplied handle to DRAFT state
|
void |
IRestApiClient.retireOffer(ExecutionContextToken executionContextToken,
Handle handle,
java.lang.String comments)
Transition state of offer represented by supplied handle to RETIRED state
|
void |
IRestApiClient.setMembersByParticipationLevel(ExecutionContextToken executionContextToken,
Handle hProject,
Handle[] users,
ProjectParticipantLevelEnum participantLevel,
boolean appendOrReplace)
Update members for a specific participation level for an existing project.
|
void |
IRestApiClient.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 |
IRestApiClient.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 |
IRestApiClient.transitionApprovalStateByHandle(ExecutionContextToken executionContextToken,
Handle hApproval,
ApprovalStateEnum stateEnum,
java.lang.String comments)
Change the approval state of an existing approval to a new state.
|
void |
IRestApiClient.transitionAssetStateByCode(ExecutionContextToken executionContextToken,
java.lang.String code,
AssetStateEnum stateEnum,
java.lang.String comments) |
void |
IRestApiClient.transitionInvoiceState(ExecutionContextToken executionContextToken,
Handle handle,
InvoiceStateEnum stateEnum,
AttributeMap attributeMap)
API to update state of the Invoice
|
void |
IRestApiClient.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 |
IRestApiClient.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 |
IRestApiClient.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 |
IRestApiClient.transitionProjectStateByCode(ExecutionContextToken executionContextToken,
java.lang.String code,
ProjectStateEnum stateEnum)
Deprecated.
|
void |
IRestApiClient.transitionProjectStateByHandle(ExecutionContextToken executionContextToken,
Handle hProject,
ProjectStateEnum stateEnum,
java.lang.String comments)
Overloaded API with comments parameters.
|
void |
IRestApiClient.transitionWorkflowTaskStateByHandle(ExecutionContextToken executionContextToken,
Handle hTask,
TaskStateEnum taskStateEnum,
java.lang.String comments)
Overloaded API with comments parameters.
|
void |
IRestApiClient.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 |
IRestApiClient.triggerAcknowledgementNotification(ExecutionContextToken executionContextToken,
TriggerReturnObject triggerReturnObject)
Acknowledgment that this client will handle a given triggered event.
|
void |
IRestApiClient.triggerCompleteNotification(ExecutionContextToken executionContextToken,
TriggerReturnObject triggerReturnObject)
A notification that the processing for the given triggered event is complete.
|
void |
IRestApiClient.unlinkProgramChildren(ExecutionContextToken executionContextToken,
Handle hParent,
Handle[] hChildren)
Unlinks one or more child projects from their common parent program; all projects
must already exist.
|
void |
IRestApiClient.unlinkProgramPlan(ExecutionContextToken executionContextToken,
Handle handle)
UnLink existing Plan object from Program
|
void |
IRestApiClient.unlinkProjectChildren(ExecutionContextToken executionContextToken,
Handle hParent,
Handle[] hChildren)
Unlinks one or more child projects from their common parent project; all projects
must already exist.
|
void |
IRestApiClient.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 |
IRestApiClient.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 |
IRestApiClient.updateAttributes(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap)
Update one or more attributes of the object instance given by the specified handle.
|
void |
IRestApiClient.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 |
IRestApiClient.updateMembersByRoleType(ExecutionContextToken executionContextToken,
Handle handle,
java.lang.String roleType,
Handle[] hUser) |
void |
IRestApiClient.updateProjectLineItemAllocation(ExecutionContextToken executionContextToken,
Handle handle,
AttributeMap attributeMap)
Use this API function to update project line item allocation
|
void |
IRestApiClient.updateProjectRequestRecepient(ExecutionContextToken executionContextToken,
Handle hProjectRequest,
Handle userHandle,
AttributeMap attributeMap)
Update project request recipients.
|
void |
IRestApiClient.updateSubProjectAllocation(ExecutionContextToken executionContextToken,
Handle handle,
Handle hSubProject,
AttributeMap attributeMap)
Use this API function to update sub project allocation
|