Jump to

• Request
• Response
• Examples

Get all budget transaction types

get

/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes

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 budget transaction type that matches the primary key criteria specified.
    Finder Variables
    • TransactionTypeId; integer; The unique identifier of the budget transaction type.
• 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:
  

  • AnticipatedInCurrentFy; string; Indicates that the transaction is expected or anticipated to occur in the current fiscal year.
  • ApportionmentCategory; string; Apportionment category code of the budget transaction type.
  • BudgetLevel; string; Budget level of the budget transaction type.
  • CreatedBy; string; The user who created the record.
  • CreationDate; string; The date when the record was created.
  • Description; string; Description of the budget transaction type.
  • DirectOrReimbursable; string; The direct or reimbursable value of the budget transaction type.
  • Enabled; string; Indicates whether the budget transaction type is enabled or not.
  • FederalGroup; string; Federal group associated with the budget transaction type.
  • LastUpdateDate; string; The date when the record was last updated.
  • LastUpdateLogin; string; The last user login that was used to update the record.
  • LastUpdatedBy; string; The user who last updated the record.
  • LedgerName; string; Ledger name used for the transaction type.
  • Name; string; Name of the budget transaction type.
  • TransactionTypeId; integer; The unique identifier of the transaction type associated with the budget transaction type.
• 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:
  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 : fedBudgetTransactionTypes

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/fedBudgetTransactionTypes-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object fedBudgetTransactionTypes-item-response

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

Type: object

Show Source

• AnticipatedInCurrentFy: string
  Title: Anticipated

  Maximum Length: 255

  Indicates that the transaction is expected or anticipated to occur in the current fiscal year.
• ApportionmentCategory: string
  Title: Apportionment Category Code

  Maximum Length: 255

  Apportionment category code of the budget transaction type.
• BudgetLevel: string
  Title: Budget Level

  Budget level of the budget transaction type.
• 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.
• Description: string
  Title: Description

  Maximum Length: 240

  Description of the budget transaction type.
• DirectOrReimbursable: string
  Title: Direct or Reimbursable Code

  Maximum Length: 255

  The direct or reimbursable value of the budget transaction type.
• Enabled: string
  Title: Enabled

  Indicates whether the budget transaction type is enabled or not.
• fedBudgetTransactionTypeAccounts: array Federal Budget Transaction Type Accounts
  Title: Federal Budget Transaction Type Accounts

  The budget transaction type accounts resource is used to query, create, and update budget transaction type accounts.
• fedBudgetTransactionTypeDFF: array fedBudgetTransactionTypeDFF
• FederalGroup: string
  Title: Federal Group

  Federal group associated with the budget transaction type.
• 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.
• LedgerName: string
  Title: Ledger Name

  Maximum Length: 255

  Ledger name used for the transaction type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Transaction Type

  Maximum Length: 30

  Name of the budget transaction type.
• TransactionTypeId: integer (int64)
  Title: Transaction Type ID

  The unique identifier of the transaction type associated with the budget transaction type.

{
    "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
        },
        "AnticipatedInCurrentFy":{
            "title":"Anticipated",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates that the transaction is expected or anticipated to occur in the current fiscal year.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the budget transaction type.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DirectOrReimbursable":{
            "title":"Direct or Reimbursable Code",
            "maxLength":"255",
            "type":"string",
            "description":"The direct or reimbursable value of the budget transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionTypeId":{
            "title":"Transaction Type ID",
            "type":"integer",
            "description":"The unique identifier of the transaction type associated with the budget transaction type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "type":"string",
            "description":"Indicates whether the budget transaction type is enabled or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "Meaning"
                ]
            },
            "x-queryable":true
        },
        "FederalGroup":{
            "title":"Federal Group",
            "type":"string",
            "description":"Federal group associated with the budget transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "AccountValueSetId1",
                    "GroupName"
                ]
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Transaction Type",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the budget transaction type.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "fedBudgetTransactionTypeDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/fedBudgetTransactionTypes-fedBudgetTransactionTypeDFF-item-response"
            }
        },
        "fedBudgetTransactionTypeAccounts":{
            "title":"Federal Budget Transaction Type Accounts",
            "type":"array",
            "description":"The budget transaction type accounts resource is used to query, create, and update budget transaction type accounts.",
            "items":{
                "$ref":"#/components/schemas/fedBudgetTransactionTypes-fedBudgetTransactionTypeAccounts-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ApportionmentCategory":{
            "title":"Apportionment Category Code",
            "maxLength":"255",
            "type":"string",
            "description":"Apportionment category code of the budget transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LedgerName":{
            "title":"Ledger Name",
            "maxLength":"255",
            "type":"string",
            "description":"Ledger name used for the transaction type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LedgerId"
                ]
            },
            "x-queryable":true
        },
        "BudgetLevel":{
            "title":"Budget Level",
            "type":"string",
            "description":"Budget level of the budget transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "BudgetLevelName",
                    "FederalGroup",
                    "LedgerGroupId1"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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
        }
    }
}

Nested Schema : Federal Budget Transaction Type Accounts

Type: array

Title: Federal Budget Transaction Type Accounts

The budget transaction type accounts resource is used to query, create, and update budget transaction type accounts.

Show Source

• Array of: object fedBudgetTransactionTypes-fedBudgetTransactionTypeAccounts-item-response

{
    "title":"Federal Budget Transaction Type Accounts",
    "type":"array",
    "description":"The budget transaction type accounts resource is used to query, create, and update budget transaction type accounts.",
    "items":{
        "$ref":"#/components/schemas/fedBudgetTransactionTypes-fedBudgetTransactionTypeAccounts-item-response"
    }
}

Nested Schema : fedBudgetTransactionTypeDFF

Type: array

Show Source

• Array of: object fedBudgetTransactionTypes-fedBudgetTransactionTypeDFF-item-response

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

Type: object

Show Source

• AccountAssignmentId: integer (int64)
  The unique identifier of the account assignment associated with the budget transaction type account.
• 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.
• CreditAccount: string
  Title: Credit

  Maximum Length: 25

  Credit account of the budget transaction type account.
• CreditAccountDescription: string
  Title: Description

  Description of the credit account associated with the budget transaction type account.
• DebitAccount: string
  Title: Debit

  Maximum Length: 25

  Debit account of the budget transaction type account.
• DebitAccountDescription: string
  Title: Description

  Description of the debit account associated with the budget transaction type account.
• fedBudgetTransactionAccountDFF: array fedBudgetTransactionAccountDFF
• 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.

{
    "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
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditAccount":{
            "title":"Credit",
            "maxLength":"25",
            "type":"string",
            "description":"Credit account of the budget transaction type account.",
            "nullable":false,
            "x-hints":{
                "FND_ACFF_VF_CreditAccountSin__4001":"c",
                "FND_ACFF_VF_CreditAccountSin__3001":"c",
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "FND_ACFF_VF_CreditAccountSin__2001":"c",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AccountAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of the account assignment associated with the budget transaction type account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DebitAccountDescription":{
            "title":"Description",
            "type":"string",
            "description":"Description of the debit account associated with the budget transaction type account.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "fedBudgetTransactionAccountDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/fedBudgetTransactionTypes-fedBudgetTransactionTypeAccounts-fedBudgetTransactionAccountDFF-item-response"
            }
        },
        "DebitAccount":{
            "title":"Debit",
            "maxLength":"25",
            "type":"string",
            "description":"Debit account of the budget transaction type account.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "FND_ACFF_VF_AccountStructureInstanceId__2001":"c",
                "FND_ACFF_VF_AccountStructureInstanceId__3001":"c",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "FND_ACFF_VF_AccountStructureInstanceId__4001":"c",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreditAccountDescription":{
            "title":"Description",
            "type":"string",
            "description":"Description of the credit account associated with the budget transaction type account.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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
        }
    }
}

Nested Schema : fedBudgetTransactionAccountDFF

Type: array

Show Source

• Array of: object fedBudgetTransactionTypes-fedBudgetTransactionTypeAccounts-fedBudgetTransactionAccountDFF-item-response

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

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• AccountAssignmentId: 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"
            }
        },
        "AccountAssignmentId":{
            "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_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."
        }
    }
}

Nested Schema : fedBudgetTransactionTypes-fedBudgetTransactionTypeDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• links: array Links
  Title: Links

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

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

Back to Top

Examples

The following example shows how to retrieve all the budget transaction types 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/fedBudgetTransactionTypes

Example Response Body

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

{
    "items": [
        {
            "TransactionTypeId": 300100542845797,
            "Name": "BTT",
            "FederalGroup": "US Federal3 US Group Name",
            "Description": "BTT",
            "BudgetLevel": "Allocation",
            "AuthorityType": null,
            "CloseBudget": "No",
            "RequireTradingPartner": "No",
            "RequireReductionType": "No",
            "Enabled": "Yes",
            "CreatedBy": "FEDERAL",
            "CreationDate": "2021-07-06T04:39:52.015+00:00",
            "LastUpdatedBy": "FEDERAL",
            "LastUpdateDate": "2021-07-06T04:39:53.082+00:00",
            "LastUpdateLogin": "C5EC832E1EBD926AE053BB28F70A7FB0",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/300100542845797",
                    "name": "fedBudgetTransactionTypes",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/300100542845797",
                    "name": "fedBudgetTransactionTypes",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/300100542845797/child/fedBudgetTransactionTypeAccounts",
                    "name": "fedBudgetTransactionTypeAccounts",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/300100542845797/child/fedBudgetTransactionTypeDFF",
                    "name": "fedBudgetTransactionTypeDFF",
                    "kind": "collection"
                }
            ]
        },
        {
            "TransactionTypeId": 300100543686962,
            "Name": "Safety BTT",
            "FederalGroup": "Safety Group",
            "Description": "Safety Budget Transaction Types Description",
            "BudgetLevel": "Allocation",
            "AuthorityType": null,
            "CloseBudget": "No",
            "RequireTradingPartner": "No",
            "RequireReductionType": "No",
            "Enabled": "Yes",
            "CreatedBy": "FEDERAL",
            "CreationDate": "2021-07-19T10:19:52.003+00:00",
            "LastUpdatedBy": "FEDERAL",
            "LastUpdateDate": "2021-07-19T10:19:52.063+00:00",
            "LastUpdateLogin": "C5EC832E773A926AE053BB28F70A7FB0",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/300100543686962",
                    "name": "fedBudgetTransactionTypes",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/300100543686962",
                    "name": "fedBudgetTransactionTypes",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/300100543686962/child/fedBudgetTransactionTypeAccounts",
                    "name": "fedBudgetTransactionTypeAccounts",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/300100543686962/child/fedBudgetTransactionTypeDFF",
                    "name": "fedBudgetTransactionTypeDFF",
                    "kind": "collection"
                }
            ]
        },
		...
    ],
    "count": 10,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes",
            "name": "fedBudgetTransactionTypes",
            "kind": "collection"
        }
    ]
}

Back to Top