Update descriptive flexfields for an invoice
patch
/fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceDff/{InvoiceId}
Request
Path Parameters
-
InvoiceId(required): integer(int64)
The unique identifier for the invoice to which the descriptive flexfield is associated.
-
invoicesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Invoices resource and used to uniquely identify an instance of Invoices. The client should not generate the hash key value. Instead, the client should query on the Invoices collection resource in order to navigate to a specific instance of Invoices 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
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
The descriptive flexfield context name for the invoice. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
The descriptive flexfield context display value for the invoice.
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 : invoices-invoiceDff-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
The descriptive flexfield context name for the invoice. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
The descriptive flexfield context display value for the invoice. -
InvoiceId: integer
(int64)
Title:
Invoice ID
The unique identifier for the invoice to which the descriptive flexfield is associated. -
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
- LVVO_V___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D200%2CBind_DescriptiveFlexfieldCode%3DAP_INVOICES
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Name
- Display Attribute: Name, Description
- finder:
- LVVO___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D200%2CBind_DescriptiveFlexfieldCode%3DAP_INVOICES
The following properties are defined on the LOV link relation:- Source Attribute: __FLEX_Context; Target Attribute: ContextCode
- Display Attribute: Name
- finder:
Examples
The following example shows how to update a descriptive flexfield for an invoice by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceDff/300100128521001
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "ProcessingQueue": "Section 2" }
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "InvoiceId": 300100155475915, "ProcessingQueue": "Section 2", "__FLEX_Context": "Additional information", "__FLEX_Context_DisplayValue": "Additional Information", "InvoicePriority": "Urgent", "Confidential": "Yes", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155475915/child/invoiceDff/300100155475915", "name": "invoiceDff", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155475915/child/invoiceDff/300100155475915", "name": "invoiceDff", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155475915", "name": "invoices", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100155475915/child/invoiceDff/300100155475915/lov/LVVO___FLEX_Context", "name": "LVVO___FLEX_Context", "kind": "collection" } ] }