Update a setup option
patch
/fscmRestApi/resources/11.13.18.05/fedSetupOptions/{ConfigOptionId}
Request
Path Parameters
-
ConfigOptionId(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
-
AgencyAbbreviation: string
Title:
PAM Agency Abbreviation
Maximum Length:4
Agency abbreviation of the setup option. -
BusinessUnit: string
Title:
Business Unit
Maximum Length:80
Business unit of the setup option. -
ConfigOptionId: integer
(int64)
Title:
Configuration Option ID
Unique identifier of the setup option. -
DefaultDiscountLostReason: string
Title:
Default Discount Lost Reason
Maximum Length:255
Default discount lost reason for the setup option. -
DefaultInterestReason: string
Title:
Default Interest Reason
Maximum Length:255
Default interest reason for the setup option. -
FederalEmployerNumber: integer
(int64)
Title:
Federal Employer ID Number
Federal employer ID for the setup option. -
fedSetupOptionDFF: array
fedSetupOptionDFF
-
PamInputSystemName: string
Title:
PAM Input System
Maximum Length:40
The name of the PAM input system associated with the setup option. -
SAMDefaultBank: string
Title:
SAM Default Bank
Maximum Length:255
SAM default bank for the setup option. -
SAMDefaultBranch: string
Title:
SAM Default Bank Branch
Maximum Length:255
SAM default branch for the setup option.
Nested Schema : fedSetupOptions-fedSetupOptionDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
ConfigOptionId: integer
(int64)
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 : fedSetupOptions-item-response
Type:
Show Source
object
-
AgencyAbbreviation: string
Title:
PAM Agency Abbreviation
Maximum Length:4
Agency abbreviation of the setup option. -
BusinessUnit: string
Title:
Business Unit
Maximum Length:80
Business unit of the setup option. -
ConfigOptionId: integer
(int64)
Title:
Configuration Option ID
Unique identifier of the setup option. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
DefaultDiscountLostReason: string
Title:
Default Discount Lost Reason
Maximum Length:255
Default discount lost reason for the setup option. -
DefaultInterestReason: string
Title:
Default Interest Reason
Maximum Length:255
Default interest reason for the setup option. -
FederalEmployerNumber: integer
(int64)
Title:
Federal Employer ID Number
Federal employer ID for the setup option. -
fedSetupOptionDFF: array
fedSetupOptionDFF
-
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PamInputSystemName: string
Title:
PAM Input System
Maximum Length:40
The name of the PAM input system associated with the setup option. -
SAMDefaultBank: string
Title:
SAM Default Bank
Maximum Length:255
SAM default bank for the setup option. -
SAMDefaultBranch: string
Title:
SAM Default Bank Branch
Maximum Length:255
SAM default branch for the setup option.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedSetupOptions-fedSetupOptionDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
ConfigOptionId: integer
(int64)
-
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
- fedSetupOptionDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/fedSetupOptions/{ConfigOptionId}/child/fedSetupOptionDFFParameters:
- ConfigOptionId:
$request.path.ConfigOptionId
- ConfigOptionId:
Examples
The following example shows how to update a federal setup option 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/fedSetupOptions/300100208866413
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "FederalEmployerNumber": 111888888, "AgencyAbbreviation": "5678" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "ConfigOptionId": 300100208866413, "BusinessUnit": "FederalBusinessUnit", "FederalEmployerNumber": 111888888, "AgencyAbbreviation": "5678", "DefaultInterestReason": "Late", "DefaultDiscountLostReason": "Discount Lost", "CreatedBy": "FEDERAL", "CreationDate": "2020-08-21T12:09:21+00:00", "LastUpdatedBy": "FEDERAL", "LastUpdateDate": "2020-08-21T12:15:03+00:00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedSetupOptions/300100208866413", "name": "fedSetupOptions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedSetupOptions/300100208866413", "name": "fedSetupOptions", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedSetupOptions/300100208866413/child/fedSetupOptionDFF", "name": "fedSetupOptionDFF", "kind": "collection" } ] }