Jump to

• Request
• Response

Get a federal fund attribute

get

/fscmRestApi/resources/11.13.18.05/fedFundAttributesLOV/{fedFundAttributesLOVUniqID}

Request

Path Parameters

• fedFundAttributesLOVUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Federal Fund Attributes List of Values resource and used to uniquely identify an instance of Federal Fund Attributes List of Values. The client should not generate the hash key value. Instead, the client should query on the Federal Fund Attributes List of Values collection resource in order to navigate to a specific instance of Federal Fund Attributes List of Values to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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:
  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 : fedFundAttributesLOV-item-response

Type: object

Show Source

• AgencyIdentifier: string
  Title: Agency Identifier

  Read Only: true

  Maximum Length: 255

  Agency identifier of the federal fund attributes list of values.
• ApportionmentCategory: string
  Title: Apportionment Category Code

  Read Only: true

  Maximum Length: 255

  Apportionment category code of the federal fund attributes list of values.
• AuthorityDurationCode: string
  Title: Authority Duration Code

  Read Only: true

  Maximum Length: 30

  Authority duration code of the federal fund attributes list of values.
• BorrowingSource: string
  Title: Borrowing Source Code

  Read Only: true

  Maximum Length: 255

  Borrowing source of the federal fund attributes list of values.
• BudgetEnforcementAct: string
  Title: Budget Enforcement Act Category Code

  Read Only: true

  Maximum Length: 255

  Budget enforcement act of the federal fund attributes list of values.
• BudgetSubfunction: string
  Title: Budget Subfunction Code

  Read Only: true

  Maximum Length: 255

  Budget subfunction of the federal fund attributes list of values.
• CustodialOrNonCustodial: string
  Title: Custodial or Noncustodial Code

  Read Only: true

  Maximum Length: 255

  Custodial or noncustodial of the federal fund attributes list of values.
• DefiniteOrIndefiniteAuthority: string
  Title: Definite or Indefinite Authority

  Read Only: true

  Maximum Length: 255

  Definite or indefinite authority of the federal fund attributes list of values.
• DirectOrReimbursable: string
  Title: Direct or Reimbursable Code

  Read Only: true

  Maximum Length: 255

  Direct or reimbursable code of the federal fund attributes list of values.
• FederalAccountSymbolTitle: string
  Title: Federal Account Symbol Title

  Read Only: true

  Maximum Length: 255

  Federal account symbol title of the federal fund attributes list of values.
• FundCode: string
  Title: Fund

  Read Only: true

  Maximum Length: 25

  Fund code of the federal fund attributes list of values.
• FundValueId: integer (int64)
  Title: Fund Value ID

  Read Only: true

  Unique identifier of the federal fund value of the federal fund attributes list of values.
• Ledger: string
  Title: Ledger

  Read Only: true

  Maximum Length: 255

  Ledger of the federal fund attributes list of values.
• LedgerId: integer (int64)
  Title: Ledger ID

  Read Only: true

  Unique identifier of the ledger of the federal fund attributes list of values.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MainAccountCode: string
  Title: Main Account Code

  Read Only: true

  Maximum Length: 255

  Main account code of the federal fund attributes list of values.
• OutlaysBeaCategory: string
  Title: Outlays BEA Category Code

  Read Only: true

  Maximum Length: 255

  Outlays BEA category of the federal fund attributes list of values.
• TreasuryAccountSymbol: string
  Title: Treasury Account Symbol

  Read Only: true

  Maximum Length: 35

  Treasury account symbol of the federal fund attributes list of values.
• TreasuryAccountSymbolId: integer (int64)
  Title: Treasury Account Symbol ID

  Read Only: true

  Unique identifier of the treasury account symbol of the federal fund attributes list of values.
• YearOfBudgetAuthority: string
  Title: Year of Budget Authority

  Read Only: true

  Maximum Length: 255

  Identifies the year of budget authority indicator associated with the account list of values.

{
    "type":"object",
    "properties":{
        "TreasuryAccountSymbolId":{
            "title":"Treasury Account Symbol ID",
            "type":"integer",
            "description":"Unique identifier of the treasury account symbol of the federal fund attributes list of values.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BudgetSubfunction":{
            "title":"Budget Subfunction Code",
            "maxLength":"255",
            "type":"string",
            "description":"Budget subfunction of the federal fund attributes list of values.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "BudgetSubfunctionCode",
                    "LookupCode3",
                    "Meaning3"
                ]
            },
            "x-queryable":true
        },
        "DirectOrReimbursable":{
            "title":"Direct or Reimbursable Code",
            "maxLength":"255",
            "type":"string",
            "description":"Direct or reimbursable code of the federal fund attributes list of values.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "DirectOrReimbursableCode",
                    "LookupCode6",
                    "Meaning6"
                ]
            },
            "x-queryable":true
        },
        "BudgetEnforcementAct":{
            "title":"Budget Enforcement Act Category Code",
            "maxLength":"255",
            "type":"string",
            "description":"Budget enforcement act of the federal fund attributes list of values.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "BudgetBeaCategoryCode",
                    "LookupCode2",
                    "Meaning2"
                ]
            },
            "x-queryable":true
        },
        "Ledger":{
            "title":"Ledger",
            "maxLength":"255",
            "type":"string",
            "description":"Ledger of the federal fund attributes list of values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FederalAccountSymbolTitle":{
            "title":"Federal Account Symbol Title",
            "maxLength":"255",
            "type":"string",
            "description":"Federal account symbol title of the federal fund attributes list of values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LedgerId":{
            "title":"Ledger ID",
            "type":"integer",
            "description":"Unique identifier of the ledger of the federal fund attributes list of values.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AgencyIdentifier":{
            "title":"Agency Identifier",
            "maxLength":"255",
            "type":"string",
            "description":"Agency identifier of the federal fund attributes list of values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustodialOrNonCustodial":{
            "title":"Custodial or Noncustodial Code",
            "maxLength":"255",
            "type":"string",
            "description":"Custodial or noncustodial of the federal fund attributes list of values.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CustodialNonCustodialCode",
                    "LookupCode4",
                    "Meaning4"
                ]
            },
            "x-queryable":true
        },
        "OutlaysBeaCategory":{
            "title":"Outlays BEA Category Code",
            "maxLength":"255",
            "type":"string",
            "description":"Outlays BEA category of the federal fund attributes list of values.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LookupCode7",
                    "Meaning7",
                    "OutlaysBeaCategoryCode"
                ]
            },
            "x-queryable":true
        },
        "BorrowingSource":{
            "title":"Borrowing Source Code",
            "maxLength":"255",
            "type":"string",
            "description":"Borrowing source of the federal fund attributes list of values.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "BorrowingSourceCode",
                    "LookupCode1",
                    "Meaning1"
                ]
            },
            "x-queryable":true
        },
        "AuthorityDurationCode":{
            "title":"Authority Duration Code",
            "maxLength":"30",
            "type":"string",
            "description":"Authority duration code of the federal fund attributes list of values.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FundCode":{
            "title":"Fund",
            "maxLength":"25",
            "type":"string",
            "description":"Fund code of the federal fund attributes list of values.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FundValueId":{
            "title":"Fund Value ID",
            "type":"integer",
            "description":"Unique identifier of the federal fund value of the federal fund attributes list of values.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DefiniteOrIndefiniteAuthority":{
            "title":"Definite or Indefinite Authority",
            "maxLength":"255",
            "type":"string",
            "description":"Definite or indefinite authority of the federal fund attributes list of values.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "DefiniteOrIndefiniteCode",
                    "LookupCode5",
                    "Meaning5"
                ]
            },
            "x-queryable":true
        },
        "ApportionmentCategory":{
            "title":"Apportionment Category Code",
            "maxLength":"255",
            "type":"string",
            "description":"Apportionment category code of the federal fund attributes list of values.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ApportionmentCategoryCode",
                    "LookupCode",
                    "Meaning"
                ]
            },
            "x-queryable":true
        },
        "TreasuryAccountSymbol":{
            "title":"Treasury Account Symbol",
            "maxLength":"35",
            "type":"string",
            "description":"Treasury account symbol of the federal fund attributes list of values.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MainAccountCode":{
            "title":"Main Account Code",
            "maxLength":"255",
            "type":"string",
            "description":"Main account code of the federal fund attributes list of values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "YearOfBudgetAuthority":{
            "title":"Year of Budget Authority",
            "maxLength":"255",
            "type":"string",
            "description":"Identifies the year of budget authority indicator associated with the account list of values.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LookupCode8",
                    "Meaning8",
                    "YearOfBudgetAuthorityCode"
                ]
            },
            "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