Get one option dependent resource detail
get
/fscmRestApi/resources/11.13.18.05/planInputs/{PlanInputId}/child/BillOfResources/{BorId}/child/OptionDependentDetails/{OptionId}
Request
Path Parameters
-
BorId(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=
-
OptionId(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=
-
PlanInputId(required): integer
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:
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(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : planInputs-BillOfResources-OptionDependentDetails-item-response
Type:
Show Source
object
-
AssemblyItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the assembly item. -
AssemblyItemName: string
Read Only:
true
Maximum Length:255
Name of the assembly item. -
BorId: integer
Read Only:
true
Value that uniquely identifies the bill of resources. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationSequenceNumber: number
Read Only:
true
Number that indicates the order for operations that are dependent on the choice of one or multiple optional components in the bill of resources. -
OptionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the optional component for the option dependent resource in the bill of resources. -
OptionMemberId: integer
(int64)
Read Only:
true
Value that uniquely identifies the end option item or class in the optional component lineage in the bill of resources. -
OptionMemberLineageNames: string
Read Only:
true
Maximum Length:4000
Ordered list of names for the parent option items or classes of an optional component in the bill of resources. -
OptionMemberName: string
Read Only:
true
Maximum Length:4000
Name of the end option item or class in the optional component lineage in the bill of resources. -
OptionMemberType: string
Read Only:
true
Maximum Length:4000
Value that indicates whether the optional component in the bill of resources is an item or class. Contains one of the following values: 0 or 1. If 0, then the component is an option item. If 1, then the component is an option class. This attribute doesn't have a default value. -
OptionMemberUsageQuantity: number
Read Only:
true
Value that indicates the quantity of the optional component being consumed in the bill of resources. -
Organization: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the organization associated with the item. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization. -
ResourceCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the resource. -
ResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the resource. -
ResourceUsageQuantity: number
Read Only:
true
Quantity of the resource being consumed.
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.
Examples
This example describes how to get one option dependent resource detail.
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/planInputs/PlanInputId/child/BillOfResources/BorId/child/OptionDependentDetails/OptionId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/planInputs/-1/child/BillOfResources/170045/child/OptionDependentDetails/31051"
Example Response Body
The following shows an example of the response body in JSON format.
{ "BorId": 170045, "OrganizationId": 10001, "Organization": "M1", "AssemblyItemId": 26630126, "AssemblyItemName": "RB-HV-IPPA", "ResourceId": 210491, "ResourceCode": "RB-ODR-R6", "OptionId": 31051, "OptionMemberId": 26630114, "OptionMemberName": "RB-HV-A370-1002", "OptionMemberType": "4", "OptionMemberLineageNames": "RB-HV-A370-OC1>RB-HV-A370-1002", "OperationSequenceNumber": 30, "OptionMemberUsageQuantity": 1, "ResourceUsageQuantity": 1, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/planInputs/-1/child/BillOfResources/170045/child/OptionDependentDetails/31051", "name": "OptionDependentDetails", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/planInputs/-1/child/BillOfResources/170045/child/OptionDependentDetails/31051", "name": "OptionDependentDetails", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/planInputs/-1/child/BillOfResources/170045", "name": "BillOfResources", "kind": "item" } ] }