Idea Web Service

Logical Business Objects

SCM : Product Requirements and Ideation Management : Idea

Relationships

The following table describes how this service data object is related to other service data objects or business object services.

Relationship Type	Object or Service
Handles	Idea Translation
Handles	Idea Object
Handles	Attachment Response Object
Handles	Attachment Update Request Object
Handles	Attachment Request Object

Operations

deleteIdeaByName
likeIdea
getCustomers
getComments
dislikeIdea
deleteCustomer
addCustomer
addComment
updateAttachments
getAttachments
getAttachmentContent
addAttachments
deleteAttachment
getTeam
addTeamMembers
deleteTeamMembers
getIdea
createIdea
updateIdea
deleteIdea
findIdeaFindIdeaByName

deleteIdeaByName

Use this method to delete an idea object by name.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
ideaName	string	The parameter that contains the name of an idea object to delete.

Response Payload

Element Name	Type	Description
result	void

likeIdea

Use this method to vote Yes for an idea object where the vote is associated with the user connected to the web service.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
ideaId	long	The parameter that contains the unique identifier from the application for the idea object.

Response Payload

Element Name	Type	Description
result	void

getCustomers

Use this method to return a list of customers associated with the idea object.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
ideaId	long	The parameter that contains the unique identifier from the application for the idea object.

Response Payload

Element Name	Type	Description
result	string	Returns the result of a list of customer names that are associated with the idea object.

getComments

Use this method to return a list of comments that were posted for an idea object.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
ideaId	long	The parameter that contains the unique identifier from the application for the idea object.

Response Payload

Element Name	Type	Description
result	string	Returns the result of a list of all comments posted to the idea object.

dislikeIdea

Use this method to vote No for an idea object where the vote is associated with the user connected to the web service.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
ideaId	long	The parameter that contains the unique identifier from the application for the idea object.

Response Payload

Element Name	Type	Description
result	void

deleteCustomer

Use this method to delete a customer from the idea object.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
ideaId	long	The parameter that contains the unique identifier from the application for the idea object.
customerName	string	The parameter that contains the customer name to remove from the idea object.

Response Payload

Element Name	Type	Description
result	void

addCustomer

Use this method to add a customer to the idea object.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
ideaId	long	The parameter that contains the unique identifier from the application for the idea object.
customerName	string	The parameter that contains the customer name to add to the idea object.

Response Payload

Element Name	Type	Description
result	void

addComment

Use this method to add a comment to the idea object from the user connected to the web service.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
ideaId	long	The parameter that contains the unique identifier from the application for the idea object.
comment	string	The parameter that contains the comment to post to the idea object.

Response Payload

Element Name	Type	Description
result	void

updateAttachments

Operation to update attachments title or description associated to an Idea.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
updateAttachmentRequests	Attachment Update Request Object	List of attachment request parameters for updating attachment title and/or description.

Response Payload

Element Name	Type	Description
result	Attachment Response Object	Update list of attachments metadata.

getAttachments

Use this method to return a list of attachments associated with the idea object. This method returns only the attachments metadata. To get the file content use getAttachmentContent() method.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
getRequest	Attachment Request Object	Attachments request object which contains query values for the attachments. At least IdeaId or Attachment Id must be passed as parameter.

Response Payload

Element Name	Type	Description
result	Attachment Response Object	List of attachments metadata.

getAttachmentContent

Get the file content and metadata for an file attachment.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
attachmentId	long	Unique id of an attachment associated with an Idea that should be deleted.

Response Payload

Element Name	Type	Description
result	Attachment Response Object	Attachment metadata and file content for file attachments.

addAttachments

Use this method to add attachments to an Idea.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
attachmentRows	Attachment Request Object	List of attachments which should be added to an Idea.

Response Payload

Element Name	Type	Description
result	Attachment Response Object	List of added attachments.

deleteAttachment

Operation to delete attachments associated to an Idea.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
attachmentIds	long	List of attachment id(s) which should be deleted.

Response Payload

Element Name	Type	Description
result	string	Success or failure status of the operation.

getTeam

Use this method to return a list of team members who are associated with the idea.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
ideaId	long	The parameter that contains the unique identifier from the application for the idea.

Response Payload

Element Name	Type	Description
result	string	Returns the result of a list of team members that are associated with the idea object.

addTeamMembers

Use this method to add team members to the idea.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
ideaId	long	The parameter that contains the unique identifier from the application for the idea.
userNames	string	The parameter that contains the list of user names to be added to the idea. The user name is the user login name.

Response Payload

Element Name	Type	Description
result	void

deleteTeamMembers

Use this method to delete team members from the idea.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
ideaId	long	The parameter that contains the unique identifier from the application for the idea.
userNames	string	The parameter that contains the list of user names to be deleted from the idea. The user name is the user login name.

Response Payload

Element Name	Type	Description
result	void

getIdea

Use this method to get an idea object using the unique identifier from the application for the idea object.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
ideaId	long	The parameter that contains the unique identifier from the application for the idea object.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/apps/scm/customerNeedsManagement/ideas/ideaService/}IdeaResult	Returns the result of getting the idea object.

createIdea

Use this method to create an idea object.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
idea	Idea Object	The parameter that contains an idea object.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/apps/scm/customerNeedsManagement/ideas/ideaService/}IdeaResult	Returns the result of creating an idea object.

updateIdea

Use this method to update an idea object using the unique identifier from the application for the idea object.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
idea	Idea Object	The parameter that contains an idea object.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/apps/scm/customerNeedsManagement/ideas/ideaService/}IdeaResult	Returns the result of updating the idea object.

deleteIdea

Use this method to delete an idea object using the unique identifier from the application for the idea object.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
idea	Idea Object	The parameter that contains an idea object.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}MethodResult	Returns the result of deleting an idea object.

findIdeaFindIdeaByName

Use this method to search for idea object by name.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	The parameter that contains the search criteria to filter the search results.
byName	string	The parameter that contains the idea name to search for.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	Not currently used.

Response Payload

Element Name	Type	Description
result	Idea Object	Returns the result of searching for an idea object using the idea name.

Security

The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.

Service Operations to Privileges Mapping

Operation Name	Privilege Code	Privilege Name	Privilege Description
All Operations	ACN_REVIEW_PRODUCT_IDEAS_PRIV	Review Product Ideas	Allows reviewing of product ideas
All Operations	ACN_CREATE_PRODUCT_IDEA_PRIV	Create Product Idea	Allows for the creation of an Idea
All Operations	ACN_MANAGE_PRODUCT_IDEA_PRIV	Manage Product Idea	Allows managing of an Idea - creating and updating
All Operations	ACN_ACCEPT_PRODUCT_IDEA_PRIV	Accept Product Idea	Allows accepting or rejecting of a Product Idea

Privileges to Duty Roles Mapping

Privilege Code	Granted to Duty Role Code	Granted to Duty Role Name	Granted To Duty Role Description
ACN_CREATE_PRODUCT_IDEA_PRIV	ORA_EGP_PRODUCT_MANAGER_JOB	Product Manager	Ensures that a product gets created, tested, and shipped on schedule and meets specifications. A member of either the marketing organization or the development organization.
ACN_CREATE_PRODUCT_IDEA_PRIV	ORA_ACD_PRODUCT_DESIGN_MANAGER_JOB	Product Design Manager	Individual responsible for the business side of design, encompassing the ongoing processes, business decisions, and strategies that enable innovation and create effectively designed products.
ACN_CREATE_PRODUCT_IDEA_PRIV	ORA_ACE_PRODUCT_PORTFOLIO_MANAGER_JOB	Product Portfolio Manager	Ensures good alignment of the product portfolio with the organizational strategy. Responsible for proposing investment or de-investment in products and concept projects based on the defined strategy, market data, cost and schedule.
ACN_CREATE_PRODUCT_IDEA_PRIV	ORA_ACD_PRODUCT_DESIGN_ENGINEER_JOB	Product Design Engineer	Individual responsible for creating the definition of mechanical and electronic products including their shape, physical characteristics, electronic characteristics, and manufacturing parameters such as tolerance.
ACN_REVIEW_PRODUCT_IDEAS_PRIV	ORA_EGP_PRODUCT_MANAGER_JOB	Product Manager	Ensures that a product gets created, tested, and shipped on schedule and meets specifications. A member of either the marketing organization or the development organization.
ACN_REVIEW_PRODUCT_IDEAS_PRIV	ORA_ACD_PRODUCT_DESIGN_MANAGER_JOB	Product Design Manager	Individual responsible for the business side of design, encompassing the ongoing processes, business decisions, and strategies that enable innovation and create effectively designed products.
ACN_REVIEW_PRODUCT_IDEAS_PRIV	ORA_ACE_PRODUCT_PORTFOLIO_MANAGER_JOB	Product Portfolio Manager	Ensures good alignment of the product portfolio with the organizational strategy. Responsible for proposing investment or de-investment in products and concept projects based on the defined strategy, market data, cost and schedule.
ACN_REVIEW_PRODUCT_IDEAS_PRIV	ORA_ACD_PRODUCT_DESIGN_ENGINEER_JOB	Product Design Engineer	Individual responsible for creating the definition of mechanical and electronic products including their shape, physical characteristics, electronic characteristics, and manufacturing parameters such as tolerance.
ACN_MANAGE_PRODUCT_IDEA_PRIV	ORA_EGP_PRODUCT_MANAGER_JOB	Product Manager	Ensures that a product gets created, tested, and shipped on schedule and meets specifications. A member of either the marketing organization or the development organization.
ACN_MANAGE_PRODUCT_IDEA_PRIV	ORA_ACD_PRODUCT_DESIGN_MANAGER_JOB	Product Design Manager	Individual responsible for the business side of design, encompassing the ongoing processes, business decisions, and strategies that enable innovation and create effectively designed products.
ACN_MANAGE_PRODUCT_IDEA_PRIV	ORA_ACE_PRODUCT_PORTFOLIO_MANAGER_JOB	Product Portfolio Manager	Ensures good alignment of the product portfolio with the organizational strategy. Responsible for proposing investment or de-investment in products and concept projects based on the defined strategy, market data, cost and schedule.
ACN_MANAGE_PRODUCT_IDEA_PRIV	ORA_ACD_PRODUCT_DESIGN_ENGINEER_JOB	Product Design Engineer	Individual responsible for creating the definition of mechanical and electronic products including their shape, physical characteristics, electronic characteristics, and manufacturing parameters such as tolerance.
ACN_ACCEPT_PRODUCT_IDEA_PRIV	ORA_ACD_PRODUCT_PROPOSAL_MANAGEMENT_DUTY	Product Proposal Management	This duty allows for managing of a product proposal. A person with this duty can perform all activities on a product proposal.

Duty Roles to Duty or Job Roles Mapping

Duty Role Code	Granted to Duty or Job Role Code	Granted to Duty or Job Role Name	Granted To Duty or Job Role Description
ORA_ACD_PRODUCT_DESIGN_ENGINEER_JOB	ORA_ACD_CONCEPT_DEVELOPMENT_DUTY	Concept Development	A person with this duty can perform concept development related duties such as managing of components within the concept. This duty does not allow for creating or deleting of a concept which is controlled by the Concept Management Duty
ORA_ACD_PRODUCT_PROPOSAL_MANAGEMENT_DUTY	ORA_ACD_CONCEPT_DEVELOPMENT_DUTY	Concept Development	A person with this duty can perform concept development related duties such as managing of components within the concept. This duty does not allow for creating or deleting of a concept which is controlled by the Concept Management Duty
ORA_ACD_PRODUCT_DESIGN_MANAGER_JOB	ORA_ACD_CONCEPT_DEVELOPMENT_DUTY	Concept Development	A person with this duty can perform concept development related duties such as managing of components within the concept. This duty does not allow for creating or deleting of a concept which is controlled by the Concept Management Duty
ORA_EGP_PRODUCT_MANAGER_JOB	ORA_FUN_FSCM_LOAD_INTERFACE_ADMIN_DUTY	FSCM Load Interface Administration	Manages load interface file for import
ORA_EGP_PRODUCT_MANAGER_JOB	ORA_EGP_ITEM_INQUIRY_DUTY	Item Inquiry	Queries and views items in the enterprise.
ORA_ACD_PRODUCT_DESIGN_ENGINEER_JOB	ORA_EGP_ITEM_INQUIRY_DUTY	Item Inquiry	Queries and views items in the enterprise.
ORA_ACD_PRODUCT_DESIGN_MANAGER_JOB	ORA_EGP_ITEM_INQUIRY_DUTY	Item Inquiry	Queries and views items in the enterprise.
ORA_EGP_PRODUCT_MANAGER_JOB	ORA_EGP_ITEM_MANAGEMENT_DUTY	Item Management	Creates and manages items including item attributes, item structures, packs, associations, relationships, and catalog assignments.
ORA_ACD_PRODUCT_DESIGN_ENGINEER_JOB	ORA_EGP_ITEM_MANAGEMENT_DUTY	Item Management	Creates and manages items including item attributes, item structures, packs, associations, relationships, and catalog assignments.
ORA_ACD_PRODUCT_DESIGN_MANAGER_JOB	ORA_EGP_ITEM_MANAGEMENT_DUTY	Item Management	Creates and manages items including item attributes, item structures, packs, associations, relationships, and catalog assignments.
ORA_ACE_PRODUCT_PORTFOLIO_MANAGER_JOB	ORA_ACE_PORTFOLIO_MANAGEMENT_DUTY	Portfolio Management	This duty allows for managing of a product portfolio.
ORA_EGP_PRODUCT_MANAGER_JOB	ORA_EGP_PRODUCT_COMMON_MGT_DUTY	Product Common Management	Creates and manages items including item attributes, catalogs, item structures, packs, associations, relationships, and catalog assignments common to the Product Manager and Product Data Steward.
ORA_ACD_PRODUCT_DESIGN_ENGINEER_JOB	ORA_EGP_PRODUCT_COMMON_MGT_DUTY	Product Common Management	Creates and manages items including item attributes, catalogs, item structures, packs, associations, relationships, and catalog assignments common to the Product Manager and Product Data Steward.
ORA_ACD_PRODUCT_DESIGN_MANAGER_JOB	ORA_EGP_PRODUCT_COMMON_MGT_DUTY	Product Common Management	Creates and manages items including item attributes, catalogs, item structures, packs, associations, relationships, and catalog assignments common to the Product Manager and Product Data Steward.
ORA_EGP_PRODUCT_MANAGER_JOB	ORA_ACD_PRODUCT_PROPOSAL_MANAGEMENT_DUTY	Product Proposal Management	This duty allows for managing of a product proposal. A person with this duty can perform all activities on a product proposal.
ORA_EGP_PRODUCT_MANAGER_JOB	ORA_ACN_REQUIREMENT_MANAGEMENT_DUTY	Requirement Management	This duty allows for performing all actions on a Requirement.