Update one approved supplier list source document
patch
/fscmRestApi/resources/11.13.18.05/approvedSupplierListSourceDocuments/{approvedSupplierListSourceDocumentsUniqID}
Request
Path Parameters
-
approvedSupplierListSourceDocumentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Approved Supplier List Source Documents resource and used to uniquely identify an instance of Approved Supplier List Source Documents. The client should not generate the hash key value. Instead, the client should query on the Approved Supplier List Source Documents collection resource in order to navigate to a specific instance of Approved Supplier List Source Documents to get the hash key.
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Agreement: string
Title:
Agreement
Maximum Length:30
Contract stating the terms of a purchase. -
AgreementId: integer
(int64)
Identifier of the purchasing document's header.
-
AgreementLine: number
Title:
Agreement Line
Agreement line number with which the approved supplier list entry is associated. -
AgreementLineId: integer
(int64)
Identifier of the purchasing document's line.
-
AgreementType: string
Title:
Type
Maximum Length:80
Type of agreement associated with the requested item. Applicable types are blanket purchase agreement and contract purchase agreement. -
AgreementTypeCode: string
Maximum Length:
25
Code that indicates the type of document. -
DFF: array
DFF
-
Item: string
Title:
Item
Maximum Length:300
Anything that a business makes, purchases, or sells, including components, subassemblies, finished products, or supplies. -
ItemId: integer
(int64)
Value that uniquely identifies the item on the approved supplier list entry.
-
ProcurementBU: string
Title:
Procurement BU
Maximum Length:240
Business unit that manages and owns the purchasing document. -
ProcurementBUId: integer
(int64)
Value that uniquely identifies the business unit that manages and owns the approved supplier list entry.
-
Supplier: string
Title:
Supplier
Maximum Length:360
Organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier who fulfills the order.
-
SupplierSite: string
Title:
Supplier Site
Maximum Length:240
Entity that models how the buying organization conducts business with the supplier. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the location that the supplier uses to fulfill the order.
Nested Schema : approvedSupplierListSourceDocuments-DFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
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.
Root Schema : approvedSupplierListSourceDocuments-item-response
Type:
Show Source
object
-
Agreement: string
Title:
Agreement
Maximum Length:30
Contract stating the terms of a purchase. -
AgreementEndDate: string
(date)
Title:
Agreement End Date
Read Only:true
Date after which the agreement isn't usable. -
AgreementId: integer
(int64)
Identifier of the purchasing document's header.
-
AgreementLine: number
Title:
Agreement Line
Agreement line number with which the approved supplier list entry is associated. -
AgreementLineId: integer
(int64)
Identifier of the purchasing document's line.
-
AgreementStartDate: string
(date)
Title:
Agreement Start Date
Read Only:true
Date on which the agreement associated with the approved supplier list entry becomes effective. -
AgreementStatus: string
Title:
Agreement Status
Read Only:true
Maximum Length:25
Indicates the state of the document with reference to the entire document lifecycle. For example, Incomplete, or Open. -
AgreementType: string
Title:
Type
Maximum Length:80
Type of agreement associated with the requested item. Applicable types are blanket purchase agreement and contract purchase agreement. -
AgreementTypeCode: string
Maximum Length:
25
Code that indicates the type of document. -
AslAttributesId: integer
Identifier of the approved supplier list??s supplier item attribute.
-
AslId: integer
(int64)
Unique identifier of the approved supplier list entry.
-
AslSourceDocumentsId: integer
Identifier of the approved supplier list??s source document.
-
DFF: array
DFF
-
Item: string
Title:
Item
Maximum Length:300
Anything that a business makes, purchases, or sells, including components, subassemblies, finished products, or supplies. -
ItemId: integer
(int64)
Value that uniquely identifies the item on the approved supplier list entry.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcurementBU: string
Title:
Procurement BU
Maximum Length:240
Business unit that manages and owns the purchasing document. -
ProcurementBUId: integer
(int64)
Value that uniquely identifies the business unit that manages and owns the approved supplier list entry.
-
Scope: string
Title:
Scope
Read Only:true
Maximum Length:80
Identifies if the approved supplier list entry is used by a ship-to organization or by all ship-to organizations serviced by the procurement business unit. -
ScopeCode: string
Read Only:
true
Maximum Length:80
Code that identifies if the approved supplier list entry is used by a ship-to organization or by all ship-to organizations serviced by the procurement business unit. -
ShipToOrganization: string
Title:
Ship-to Organization
Maximum Length:240
Name of the inventory organization to which the supplier should ship the goods. -
ShipToOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization that receives the item.
-
Supplier: string
Title:
Supplier
Maximum Length:360
Organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier who fulfills the order.
-
SupplierSite: string
Title:
Supplier Site
Maximum Length:240
Entity that models how the buying organization conducts business with the supplier. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the location that the supplier uses to fulfill the order.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : approvedSupplierListSourceDocuments-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
-
AslSourceDocumentsId: integer
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Links
- DFF
-
Parameters:
- approvedSupplierListSourceDocumentsUniqID:
$request.path.approvedSupplierListSourceDocumentsUniqID
- approvedSupplierListSourceDocumentsUniqID:
Examples
This example describes how to update one approved supplier list source document.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/approvedSupplierListSourceDocumentsUniqID"For example:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/300100564828018"
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 updates.
{ "parts": [ { "id": "part0", "path": "/approvedSupplierListSourceDocuments/300100564828018", "operation": "update", "payload": { "ProcurementBU": "Vision Operations", "Supplier": "Big Computers", "SupplierSite": null, "Item": "RCV-100", "AgreementType": "Blanket Purchase Agreement", "Agreement": "1000446", "AgreementLine": 2 } }, { "id": "part1", "path": "/approvedSupplierListSourceDocuments/300100564828025", "operation": "update", "payload": { "ProcurementBU": "Vision Operations", "Supplier": "Big Computers", "SupplierSite": null, "Item": "RCV-100", "AgreementType": "Contract Purchase Agreement", "Agreement": "1000004", "AgreementLine": null } } ] }
Example Response Body
The following example includes the contents of the response
body in JSON format:
{ "parts": [ { "id": "part0", "path": "https://server/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/300100564828018", "operation": "update", "preconditionSucceeded": true, "payload": { "AslSourceDocumentsId": 300100564828018, "AslId": 300100563020927, "AslAttributesId": 300100563020928, "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "ScopeCode": "SHIP_TO_ORG", "Scope": "Ship-to Organization", "ShipToOrganizationId": 204, "ShipToOrganization": "Vision Operations", "ItemId": 663907, "Item": "RCV-100", "SupplierId": 12, "Supplier": "Big Computers", "SupplierSiteId": null, "SupplierSite": null, "AgreementTypeCode": "BLANKET", "AgreementType": "Blanket Purchase Agreement", "AgreementId": 421837, "Agreement": "1000446", "AgreementLineId": 379753, "AgreementLine": 2, "AgreementStatus": "OPEN", "AgreementStartDate": "2010-05-01", "AgreementEndDate": null } }, { "id": "part1", "path": "https://server/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/300100564828025", "operation": "update", "preconditionSucceeded": true, "payload": { "AslSourceDocumentsId": 300100564828025, "AslId": 300100563020927, "AslAttributesId": 300100563020928, "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "ScopeCode": "SHIP_TO_ORG", "Scope": "Ship-to Organization", "ShipToOrganizationId": 204, "ShipToOrganization": "Vision Operations", "ItemId": 663907, "Item": "RCV-100", "SupplierId": 12, "Supplier": "Big Computers", "SupplierSiteId": null, "SupplierSite": null, "AgreementTypeCode": "CONTRACT", "AgreementType": "Contract Purchase Agreement", "AgreementId": 300100561934996, "Agreement": "1000004", "AgreementLineId": null, "AgreementLine": null, "AgreementStatus": "OPEN", "AgreementStartDate": null, "AgreementEndDate": null } } ] }