Get all proposals

get

/fscmRestApi/resources/11.13.18.05/productConcepts/{ConceptId}/child/Proposal

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • FindByProductProposalId: Find product proposals according to the proposal identifier.
      Finder Variables:
      • ProductProposalId; integer; Value that uniquely identifies the product proposal.
    • PrimaryKey: Find product proposals according to the proposal identifier.
      Finder Variables:
      • ProductProposalId; integer; Value that uniquely identifies the product proposal.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActualCost; number; Sum of actual costs of the proposal.
    • 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.
    • ActualDevelopmentCost; number; Sum of actual costs for development.
    • ActualLaunch; string; 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.
    • ActualProdVariableCost; number; Sum of variable costs for the actual production.
    • ActualProductionCost; number; Sum of actual costs for production.
    • ActualResources; number; Sum of actual resources.
    • ActualRevenue; number; Sum of actual revenues.
    • Alignment; string; Alignment score of the proposal.
    • AllocatedBudget; number; Budget allocated for the proposal.
    • AverageSellingPrice; number; Average selling price of the proposal.
    • BaselineDate; string; Date when the proposal metrics were calculated.
    • BreakEvenTime; number; Time when break even should be reached.
    • BusinessObjectives; string; Value that indicates the business objectives of the proposal.
    • BusinessUnit; string; Business unit of the proposal.
    • BusinessUnitStrength; number; Strength of business unit of the proposal.
    • CPI; number; Consumer price index metric of the proposal.
    • CompetitiveAdvantage; string; Value that indicates the competitive advantage of the proposal.
    • ConceptCurrencyCode; string; Abbreviation that identifies the currency of the proposal.
    • ConceptMasterId; integer; Value that uniquely identifies the associated concept master.
    • ConceptMasterName; string; Alternate value that uniquely identifies the name of the associated concept master.
    • ConceptType; string; Type of the associated concept.
    • CostValueIndex; number; Cost value index of the proposal.
    • CreatedBy; string; User who created the proposal.
    • CreationDate; string; Date when the user created the proposal.
    • Description; string; Description of the product proposal.
    • DevelopmentEnd; string; Date when the development of the proposal ends.
    • DevelopmentStart; string; Date when the development begins.
    • DiscountRate; number; Rate of discount of the proposal.
    • EOL; string; Estimated end of life of the proposal.
    • ExpectedCommercialValue; number; Expected commercial value.
    • FundingAmount; number; Funding amount for the proposal.
    • FundingRequestFor; string; Phase of the proposal for which the funding is requested.
    • HighLevelDesign; string; High level design milestone of the proposal.
    • Impact; string; Impact of the proposal.
    • InternalRateOfReturn; number; Rate of discount that makes the net present value of all cash flows for a product equal to zero.
    • IsLatest; string; Value that indicates if this version is the latest version.
    • LastUpdateDate; string; Date when the user most recently updated the proposal.
    • LastUpdatedBy; string; User who most recently updated the proposal.
    • Launch; string; Date when the proposal is planned to be launched.
    • MarketAttractiveness; number; Value that indicates the market attractiveness of the proposal.
    • MarketGrowthPercent; number; Percent of market growth.
    • MarketSharePercent; number; Percent of the market share estimated for the proposal.
    • MarketStrategy; string; Market strategy intended with this proposal.
    • Name; string; Name of the product proposal.
    • NetPresentValue; number; 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; 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; Category under which the product is classified.
    • ProductLine; string; Product line of the proposal.
    • ProductProposalId; integer; Value that uniquely identifies the product proposal.
    • ProductStrategicFit; string; 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.
    • 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.
    • ProjectedMargin; number; Projected margin of the proposal.
    • ProjectedResources; number; Projected resources for the proposal.
    • ProposalNumber; string; Number that uniquely identifies the proposal.
    • ProposalProjectedCost; number; Projected cost of the proposal.
    • ProposalProjectedRevenue; number; Sum of projected revenues of the proposal.
    • ProposalStatus; string; Status of the proposal.
    • ProposalStatusName; string; Value that identifies the status of the proposal.
    • ProposalType; string; Type of the proposal.
    • ProposalVersionNotes; string; Notes on the proposal version.
    • PublishedFromPortfolio; string; Value that indicates if the proposal was published from a portfolio.
    • RequirementsDefinition; string; Milestone for the requirements definition.
    • ResourceValueIndex; number; Value that indicates the net present value divided by projected resources for product.
    • ReturnOnInvestment; number; Value that indicates the ratio of the benefit gain minus cost of the product divided by the cost to develop the product.
    • RiskNumeric; string; Risk of the proposal.
    • RiskSubjective; string; Overall risk for the product on subjective basis. Valid values are High, Medium, and Low.
    • RndKnowHow; string; Know how for research and development.
    • Rpi; number; Retail price index of the proposal.
    • SecondaryJustification; string; Secondary justification for the product proposal.
    • Summary; string; Summary of the proposal.
    • SupplyChainFit; string; Supply chain fit of the proposal.
    • TargetCost; number; Sum of target costs.
    • Version; integer; Version of 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.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : productConcepts-Proposal
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : productConcepts-Proposal-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get the latest product proposal of a concept.

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/productConcepts/{ConceptId}/child/Proposal"

Example Response Body

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

{
	"items": [
	{
		"ProductProposalId": 300100250841759,
		"Name": "XYZ",
		"Description": "Test Data Update",
		"AllowAccesstoEveryone": "Y",
		"ConceptCurrencyCode": "USD",
		"ConceptMasterId": 300100250840675,
		"ConceptMasterName": "XYZ",
		"ConceptMasterVersion": "1",
		"CreatedBy": "PRODUCT_MANAGER",
		"CreationDate": "2020-09-02T12:04:14+00:00",
		"CurrencyConversionRate": null,
		"InstanceId": null,
		"IsCloned": "N",
		"IsLatest": "Y",
		"LastConceptVersion": null,
		"LastProjCostRefreshTime": null,
		"LastProjResourceRefreshTime": null,
		"LastUpdateDate": "2020-09-04T10:53:39.826+00:00",
		"LastUpdatedBy": "PRODUCT_MANAGER",
		"LatestConceptId": 300100250840675,
		"LatestConceptName": "XYZ",
		"LatestConceptVersion": "1",
		"LifecyclePhase": "DRAFT",
		"ProposalStatus": "DRAFT",
		"ProposalType": "NEW_PRODUCT",
		"PublishedFromPortfolio": "N",
		"ReportId": "/Supply Chain Management/Innovation Management/Concepts/DefaultProposalReport.xdo",
		"ReportTemplate": "",
		"SrcProductProposalId": 300100250841756,
		"SrcProductProposalName": "XYZ",
		"SrcProductProposalVersion": 2,
		"Version": 3,
		"WorkflowObjectType": null,
		"ProjectedResources": 3,
		"ActualDevFixedCost": 200000,
		"MarketSharePercent": null,
		"HighLevelDesign": null,
		"ActualCost": 200000,
		"CompetitiveAdvantage": null,
		"ProjProdMaterialCost": null,
		"ActualProdFixedCost": null,
		"ReturnOnInvestment": 2666566.67,
		"ProjectedMargin": 3999850,
		"Summary": null,
		"Impact": null,
		"PaybackPeriod": null,
		"RiskSubjective": null,
		"DevelopmentStart": null,
		"TargetCost": null,
		"RndKnowHow": null,
		"AllocatedBudget": null,
		"ProjDevFixedCost": 100,
		"BusinessObjectives": null,
		"ActualProductionCost": null,
		"ProposalVersionNotes": null,
		"ActualDevLaborCost": null,
		"ActualProdLaborCost": null,
		"ProjDevLaborCost": null,
		"ProductCategorization": null,
		"InternalRateOfReturn": null,
		"ProposalProjectedCost": 150,
		"MarketAttractiveness": null,
		"ProductStrategicFit": null,
		"DiscountRate": 0,
		"DevelopmentEnd": null,
		"YearTwoRevenue": null,
		"ProbOfCommercialSuccess": null,
		"BusinessUnitStrength": null,
		"ProjDevCost": 150,
		"RiskNumeric": null,
		"ActualDevelopmentCost": 200000,
		"YearFiveRevenue": null,
		"CostValueIndex": null,
		"BaselineDate": "2020-09-02",
		"ActualDevVariableCost": null,
		"ExpectedCommercialValue": null,
		"ProposalProjectedRevenue": 4000000,
		"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": 3999850,
		"ProductLine": null,
		"RequirementsDefinition": null,
		"ProjDevVariableCost": 50,
		"BusinessUnit": null,
		"ResourceValueIndex": null,
		"MarketGrowthPercent": null,
		"BreakEvenTime": null,
		"YearThreeRevenue": null,
		"SecondaryJustification": null,
		"Rpi": null,
		"ConceptType": "CONCEPT",
		"ProductProposalEO_PROPOSAL_DCL_IDEA_Id_c": null,
		"ProductProposalEO_PROPOSAL_DCL_IDEA_c": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/productConcepts/300100250840675/child/Proposal/00030000000EACED00057708000110F088D9329F0000000EACED00057708000110F088D92E630000000EACED00057708000110F088D932A0",
			"name": "Proposal",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000003770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000137371007E0002000000037371007E00020000000B78"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/productConcepts/300100250840675/child/Proposal/00030000000EACED00057708000110F088D9329F0000000EACED00057708000110F088D92E630000000EACED00057708000110F088D932A0",
			"name": "Proposal",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/productConcepts/300100250840675",
			"name": "productConcepts",
			"kind": "item"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/productConcepts/300100250840675/child/Proposal",
		"name": "Proposal",
		"kind": "collection"
	}
	]
}
Back to Top