Create business event type codes
post
/fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodes
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AdjustmentBETCCode: string
Title:
Adjustment BETC
Maximum Length:8
Adjustment BETC code of the business event type code. -
BusinessEventType: string
Title:
Type
Maximum Length:255
Type of the business event type code. -
BusinessEventTypeCode(required): string
Title:
Business Event Type
Maximum Length:8
Code of the business event type code. -
BusinessEventTypeId: integer
Unique identifier of the business event type code.
-
BusinessEventTypeName(required): string
Title:
BETC
Maximum Length:100
Name of the business event type code. -
Enabled: string
Title:
Enabled
Maximum Length:255
Indicates whether the business event type code is enabled. -
fedBusinessEventTypeCodeDFF: array
fedBusinessEventTypeCodeDFF
-
FundingDerivationType: string
Title:
Funding Derivation Type
Maximum Length:255
Type of funding derivation associated with the adjustment business event type codes list of values. The valid values are Derived from General Fund, Not Derived from General Fund. -
PaymentOrCollection: string
Title:
Payment or Collection
Maximum Length:255
Indicates whether the BETC is a payment or collection.
Nested Schema : fedBusinessEventTypeCodes-fedBusinessEventTypeCodeDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
BusinessEventTypeId: integer
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 : fedBusinessEventTypeCodes-item-response
Type:
Show Source
object
-
AdjustmentBETCCode: string
Title:
Adjustment BETC
Maximum Length:8
Adjustment BETC code of the business event type code. -
BusinessEventType: string
Title:
Type
Maximum Length:255
Type of the business event type code. -
BusinessEventTypeCode: string
Title:
Business Event Type
Maximum Length:8
Code of the business event type code. -
BusinessEventTypeId: integer
Unique identifier of the business event type code.
-
BusinessEventTypeName: string
Title:
BETC
Maximum Length:100
Name of the business event type code. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
Enabled: string
Title:
Enabled
Maximum Length:255
Indicates whether the business event type code is enabled. -
fedBusinessEventTypeCodeDFF: array
fedBusinessEventTypeCodeDFF
-
FundingDerivationType: string
Title:
Funding Derivation Type
Maximum Length:255
Type of funding derivation associated with the adjustment business event type codes list of values. The valid values are Derived from General Fund, Not Derived from General Fund. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The last user login that was used to update the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentOrCollection: string
Title:
Payment or Collection
Maximum Length:255
Indicates whether the BETC is a payment or collection.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedBusinessEventTypeCodes-fedBusinessEventTypeCodeDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
BusinessEventTypeId: integer
-
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
- adjBusinessEventTypeCodes
-
The following properties are defined on the LOV link relation:
- Source Attribute: AdjustmentBETCCode; Target Attribute: BusinessEventTypeCode
- Display Attribute: BusinessEventTypeCode, BusinessEventTypeName
- fedBusinessEventTypeCodeDFF
-
Parameters:
- BusinessEventTypeId:
$request.path.BusinessEventTypeId
- BusinessEventTypeId:
Examples
The following example shows how to create federal business event type codes by submitting a POST request on the REST resource using cURL.
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/fedBusinessEventTypeCodes
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "BusinessEventTypeCode": "EXAMPLE", "BusinessEventTypeName": "Example Test BETC", "BusinessEventType": "Adjustment", "AdjustmentBETCCode": null, "PaymentOrCollection": "Collection", "Enabled": "No" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "BusinessEventTypeId": 300100212885654, "BusinessEventTypeCode": "EXAMPLE", "BusinessEventTypeName": "Example Test BETC", "BusinessEventType": "Adjustment", "AdjustmentBETCCode": null, "PaymentOrCollection": "Collection", "Enabled": "No", "CreatedBy": "FEDERAL", "CreationDate": "2020-12-07T10:47:59+00:00", "LastUpdateDate": "2020-12-07T10:48:00.334+00:00", "LastUpdateLogin": "B234192A81E6B33EE053D9B1F20A2590", "LastUpdatedBy": "FEDERAL", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodes/300100212885654", "name": "fedBusinessEventTypeCodes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodes/300100212885654", "name": "fedBusinessEventTypeCodes", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodes/300100212885654/child/fedBusinessEventTypeCodeDFF", "name": "fedBusinessEventTypeCodeDFF", "kind": "collection" } ] }