Jump to

• Request
• Response

Get one parts list component

get

/fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/partsListComponents/{ListComponentId}

Request

Path Parameters

• AssetId(required): integer(int64)
  Value that uniquely identifies the asset. The application generates this value when it creates the asset. This attribute is read-only.
• ListComponentId(required): integer(int64)
  Value that uniquely identifies the parts list item that the asset references.

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 Top

Response

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.

Body ()

Root Schema : installedBaseAssets-partsListComponents-item-response

Type: object

Show Source

• AssetId: integer
  Read Only: true

  Value that uniquely identifies the asset for each component. You can create only one relationship between each value that is specified by ListComponentId and AssetId.
• ComponentQuantity: number
  Title: Quantity

  Quantity of each part list component for the asset.
• ItemId: integer (int64)
  Value that uniquely identifies the item that is part of the part list for the asset. Asset item cannot be part of the part list for the same asset.
• ItemNumber: string
  Maximum Length: 255

  Number that uniquely identifies the item that is part of the part list for the asset. An asset item cannot be part of the part list for the same asset.
• ItemOrganizationId: integer (int64)
  Value that uniquely identifies the organization to which the part list item is assigned to. This is a required attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListComponentId: integer (int64)
  Value that uniquely identifies the parts list item that the asset references.
• SecondaryQuantity: number
  Title: Secondary Quantity

  Secondary quantity of product that the asset references. If item is not defined as dual UOM item or if conversion for the secondary UOM is set to fix, this quantity is not required. If dual UOM conversion is set to default, this quantity will override the defaulted quantity. If conversion is no default, this quantity is required. Secondary UOM is defaulted from setup.
• SecondaryUOMCode: string
  Title: Secondary UOM

  Maximum Length: 3

  Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure is not required to create an asset. If provided it must be the same than the asset item secondary unit of measure. If not provided the value is defaulted from the asset item secondary unit of measure.

{
    "type":"object",
    "properties":{
        "ItemOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization to which the part list item is assigned to. This is a required attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ListComponentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parts list item that the asset references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ComponentQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of each part list component for the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the item that is part of the part list for the asset. An asset item cannot be part of the part list for the same asset.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SecondaryQuantity":{
            "title":"Secondary Quantity",
            "type":"number",
            "description":"Secondary quantity of product that the asset references. If item is not defined as dual UOM item or if conversion for the secondary UOM is set to fix, this quantity is not required. If dual UOM conversion is set to  default, this quantity will override the defaulted quantity. If conversion is no default, this quantity is required. Secondary UOM is defaulted from setup.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure is not required to create an asset. If provided it must be the same than the asset item secondary unit of measure. If not provided the value is defaulted from the asset item secondary unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset for each component. You can create only one relationship between each value that is specified by ListComponentId and AssetId.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item that is part of the part list for the asset. Asset item cannot be part of the part list for the same asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top