Jump to

• Request
• Response
• Examples

Create a parts list component

post

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

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.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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"
            }
        },
        "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"
            }
        },
        "ComponentQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of each part list component for the asset.",
            "nullable":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"
            }
        },
        "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
        },
        "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
        },
        "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"
            }
        }
    }
}

Back to Top

Response

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.

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

Examples

This example describes how to create one parts list component.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/installedBaseAssets/AssetId/child/PartsListComponent"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"ItemOrganizationId":"300100113363336",
	"ComponentQuantity":"1",
	"ItemId":"300100013645842"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"RelationshipId" : 300100176686313,
	"AssetId" : 300100176686307,
	"AssetNumber" : "F/0554-3134_CHILD",
	"SerialNumber" : "SR554-3134",
	"ItemNumber" : null,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/installedBaseAssets/300100176686291/child/relationships/300100176686313",
		"name" : "relationships",
		"kind" : "item",
		"properties" : {
			"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	}, {
		"rel" : "canonical",
		"href" : "https://servername/fscmRestApi/resources/version/installedBaseAssets/300100176686291/child/relationships/300100176686313",
		"name" : "relationships",
		"kind" : "item"
	}, {
		"rel" : "parent",
		"href" : "https://servername/fscmRestApi/resources/version/installedBaseAssets/300100176686291",
		"name" : "installedBaseAssets",
		"kind" : "item"
	} ]
}

Back to Top