Jump to

• Request
• Response
• Examples

Create a default purchase order schedule

post

/fscmRestApi/resources/11.13.18.05/tradeOperations/{TradeOperationId}/child/defaultPOSchedules

Request

Path Parameters

• TradeOperationId(required): integer(int64)
  Value that uniquely identifies the trade operation.

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• POCurrencyCode: string
  Title: PO Currency

  Maximum Length: 15

  Value that identifies the currency on the purchase order.
• POLineLocationId: integer (int64)
  Title: Purchase Order Line Location ID

  Value that uniquely identifies the purchase order shipment schedule.
• POPrimaryUOMCode: string
  Title: PO Primary UOM

  Maximum Length: 3

  Value that identifies the primary unit of measure for the purchase order schedule quantity.
• POQuantityInPrimaryUOM: number
  Title: Ordered Quantity (Primary UOM)

  Ordered quantity on the purchase order in the primary unit of measure.
• POQuantityInSecondaryUOM: number
  Title: Ordered Quantity (Secondary UOM)

  Ordered quantity on the purchase order in the secondary unit of measure.
• POSecondaryUOMCode: string
  Title: PO Secondary UOM

  Maximum Length: 3

  Value that identifies the secondary unit of measure for the purchase order schedule quantity.
• TradeOperationDefaultPOScheduleId: integer (int64)
  Title: Trade Operation Default PO Schedule ID

  Value that uniquely identifies the trade operation currency.
• TradeOperationId: integer (int64)
  Title: Trade Operation ID

  Value that uniquely identifies the trade operation.

{
    "type":"object",
    "properties":{
        "POCurrencyCode":{
            "title":"PO Currency",
            "maxLength":15,
            "type":"string",
            "description":"Value that identifies the currency on the purchase order.",
            "nullable":false
        },
        "POPrimaryUOMCode":{
            "title":"PO Primary UOM",
            "maxLength":3,
            "type":"string",
            "description":"Value that identifies the primary unit of measure for the purchase order schedule quantity.",
            "nullable":false
        },
        "POQuantityInSecondaryUOM":{
            "title":"Ordered Quantity (Secondary UOM)",
            "type":"number",
            "description":"Ordered quantity on the purchase order in the secondary unit of measure.",
            "nullable":true
        },
        "POLineLocationId":{
            "title":"Purchase Order Line Location ID",
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order shipment schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TradeOperationId":{
            "title":"Trade Operation ID",
            "type":"integer",
            "description":"Value that uniquely identifies the trade operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "POQuantityInPrimaryUOM":{
            "title":"Ordered Quantity (Primary UOM)",
            "type":"number",
            "description":"Ordered quantity on the purchase order in the primary unit of measure.",
            "nullable":false
        },
        "POSecondaryUOMCode":{
            "title":"PO Secondary UOM",
            "maxLength":3,
            "type":"string",
            "description":"Value that identifies the secondary unit of measure for the purchase order schedule quantity.",
            "nullable":true
        },
        "TradeOperationDefaultPOScheduleId":{
            "title":"Trade Operation Default PO Schedule ID",
            "type":"integer",
            "description":"Value that uniquely identifies the trade operation currency.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

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 : tradeOperations-defaultPOSchedules-item-response

Type: object

Show Source

• ChargeBU: string
  Title: Charge BU

  Read Only: true

  Maximum Length: 240

  Value that indicates the requisitioning business unit that incurs the charge.
• ItemNumber: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Number that identifies the item on the purchase order schedule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• POCurrencyCode: string
  Title: PO Currency

  Maximum Length: 15

  Value that identifies the currency on the purchase order.
• POLineLocationId: integer (int64)
  Title: Purchase Order Line Location ID

  Value that uniquely identifies the purchase order shipment schedule.
• POLineNumber: string
  Title: Purchase Order Line

  Read Only: true

  Maximum Length: 40

  Number that identifies the line in the purchase order.
• PONumber: string
  Title: PO Number

  Read Only: true

  Maximum Length: 40

  Number that identifies the purchase order.
• POPrimaryUOMCode: string
  Title: PO Primary UOM

  Maximum Length: 3

  Value that identifies the primary unit of measure for the purchase order schedule quantity.
• POQuantityInPrimaryUOM: number
  Title: Ordered Quantity (Primary UOM)

  Ordered quantity on the purchase order in the primary unit of measure.
• POQuantityInSecondaryUOM: number
  Title: Ordered Quantity (Secondary UOM)

  Ordered quantity on the purchase order in the secondary unit of measure.
• POScheduleAmount: number
  Title: PO Schedule Amount

  Read Only: true

  Amount on the purchase order schedule line.
• POScheduleFuncCurrencyAmount: number
  Title: PO Schedule Functional Currency Amount

  Read Only: true

  Amount on the purchase order schedule line in the functional currency.
• POScheduleNumber: string
  Title: Purchase Order Schedule

  Read Only: true

  Maximum Length: 40

  Number that identifies the schedule of the material purchase order line used for the landed cost estimate.
• POSecondaryUOMCode: string
  Title: PO Secondary UOM

  Maximum Length: 3

  Value that identifies the secondary unit of measure for the purchase order schedule quantity.
• TradeOperationDefaultPOScheduleId: integer (int64)
  Title: Trade Operation Default PO Schedule ID

  Value that uniquely identifies the trade operation currency.
• TradeOperationId: integer (int64)
  Title: Trade Operation ID

  Value that uniquely identifies the trade operation.
• UnitOfMeasure: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 25

  Unit of measure for the purchase order schedule quantity.

{
    "type":"object",
    "properties":{
        "PONumber":{
            "title":"PO Number",
            "maxLength":40,
            "type":"string",
            "description":"Number that identifies the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POScheduleAmount":{
            "title":"PO Schedule Amount",
            "type":"number",
            "description":"Amount on the purchase order schedule line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POScheduleFuncCurrencyAmount":{
            "title":"PO Schedule Functional Currency Amount",
            "type":"number",
            "description":"Amount on the purchase order schedule line in the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure for the purchase order schedule quantity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "POQuantityInSecondaryUOM":{
            "title":"Ordered Quantity (Secondary UOM)",
            "type":"number",
            "description":"Ordered quantity on the purchase order in the secondary unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "POLineLocationId":{
            "title":"Purchase Order Line Location ID",
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order shipment schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradeOperationDefaultPOScheduleId":{
            "title":"Trade Operation Default PO Schedule ID",
            "type":"integer",
            "description":"Value that uniquely identifies the trade operation currency.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "POCurrencyCode":{
            "title":"PO Currency",
            "maxLength":15,
            "type":"string",
            "description":"Value that identifies the currency on the purchase order.",
            "nullable":false,
            "x-queryable":true
        },
        "POScheduleNumber":{
            "title":"Purchase Order Schedule",
            "maxLength":40,
            "type":"string",
            "description":"Number that identifies the schedule of the material purchase order line used for the landed cost estimate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the item on the purchase order schedule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeBU":{
            "title":"Charge BU",
            "maxLength":240,
            "type":"string",
            "description":"Value that indicates the requisitioning business unit that incurs the charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POPrimaryUOMCode":{
            "title":"PO Primary UOM",
            "maxLength":3,
            "type":"string",
            "description":"Value that identifies the primary unit of measure for the purchase order schedule quantity.",
            "nullable":false,
            "x-queryable":true
        },
        "POLineNumber":{
            "title":"Purchase Order Line",
            "maxLength":40,
            "type":"string",
            "description":"Number that identifies the line in the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TradeOperationId":{
            "title":"Trade Operation ID",
            "type":"integer",
            "description":"Value that uniquely identifies the trade operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "POQuantityInPrimaryUOM":{
            "title":"Ordered Quantity (Primary UOM)",
            "type":"number",
            "description":"Ordered quantity on the purchase order in the primary unit of measure.",
            "nullable":false,
            "x-queryable":true
        },
        "POSecondaryUOMCode":{
            "title":"PO Secondary UOM",
            "maxLength":3,
            "type":"string",
            "description":"Value that identifies the secondary unit of measure for the purchase order schedule quantity.",
            "nullable":true,
            "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 a default purchase order schedule.

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/tradeOperations/TradeOperationId/child/defaultPOSchedules"

Example 1Request 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.

{
	""POLineLocationId": 20715"
}

Example 1 Response Body

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

{
	"ChargeBU": null,
	"ItemNumber": null,
	"POCurrencyCode": "USD",
	"POLineLocationId": 20715,
	"POLineNumber": "1",
	"PONumber": "1000987",
	"POPrimaryUOMCode": "Ea",
	"POQuantityInPrimaryUOM": 100,
	"POQuantityInSecondaryUOM": 0,
	"POScheduleAmount": 10,
	"POScheduleFuncCurrencyAmount": 10,
	"POScheduleNumber": "1",
	"POSecondaryUOMCode": null,
	"TradeOperationDefaultPOScheduleId": 300100154036887,
	"TradeOperationId": 300100085591704,
	"UnitOfMeasure": "Each",
	"links": [{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/defaultPOSchedules/300100154036887",
		"name": "defaultPOSchedules",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	}, {
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/defaultPOSchedules/300100154036887",
		"name": "defaultPOSchedules",
		"kind": "item"
	}, {
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704",
		"name": "tradeOperations",
		"kind": "item"
	}]
}

Example 2 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.

{
	"parts" : [{
		"id": "part1",
		"path": "/tradeOperations/300100085591704/child/defaultPOSchedules",
		"operation": "create",
		"payload":  {
			"POLineLocationId": 20716
		}
	},
	{
		"id": "part2",
		"path": "/tradeOperations/300100085591704/child/defaultPOSchedules",
		"operation": "create",
		"payload":  {
			"POLineLocationId": 20717
		}
	}
	]
}

Example 2 Response Body

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

{
	"parts": [{
		"id": "part1",
		"path": "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/defaultPOSchedules",
		"operation": "create",
		"payload": {
			"ChargeBU": "Vision Operations",
			"ItemNumber": "RCV-100",
			"POCurrencyCode": "USD",
			"POLineLocationId": 20716,
			"POLineNumber": "1",
			"PONumber": "1000986",
			"POPrimaryUOMCode": "Ea",
			"POQuantityInPrimaryUOM": 100,
			"POQuantityInSecondaryUOM": 0,
			"POScheduleAmount": 10,
			"POScheduleFuncCurrencyAmount": 10,
			"POScheduleNumber": "1",
			"POSecondaryUOMCode": null,
			"TradeOperationDefaultPOScheduleId": 300100154037088,
			"TradeOperationId": 300100085591704,
			"UnitOfMeasure": "Each",
			"links": [{
				"rel": "self",
				"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/defaultPOSchedules/300100154037088",
				"name": "defaultPOSchedules",
				"kind": "item",
				"properties": {
					"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
				}
			}, {
				"rel": "canonical",
				"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/defaultPOSchedules/300100154037088",
				"name": "defaultPOSchedules",
				"kind": "item"
			}, {
				"rel": "parent",
				"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704",
				"name": "tradeOperations",
				"kind": "item"
			}]
		}
	}, {
		"id": "part2",
		"path": "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/defaultPOSchedules",
		"operation": "create",
		"payload": {
			"ChargeBU": "Vision Operations",
			"ItemNumber": "RCV-105",
			"POCurrencyCode": "USD",
			"POLineLocationId": 20717,
			"POLineNumber": "5",
			"PONumber": "1000125",
			"POPrimaryUOMCode": "Ea",
			"POQuantityInPrimaryUOM": 2000,
			"POQuantityInSecondaryUOM": 0,
			"POScheduleAmount": 20,
			"POScheduleFuncCurrencyAmount": 20,
			"POScheduleNumber": "1",
			"POSecondaryUOMCode": null,
			"TradeOperationDefaultPOScheduleId": 300100154037095,
			"TradeOperationId": 300100085591704,
			"UnitOfMeasure": "Each",
			"links": [{
				"rel": "self",
				"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/defaultPOSchedules/300100154037095",
				"name": "defaultPOSchedules",
				"kind": "item",
				"properties": {
					"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
				}
			}, {
				"rel": "canonical",
				"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/defaultPOSchedules/300100154037095",
				"name": "defaultPOSchedules",
				"kind": "item"
			}, {
				"rel": "parent",
				"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704",
				"name": "tradeOperations",
				"kind": "item"
			}]
		}
	}]
}

Back to Top