Create an idea
post
/fscmRestApi/resources/11.13.18.05/ideas
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AllowAccesstoEveryone: string
Maximum Length:
1
Default Value:Y
Contains one of the following values: true or false. If true, then access is allowed for all users. If false, then access is not allowed for all users. The default value is false. -
Attachments: array
Idea Attachments
Title:
Idea Attachments
The Idea Attachments resource manages the attachments for an idea. -
CommentsCnt: integer
Total number of comments on the idea.
-
Content: string
(byte)
Title:
Description
Detailed description of the idea along with pictures and images. -
Description: string
Title:
Description
Description of the idea. -
HasMyVote: boolean
Contains one of the following values: true or false. If true, then the user has voted in favor of the idea. If false, then the user has not voted in favor of the idea. The default value is false.
-
IdeaComment: array
Idea Comments
Title:
Idea Comments
The Idea Comments resource manages the comments for an idea. -
IdeaId: integer
(int64)
Value that uniquely identifies an idea.
-
IdeaTeam: array
Idea Team Members
Title:
Idea Team Members
The Idea Team Members resource manages the users who are authorized to access the idea. -
IdeaVote: array
Idea Votes
Title:
Idea Votes
The Idea Votes resource manages the votes for an idea. The values are Like or Dislike. -
LikeIt: integer
Value that indicates the number of users who have liked the idea.
-
Name(required): string
Title:
Idea
Maximum Length:400
Name of the idea. -
NoVoteCnt: integer
Total number of users that have voted No.
-
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
Number that identifies the version of the record in the database. -
Popularity: integer
Value that indicates the popularity of the idea.
-
ReferencesCnt: integer
Title:
References
Value that indicates the count of references for an idea. The references to an idea are typically other objects that are linked to this idea. -
Status(required): string
Title:
Status
Maximum Length:30
Status of the idea. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Product Idea Statuses task. -
Type: string
Title:
Type
Maximum Length:80
Value that indicates the type of idea. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Product Idea Classes task. -
YesVoteCnt: integer
Total number of users that have voted Yes.
Nested Schema : Idea Attachments
Type:
array
Title:
Idea Attachments
The Idea Attachments resource manages the attachments for an idea.
Show Source
Nested Schema : Idea Comments
Type:
array
Title:
Idea Comments
The Idea Comments resource manages the comments for an idea.
Show Source
Nested Schema : Idea Team Members
Type:
array
Title:
Idea Team Members
The Idea Team Members resource manages the users who are authorized to access the idea.
Show Source
Nested Schema : Idea Votes
Type:
array
Title:
Idea Votes
The Idea Votes resource manages the votes for an idea. The values are Like or Dislike.
Show Source
Nested Schema : ideas-Attachments-item-post-request
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Repository folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attached file. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) of the attachment.
Nested Schema : ideas-IdeaComment-item-post-request
Type:
Show Source
object
-
IdeaComment: string
(byte)
Text that describes the comment.
-
IdeaCommentId: integer
(int64)
Value that uniquely identifies the comment.
-
IdeaId: integer
(int64)
Value that uniquely identifies the idea.
-
ObjectVersionNumber: integer
(int32)
Number that identifies the version of the record in the database.
Nested Schema : ideas-IdeaTeam-item-post-request
Type:
Show Source
object
-
UserId: integer
(int64)
Value that uniquely identifies the user, who is a team member.
-
UserName: string
Name of the user, who is a team member.
Nested Schema : schema
Type:
Show Source
object
-
IdeaId: integer
(int64)
Value that uniquely identifies the idea.
-
IdeaVoteId: integer
(int64)
Value that uniquely identifies the vote.
-
ObjectVersionNumber: integer
(int32)
Number that identifies the version of the vote in the database.
-
UserName: string
Maximum Length:
100
Login that the user used when adding the vote. -
Vote: string
Maximum Length:
1
Value that indicates whether the user liked the idea or not.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : ideas-item-response
Type:
Show Source
object
-
AllowAccesstoEveryone: string
Maximum Length:
1
Default Value:Y
Contains one of the following values: true or false. If true, then access is allowed for all users. If false, then access is not allowed for all users. The default value is false. -
Attachments: array
Idea Attachments
Title:
Idea Attachments
The Idea Attachments resource manages the attachments for an idea. -
CommentsCnt: integer
Total number of comments on the idea.
-
CommentsCount: integer
Read Only:
true
Total number of comments. -
Content: string
(byte)
Title:
Description
Detailed description of the idea along with pictures and images. -
CreatedBy: string
Title:
Posted By
Read Only:true
Maximum Length:64
User who created the idea. -
CreationDate: string
(date-time)
Title:
Posted On
Read Only:true
Date and time when the user created the idea. -
Customers: string
Title:
Customers
Read Only:true
List of customers who have provided the idea. -
Description: string
Title:
Description
Description of the idea. -
DisLikeCount: integer
(int64)
Read Only:
true
Total number of users who have disliked the idea. -
HasMyVote: boolean
Contains one of the following values: true or false. If true, then the user has voted in favor of the idea. If false, then the user has not voted in favor of the idea. The default value is false.
-
IdeaComment: array
Idea Comments
Title:
Idea Comments
The Idea Comments resource manages the comments for an idea. -
IdeaId: integer
(int64)
Value that uniquely identifies an idea.
-
IdeaNumber: string
Title:
Number
Read Only:true
Maximum Length:100
Number that uniquely identifies the idea. -
IdeaTeam: array
Idea Team Members
Title:
Idea Team Members
The Idea Team Members resource manages the users who are authorized to access the idea. -
IdeaVote: array
Idea Votes
Title:
Idea Votes
The Idea Votes resource manages the votes for an idea. The values are Like or Dislike. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the user most recently updated the idea. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the idea. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Login session associated with the login of the user who most recently updated the idea. -
LikeCount: integer
Read Only:
true
Total number of users who have liked the idea. -
LikeIt: integer
Value that indicates the number of users who have liked the idea.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Idea
Maximum Length:400
Name of the idea. -
NoVoteCnt: integer
Total number of users that have voted No.
-
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
Number that identifies the version of the record in the database. -
Popularity: integer
Value that indicates the popularity of the idea.
-
ReferencesCnt: integer
Title:
References
Value that indicates the count of references for an idea. The references to an idea are typically other objects that are linked to this idea. -
Status: string
Title:
Status
Maximum Length:30
Status of the idea. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Product Idea Statuses task. -
StatusDisplayValue: string
Read Only:
true
Name of the status associated with the idea. -
Tags: string
Title:
Tags
Read Only:true
Alternate names or other values provided by users for the idea. -
Type: string
Title:
Type
Maximum Length:80
Value that indicates the type of idea. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Product Idea Classes task. -
TypeDisplayValue: string
Read Only:
true
Name of the type of idea. -
VoteSummaryAsText: string
Title:
Vote Summary
Read Only:true
Summary text of the vote on the idea. -
YesVoteCnt: integer
Total number of users that have voted Yes.
Nested Schema : Idea Attachments
Type:
array
Title:
Idea Attachments
The Idea Attachments resource manages the attachments for an idea.
Show Source
Nested Schema : Idea Comments
Type:
array
Title:
Idea Comments
The Idea Comments resource manages the comments for an idea.
Show Source
Nested Schema : Idea Team Members
Type:
array
Title:
Idea Team Members
The Idea Team Members resource manages the users who are authorized to access the idea.
Show Source
Nested Schema : Idea Votes
Type:
array
Title:
Idea Votes
The Idea Votes resource manages the votes for an idea. The values are Like or Dislike.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : ideas-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment for the specification. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Repository folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attached file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the attached document. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the attached document. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the attachment for the specification. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : ideas-IdeaComment-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the comment. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the comment record. -
DisplayName: string
Read Only:
true
Display name of the user who added the comment. -
IdeaComment: string
(byte)
Text that describes the comment.
-
IdeaCommentId: integer
(int64)
Value that uniquely identifies the comment.
-
IdeaId: integer
(int64)
Value that uniquely identifies the idea.
-
IdeaName: string
Read Only:
true
Name of the idea. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the comment. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the comment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Number that identifies the version of the record in the database.
-
PersonId: integer
Read Only:
true
Value that uniquely identifies the user. -
UserName: string
Read Only:
true
Maximum Length:100
Login that the user used when adding the comment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : ideas-IdeaTeam-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the team member. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the team member. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the team member. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the team member. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UserId: integer
(int64)
Value that uniquely identifies the user, who is a team member.
-
UserName: string
Name of the user, who is a team member.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : ideas-IdeaVote-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the vote. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the vote. -
IdeaId: integer
(int64)
Value that uniquely identifies the idea.
-
IdeaName: string
Read Only:
true
Name of the idea. -
IdeaVoteId: integer
(int64)
Value that uniquely identifies the vote.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the vote. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the vote. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Number that identifies the version of the vote in the database.
-
UserName: string
Maximum Length:
100
Login that the user used when adding the vote. -
Vote: string
Maximum Length:
1
Value that indicates whether the user liked the idea or not.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Parameters:
- IdeaId:
$request.path.IdeaId
The Idea Attachments resource manages the attachments for an idea. - IdeaId:
- IdeaComment
-
Parameters:
- IdeaId:
$request.path.IdeaId
The Idea Comments resource manages the comments for an idea. - IdeaId:
- IdeaTeam
-
Parameters:
- IdeaId:
$request.path.IdeaId
The Idea Team Members resource manages the users who are authorized to access the idea. - IdeaId:
- IdeaVote
-
Parameters:
- IdeaId:
$request.path.IdeaId
The Idea Votes resource manages the votes for an idea. The values are Like or Dislike. - IdeaId:
Examples
This example describes how to create ideas.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/ideas"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "Type" : "IDEA", "Name" : "POST_AN_IDEA" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "items" : [ { "IdeaId" : 300100155304259, "Type" : "IDEA", "TypeDisplayValue" : "Idea", "Name" : "POST_AN_IDEA", "CreatedBy" : "PRODUCT_MANAGER", "ObjectVersionNumber" : 1, "CreationDate" : "2018-08-06T12:51:03+00:00", "LastUpdateDate" : "2018-08-06T12:51:39.010+00:00", "LastUpdatedBy" : "PRODUCT_MANAGER", } ] }