GET action is not supported
get
/fscmRestApi/resources/11.13.18.05/productConcepts/{ConceptId}/child/Proposal/{ProposalUniqID}
Request
Path Parameters
-
ConceptId(required): integer(int64)
Value that uniquely identifies the concept.
-
ProposalUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Product Proposals resource and used to uniquely identify an instance of Product Proposals. The client should not generate the hash key value. Instead, the client should query on the Product Proposals collection resource in order to navigate to a specific instance of Product Proposals to get the hash key.
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 : productConcepts-Proposal-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 Launch
Date 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:
30
Alignment score of the proposal. -
AllocatedBudget: number
Title:
Allocated Budget
Budget allocated for the proposal. -
AllowAccesstoEveryone: string
Value that indicates whether to allow access to everyone with the right privileges.
-
AverageSellingPrice: number
Title:
Average Selling Price
Average selling price of the proposal. -
BaselineDate: string
(date)
Title:
Baseline Date
Date when the proposal metrics were calculated. -
BreakEvenTime: number
Title:
Break Even Time
Time when break even should be reached. -
BusinessObjectives: string
Title:
Business Objectives
Maximum Length:400
Value that indicates the business objectives of the proposal. -
BusinessUnit: string
Title:
Business Unit
Maximum Length:30
Business unit of the proposal. -
BusinessUnitStrength: number
Strength of business unit of the proposal.
-
CompetitiveAdvantage: string
Maximum Length:
30
Value that indicates the competitive advantage of the proposal. -
ConceptCurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the currency of the proposal. -
ConceptMasterId: integer
(int64)
Title:
Master ID
Value that uniquely identifies the associated concept master. -
ConceptMasterName: string
Read Only:
true
Maximum Length:400
Alternate value that uniquely identifies the name of the associated concept master. -
ConceptMasterVersion: string
Read Only:
true
Maximum Length:10
Alternate value that uniquely identifies the version of the associated concept master. -
ConceptType: string
Maximum Length:
80
Type of the associated concept. -
CostValueIndex: number
Cost value index of the proposal.
-
CPI: number
Consumer price index metric of the proposal.
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the proposal. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the proposal. -
CurrencyConversionRate: number
Title:
Conversion Rate to US Dollar
Rate of conversion applied to convert the currency to US dollars. -
Description: string
Title:
Description
Maximum Length:1000
Description of the product proposal. -
DevelopmentEnd: string
(date)
Title:
Development End
Date when the development of the proposal ends. -
DevelopmentStart: string
(date)
Title:
Development Start
Date when the development begins. -
DiscountRate: number
Title:
Annual Discount Rate
Default Value:0
Rate of discount of the proposal. -
EOL: string
(date)
Title:
End of Life
Estimated end of life of the proposal. -
ExpectedCommercialValue: number
Expected commercial value.
-
FundingAmount: number
Title:
Funding Amount
Funding amount for the proposal. -
FundingRequestFor: string
Title:
Funding Request For
Maximum Length:30
Phase of the proposal for which the funding is requested. -
HighLevelDesign: string
(date)
Title:
High-Level Design
High level design milestone of the proposal. -
Impact: string
Maximum Length:
30
Impact of the proposal. -
InstanceId: integer
Value that uniquely identifies the instance.
-
InternalRateOfReturn: number
Title:
Internal Rate of Return
Rate of discount that makes the net present value of all cash flows for a product equal to zero. -
IsCloned: string
Title:
Is Cloned
Read Only:true
Maximum Length:1
Default Value:N
Value that indicates if the proposal was cloned. -
IsLatest: string
Title:
Latest
Read Only:true
Maximum Length:1
Value that indicates if this version is the latest version. -
LastConceptVersion: string
Title:
Last Concept Version
Read Only:true
Maximum Length:10
Version 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 Date
Read Only:true
Date when the user most recently updated the proposal. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the proposal. -
LatestConceptId: integer
(int64)
Read Only:
true
Value that uniquely identifies the concept which was most recently associated with this proposal. -
LatestConceptName: string
Read Only:
true
Maximum Length:400
Alternate value that uniquely identifies the name of the concept that was most recently associated with this proposal. -
LatestConceptVersion: string
Read Only:
true
Maximum Length:10
Alternate value that uniquely identifies the version of the concept that was most recently associated with this proposal. -
Launch: string
(date)
Title:
Planned Launch
Date when the proposal is planned to be launched. -
LifecyclePhase: string
Read Only:
true
Maximum Length:80
Value that indicates the lifecycle phase of the proposal. -
links: array
Links
Title:
Links
The 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 Strategy
Maximum Length:30
Market strategy intended with this proposal. -
Name: string
Title:
Name
Maximum Length:150
Name of the product proposal. -
NetPresentValue: number
Title:
Net Present Value
Value that is the difference 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. -
PaybackPeriod: number
Period of time required to repay the sum of the original investment on the product.
-
PrimaryJustification: string
Title:
Primary Justification
Maximum Length:30
Primary 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:
30
Category under which the product is classified. -
ProductLine: string
Title:
Product Line
Maximum Length:30
Product line of the proposal. -
ProductProposalId: integer
(int64)
Read Only:
true
Value that uniquely identifies the product proposal. -
ProductStrategicFit: string
Maximum Length:
30
Product 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:
Number
Read Only:true
Maximum Length:100
Number that uniquely identifies the proposal. -
ProposalProjectedCost: number
Title:
Projected Cost
Projected cost of the proposal. -
ProposalProjectedRevenue: number
Title:
Projected Revenue
Sum of projected revenues of the proposal. -
ProposalStatus: string
Title:
Proposal Status
Read Only:true
Maximum Length:30
Default Value:DRAFT
Status of the proposal. -
ProposalStatusName: string
Read Only:
true
Maximum Length:255
Value that identifies the status of the proposal. -
ProposalType: string
Title:
Proposal Type
Maximum Length:30
Type of the proposal. -
ProposalVersionNotes: string
Read Only:
true
Maximum Length:400
Notes on the proposal version. -
PublishedFromPortfolio: string
Read Only:
true
Maximum Length:30
Default Value:N
Value that indicates if the proposal was published from a portfolio. -
ReportId: string
Read Only:
true
Value that uniquely identifies the associated report. -
ReportTemplate: string
Read Only:
true
Value that uniquely identifies the template of the associated report. -
RequirementsDefinition: string
(date)
Title:
Requirements Definition
Milestone for the requirements definition. -
ResourceValueIndex: number
Value that indicates the net present value divided by projected resources for product.
-
ReturnOnInvestment: number
Title:
Return on Investment
Value that indicates the ratio of the benefit gain minus cost of the product divided by the cost to develop the product. -
RiskNumeric: string
Maximum Length:
30
Risk of the proposal. -
RiskSubjective: string
Maximum Length:
30
Overall risk for the product on subjective basis. Valid values are High, Medium, and Low. -
RndKnowHow: string
Maximum Length:
30
Know how for research and development. -
Rpi: number
Retail price index of the proposal.
-
SecondaryJustification: string
Title:
Secondary Justification
Maximum Length:30
Secondary justification for the product proposal. -
SrcProductProposalId: integer
(int64)
Title:
Source Product Proposal ID
Read Only:true
Value that uniquely identifies the source proposal. -
SrcProductProposalName: string
Read Only:
true
Alternate value that uniquely identifies the name of the source proposal. -
SrcProductProposalVersion: integer
Read Only:
true
Alternate value that uniquely identifies the version of the source proposal. -
Summary: string
Title:
Business Case Overview
Maximum Length:2147483647
Summary of the proposal. -
SupplyChainFit: string
Maximum Length:
30
Supply chain fit of the proposal. -
TargetCost: number
Title:
Target Cost
Sum of target costs. -
Version: integer
(int32)
Title:
Version
Read Only:true
Default Value:1
Version of the proposal. -
WorkflowObjectType: string
Read Only:
true
Type 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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.