Get one configuration component

get

/fscmRestApi/resources/11.13.18.05/purchaseOrders/{purchaseOrdersUniqID}/child/lines/{POLineId}/child/configurationComponents/{configurationComponentsUniqID}

Request

Path Parameters
  • 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=
  • This is the hash key of the attributes which make up the composite key for the Configuration Components resource and used to uniquely identify an instance of Configuration Components. The client should not generate the hash key value. Instead, the client should query on the Configuration Components collection resource in order to navigate to a specific instance of Configuration Components to get the hash key.
  • This is the hash key of the attributes which make up the composite key for the Purchase Orders resource and used to uniquely identify an instance of Purchase Orders. The client should not generate the hash key value. Instead, the client should query on the Purchase Orders collection resource in order to navigate to a specific instance of Purchase Orders to get the hash key.
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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : purchaseOrders-lines-configurationComponents-item-response
Type: object
Show Source
  • Title: Base Model
    Read Only: true
    Maximum Length: 255
    The buying organization's identification number or code for the model on which the unique submodel is built. The submodel makes up part of the configuration.
  • Value that uniquely identifies the number or code for the model on which the unique submodel is built. The submodel makes up part of the configuration.
  • Unique identifier of the component that's part of the configuration.
  • Title: Line
    Number that uniquely identifies the component that's part of the configuration.
  • Title: Currency Name
    Read Only: true
    Maximum Length: 80
    Purchase order currency.
  • Title: Currency Code
    Read Only: true
    Maximum Length: 15
    Abbreviation that identifies the purchase order currency.
  • Title: Description
    Maximum Length: 240
    Text describing the component used in the configuration.
  • Title: Extended Price
    Read Only: true
    Extended price of the component used in the configuration. Extended price is calculated as quantity multiplied by price.
  • Title: Extended Price
    Read Only: true
    Maximum Length: 255
    Extended price of the component used in the configuration. Extended price is calculated as quantity multiplied by price. Value is shown in the currency code.
  • Title: Item
    Read Only: true
    Maximum Length: 255
    The buying organization's identification number or code for the component used in the configuration.
  • Title: Item
    Value that uniquely identifies the number or code for the component used in the configuration.
  • Title: Item Type
    Read Only: true
    Maximum Length: 80
    Indicates whether the component is a configured product, an option class, or an option.
  • Maximum Length: 30
    Abbreviation that identifies whether the component is a configured product, an option class, or an option.
  • Title: Line
    Read Only: true
    Number that uniquely identifies the purchase order line.
  • Links
  • Title: Order
    Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the purchase order in the sold-to legal entity.
  • Title: Parent Line
    Unique identifier of the parent component.
  • Title: Parent Line
    Read Only: true
    Number that uniquely identifies the parent component line for a component that's included in a configuration.
  • Value that uniquely identifies the purchase order.
  • Value that uniquely identifies the purchase order line.
  • Title: Price
    Price of the component used in the configuration.
  • Title: Price
    Read Only: true
    Maximum Length: 255
    Price of the component used in the configuration. Value is shown in the currency code.
  • Title: Quantity
    Number of units needed to complete a single configuration.
  • Title: Quantity
    Read Only: true
    Maximum Length: 255
    Number of units needed to complete a single configuration. Value is shown in the unit of measure.
  • Title: Revision
    Maximum Length: 18
    Identifier of the version of the component referenced in the configuration details.
  • Value that uniquely identifies the source agreement that the component references.
  • Title: Source Agreement Line
    Read Only: true
    Number that uniquely identifies the source agreement line that the component references.
  • Value that uniquely identifies the source agreement line that the component references.
  • Title: Source Agreement
    Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the source agreement that the component references.
  • Title: Supplier Item
    Maximum Length: 300
    The supplier's identification number or code for the component used in the configuration.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure that the component uses for quantity.
  • Title: UOM
    Maximum Length: 3
    Abbreviation that identifies the unit of measure.
Back to Top