Jump to

• Request
• Response
• Examples

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "required":[
        "BusinessEventTypeCode",
        "BusinessEventTypeName"
    ],
    "type":"object",
    "properties":{
        "BusinessEventTypeCode":{
            "title":"Business Event Type",
            "maxLength":"8",
            "type":"string",
            "description":"Code of the business event type code.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "BusinessEventTypeName":{
            "title":"BETC",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the business event type code.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "BusinessEventType":{
            "title":"Type",
            "maxLength":"255",
            "type":"string",
            "description":"Type of the business event type code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode",
                    "Meaning",
                    "TypeBusinessEventTypeCode"
                ]
            }
        },
        "AdjustmentBETCCode":{
            "title":"Adjustment BETC",
            "maxLength":"8",
            "type":"string",
            "description":"Adjustment BETC code of the business event type code.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "PaymentOrCollection"
                ]
            }
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates whether the business event type code is enabled.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ActiveFlag",
                    "LookupCode2",
                    "LookupType2",
                    "Meaning2"
                ]
            }
        },
        "BusinessEventTypeId":{
            "type":"integer",
            "description":"Unique identifier of the business event type code.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "FundingDerivationType":{
            "title":"Funding Derivation Type",
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "FundingDerivationTypeCode",
                    "LookupCode3",
                    "Meaning3"
                ]
            }
        },
        "PaymentOrCollection":{
            "title":"Payment or Collection",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates whether the BETC is a payment or collection.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode1",
                    "Meaning1",
                    "PaymentOrCollectionCode"
                ]
            }
        },
        "fedBusinessEventTypeCodeDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/fedBusinessEventTypeCodes-fedBusinessEventTypeCodeDFF-item-post-request"
            }
        }
    }
}

Nested Schema : fedBusinessEventTypeCodeDFF

Type: array

Show Source

• Array of: object fedBusinessEventTypeCodes-fedBusinessEventTypeCodeDFF-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/fedBusinessEventTypeCodes-fedBusinessEventTypeCodeDFF-item-post-request"
    }
}

Nested Schema : fedBusinessEventTypeCodes-fedBusinessEventTypeCodeDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• BusinessEventTypeId: integer

{
    "type":"object",
    "properties":{
        "BusinessEventTypeId":{
            "type":"integer",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : fedBusinessEventTypeCodes-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEventTypeCode":{
            "title":"Business Event Type",
            "maxLength":"8",
            "type":"string",
            "description":"Code of the business event type code.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentBETCCode":{
            "title":"Adjustment BETC",
            "maxLength":"8",
            "type":"string",
            "description":"Adjustment BETC code of the business event type code.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "PaymentOrCollection"
                ]
            },
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates whether the business event type code is enabled.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ActiveFlag",
                    "LookupCode2",
                    "LookupType2",
                    "Meaning2"
                ]
            },
            "x-queryable":true
        },
        "FundingDerivationType":{
            "title":"Funding Derivation Type",
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "FundingDerivationTypeCode",
                    "LookupCode3",
                    "Meaning3"
                ]
            },
            "x-queryable":true
        },
        "fedBusinessEventTypeCodeDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/fedBusinessEventTypeCodes-fedBusinessEventTypeCodeDFF-item-response"
            }
        },
        "BusinessEventTypeName":{
            "title":"BETC",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the business event type code.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BusinessEventType":{
            "title":"Type",
            "maxLength":"255",
            "type":"string",
            "description":"Type of the business event type code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode",
                    "Meaning",
                    "TypeBusinessEventTypeCode"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessEventTypeId":{
            "type":"integer",
            "description":"Unique identifier of the business event type code.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The last user login that was used to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentOrCollection":{
            "title":"Payment or Collection",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates whether the BETC is a payment or collection.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode1",
                    "Meaning1",
                    "PaymentOrCollectionCode"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : fedBusinessEventTypeCodeDFF

Type: array

Show Source

• Array of: object fedBusinessEventTypeCodes-fedBusinessEventTypeCodeDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/fedBusinessEventTypeCodes-fedBusinessEventTypeCodeDFF-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : fedBusinessEventTypeCodes-fedBusinessEventTypeCodeDFF-item-response

Type: object

Show Source

• __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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessEventTypeId":{
            "type":"integer",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

adjBusinessEventTypeCodes

Operation: /fscmRestApi/resources/11.13.18.05/fedBETCAdjustmentsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: AdjustmentBETCCode; Target Attribute: BusinessEventTypeCode
• Display Attribute: BusinessEventTypeCode, BusinessEventTypeName

fedBusinessEventTypeCodeDFF

Operation: /fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodes/{BusinessEventTypeId}/child/fedBusinessEventTypeCodeDFF

Parameters:

• BusinessEventTypeId: $request.path.BusinessEventTypeId

Back to Top

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"
        }
    ]
} 

Back to Top