Get one proposal
get
/fscmRestApi/resources/11.13.18.05/productProposals/{ProductProposalId}
Request
Path Parameters
-
ProductProposalId(required): integer(int64)
Value that uniquely identifies the product proposal.
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:
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : productProposals-item-response
Type:
Show Source
object-
ActualCost: number
Sum of actual costs of the proposal.
-
ActualDevelopmentCost: number
Sum of actual costs for development.
-
ActualDevFixedCost: number
Sum of actual fixed costs for development.
-
ActualDevLaborCost: number
Sum of actual labor costs for development.
-
ActualDevMaterialCost: number
Sum of actual costs for the development material.
-
ActualDevVariableCost: number
Sum of variable costs for the actual development.
-
ActualLaunch: string
(date)
Title:
Actual LaunchDate when the product is actually launched. -
ActualMargin: number
Actual margin of the proposal.
-
ActualProdFixedCost: number
Sum of actual fixed costs for the product.
-
ActualProdLaborCost: number
Sum of actual labor costs for production.
-
ActualProdMaterialCost: number
Sum of actual costs for the production material.
-
ActualProductionCost: number
Sum of actual costs for production.
-
ActualProdVariableCost: number
Sum of variable costs for the actual production.
-
ActualResources: number
Sum of actual resources.
-
ActualRevenue: number
Sum of actual revenues.
-
Alignment: string
Maximum Length:
30Alignment score of the proposal. -
AllocatedBudget: number
Title:
Allocated BudgetBudget allocated for the proposal. -
AllowAccesstoEveryone: string
Value that indicates whether to allow access to everyone with the right privileges.
-
Attachments: array
Attachments
Title:
AttachmentsThe Attachments resource manages the files and uniform resource locators (URLs) associated with the proposal. -
AverageSellingPrice: number
Title:
Average Selling PriceAverage selling price of the proposal. -
BaselineDate: string
(date)
Title:
Baseline DateDate when the proposal metrics were calculated. -
BreakEvenTime: number
Title:
Break Even TimeTime when break even should be reached. -
BusinessObjectives: string
Title:
Business ObjectivesMaximum Length:400Value that indicates the business objectives of the proposal. -
BusinessUnit: string
Title:
Business UnitMaximum Length:30Business unit of proposal. -
BusinessUnitStrength: number
Strength of business unit of the proposal.
-
CompetitiveAdvantage: string
Maximum Length:
30Value that indicates the competitive advantage of the proposal. -
ConceptCurrencyCode: string
Maximum Length:
15Abbreviation that identifies the currency of the proposal. -
ConceptMasterId: integer
(int64)
Title:
Master IDValue that uniquely identifies the associated concept master. -
ConceptMasterName: string
Read Only:
trueMaximum Length:400Alternate value that uniquely identifies the associated concept master. -
ConceptMasterVersion: string
Read Only:
trueMaximum Length:10Alternate value that uniquely identifies the associated concept master. -
ConceptType: string
Maximum Length:
80Type of the associated concept. -
Cost: array
Costs
Title:
CostsThe Costs resource manages various types of costs of the product proposal. -
CostValueIndex: number
Cost value index of the proposal.
-
CPI: number
Consumer price index metric of the proposal.
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the proposal. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the proposal. -
CurrencyConversionRate: number
Title:
Conversion Rate to US DollarRate of conversion applied to convert the currency to US dollars. -
Description: string
Title:
DescriptionMaximum Length:1000Description of the product proposal. -
DevelopmentEnd: string
(date)
Title:
Development EndDate when the development of the proposal ends. -
DevelopmentStart: string
(date)
Title:
Development StartDate when the development begins. -
DiscountRate: number
Title:
Annual Discount RateDefault Value:0Rate of discount of the proposal. -
EOL: string
(date)
Title:
End of LifeEstimated end of life of the proposal. -
ExpectedCommercialValue: number
Expected commercial value.
-
FundingAmount: number
Title:
Funding AmountFunding amount for the proposal. -
FundingRequestFor: string
Title:
Funding Request ForMaximum Length:30Phase of the proposal for which the funding is requested. -
HighLevelDesign: string
(date)
Title:
High-Level DesignHigh level design milestone of the proposal. -
Impact: string
Maximum Length:
30Impact of the proposal. -
InstanceId: integer
Value that uniquely identifies the instance.
-
InternalRateOfReturn: number
Title:
Internal Rate of ReturnRate of discount that makes the net present value of all cash flows for a product equal to zero. -
IsCloned: string
Title:
Is ClonedRead Only:trueMaximum Length:1Default Value:NValue that indicates if the proposal was cloned. -
IsLatest: string
Title:
LatestRead Only:trueMaximum Length:1Value that indicates if this version is the latest version. -
LastConceptVersion: string
Title:
Last Concept VersionRead Only:trueMaximum Length:10Version of the concept which was most recently associated with the proposal. -
LastProjCostRefreshTime: string
(date-time)
Time taken to refresh the most recent project cost. This attribute is used only when being connected to Agile PLM.
-
LastProjResourceRefreshTime: string
(date-time)
Time taken to refresh the most recent project resource. This attribute is used only when being connected to Agile PLM.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate when the user most recently updated the proposal. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who most recently updated the proposal. -
LatestConceptId: integer
(int64)
Read Only:
trueValue that uniquely identifies the concept which was most recently associated with this proposal. -
LatestConceptName: string
Read Only:
trueMaximum Length:400Alternate value that uniquely identifies the name of the concept that was most recently associated with this proposal. -
LatestConceptVersion: string
Read Only:
trueMaximum Length:10Alternate value that uniquely identifies the version of the concept that was most recently associated with this proposal. -
Launch: string
(date)
Title:
Planned LaunchDate when the proposal is planned to be launched. -
LifecyclePhase: string
Read Only:
trueMaximum Length:80Value that indicates the lifecycle phase of the proposal. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MarketAttractiveness: number
Value that indicates the market attractiveness of the proposal.
-
MarketGrowthPercent: number
Percent of market growth.
- MarketSharePercent: number
-
MarketStrategy: string
Title:
Market StrategyMaximum Length:30Market strategy intended with this proposal. -
Name: string
Title:
NameMaximum Length:150Name of the product proposal. -
NetPresentValue: number
Title:
Net Present ValueDifference between present value of cash inflows and the present value of cash outflows. Future cash flows are discounted by the discount rate in order to convert them to present cash flows. -
NextStatuses: array
Next Statuses
Title:
Next StatusesThe Next Statuses resource gets the next possible workflow statuses of the product proposal. -
PaybackPeriod: number
Period of time required to repay the sum of the original investment on the product.
-
PrimaryJustification: string
Title:
Primary JustificationMaximum Length:30Primary justification for the proposal. -
ProbOfCommercialSuccess: number
Value that indicates the probability of the product to be sold commercially.
-
ProbOfTechnicalSuccess: number
Value that indicates the probability of technical success.
-
ProductCategorization: string
Maximum Length:
30Category under which the product is classified. -
ProductLine: string
Title:
Product LineMaximum Length:30Product line of the proposal. -
ProductProposalId: integer
(int64)
Read Only:
trueValue that uniquely identifies the product proposal. -
ProductStrategicFit: string
Maximum Length:
30Product strategic fit of the proposal. -
ProjDevCost: number
Sum of projected costs for development.
-
ProjDevFixedCost: number
Sum of projected fixed costs for development.
-
ProjDevLaborCost: number
Sum of projected labor costs for development.
-
ProjDevMaterialCost: number
Sum of projected costs for the development material.
-
ProjDevVariableCost: number
Sum of projected variable costs for development.
-
ProjectedMargin: number
Projected margin of the proposal.
-
ProjectedResources: number
Projected resources for the proposal.
-
ProjProdCost: number
Sum of projected costs for production.
-
ProjProdFixedCost: number
Sum of projected fixed costs for production.
-
ProjProdLaborCost: number
Sum of projected labor costs for production.
-
ProjProdMaterialCost: number
Sum of projected costs for the product materials.
-
ProjProdVariableCost: number
Sum of projected variable costs for production.
-
ProposalNumber: string
Title:
NumberRead Only:trueMaximum Length:100Number that uniquely identifies the product proposal. -
ProposalPortfolioRelationships: array
Proposal Portfolio Relationships
Title:
Proposal Portfolio RelationshipsThe Proposal Portfolio Relationships resource manages the portfolios of the product proposal. -
ProposalProjectedCost: number
Title:
Projected CostProjected cost of the proposal. -
ProposalProjectedRevenue: number
Title:
Projected RevenueSum of projected revenues of the proposal. -
ProposalStatus: string
Title:
Proposal StatusRead Only:trueMaximum Length:30Default Value:DRAFTStatus of the proposal. -
ProposalStatusName: string
Read Only:
trueMaximum Length:255Value that identifies the status of the proposal. -
ProposalType: string
Title:
Proposal TypeMaximum Length:30Type of the proposal. -
ProposalVersionNotes: string
Read Only:
trueMaximum Length:400Notes on the proposal version. -
ProposalVersions: array
Versions
Title:
VersionsThe Versions resource manages the versions of the product proposal. -
PublishedFromPortfolio: string
Read Only:
trueMaximum Length:30Default Value:NValue that indicates if the proposal was published from a portfolio. -
Relationships: array
Relationships
Title:
RelationshipsThe Relationships resource manages the objects related to a proposal. The objects reference a concept, an item, or other objects. -
ReportId: string
Read Only:
trueValue that uniquely identifies the associated report. -
ReportTemplate: string
Read Only:
trueValue that uniquely identifies the template of the associated report. -
RequirementsDefinition: string
(date)
Title:
Requirements DefinitionMilestone for the requirements definition. -
Resource: array
Resources
Title:
ResourcesThe Resources resource manages the resources of the product proposal. -
ResourceValueIndex: number
Value that indicates the net present value divided by projected resources for product.
-
ReturnOnInvestment: number
Title:
Return on InvestmentValue that indicates the ratio of the benefit gain minus cost of the product divided by the cost to develop the product. -
Revenue: array
Revenues
Title:
RevenuesThe Revenues resource manages various types of revenue of the product proposal. -
RiskNumeric: string
Maximum Length:
30Risk of the proposal. -
RiskSubjective: string
Maximum Length:
30Overall risk for product on subjective basis. Valid values are High, Medium, and Low. -
RndKnowHow: string
Maximum Length:
30Know-how for research and development. -
Rpi: number
Retail price index of the proposal.
-
SecondaryJustification: string
Title:
Secondary JustificationMaximum Length:30Secondary justification for the product proposal. -
SrcProductProposalId: integer
(int64)
Title:
Source Product Proposal IDRead Only:trueValue that uniquely identifies the source proposal. -
SrcProductProposalName: string
Read Only:
trueAlternate value that uniquely identifies the name of the source proposal. -
SrcProductProposalVersion: integer
Read Only:
trueAlternate value that uniquely identifies the version of the source proposal. -
Summary: string
Title:
Business Case OverviewMaximum Length:2147483647Summary of the proposal. -
SupplyChainFit: string
Maximum Length:
30Supply chain fit of the proposal. -
TargetCost: number
Title:
Target CostSum of target costs. -
Team: array
Team Members
Title:
Team MembersThe Team Members resource manages the team members of the product proposal. -
Version: integer
(int32)
Title:
VersionRead Only:trueDefault Value:1Version of the proposal. -
WorkflowObjectType: string
Read Only:
trueType of workflow object for the proposal. -
YearFiveRevenue: number
Sum of revenues for first five years after the product launch.
-
YearThreeRevenue: number
Sum of revenues for the first three years after product launch.
-
YearTwoRevenue: number
Sum of revenues for first two years after the product launch.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe Attachments resource manages the files and uniform resource locators (URLs) associated with the proposal.
Show Source
Nested Schema : Costs
Type:
arrayTitle:
CostsThe Costs resource manages various types of costs of the product proposal.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Next Statuses
Type:
arrayTitle:
Next StatusesThe Next Statuses resource gets the next possible workflow statuses of the product proposal.
Show Source
Nested Schema : Proposal Portfolio Relationships
Type:
arrayTitle:
Proposal Portfolio RelationshipsThe Proposal Portfolio Relationships resource manages the portfolios of the product proposal.
Show Source
Nested Schema : Versions
Type:
arrayTitle:
VersionsThe Versions resource manages the versions of the product proposal.
Show Source
Nested Schema : Relationships
Type:
arrayTitle:
RelationshipsThe Relationships resource manages the objects related to a proposal. The objects reference a concept, an item, or other objects.
Show Source
Nested Schema : Resources
Type:
arrayTitle:
ResourcesThe Resources resource manages the resources of the product proposal.
Show Source
Nested Schema : Revenues
Type:
arrayTitle:
RevenuesThe Revenues resource manages various types of revenue of the product proposal.
Show Source
Nested Schema : Team Members
Type:
arrayTitle:
Team MembersThe Team Members resource manages the team members of the product proposal.
Show Source
Nested Schema : productProposals-Attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attached document. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueLogin that the user used when creating the document. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the attached document. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path where the attachment resides. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the document version from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents of the attached document expire. -
FileContents: string
(byte)
Title:
File ContentsContents of the attached document. -
FileName: string
Title:
File NameMaximum Length:2048Name of the file that is attached. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) that locates the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when the user most recently updated the attached document. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the attached document. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the document. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeSize of the attached file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached file. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
UrlMaximum Length:4000URL (Uniform Resource Locator) of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : productProposals-Cost-item-response
Type:
Show Source
object-
CostAmount: number
Title:
AmountAmount of cost associated with the proposal. -
CostCategory: string
Title:
CategoryMaximum Length:30Default Value:DEVELOPMENTCategory of cost associated with the proposal. -
CostId: integer
(int64)
Value that uniquely identifies the proposal cost.
-
CostStatus: string
Title:
StatusMaximum Length:30Default Value:PROJECTEDStatus of cost associated with the proposal. -
CostTrend: string
Title:
TrendMaximum Length:30Default Value:POINTTrend of cost associated with the proposal. -
CostType: string
Title:
TypeMaximum Length:30Default Value:VARIABLEType of cost associated with the proposal. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
StartDate: string
(date)
Title:
DateDate when the cost will incur.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : productProposals-NextStatuses-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SequenceNumber: integer
Number that identifies the sequence of the status.
-
StatusCode: string
Maximum Length:
255Abbreviation that identifies the status. -
StatusDescription: string
Description of the status.
-
StatusName: string
Name of the status.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : productProposals-ProposalPortfolioRelationships-item-response
Type:
Show Source
object-
EndDate: string
(date)
Title:
End DateRead Only:trueEnd date for the portfolio -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PortfolioCode: string
Title:
CodeMaximum Length:30Abbreviation that identifies the portfolio -
PortfolioDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the portfolio -
PortfolioEnabled: string
Title:
Enabled FlagRead Only:trueMaximum Length:1Value that indicates the portfolio is enabled or disabled -
PortfolioId: integer
(int64)
Value that uniquely identifies a portfolio
-
PortfolioName: string
Maximum Length:
255Name of the portfolio -
StartDate: string
(date)
Title:
Start DateRead Only:trueStart date of the portfolio
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : productProposals-ProposalVersions-item-response
Type:
Show Source
object-
ConceptMasterId: integer
(int64)
Title:
Master IDRead Only:trueValue that uniquely identifies the associated concept master. -
ConceptMasterName: string
Read Only:
trueMaximum Length:400Alternate value that uniquely identifies the name of the associated concept master. -
ConceptMasterVersion: string
Read Only:
trueMaximum Length:10Alternate value that uniquely identifies the version of the associated concept master. -
IsLatest: string
Title:
LatestRead Only:trueMaximum Length:1Contains one of the following values: true or false. If true, then this version is the latest version. If false, then this version is not the latest version. Upon creation of a new proposal, the first version gets defaulted to true. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Title:
ProposalRead Only:trueMaximum Length:150Alternate value that uniquely identifies the name of the proposal. -
ProductProposalId: integer
(int64)
Read Only:
trueValue that uniquely identifies the proposal. -
ProposalVersionNotes: string
Read Only:
trueMaximum Length:400Notes that are entered when creating a proposal version. -
Version: integer
(int32)
Title:
VersionRead Only:trueDefault Value:1Alternate value that uniquely identifies the proposal.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : productProposals-Relationships-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the relationship. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the relationship. -
Description: string
Description of the related object.
-
DestObjId: integer
(int64)
Value that uniquely identifies the destination object.
-
DestObjType: string
Maximum Length:
30Type of the destination object. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the relationship. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the relationship. -
LatestFlag: boolean
Contains one of the following values: true or false. If true, then the related object is the latest. If false, then the related object is not the latest. This attribute does not have a default value.
-
LatestFlagName: string
Read Only:
trueName of the latest flag. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Name of the related object.
-
ObjectSubType: string
Object subtype of the related object.
-
ObjectTypeValue: string
Display value of the object type.
-
OrganizationCode: string
Organization code of the related object.
-
RelatedObjectPk1Value: integer
(int64)
Read Only:
trueFirst primary key identifier of the related object in the relationship. -
RelatedObjectPk2Value: integer
(int64)
Read Only:
trueSecond primary key identifier of the related object in the relationship. -
RelationshipId: integer
(int64)
Read Only:
trueValue that uniquely identifies the relationship. -
RelationshipType: string
Title:
Relationship TypeMaximum Length:30Type of relationship. -
RelationshipTypeValue: string
Maximum Length:
255Display value of the relationship type. -
Revision: string
Maximum Length:
255Value that indicates the version or revision of the referenced object. -
SrcObjId: integer
(int64)
Value that uniquely identifies the source object.
-
SrcObjType: string
Maximum Length:
30Type of the source object. -
Status: string
Status of the related object.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : productProposals-Resource-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the proposal resource. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the resource. -
EndDate: string
(date)
Title:
End DateDate when the resource is no longer required. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the resource. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the proposal resource. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ResourceCategory: string
Title:
CategoryMaximum Length:30Category of the resource associated with the proposal. -
ResourceHeadcount: number
Title:
HeadcountResource headcount required for the proposal. -
ResourceId: integer
(int64)
Value that uniquely identifies the proposal resource.
-
ResourcePool: string
Title:
PoolMaximum Length:30Pool where the resource would be required from. -
ResourceStatus: string
Title:
StatusMaximum Length:30Default Value:PROJECTEDStatus of resource associated with the proposal. -
ResourceTrend: string
Title:
TrendMaximum Length:30Default Value:NATrend of resource associated with the proposal. -
Source: string
Title:
SourceMaximum Length:30Default Value:PROPOSALSource from where the resource is coming. -
StartDate: string
(date)
Title:
Start DateStarting date when the resource is required.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : productProposals-Revenue-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RevenueAmount: number
Title:
AmountRevenue amount associated with the proposal. -
RevenueCategory: string
Title:
CategoryMaximum Length:30Category of revenue line associated with the proposal. -
RevenueId: integer
(int64)
Value that uniquely identifies the proposal revenue.
-
RevenueStatus: string
Title:
StatusMaximum Length:30Default Value:PROJECTEDStatus of revenue line associated with the proposal. -
RevenueTrend: string
Title:
TrendMaximum Length:30Default Value:POINTTrend of revenue line associated with the proposal. -
RevenueType: string
Title:
TypeMaximum Length:30Type of revenue line associated with the proposal. -
StartDate: string
(date)
Title:
DateStarting date when the revenue is generated or planned.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : productProposals-Team-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the proposal team member. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the proposal team member. -
DisplayName: string
Title:
NameRead Only:trueMaximum Length:240Display name of the user who is part of the team. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the proposal team. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the proposal team. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TeamId: integer
(int64)
Value that uniquely identifies the team member.
-
UserId: integer
(int64)
Value that uniquely identifies the user who is part of the team.
-
UserName: string
Name of the user who is part of the team.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Operation: /fscmRestApi/resources/11.13.18.05/productProposals/{ProductProposalId}/child/AttachmentsParameters:
- ProductProposalId:
$request.path.ProductProposalId
The Attachments resource manages the files and uniform resource locators (URLs) associated with the proposal. - ProductProposalId:
- Cost
-
Parameters:
- ProductProposalId:
$request.path.ProductProposalId
The Costs resource manages various types of costs of the product proposal. - ProductProposalId:
- NextStatuses
-
Operation: /fscmRestApi/resources/11.13.18.05/productProposals/{ProductProposalId}/child/NextStatusesParameters:
- ProductProposalId:
$request.path.ProductProposalId
The Next Statuses resource gets the next possible workflow statuses of the product proposal. - ProductProposalId:
- ProposalPortfolioRelationships
-
Parameters:
- ProductProposalId:
$request.path.ProductProposalId
The Proposal Portfolio Relationships resource manages the portfolios of the product proposal. - ProductProposalId:
- ProposalVersions
-
Operation: /fscmRestApi/resources/11.13.18.05/productProposals/{ProductProposalId}/child/ProposalVersionsParameters:
- ProductProposalId:
$request.path.ProductProposalId
The Versions resource manages the versions of the product proposal. - ProductProposalId:
- Relationships
-
Operation: /fscmRestApi/resources/11.13.18.05/productProposals/{ProductProposalId}/child/RelationshipsParameters:
- ProductProposalId:
$request.path.ProductProposalId
The Relationships resource manages the objects related to a proposal. The objects reference a concept, an item, or other objects. - ProductProposalId:
- Resource
-
Parameters:
- ProductProposalId:
$request.path.ProductProposalId
The Resources resource manages the resources of the product proposal. - ProductProposalId:
- Revenue
-
Parameters:
- ProductProposalId:
$request.path.ProductProposalId
The Revenues resource manages various types of revenue of the product proposal. - ProductProposalId:
- Team
-
Parameters:
- ProductProposalId:
$request.path.ProductProposalId
The Team Members resource manages the team members of the product proposal. - ProductProposalId:
Examples
This example describes how to get one proposal.
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/productProposals/ProductProposalId"
For example, the following command gets one proposal:
curl -u username:password "https://servername/fscmRestApi/resources/version/productProposals/300100249901398"
Example Response Body
The following shows an example of the response body in JSON format.
{
"ProductProposalId": 300100249901398,
"Name": "XYZ",
"Description": "Test Data",
"AllowAccesstoEveryone": "Y",
"ConceptCurrencyCode": "USD",
"ConceptMasterId": 300100249901400,
"ConceptMasterName": "XYZ",
"ConceptMasterVersion": "1",
"CreatedBy": "PRODUCT_MANAGER",
"CreationDate": "2020-08-31T08:09:18+00:00",
"CurrencyConversionRate": null,
"InstanceId": null,
"IsCloned": "N",
"IsLatest": "Y",
"LastConceptVersion": null,
"LastProjCostRefreshTime": null,
"LastProjResourceRefreshTime": null,
"LastUpdateDate": "2020-08-31T08:09:30.016+00:00",
"LastUpdatedBy": "PRODUCT_MANAGER",
"LatestConceptId": 300100249901400,
"LatestConceptName": "XYZ",
"LatestConceptVersion": "1",
"LifecyclePhase": "DRAFT",
"ProposalStatus": "DRAFT",
"ProposalType": "NEW_PRODUCT",
"PublishedFromPortfolio": "N",
"ReportId": "/Supply Chain Management/Innovation Management/Concepts/DefaultProposalReport.xdo",
"ReportTemplate": "",
"SrcProductProposalId": null,
"SrcProductProposalName": null,
"SrcProductProposalVersion": null,
"Version": 1,
"WorkflowObjectType": null,
"ProjectedResources": null,
"ActualDevFixedCost": null,
"MarketSharePercent": null,
"HighLevelDesign": null,
"ActualCost": null,
"CompetitiveAdvantage": null,
"ProjProdMaterialCost": null,
"ActualProdFixedCost": null,
"ReturnOnInvestment": null,
"ProjectedMargin": null,
"Summary": null,
"Impact": null,
"PaybackPeriod": null,
"RiskSubjective": null,
"DevelopmentStart": null,
"TargetCost": null,
"RndKnowHow": null,
"AllocatedBudget": null,
"ProjDevFixedCost": null,
"BusinessObjectives": null,
"ActualProductionCost": null,
"ProposalVersionNotes": "Initial Version",
"ActualDevLaborCost": null,
"ActualProdLaborCost": null,
"ProjDevLaborCost": null,
"ProductCategorization": null,
"InternalRateOfReturn": null,
"ProposalProjectedCost": null,
"MarketAttractiveness": null,
"ProductStrategicFit": null,
"DiscountRate": 0,
"DevelopmentEnd": null,
"YearTwoRevenue": null,
"ProbOfCommercialSuccess": null,
"BusinessUnitStrength": null,
"ProjDevCost": null,
"RiskNumeric": null,
"ActualDevelopmentCost": null,
"YearFiveRevenue": null,
"CostValueIndex": null,
"BaselineDate": "2020-08-31",
"ActualDevVariableCost": null,
"ExpectedCommercialValue": null,
"ProposalProjectedRevenue": null,
"ActualProdMaterialCost": null,
"ActualRevenue": null,
"Alignment": null,
"ActualResources": null,
"Launch": null,
"EOL": null,
"AverageSellingPrice": null,
"ProjProdFixedCost": null,
"ProjProdCost": null,
"ProbOfTechnicalSuccess": null,
"CPI": null,
"ProjProdLaborCost": null,
"MarketStrategy": null,
"ProjProdVariableCost": null,
"SupplyChainFit": null,
"ActualMargin": null,
"PrimaryJustification": null,
"FundingAmount": null,
"ActualDevMaterialCost": null,
"ProjDevMaterialCost": null,
"ActualLaunch": null,
"FundingRequestFor": null,
"ActualProdVariableCost": null,
"NetPresentValue": null,
"ProductLine": null,
"RequirementsDefinition": null,
"ProjDevVariableCost": null,
"BusinessUnit": null,
"ResourceValueIndex": null,
"MarketGrowthPercent": null,
"BreakEvenTime": null,
"YearThreeRevenue": null,
"SecondaryJustification": null,
"Rpi": null,
"ConceptType": "CONCEPT",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/productProposals/300100249901398",
"name": "productProposals",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000003770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E0002000000017371007E00020000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/productProposals/300100249901398",
"name": "productProposals",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/productProposals/300100249901398/child/Attachments",
"name": "Attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/productProposals/300100249901398/child/Cost",
"name": "Cost",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/productProposals/300100249901398/child/ProposalVersions",
"name": "ProposalVersions",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/productProposals/300100249901398/child/Resource",
"name": "Resource",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/productProposals/300100249901398/child/Revenue",
"name": "Revenue",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/productProposals/300100249901398/child/Team",
"name": "Team",
"kind": "collection"
}
]
}