Create a SAM exception message record
post
/fscmRestApi/resources/11.13.18.05/fedSAMVendorDetails/{SamTradingPartnerId}/child/fedSAMExceptionMessages
Request
Path Parameters
-
SamTradingPartnerId(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
-
Code: string
Title:
Exception Code
Maximum Length:30
Code of the SAM exception message record. -
Description: string
Title:
Exception Text
Maximum Length:4000
Description of the SAM exception message record. -
ExceptionUniqueId: integer
(int64)
Title:
Exception Unique Id
The unique identifier of the SAM exception message record. -
JobId: integer
(int64)
Title:
Job Id
Job identifier of the SAM exception message record. -
ProcessName: string
Title:
Process Name
Maximum Length:150
Process name of the SAM exception message record.
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 : fedSAMVendorDetails-fedSAMExceptionMessages-item-response
Type:
Show Source
object
-
Code: string
Title:
Exception Code
Maximum Length:30
Code of the SAM exception message record. -
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. -
Description: string
Title:
Exception Text
Maximum Length:4000
Description of the SAM exception message record. -
ExceptionUniqueId: integer
(int64)
Title:
Exception Unique Id
The unique identifier of the SAM exception message record. -
JobId: integer
(int64)
Title:
Job Id
Job identifier of the SAM exception message record. -
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
Date when the user who last updated the record logged in. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcessName: string
Title:
Process Name
Maximum Length:150
Process name of the SAM exception message record.
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 Federal SAM Trading Partner Details Exception Messages resource is used to manage details about the process error references for a Federal SAM Trading Partner Vendor Details.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedSAMVendorDetails/100100869784250/child/fedSAMExceptionMessages
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "Code": "CASHBANKBRANCHES", "Description": "400: The Routing Number field is invalid. Enter a correct value for the Routing Number field. (CE-660076)", "ProcessName": "SAM Custom REST Process for CASHBANKBRANCHES" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "ExceptionUniqueId": 300100566955898, "Code": "CASHBANKBRANCHES", "Description": "400: The Routing Number field is invalid. Enter a correct value for the Routing Number field. (CE-660076)", "ProcessName": "SAM Custom REST Process for CASHBANKBRANCHES", "JobId": null, "CreationDate": "2022-12-02T09:51:08+00:00", "CreatedBy": "FEDBUYER", "LastUpdateDate": "2022-12-02T09:51:08.034+00:00", "LastUpdatedBy": "FEDBUYER", "LastUpdateLogin": "EB5F93A196E62228E053CF2FF70A1C0F", "links": [ { "rel": "self", "href": "https://fuscdrmsmc58-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.18.05/fedSAMVendorDetails/100100869784250/child/fedSAMExceptionMessages/300100566955898", "name": "fedSAMExceptionMessages", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://fuscdrmsmc58-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.18.05/fedSAMVendorDetails/100100869784250/child/fedSAMExceptionMessages/300100566955898", "name": "fedSAMExceptionMessages", "kind": "item" }, { "rel": "parent", "href": "https://fuscdrmsmc58-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.18.05/fedSAMVendorDetails/100100869784250", "name": "fedSAMVendorDetails", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://fuscdrmsmc58-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.18.05/fedSAMVendorDetails/100100869784250/child/fedSAMExceptionMessages", "name": "fedSAMExceptionMessages", "kind": "collection" } ] }