Jump to

• Request
• Response
• Examples

Get all fund attributes

get

/fscmRestApi/resources/11.13.18.05/fedFundAttributes

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the fund attribute that matches the primary key specified.
    Finder Variables
    • FundValueId; integer; Unique identifier for the fund attribute.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ApportionmentCategory; string; Apportionment category of the fund attribute.
  • AuthorityDuration; string; Authority duration code of the treasury account symbol.
  • BorrowingSource; string; Borrowing source of the fund attribute.
  • BudgetEnforcementAct; string; Budget enforcement code of the fund attribute.
  • BudgetSubfunction; string; Budget subfunction code of the fund attribute.
  • CopyFund; string; Indicates whether the fund information of the fund attribute will be copied to the next year.
  • CreatedBy; string; The user who created the record.
  • CreationDate; string; The date when the record was created.
  • CustodialOrNonCustodial; string; Custodial or noncustodial code of the fund attribute.
  • DefaultCollectionBetcCode; string; Default collection BETC code of the fund attribute.
  • DefaultCollectionBetcName; string; Default collection BETC name of the fund attribute.
  • DefaultPaymentBetcCode; string; Default payment BETC code of the fund attribute.
  • DefaultPaymentBetcName; string; Default payment BETC name of the fund attribute.
  • DefiniteOrIndefiniteAuthority; string; Definite or indefinite authority of the fund attribute.
  • DirectOrReimbursable; string; Direct or reimbursable code of the fund attribute.
  • FedAccountSymbolTitle; string; Federal account symbol title of the fund attribute.
  • FundCode; string; Fund code of the fund attribute.
  • FundStructureInstanceId; integer; Fund structure instance identifier of the fund attribute.
  • FundValueId; integer; Unique identifier for the fund attribute.
  • FundingDerivationType; string; 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; The date when the record was last updated.
  • LastUpdatedBy; string; The user who last updated the record.
  • Ledger; string; Ledger of the fund attribute.
  • LedgerId; integer; The unique identifier of the federal ledger.
  • NextYearFund; string; Next year fund value of the fund attribute.
  • OutlaysBeaCategory; string; Outlays BEA category of the fund attribute.
  • RequisitionClosingMethod; string; Requisition closing method of the fund attribute.
  • TreasuryAccountSymbol; string; Treasury account symbol of the fund attribute.
  • TreasuryAccountSymbolId; integer; Unique identifier of the treasury account symbol.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : fedFundAttributes

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/fedFundAttributes-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object fedFundAttributes-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/fedFundAttributes-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 : fedFundAttributes-item-response

Type: object

Show Source

• ApportionmentCategory: string
  Title: Apportionment Category Code

  Apportionment category of the fund attribute.
• AuthorityDuration: string
  Title: Authority Duration

  Maximum Length: 1

  Authority duration code of the treasury account symbol.
• BorrowingSource: string
  Title: Borrowing Source Code

  Borrowing source of the fund attribute.
• BudgetEnforcementAct: string
  Title: Budget Enforcement Act Category Code

  Default Value: Discretionary

  Budget enforcement code of the fund attribute.
• BudgetSubfunction: string
  Title: Budget Sub-Function Code

  Budget subfunction code of the fund attribute.
• CopyFund: string
  Title: Copy fund attributes to next year

  Indicates whether the fund information of the fund attribute will be copied to the next year.
• 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.
• CustodialOrNonCustodial: string
  Title: Custodial or Non-Custodial Code

  Default Value: Non-Custodial

  Custodial or noncustodial code of the fund attribute.
• DefaultCollectionBetcCode: string
  Title: Default Collection BETC

  Maximum Length: 8

  Default collection BETC code of the fund attribute.
• DefaultCollectionBetcName: string
  Title: Default Collection BETC Name

  Read Only: true

  Default collection BETC name of the fund attribute.
• DefaultPaymentBetcCode: string
  Title: Default Payment BETC

  Maximum Length: 8

  Default payment BETC code of the fund attribute.
• DefaultPaymentBetcName: string
  Title: Default Payment BETC Name

  Read Only: true

  Default payment BETC name of the fund attribute.
• DefiniteOrIndefiniteAuthority: string
  Title: Definite or Indefinite Authority

  Default Value: Definite

  Definite or indefinite authority of the fund attribute.
• DirectOrReimbursable: string
  Title: Direct or Reimbursable Code

  Direct or reimbursable code of the fund attribute.
• FedAccountSymbolTitle: string
  Title: Federal Account Symbol

  Federal account symbol title of the fund attribute.
• fedFundAttributeDFF: array fedFundAttributeDFF
• FundCode: string
  Title: Fund

  Maximum Length: 25

  Fund code of the fund attribute.
• FundingDerivationType: string
  Title: Funding Derivation Type

  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.
• FundStructureInstanceId: integer (int64)
  Title: Fund Structure Instance ID

  Fund structure instance identifier of the fund attribute.
• FundValueId: integer (int64)
  Title: Fund Value ID

  Unique identifier for the fund attribute.
• 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.
• Ledger: string
  Title: Ledger

  Ledger of the fund attribute.
• LedgerId: integer (int64)
  Title: Ledger

  The unique identifier of the federal ledger.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NextYearFund: string
  Title: Next Year Fund

  Maximum Length: 25

  Next year fund value of the fund attribute.
• OutlaysBeaCategory: string
  Title: Outlays BEA Category Code

  Default Value: Discretionary

  Outlays BEA category of the fund attribute.
• RequisitionClosingMethod: string
  Title: Requisition Closing Method

  Requisition closing method of the fund attribute.
• TreasuryAccountSymbol: string
  Title: Treasury Account Symbol

  Treasury account symbol of the fund attribute.
• TreasuryAccountSymbolId: integer (int64)
  Title: Treasury Account Symbol ID

  Unique identifier of the treasury account symbol.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TreasuryAccountSymbolId":{
            "title":"Treasury Account Symbol ID",
            "type":"integer",
            "description":"Unique identifier of the treasury account symbol.",
            "format":"int64",
            "nullable":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"
            },
            "x-queryable":true
        },
        "NextYearFund":{
            "title":"Next Year Fund",
            "maxLength":25,
            "type":"string",
            "description":"Next year fund value of the fund attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DefaultCollectionBetcName":{
            "title":"Default Collection BETC Name",
            "type":"string",
            "description":"Default collection BETC name of the fund attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "FundingDerivationTypeCode",
                    "LookupCode10",
                    "Meaning10"
                ]
            },
            "x-queryable":true
        },
        "OutlaysBeaCategory":{
            "title":"Outlays BEA Category Code",
            "type":"string",
            "description":"Outlays BEA category of the fund attribute.",
            "nullable":false,
            "default":"Discretionary",
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode8",
                    "Meaning8",
                    "OutlaysBeaCategoryCode"
                ]
            },
            "x-queryable":true
        },
        "BorrowingSource":{
            "title":"Borrowing Source Code",
            "type":"string",
            "description":"Borrowing source of the fund attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BorrowingSourceCode",
                    "LookupCode1",
                    "Meaning1"
                ]
            },
            "x-queryable":true
        },
        "FundStructureInstanceId":{
            "title":"Fund Structure Instance ID",
            "type":"integer",
            "description":"Fund structure instance identifier of the fund attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_FlexfieldCode":"GL#",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "FND_ACFF_ApplicationID":"101",
                "FND_ACFF_StructureLookupRequired":"false",
                "FND_ACFF_ModelID":"KFF_GL_GL_23_FV_5FTR_5FFUND_5FATTR_5FBALSEG_FV_5FTR_5FFUND_5FATTRIBUTES",
                "FND_ACFF_ApplicationShortName":"GL"
            },
            "x-queryable":true
        },
        "CopyFund":{
            "title":"Copy fund attributes to next year",
            "type":"string",
            "description":"Indicates whether the fund information of the fund attribute will be copied to the next year.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CopyFundFlag1",
                    "LookupCode4",
                    "Meaning4"
                ]
            },
            "x-queryable":true
        },
        "FundCode":{
            "title":"Fund",
            "maxLength":25,
            "type":"string",
            "description":"Fund code of the fund attribute.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FK_WHEREATTR_ADDL":"LookupType",
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.fnd.applcore.lookups.restModel.view.StandardLookupLOVVO",
                "fnd:FND_AUDIT_VALUE_ADDL":"'GL_BALANCING'",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Meaning",
                "fnd:FND_AUDIT_FK_WHEREATTR":"LookupCode"
            },
            "x-queryable":true
        },
        "fedFundAttributeDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/fedFundAttributes-fedFundAttributeDFF-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefiniteOrIndefiniteAuthority":{
            "title":"Definite or Indefinite Authority",
            "type":"string",
            "description":"Definite or indefinite authority of the fund attribute.",
            "nullable":false,
            "default":"Definite",
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DefiniteOrIndefiniteCode",
                    "LookupCode6",
                    "Meaning6"
                ]
            },
            "x-queryable":true
        },
        "RequisitionClosingMethod":{
            "title":"Requisition Closing Method",
            "type":"string",
            "description":"Requisition closing method of the fund attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode9",
                    "Meaning9",
                    "RequisitionClosingMethod2"
                ]
            },
            "x-queryable":true
        },
        "ApportionmentCategory":{
            "title":"Apportionment Category Code",
            "type":"string",
            "description":"Apportionment category of the fund attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ApportionmentCategoryCode",
                    "LookupCode",
                    "Meaning"
                ]
            },
            "x-queryable":true
        },
        "TreasuryAccountSymbol":{
            "title":"Treasury Account Symbol",
            "type":"string",
            "description":"Treasury account symbol of the fund attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LedgerId",
                    "TreasuryAccountSymbol1",
                    "TreasuryAccountSymbolId1"
                ]
            },
            "x-queryable":true
        },
        "DefaultPaymentBetcName":{
            "title":"Default Payment BETC Name",
            "type":"string",
            "description":"Default payment BETC name of the fund attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuthorityDuration":{
            "title":"Authority Duration",
            "maxLength":1,
            "type":"string",
            "description":"Authority duration code of the treasury account symbol.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "BudgetSubfunction":{
            "title":"Budget Sub-Function Code",
            "type":"string",
            "description":"Budget subfunction code of the fund attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BudgetSubfunctionCode",
                    "LookupCode3",
                    "Meaning3"
                ]
            },
            "x-queryable":true
        },
        "DirectOrReimbursable":{
            "title":"Direct or Reimbursable Code",
            "type":"string",
            "description":"Direct or reimbursable code of the fund attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DirectOrReimbursableCode",
                    "LookupCode7",
                    "Meaning7"
                ]
            },
            "x-queryable":true
        },
        "BudgetEnforcementAct":{
            "title":"Budget Enforcement Act Category Code",
            "type":"string",
            "description":"Budget enforcement code of the fund attribute.",
            "nullable":false,
            "default":"Discretionary",
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BudgetBeaCategoryCode",
                    "LookupCode2",
                    "Meaning2"
                ]
            },
            "x-queryable":true
        },
        "Ledger":{
            "title":"Ledger",
            "type":"string",
            "description":"Ledger of the fund attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "FundStructureInstanceId",
                    "LedgerId",
                    "Name"
                ]
            },
            "x-queryable":true
        },
        "LedgerId":{
            "title":"Ledger",
            "type":"integer",
            "description":"The unique identifier of the federal ledger.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CustodialOrNonCustodial":{
            "title":"Custodial or Non-Custodial Code",
            "type":"string",
            "description":"Custodial or noncustodial code of the fund attribute.",
            "nullable":false,
            "default":"Non-Custodial",
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CustodialNonCustodialCode",
                    "LookupCode5",
                    "Meaning5"
                ]
            },
            "x-queryable":true
        },
        "DefaultCollectionBetcCode":{
            "title":"Default Collection BETC",
            "maxLength":8,
            "type":"string",
            "description":"Default collection BETC code of the fund attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DefaultPaymentBetcCode":{
            "title":"Default Payment BETC",
            "maxLength":8,
            "type":"string",
            "description":"Default payment BETC code of the fund attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FedAccountSymbolTitle":{
            "title":"Federal Account Symbol",
            "type":"string",
            "description":"Federal account symbol title of the fund attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "FundValueId":{
            "title":"Fund Value ID",
            "type":"integer",
            "description":"Unique identifier for the fund attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "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":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : fedFundAttributeDFF

Type: array

Show Source

• Array of: object fedFundAttributes-fedFundAttributeDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/fedFundAttributes-fedFundAttributeDFF-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 : fedFundAttributes-fedFundAttributeDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• FundValueId: integer (int64)
• 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"
            }
        },
        "FundValueId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "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_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."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve all the fund attributes by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedFundAttributes

Example Response Body

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

{
    "items": [
        {
            "FundValueId": 300100211882265,
            "Ledger": "USFed1 US",
            "LedgerId": 300100125495724,
            "FundStructureInstanceId": 17520,
            "TreasuryAccountSymbol": "06918/210718",
            "AuthorityDuration": "M",
            "TreasuryAccountSymbolId": 300100211711868,
            "FundCode": "H075160118DB",
            "FedAccountSymbolTitle": "Capital Assistance for Passenger Service",
            "ApportionmentCategory": "Quarterly Apportionment",
            "DirectOrReimbursable": "Direct",
            "BudgetEnforcementAct": "Discretionary",
            "OutlaysBeaCategory": "Discretionary",
            "CustodialOrNonCustodial": "Non-Custodial",
            "DefiniteOrIndefiniteAuthority": "Definite",
            "BorrowingSource": null,
            "BudgetSubfunction": null,
            "CopyFund": "No",
            "NextYearFund": null,
            "RequisitionClosingMethod": "Closing",
            "CreatedBy": "FEDERAL",
            "CreationDate": "2020-12-10T12:11:36.002+00:00",
            "LastUpdatedBy": "FEDERAL",
            "LastUpdateDate": "2020-12-10T12:11:37.363+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedFundAttributes/300100211882265",
                    "name": "fedFundAttributes",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedFundAttributes/300100211882265",
                    "name": "fedFundAttributes",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedFundAttributes/300100211882265/child/fedFundAttributeDFF",
                    "name": "fedFundAttributeDFF",
                    "kind": "collection"
                }
            ]
        },
		...
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedFundAttributes",
            "name": "fedFundAttributes",
            "kind": "collection"
        }
    ]
}

Back to Top