Jump to

• Request
• Response
• Examples

Get one idea

get

/fscmRestApi/resources/11.13.18.05/ideas/{IdeaId}

Request

Path Parameters

• IdeaId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : ideas-item-response

Type: object

Show Source

• 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 isn't allowed for all users. The default value is false.
• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• CommentsCnt: integer
  Title: Comments

  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 hasn't 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
  Title: Popularity

  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.

{
    "type":"object",
    "properties":{
        "AllowAccesstoEveryone":{
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then access is allowed for all users. If false, then access isn't allowed for all users. The default value is false.",
            "nullable":false,
            "default":"Y",
            "x-queryable":false
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/ideas-Attachments-item-response"
            }
        },
        "CommentsCnt":{
            "title":"Comments",
            "type":"integer",
            "description":"Total number of comments on the idea.",
            "nullable":true,
            "x-queryable":true
        },
        "CommentsCount":{
            "type":"integer",
            "description":"Total number of comments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Content":{
            "title":"Description",
            "type":"string",
            "description":"Detailed description of the idea along with pictures and images.",
            "format":"byte",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Posted By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the idea.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"input_text_lov",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "<>",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Posted On",
            "type":"string",
            "description":"Date and time when the user created the idea.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "=",
                    "<>",
                    "BEFORE",
                    "AFTER",
                    "ONORBEFORE",
                    "ONORAFTER",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "Customers":{
            "title":"Customers",
            "type":"string",
            "description":"List of customers who have provided the idea.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"Description of the idea.",
            "nullable":true,
            "x-queryable":false
        },
        "DisLikeCount":{
            "type":"integer",
            "description":"Total number of users who have disliked the idea.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "HasMyVote":{
            "type":"boolean",
            "description":"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 hasn't voted in favor of the idea. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LikeIt"
                ]
            }
        },
        "IdeaComment":{
            "title":"Idea Comments",
            "type":"array",
            "description":"The Idea Comments resource manages the comments for an idea.",
            "items":{
                "$ref":"#/components/schemas/ideas-IdeaComment-item-response"
            }
        },
        "IdeaId":{
            "type":"integer",
            "description":"Value that uniquely identifies an idea.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IdeaNumber":{
            "title":"Number",
            "maxLength":100,
            "type":"string",
            "description":"Number that uniquely identifies the idea.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IdeaTeam":{
            "title":"Idea Team Members",
            "type":"array",
            "description":"The Idea Team Members resource manages the users who are authorized to access the idea.",
            "items":{
                "$ref":"#/components/schemas/ideas-IdeaTeam-item-response"
            }
        },
        "IdeaVote":{
            "title":"Idea Votes",
            "type":"array",
            "description":"The Idea Votes resource manages the votes for an idea. The values are Like or Dislike.",
            "items":{
                "$ref":"#/components/schemas/ideas-IdeaVote-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the idea.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"Login session associated with the login of the user who most recently updated the idea.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the idea.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"input_text_lov",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "<>",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "LikeCount":{
            "type":"integer",
            "description":"Total number of users who have liked the idea.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LikeIt":{
            "type":"integer",
            "description":"Value that indicates the number of users who have liked the idea.",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Idea",
            "maxLength":400,
            "type":"string",
            "description":"Name of the idea.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "NoVoteCnt":{
            "type":"integer",
            "description":"Total number of users that have voted No.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "IdeaId"
                ]
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"Number that identifies the version of the record in the database.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "Popularity":{
            "title":"Popularity",
            "type":"integer",
            "description":"Value that indicates the popularity of the idea.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CommentsCnt",
                    "NoVoteCnt",
                    "YesVoteCnt"
                ]
            },
            "x-queryable":true
        },
        "ReferencesCnt":{
            "title":"References",
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "StatusDisplayValue":{
            "type":"string",
            "description":"Name of the status associated with the idea.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Tags":{
            "title":"Tags",
            "type":"string",
            "description":"Alternate names or other values provided by users for the idea.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "Type":{
            "title":"Type",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "TypeDisplayValue":{
            "type":"string",
            "description":"Name of the type of idea.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "VoteSummaryAsText":{
            "title":"Vote Summary",
            "type":"string",
            "description":"Summary text of the vote on the idea.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "YesVoteCnt":{
            "type":"integer",
            "description":"Total number of users that have voted Yes.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "IdeaId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object ideas-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/ideas-Attachments-item-response"
    }
}

Nested Schema : Idea Comments

Type: array

Title: Idea Comments

The Idea Comments resource manages the comments for an idea.

Show Source

• Array of: object ideas-IdeaComment-item-response

{
    "title":"Idea Comments",
    "type":"array",
    "description":"The Idea Comments resource manages the comments for an idea.",
    "items":{
        "$ref":"#/components/schemas/ideas-IdeaComment-item-response"
    }
}

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

• Array of: object ideas-IdeaTeam-item-response

{
    "title":"Idea Team Members",
    "type":"array",
    "description":"The Idea Team Members resource manages the users who are authorized to access the idea.",
    "items":{
        "$ref":"#/components/schemas/ideas-IdeaTeam-item-response"
    }
}

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

• Array of: object ideas-IdeaVote-item-response

{
    "title":"Idea Votes",
    "type":"array",
    "description":"The Idea Votes resource manages the votes for an idea. The values are Like or Dislike.",
    "items":{
        "$ref":"#/components/schemas/ideas-IdeaVote-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : ideas-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• 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

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the 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

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : ideas-IdeaComment-item-response

Type: object

Show Source

• 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)
  Title: Idea Comments

  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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the comment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the comment record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "type":"string",
            "description":"Display name of the user who added the comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IdeaComment":{
            "title":"Idea Comments",
            "type":"string",
            "description":"Text that describes the comment.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "IdeaCommentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IdeaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the idea.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IdeaName":{
            "type":"string",
            "description":"Name of the idea.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the comment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the comment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the version of the record in the database.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UserName":{
            "maxLength":100,
            "type":"string",
            "description":"Login that the user used when adding the comment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : ideas-IdeaTeam-item-response

Type: object

Show Source

• 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's a team member.
• UserName: string
  Name of the user, who's a team member.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the team member.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the team member.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user, who's a team member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserName":{
            "type":"string",
            "description":"Name of the user, who's a team member.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : ideas-IdeaVote-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the vote.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the vote.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IdeaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the idea.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IdeaName":{
            "type":"string",
            "description":"Name of the idea.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IdeaVoteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the vote.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the vote.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the vote.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the version of the vote in the database.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "UserName":{
            "maxLength":100,
            "type":"string",
            "description":"Login that the user used when adding the vote.",
            "nullable":false,
            "x-queryable":true
        },
        "Vote":{
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether the user liked the idea or not.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

Attachments

Operation: /fscmRestApi/resources/11.13.18.05/ideas/{IdeaId}/child/Attachments

Parameters:

• IdeaId: $request.path.IdeaId

The attachments resource is used to view, create, and update attachments.

IdeaComment

Operation: /fscmRestApi/resources/11.13.18.05/ideas/{IdeaId}/child/IdeaComment

Parameters:

• IdeaId: $request.path.IdeaId

The Idea Comments resource manages the comments for an idea.

IdeaTeam

Operation: /fscmRestApi/resources/11.13.18.05/ideas/{IdeaId}/child/IdeaTeam

Parameters:

• IdeaId: $request.path.IdeaId

The Idea Team Members resource manages the users who are authorized to access the idea.

IdeaVote

Operation: /fscmRestApi/resources/11.13.18.05/ideas/{IdeaId}/child/IdeaVote

Parameters:

• IdeaId: $request.path.IdeaId

The Idea Votes resource manages the votes for an idea. The values are Like or Dislike.

Back to Top

Examples

This example describes how to get one idea.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/ideas/IdeaId"

For example, the following command gets one idea:

curl -u username:password "https://servername/fscmRestApi/resources/version/ideas/300100240921318"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"IdeaId": 300100240921318,
	"Type": "New_Product",
	"TypeDisplayValue": "New Product",
	"Name": "Flying-Bike-Idea-202012110938",
	"CreatedBy": "PRODUCT_MANAGER",
	"ObjectVersionNumber": 1,
	"CreationDate": "2020-12-11T08:42:25+00:00",
	"LastUpdateDate": "2020-12-11T08:42:26.531+00:00",
	"LastUpdatedBy": "PRODUCT_MANAGER",
	"Status": "New_Rejected",
	"StatusDisplayValue": "New_Rejected",
	"LastUpdateLogin": "B6177046A48AB950E053D48DF50AAD04",
	"VoteSummaryAsText": "0% like it 0 out of 0",
	"AllowAccesstoEveryone": "Y",
	"Description": null,
	"Tags": "",
	"YesVoteCnt": null,
	"NoVoteCnt": null,
	"LikeIt": 0,
	"ReferencesCnt": 0,
	"Popularity": 0,
	"HasMyVote": "true",
	"CommentsCnt": null,
	"Customers": "",
	"CommentsCount": 0,
	"LikeCount": 0,
	"DisLikeCount": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/ideas/300100240921318",
		"name": "ideas",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/ideas/300100240921318",
		"name": "ideas",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/ideas/300100240921318/child/Attachments",
		"name": "Attachments",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/ideas/300100240921318/child/IdeaComment",
		"name": "IdeaComment",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/ideas/300100240921318/child/IdeaTeam",
		"name": "IdeaTeam",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/ideas/300100240921318/child/IdeaVote",
		"name": "IdeaVote",
		"kind": "collection"
	},
	{
		"rel": "enclosure",
		"href": "https://servername/fscmRestApi/resources/version/ideas/300100240921318/enclosure/Content",
		"name": "Content",
		"kind": "other"
	}
	]
}

Back to Top