Update a pay group
patch
/fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingPayGroups/{NettingPayGroupId}
Request
Path Parameters
-
NettingPayGroupId(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=
-
nettingAgreementsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Netting Agreements resource and used to uniquely identify an instance of Netting Agreements. The client should not generate the hash key value. Instead, the client should query on the Netting Agreements collection resource in order to navigate to a specific instance of Netting Agreements to get the hash key.
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
-
NettingPayGroupId: integer
(int64)
The unique identifier of the pay group.
-
PayGroup: string
Maximum Length:
255
The pay group associated with the netting agreement.
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 : nettingAgreements-nettingPayGroups-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NettingPayGroupId: integer
(int64)
The unique identifier of the pay group.
-
PayGroup: string
Maximum Length:
255
The pay group associated with the netting agreement.
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
The following example shows how to update a pay group for a netting agreement by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100548064810/child/nettingPayablesInvoiceTypes/300100548119835
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "PayablesInvoiceType" : "Credit memo" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "NettingInvTypeId": 300100548119835, "PayablesInvoiceType": "Credit memo", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100548064810/child/nettingPayablesInvoiceTypes/300100548119835", "name": "nettingPayablesInvoiceTypes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100548064810/child/nettingPayablesInvoiceTypes/300100548119835", "name": "nettingPayablesInvoiceTypes", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100548064810", "name": "nettingAgreements", "kind": "item" } ] }