Update a refund process
patch
/fscmRestApi/resources/11.13.18.05/hedRefunds/{RefundHeaderId}
Request
Path Parameters
-
RefundHeaderId(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
-
InputData: string
The JSON-formatted string that contains the parameters that control how the refund process runs.
-
ProcessStatusCode: string
Maximum Length:
80
Code representing the current status of the refund process.
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 : hedRefunds-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
Date and time of the creation of the row. -
InputData: string
The JSON-formatted string that contains the parameters that control how the refund process runs.
-
IsDeletableFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if a process is in a status where the delete action is valid. The value can be true or false based on whether the process is successful or not. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LogContents: string
(byte)
Read Only:
true
An attachment with the contents of the ESS log file for the process. -
LogFileName: string
Read Only:
true
Maximum Length:255
Name of the log file for the refund ESS process. -
ProcessId: integer
(int64)
Read Only:
true
Unique identifier of the scheduled process request. For Oracle Enterprise Scheduler ESS, this column stores the job request ID returned by ESS. -
ProcessStatusCode: string
Maximum Length:
80
Code representing the current status of the refund process. -
ProcessStatusMeaning: string
Read Only:
true
Maximum Length:80
Meaning associated with the process status code. -
RefundDescription: string
Maximum Length:
1000
User-defined description of the refund process. -
RefundHeaderId: integer
(int64)
Read Only:
true
Unique identifier of the higher education refund process. -
RefundName: string
Maximum Length:
50
User-defined name of the refund process.
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.