Update one supplier eligibility record
patch
/fscmRestApi/resources/11.13.18.05/supplierEligibilities/{EligibilityId}
Request
Path Parameters
-
EligibilityId(required): integer(int64)
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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
Value that uniquely identifies the procurement business unit associated with the supplier eligibility. -
BusinessUnitName: string
Title:
Procurement BU
Maximum Length:240
Name of the procurement business unit associated with the supplier eligibility. -
EligibilityId: integer
(int64)
Value that uniquely identifies the supplier eligibility.
-
SourcingAssessmentId: integer
(int64)
Value that uniquely identifies the assessment associated with any sourcing activity.
-
SourcingAssessmentNumber: string
Title:
Sourcing Assessment Number
Maximum Length:30
Number that identifies the most recent assessment based on which the sourcing eligibility of the supplier is decided. -
SourcingComments: string
Title:
Comments
Maximum Length:1000
Comments associated with the procurement business unit-level sourcing eligibility. -
SourcingEligibility: string
Title:
Sourcing Eligibility
Maximum Length:80
Status of sourcing eligibility at supplier level. Valid values include Eligible, Not Eligible, and Eligible with warning. -
SourcingEligibilityCode: string
Title:
Sourcing Eligibility Code
Maximum Length:30
Abbreviation that identifies the status of the sourcing eligibility. Valid values include ALLOWED, NOT_ALLOWED, and WARNING. -
SourcingEligUpdateDate: string
(date-time)
Title:
Sourcing Eligibility Updated Date
Date when the user most recently updated the sourcing eligibility for a supplier. -
SourcingEligUpdatedBy: integer
(int64)
Title:
Eligibility Updated By
Login that the user used when updating the sourcing eligibility for a supplier. -
SourcingEligUpdatedByName: string
Title:
Sourcing Eligibility Updated by Name
Maximum Length:240
User who most recently updated the sourcing eligibility for a supplier. -
SupplierId: integer
(int64)
Title:
Supplier ID
Value that uniquely identifies the supplier participating in sourcing eligibility. -
SupplierName: string
Title:
Supplier
Maximum Length:360
Name of the supplier participating in supplier eligibility.
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.
Root Schema : supplierEligibilities-item-response
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
Value that uniquely identifies the procurement business unit associated with the supplier eligibility. -
BusinessUnitName: string
Title:
Procurement BU
Maximum Length:240
Name of the procurement business unit associated with the supplier eligibility. -
EligibilityId: integer
(int64)
Value that uniquely identifies the supplier eligibility.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourcingAssessmentId: integer
(int64)
Value that uniquely identifies the assessment associated with any sourcing activity.
-
SourcingAssessmentNumber: string
Title:
Sourcing Assessment Number
Maximum Length:30
Number that identifies the most recent assessment based on which the sourcing eligibility of the supplier is decided. -
SourcingComments: string
Title:
Comments
Maximum Length:1000
Comments associated with the procurement business unit-level sourcing eligibility. -
SourcingEligibility: string
Title:
Sourcing Eligibility
Maximum Length:80
Status of sourcing eligibility at supplier level. Valid values include Eligible, Not Eligible, and Eligible with warning. -
SourcingEligibilityCode: string
Title:
Sourcing Eligibility Code
Maximum Length:30
Abbreviation that identifies the status of the sourcing eligibility. Valid values include ALLOWED, NOT_ALLOWED, and WARNING. -
SourcingEligUpdateDate: string
(date-time)
Title:
Sourcing Eligibility Updated Date
Date when the user most recently updated the sourcing eligibility for a supplier. -
SourcingEligUpdatedBy: integer
(int64)
Title:
Eligibility Updated By
Login that the user used when updating the sourcing eligibility for a supplier. -
SourcingEligUpdatedByName: string
Title:
Sourcing Eligibility Updated by Name
Maximum Length:240
User who most recently updated the sourcing eligibility for a supplier. -
SupplierId: integer
(int64)
Title:
Supplier ID
Value that uniquely identifies the supplier participating in sourcing eligibility. -
SupplierName: string
Title:
Supplier
Maximum Length:360
Name of the supplier participating in supplier eligibility.
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.
Examples
This example describes how to update one supplier eligibility record.
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/supplierEligibilities/EligibilityId"
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.
{ "SourcingEligibility": "Eligible", "SourcingComments": "Patch Update" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "EligibilityId": 300100184578699, "SupplierId": 600, "SupplierName": "Vision Corporation", "BusinessUnitId": 300100052386093, "BusinessUnitName": "Vision Brazil", "SourcingEligibilityCode": "ALLOWED", "SourcingEligibility": "Eligible", "SourcingAssessmentId": null, "SourcingAssessmentNumber": null, "SourcingEligUpdateDate": "2019-11-12T23:33:04.598+00:00", "SourcingEligUpdatedBy": 100010026863783, "SourcingEligUpdatedByName": "Clare Smith", "SourcingComments": "Patch Update", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierEligibilities/300100184578699", "name": "supplierEligibilities", "kind": "item", "properties": { "changeIndicator": ... } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierEligibilities/300100184578699", "name": "supplierEligibilities", "kind": "item" } ] }