Jump to

• Request
• Response
• Examples

Update a treasury account symbol business event type code

patch

/fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTASBusinessEventTypeCodes/{TasBetcMapId}

Request

Path Parameters

• TasBetcMapId(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=
• TreasuryAccountSymbolId(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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BusinessEventTypeCode: string
  Title: Business Event Type Codes

  Maximum Length: 8

  Code of the treasury account symbol business event type code.
• fedTASBusinessEventTypeCodeDFF: array fedTASBusinessEventTypeCodeDFF
• IsDefault: string
  Title: Default

  Indicates whether the treasury account symbol business event type code is default.
• TasBetcMapId: integer (int64)
  Title: TAS BETC Map ID

  Identifies the TAS BETC mapping of the treasury account symbol business event type code.

{
    "type":"object",
    "properties":{
        "BusinessEventTypeCode":{
            "title":"Business Event Type Codes",
            "maxLength":8,
            "type":"string",
            "description":"Code of the treasury account symbol business event type code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.financials.federal.treasury.setup.betcs.restPublicModel.view.BusinessEventTypeCodeLovVO",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"BusinessEventTypeName",
                "fnd:FND_AUDIT_FK_WHEREATTR":"BusinessEventTypeCode"
            }
        },
        "IsDefault":{
            "title":"Default",
            "type":"string",
            "description":"Indicates whether the treasury account symbol business event type code is default.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode",
                    "Meaning"
                ]
            }
        },
        "TasBetcMapId":{
            "title":"TAS BETC Map ID",
            "type":"integer",
            "description":"Identifies the TAS BETC mapping of the treasury account symbol business event type code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "fedTASBusinessEventTypeCodeDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/fedTreasuryAccountSymbols-fedTASBusinessEventTypeCodes-fedTASBusinessEventTypeCodeDFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : fedTASBusinessEventTypeCodeDFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/fedTreasuryAccountSymbols-fedTASBusinessEventTypeCodes-fedTASBusinessEventTypeCodeDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• TasBetcMapId: integer (int64)

{
    "type":"object",
    "properties":{
        "TasBetcMapId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "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"
                }
            }
        }
    }
}

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 : fedTreasuryAccountSymbols-fedTASBusinessEventTypeCodes-item-response

Type: object

Show Source

• AdjustmentBETC: string
  Title: Adjustment BETC

  Read Only: true

  Maximum Length: 8

  Adjustment BETC of the treasury account symbol business event type code.
• BusinessEventTypeCode: string
  Title: Business Event Type Codes

  Maximum Length: 8

  Code of the treasury account symbol business event type code.
• BusinessEventTypeName: string
  Title: Business Event Type Name

  Read Only: true

  Maximum Length: 100

  Name of the treasury account symbol business event type code.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• fedTASBusinessEventTypeCodeDFF: array fedTASBusinessEventTypeCodeDFF
• FundingDerivationType: string
  Title: Funding Derivation Type

  Read Only: true

  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.
• IsDefault: string
  Title: Default

  Indicates whether the treasury account symbol business event type code is default.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  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

  Read Only: true

  Maximum Length: 255

  Indicates whether the treasury account symbol BETC is a payment or collection type.
• TasBetcMapId: integer (int64)
  Title: TAS BETC Map ID

  Identifies the TAS BETC mapping of the treasury account symbol business event type code.
• TreasuryAccountSymbolId: integer (int64)
  Title: Treasury Account Symbol ID

  Read Only: true

  Unique identifier for the treasury account symbol business event type code.

{
    "type":"object",
    "properties":{
        "AdjustmentBETC":{
            "title":"Adjustment BETC",
            "maxLength":8,
            "type":"string",
            "description":"Adjustment BETC of the treasury account symbol business event type code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEventTypeCode":{
            "title":"Business Event Type Codes",
            "maxLength":8,
            "type":"string",
            "description":"Code of the treasury account symbol business event type code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.financials.federal.treasury.setup.betcs.restPublicModel.view.BusinessEventTypeCodeLovVO",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"BusinessEventTypeName",
                "fnd:FND_AUDIT_FK_WHEREATTR":"BusinessEventTypeCode"
            },
            "x-queryable":true
        },
        "BusinessEventTypeName":{
            "title":"Business Event Type Name",
            "maxLength":100,
            "type":"string",
            "description":"Name of the treasury account symbol business event type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "FundingDerivationType":{
            "title":"Funding Derivation Type",
            "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,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Meaning2"
                ]
            },
            "x-queryable":true
        },
        "IsDefault":{
            "title":"Default",
            "type":"string",
            "description":"Indicates whether the treasury account symbol business event type code is default.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode",
                    "Meaning"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The last user login that was used to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PaymentOrCollection":{
            "title":"Payment or Collection",
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the treasury account symbol BETC is a payment or collection type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Meaning1"
                ]
            },
            "x-queryable":true
        },
        "TasBetcMapId":{
            "title":"TAS BETC Map ID",
            "type":"integer",
            "description":"Identifies the TAS BETC mapping of the treasury account symbol business event type code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TreasuryAccountSymbolId":{
            "title":"Treasury Account Symbol ID",
            "type":"integer",
            "description":"Unique identifier for the treasury account symbol business event type code.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.financials.federal.treasury.setup.treasurySymbols.restPublicModel.view.TreasuryAccountSymbolsLovVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"TreasuryAccountSymbol",
                "fnd:FND_AUDIT_FK_WHEREATTR":"TreasuryAccountSymbolId"
            }
        },
        "fedTASBusinessEventTypeCodeDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/fedTreasuryAccountSymbols-fedTASBusinessEventTypeCodes-fedTASBusinessEventTypeCodeDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : fedTASBusinessEventTypeCodeDFF

Type: array

Show Source

• Array of: object fedTreasuryAccountSymbols-fedTASBusinessEventTypeCodes-fedTASBusinessEventTypeCodeDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/fedTreasuryAccountSymbols-fedTASBusinessEventTypeCodes-fedTASBusinessEventTypeCodeDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : fedTreasuryAccountSymbols-fedTASBusinessEventTypeCodes-fedTASBusinessEventTypeCodeDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TasBetcMapId: integer (int64)

{
    "type":"object",
    "properties":{
        "TasBetcMapId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

fedTASBusinessEventTypeCodeDFF

Operation: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTASBusinessEventTypeCodes/{TasBetcMapId}/child/fedTASBusinessEventTypeCodeDFF

Parameters:

• TasBetcMapId: $request.path.TasBetcMapId
• TreasuryAccountSymbolId: $request.path.TreasuryAccountSymbolId

Back to Top

Examples

The following example shows how to update a business event type code for a federal treasury account symbol by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/300100209351833/child/fedTASBusinessEventTypeCodes/300100209352028

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
"BusinessEventTypeCode":"ASDRDEC",
"IsDefault": "Yes"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "TasBetcMapId": 300100209352028,
    "TreasuryAccountSymbolId": 300100209351833,
    "BusinessEventTypeCode": "ASDRDEC",
    "BusinessEventTypeName": "Allocations of Special Drawing Rights, Decrease to Fund Balance",
    "PaymentOrCollection": "Collection",
    "AdjustmentBETC": "ASDRDCAJ",
    "IsDefault": "Yes",
    "CreatedBy": "FEDERAL",
    "CreationDate": "2020-08-26T09:09:38.026+00:00",
    "LastUpdateDate": "2020-08-26T10:17:19+00:00",
    "LastUpdateLogin": "ABC6E7208E78ACBAE0532988F40AE4A0",
    "LastUpdatedBy": "FEDERAL",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/300100209351833/child/fedTASBusinessEventTypeCodes/300100209352028",
            "name": "fedTASBusinessEventTypeCodes",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/300100209351833/child/fedTASBusinessEventTypeCodes/300100209352028",
            "name": "fedTASBusinessEventTypeCodes",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/300100209351833",
            "name": "fedTreasuryAccountSymbols",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/300100209351833/child/fedTASBusinessEventTypeCodes/300100209352028/child/fedTASBusinessEventTypeCodeDFF",
            "name": "fedTASBusinessEventTypeCodeDFF",
            "kind": "collection"
        }
    ]
}

Back to Top