Jump to

• Request
• Response

Create a budget execution control

post

/fscmRestApi/resources/11.13.18.05/fedBudgetExecutionControls

Request

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AllowOverrides: string
  Default Value: No

  Allow overrides associated with the budget execution control.
• BudgetAccount: string
  Maximum Length: 25

  Budget account of the budget execution control.
• BudgetCategory: string
  Title: Budget Category

  Budget category of the budget execution control.
• BudgetControl(required): string
  Maximum Length: 50

  Budget control of the budget execution control.
• BudgetDistributionAccount: string
  Title: Distribution GL Account

  Maximum Length: 25

  Budget distribution account of the budget execution control.
• BudgetLevel: string
  Title: Budget Level

  Budget level of the budget execution control.
• BudgetManager: string
  Title: Budget Manager

  Name of the budget manager associated with the budget execution control.
• ClosingTransactionType: string
  Title: Closing Transaction Type

  Closing transaction type of the budget execution control.
• ConsumeBudget: string
  Title: Consume Budget

  Consume budget of the budget execution control.
• ControlLevel: string
  Title: Control Level

  Control level of the budget execution control.
• DefaultTransactionType: string
  Title: Default Transaction Type ID

  Default transaction type of the budget execution control.
• Description: string
  Title: Description

  Maximum Length: 240

  Description of the budget execution control.
• DistributeBudget: string
  Title: Distribute Budget

  Distribute budget of the budget execution control.
• fedBudgetControlSegments: array Federal Budget Execution Control Segments
  Title: Federal Budget Execution Control Segments

  The federal budget execution control segments resource is used to query, create, and update budget execution control segments.
• Ledger: string
  Title: Ledger

  Ledger of the budget execution control.
• ParentBudgetControl: string
  Title: Parent Budgetary Control Type

  Parent budget control of the budget execution control.
• ParentBudgetLevel: string
  Title: Parent Budget Level

  Parent budget level of the budget execution control.
• Status: string
  Title: Status

  Status of the budget execution control.
• ToleranceAmount: number
  Title: Tolerance Amount

  Tolerance amount of the budget execution control.
• TolerancePercent: number
  Title: Tolerance Percentage

  Tolerance percentage of the budget execution control.

{
    "required":[
        "BudgetControl"
    ],
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "type":"string",
            "description":"Status of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Meaning"
                ]
            }
        },
        "BudgetDistributionAccount":{
            "title":"Distribution GL Account",
            "maxLength":"25",
            "type":"string",
            "description":"Budget distribution account of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FedGroupBudgetTypeTreeCode"
                ]
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the budget execution control.",
            "nullable":true
        },
        "DefaultTransactionType":{
            "title":"Default Transaction Type ID",
            "type":"string",
            "description":"Default transaction type of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BudgetLevel",
                    "LedgerGroupId",
                    "Name1"
                ]
            }
        },
        "BudgetAccount":{
            "maxLength":"25",
            "type":"string",
            "description":"Budget account of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "FedGroupBudgetTypeTreeCode"
                ]
            }
        },
        "Ledger":{
            "title":"Ledger",
            "type":"string",
            "description":"Ledger of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Name"
                ]
            }
        },
        "ToleranceAmount":{
            "title":"Tolerance Amount",
            "type":"number",
            "description":"Tolerance amount of the budget execution control.",
            "nullable":true
        },
        "ParentBudgetLevel":{
            "title":"Parent Budget Level",
            "type":"string",
            "description":"Parent budget level of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BudgetLevel2"
                ]
            }
        },
        "BudgetControl":{
            "maxLength":"50",
            "type":"string",
            "description":"Budget control of the budget execution control.",
            "nullable":false
        },
        "AllowOverrides":{
            "type":"string",
            "description":"Allow overrides associated with the budget execution control.",
            "nullable":true,
            "default":"No",
            "x-queryable":false
        },
        "BudgetManager":{
            "title":"Budget Manager",
            "type":"string",
            "description":"Name of the budget manager associated with the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DistributeBudget":{
            "title":"Distribute Budget",
            "type":"string",
            "description":"Distribute budget of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Meaning4"
                ]
            }
        },
        "ConsumeBudget":{
            "title":"Consume Budget",
            "type":"string",
            "description":"Consume budget of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BudgetLevelId",
                    "Meaning5"
                ]
            }
        },
        "BudgetCategory":{
            "title":"Budget Category",
            "type":"string",
            "description":"Budget category of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Meaning6"
                ]
            }
        },
        "ClosingTransactionType":{
            "title":"Closing Transaction Type",
            "type":"string",
            "description":"Closing transaction type of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Name2"
                ]
            }
        },
        "fedBudgetControlSegments":{
            "title":"Federal Budget Execution Control Segments",
            "type":"array",
            "description":"The federal budget execution control segments resource is used to query, create, and update budget execution control segments.",
            "items":{
                "$ref":"#/components/schemas/fedBudgetExecutionControls-fedBudgetControlSegments-item-post-request"
            }
        },
        "ControlLevel":{
            "title":"Control Level",
            "type":"string",
            "description":"Control level of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Meaning2"
                ]
            }
        },
        "TolerancePercent":{
            "title":"Tolerance Percentage",
            "type":"number",
            "description":"Tolerance percentage of the budget execution control.",
            "nullable":true
        },
        "BudgetLevel":{
            "title":"Budget Level",
            "type":"string",
            "description":"Budget level of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BudgetLevel1"
                ]
            }
        },
        "ParentBudgetControl":{
            "title":"Parent Budgetary Control Type",
            "type":"string",
            "description":"Parent budget control of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BudgetLevel",
                    "ControlTypeName1"
                ]
            }
        }
    }
}

Nested Schema : Federal Budget Execution Control Segments

Type: array

Title: Federal Budget Execution Control Segments

The federal budget execution control segments resource is used to query, create, and update budget execution control segments.

Show Source

• Array of: object fedBudgetExecutionControls-fedBudgetControlSegments-item-post-request

{
    "title":"Federal Budget Execution Control Segments",
    "type":"array",
    "description":"The federal budget execution control segments resource is used to query, create, and update budget execution control segments.",
    "items":{
        "$ref":"#/components/schemas/fedBudgetExecutionControls-fedBudgetControlSegments-item-post-request"
    }
}

Nested Schema : fedBudgetExecutionControls-fedBudgetControlSegments-item-post-request

Type: object

Show Source

• ControlBudgetTree: string
  Title: Tree

  Control budget tree of the budget execution control segment.
• ControlBudgetTreeLabel: string
  Title: Tree Label

  Control budget tree label of the budget execution control segment.
• ControlBudgetTreeVersion: string
  Title: Tree Version

  Control budget tree version of the budget execution control segment.
• ExistsOnParent: string
  Default Value: N

  Exists on parent attribute of the budget execution control segment.
• FilterTree: string
  Title: Filter Tree

  Filter tree of the budget execution control segment.
• FilterTreeValue: string
  Title: Filter Summary Value

  Filter tree value of the budget execution control segment.
• FilterTreeVersion: string
  Title: Filter Tree Version

  Filter tree version of the budget execution control segment.
• IsAccountSegment: string
  Default Value: N

  Account segment of the budget execution control segment.
• IsBalancingSegment: string
  Default Value: N

  Balancing segment of the budget execution control segment.
• SegmentCode: string
  Title: Segment Name

  Segment code of the budget execution control segment.
• SegmentName: string
  Maximum Length: 30

  Segment name of the budget execution control segment.
• SequenceNumber: integer (int32)
  Title: Sequence

  Sequence number of the budget execution control segment.
• SummaryControl: string
  Title: Summary Control

  Summary control of the budget execution control segment.

{
    "type":"object",
    "properties":{
        "ControlBudgetTreeLabel":{
            "title":"Tree Label",
            "type":"string",
            "description":"Control budget tree label of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "IsBalancingSegment":{
            "type":"string",
            "description":"Balancing segment of the budget execution control segment.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ExistsOnParent"
                ]
            }
        },
        "SegmentName":{
            "maxLength":"30",
            "type":"string",
            "description":"Segment name of the budget execution control segment.",
            "nullable":false
        },
        "FilterTreeVersion":{
            "title":"Filter Tree Version",
            "type":"string",
            "description":"Filter tree version of the budget execution control segment.",
            "nullable":true
        },
        "FilterTreeValue":{
            "title":"Filter Summary Value",
            "type":"string",
            "description":"Filter tree value of the budget execution control segment.",
            "nullable":true
        },
        "ControlBudgetTree":{
            "title":"Tree",
            "type":"string",
            "description":"Control budget tree of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SummaryControl":{
            "title":"Summary Control",
            "type":"string",
            "description":"Summary control of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Meaning"
                ]
            }
        },
        "IsAccountSegment":{
            "type":"string",
            "description":"Account segment of the budget execution control segment.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ExistsOnParent"
                ]
            }
        },
        "ExistsOnParent":{
            "type":"string",
            "description":"Exists on parent attribute of the budget execution control segment.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SegmentCode":{
            "title":"Segment Name",
            "type":"string",
            "description":"Segment code of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FilterTree":{
            "title":"Filter Tree",
            "type":"string",
            "description":"Filter tree of the budget execution control segment.",
            "nullable":true,
            "x-queryable":false
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"Sequence number of the budget execution control segment.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"2"
            }
        },
        "ControlBudgetTreeVersion":{
            "title":"Tree Version",
            "type":"string",
            "description":"Control budget tree version of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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

Type: object

Show Source

• AllowOverrides: string
  Default Value: No

  Allow overrides associated with the budget execution control.
• BudgetAccount: string
  Maximum Length: 25

  Budget account of the budget execution control.
• BudgetCategory: string
  Title: Budget Category

  Budget category of the budget execution control.
• BudgetChartOfAccounts: string
  Read Only: true

  Budget chart of accounts of the budget execution control.
• BudgetControl: string
  Maximum Length: 50

  Budget control of the budget execution control.
• BudgetDistributionAccount: string
  Title: Distribution GL Account

  Maximum Length: 25

  Budget distribution account of the budget execution control.
• BudgetLevel: string
  Title: Budget Level

  Budget level of the budget execution control.
• BudgetLevelSequenceNumber: integer (int64)
  Title: Budget Level Sequence

  Read Only: true

  Budget level sequence number of the budget execution control.
• BudgetManager: string
  Title: Budget Manager

  Name of the budget manager associated with the budget execution control.
• ClosingTransactionType: string
  Title: Closing Transaction Type

  Closing transaction type of the budget execution control.
• ConsumeBudget: string
  Title: Consume Budget

  Consume budget of the budget execution control.
• ControlLevel: string
  Title: Control Level

  Control level of the budget execution control.
• ControlTypeId: integer (int64)
  Read Only: true

  The unique identifier of the control type associated with the budget execution control.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date when the record was created.
• DefaultTransactionType: string
  Title: Default Transaction Type ID

  Default transaction type of the budget execution control.
• Description: string
  Title: Description

  Maximum Length: 240

  Description of the budget execution control.
• DistributeBudget: string
  Title: Distribute Budget

  Distribute budget of the budget execution control.
• fedBudgetControlSegments: array Federal Budget Execution Control Segments
  Title: Federal Budget Execution Control Segments

  The federal budget execution control segments resource is used to query, create, and update budget execution control segments.
• isParentControl: string
  Read Only: true

  Parent control of the budget execution control.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date when the record was last updated.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Date when the user who last updated the record logged in.
• Ledger: string
  Title: Ledger

  Ledger of the budget execution control.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentBudgetControl: string
  Title: Parent Budgetary Control Type

  Parent budget control of the budget execution control.
• ParentBudgetLevel: string
  Title: Parent Budget Level

  Parent budget level of the budget execution control.
• Status: string
  Title: Status

  Status of the budget execution control.
• ToleranceAmount: number
  Title: Tolerance Amount

  Tolerance amount of the budget execution control.
• TolerancePercent: number
  Title: Tolerance Percentage

  Tolerance percentage of the budget execution control.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the budget execution control.",
            "nullable":true,
            "x-queryable":true
        },
        "ToleranceAmount":{
            "title":"Tolerance Amount",
            "type":"number",
            "description":"Tolerance amount of the budget execution control.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentBudgetLevel":{
            "title":"Parent Budget Level",
            "type":"string",
            "description":"Parent budget level of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BudgetLevel2"
                ]
            },
            "x-queryable":true
        },
        "BudgetLevelSequenceNumber":{
            "title":"Budget Level Sequence",
            "type":"integer",
            "description":"Budget level sequence number of the budget execution control.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DistributeBudget":{
            "title":"Distribute Budget",
            "type":"string",
            "description":"Distribute budget of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Meaning4"
                ]
            },
            "x-queryable":true
        },
        "ConsumeBudget":{
            "title":"Consume Budget",
            "type":"string",
            "description":"Consume budget of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BudgetLevelId",
                    "Meaning5"
                ]
            },
            "x-queryable":true
        },
        "BudgetCategory":{
            "title":"Budget Category",
            "type":"string",
            "description":"Budget category of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Meaning6"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "isParentControl":{
            "type":"string",
            "description":"Parent control of the budget execution control.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ControlTypeId":{
            "type":"integer",
            "description":"The unique identifier of the control type associated with the budget execution control.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BudgetLevel":{
            "title":"Budget Level",
            "type":"string",
            "description":"Budget level of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BudgetLevel1"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Date when the record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "type":"string",
            "description":"Status of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Meaning"
                ]
            },
            "x-queryable":true
        },
        "BudgetDistributionAccount":{
            "title":"Distribution GL Account",
            "maxLength":"25",
            "type":"string",
            "description":"Budget distribution account of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FedGroupBudgetTypeTreeCode"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BudgetChartOfAccounts":{
            "type":"string",
            "description":"Budget chart of accounts of the budget execution control.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Name3"
                ]
            },
            "x-queryable":true
        },
        "DefaultTransactionType":{
            "title":"Default Transaction Type ID",
            "type":"string",
            "description":"Default transaction type of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BudgetLevel",
                    "LedgerGroupId",
                    "Name1"
                ]
            },
            "x-queryable":true
        },
        "BudgetAccount":{
            "maxLength":"25",
            "type":"string",
            "description":"Budget account of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "FedGroupBudgetTypeTreeCode"
                ]
            },
            "x-queryable":true
        },
        "Ledger":{
            "title":"Ledger",
            "type":"string",
            "description":"Ledger of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Name"
                ]
            },
            "x-queryable":true
        },
        "BudgetControl":{
            "maxLength":"50",
            "type":"string",
            "description":"Budget control of the budget execution control.",
            "nullable":false,
            "x-queryable":true
        },
        "AllowOverrides":{
            "type":"string",
            "description":"Allow overrides associated with the budget execution control.",
            "nullable":true,
            "default":"No",
            "x-queryable":false
        },
        "BudgetManager":{
            "title":"Budget Manager",
            "type":"string",
            "description":"Name of the budget manager associated with the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ClosingTransactionType":{
            "title":"Closing Transaction Type",
            "type":"string",
            "description":"Closing transaction type of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Name2"
                ]
            },
            "x-queryable":true
        },
        "fedBudgetControlSegments":{
            "title":"Federal Budget Execution Control Segments",
            "type":"array",
            "description":"The federal budget execution control segments resource is used to query, create, and update budget execution control segments.",
            "items":{
                "$ref":"#/components/schemas/fedBudgetExecutionControls-fedBudgetControlSegments-item-response"
            }
        },
        "ControlLevel":{
            "title":"Control Level",
            "type":"string",
            "description":"Control level of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Meaning2"
                ]
            },
            "x-queryable":true
        },
        "TolerancePercent":{
            "title":"Tolerance Percentage",
            "type":"number",
            "description":"Tolerance percentage of the budget execution control.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentBudgetControl":{
            "title":"Parent Budgetary Control Type",
            "type":"string",
            "description":"Parent budget control of the budget execution control.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BudgetLevel",
                    "ControlTypeName1"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Date when the user who last updated the record logged in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Federal Budget Execution Control Segments

Type: array

Title: Federal Budget Execution Control Segments

The federal budget execution control segments resource is used to query, create, and update budget execution control segments.

Show Source

• Array of: object fedBudgetExecutionControls-fedBudgetControlSegments-item-response

{
    "title":"Federal Budget Execution Control Segments",
    "type":"array",
    "description":"The federal budget execution control segments resource is used to query, create, and update budget execution control segments.",
    "items":{
        "$ref":"#/components/schemas/fedBudgetExecutionControls-fedBudgetControlSegments-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 : fedBudgetExecutionControls-fedBudgetControlSegments-item-response

Type: object

Show Source

• ControlBudgetTree: string
  Title: Tree

  Control budget tree of the budget execution control segment.
• ControlBudgetTreeLabel: string
  Title: Tree Label

  Control budget tree label of the budget execution control segment.
• ControlBudgetTreeVersion: string
  Title: Tree Version

  Control budget tree version of the budget execution control segment.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date when the record was created.
• ExistsOnParent: string
  Default Value: N

  Exists on parent attribute of the budget execution control segment.
• FilterTree: string
  Title: Filter Tree

  Filter tree of the budget execution control segment.
• FilterTreeValue: string
  Title: Filter Summary Value

  Filter tree value of the budget execution control segment.
• FilterTreeVersion: string
  Title: Filter Tree Version

  Filter tree version of the budget execution control segment.
• IsAccountSegment: string
  Default Value: N

  Account segment of the budget execution control segment.
• IsBalancingSegment: string
  Default Value: N

  Balancing segment of the budget execution control segment.
• KeySegmentId: integer (int64)
  Read Only: true

  The unique identifier of the key segment associated with the budget execution control segment.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date when the record was last updated.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Date when the user who last updated the record logged in.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SegmentCode: string
  Title: Segment Name

  Segment code of the budget execution control segment.
• SegmentName: string
  Maximum Length: 30

  Segment name of the budget execution control segment.
• SequenceNumber: integer (int32)
  Title: Sequence

  Sequence number of the budget execution control segment.
• SummaryControl: string
  Title: Summary Control

  Summary control of the budget execution control segment.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Date when the record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ControlBudgetTreeLabel":{
            "title":"Tree Label",
            "type":"string",
            "description":"Control budget tree label of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "IsBalancingSegment":{
            "type":"string",
            "description":"Balancing segment of the budget execution control segment.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ExistsOnParent"
                ]
            }
        },
        "SegmentName":{
            "maxLength":"30",
            "type":"string",
            "description":"Segment name of the budget execution control segment.",
            "nullable":false,
            "x-queryable":true
        },
        "FilterTreeVersion":{
            "title":"Filter Tree Version",
            "type":"string",
            "description":"Filter tree version of the budget execution control segment.",
            "nullable":true,
            "x-queryable":true
        },
        "FilterTreeValue":{
            "title":"Filter Summary Value",
            "type":"string",
            "description":"Filter tree value of the budget execution control segment.",
            "nullable":true,
            "x-queryable":true
        },
        "KeySegmentId":{
            "type":"integer",
            "description":"The unique identifier of the key segment associated with the budget execution control segment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ControlBudgetTree":{
            "title":"Tree",
            "type":"string",
            "description":"Control budget tree of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SummaryControl":{
            "title":"Summary Control",
            "type":"string",
            "description":"Summary control of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Meaning"
                ]
            },
            "x-queryable":true
        },
        "IsAccountSegment":{
            "type":"string",
            "description":"Account segment of the budget execution control segment.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "ExistsOnParent"
                ]
            }
        },
        "ExistsOnParent":{
            "type":"string",
            "description":"Exists on parent attribute of the budget execution control segment.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SegmentCode":{
            "title":"Segment Name",
            "type":"string",
            "description":"Segment code of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FilterTree":{
            "title":"Filter Tree",
            "type":"string",
            "description":"Filter tree of the budget execution control segment.",
            "nullable":true,
            "x-queryable":false
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"Sequence number of the budget execution control segment.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Date when the user who last updated the record logged in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ControlBudgetTreeVersion":{
            "title":"Tree Version",
            "type":"string",
            "description":"Control budget tree version of the budget execution control segment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Links

fedBudgetControlSegments

Operation: /fscmRestApi/resources/11.13.18.05/fedBudgetExecutionControls/{fedBudgetExecutionControlsUniqID}/child/fedBudgetControlSegments

Parameters:

• fedBudgetExecutionControlsUniqID: $request.path.fedBudgetExecutionControlsUniqID

The federal budget execution control segments resource is used to query, create, and update budget execution control segments.

Back to Top