Get all control budget periods

get

/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV

Request

Query Parameters
  • 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).
  • 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
  • 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

    • BudgetPeriodsFinder Finds control budgets periods that match the specified finder variable.
      Finder Variables
      • SearchTerm; string; Keyword that identifies control budget periods based on the control budget period name.
      • bindControlBudgetId; integer; The unique identifier of a control budget associated with a budget period.
    • EndBudgetPeriodsFinder Finds budget periods that come after the specified period of the control budget.
      Finder Variables
      • bindBudgetYear; string; The budget year of the specified budget period of the control budget.
      • bindControlBudgetId; integer; The unique identifier of the control budget associated with the specified budget period.
      • bindEffectivePeriodNum; string; The period number of the specified period of the control budget.
    • KeywordFinder Finds control budget periods that match the specified keyword.
      Finder Variables
      • SearchTerm; string; Keyword that identifies control budget periods based on the control budget period name.
    • PeriodStatusFinder Finds control budget period statuses that match the specified finder variable.
      Finder Variables
      • SearchTerm; string; Keyword that identifies control budget periods based on the control budget period name.
      • bindControlBudgetId; integer; The unique identifier of a control budget associated with a period status.
      • bindPeriodName; string; The name of the control budget period associated with a period status.
    • PrimaryKey Finds the control budget period that matches the primary key criteria specified.
      Finder Variables
      • BudgetPeriodStatusId; integer; The unique identifier of the control budget period.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • BudgetPeriodStatus; string; Indicates the status of the control budget period. The valid values are Never Opened, Available for Budgeting, Open, Closed, and Permanently Closed.
    • BudgetPeriodStatusId; integer; The unique identifier of the control budget period status.
    • BudgetYear; integer; The budget year of the control budget period.
    • ControlBudgetId; integer; The unique identifier of the control budget.
    • EndDate; string; The date on which a control budget period ends.
    • PeriodName; string; The name of the control budget period.
    • PeriodNumber; integer; The unique number of the control budget period.
    • StartDate; string; The date on which a control budget period starts.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : controlBudgetPeriodsLOV
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : controlBudgetPeriodsLOV-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve all control budget periods 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/fuscdrmsmc325-fa-ext.us.oracle.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV

Example Response Body

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

{
    "items": [
        {
            "ControlBudgetId": 100100995444339,
            "EndDate": "2025-12-31",
            "PeriodName": "PRD_01",
            "PeriodNumber": 1,
            "BudgetPeriodStatusId": 100100995444341,
            "BudgetYear": 1,
            "StartDate": "2007-01-01",
            "BudgetPeriodStatus": "OPEN",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0A94466E750000000EACED0005770800005B0A94466E73",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0A94466E750000000EACED0005770800005B0A94466E73",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "ControlBudgetId": 300100562631809,
            "EndDate": "2012-05-31",
            "PeriodName": "May-12",
            "PeriodNumber": 5,
            "BudgetPeriodStatusId": 100100905322572,
            "BudgetYear": 2012,
            "StartDate": "2012-05-01",
            "BudgetPeriodStatus": "OPEN",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0A8EE7484C0000000EACED00057708000110F09B6EBC81",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0A8EE7484C0000000EACED00057708000110F09B6EBC81",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "ControlBudgetId": 300100565544697,
            "EndDate": "2023-01-31",
            "PeriodName": "Jan-23",
            "PeriodNumber": 1,
            "BudgetPeriodStatusId": 100101239985014,
            "BudgetYear": 2023,
            "StartDate": "2023-01-01",
            "BudgetPeriodStatus": "OPEN",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D3760000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D3760000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "ControlBudgetId": 300100565544697,
            "EndDate": "2023-02-28",
            "PeriodName": "Feb-23",
            "PeriodNumber": 2,
            "BudgetPeriodStatusId": 100101239985015,
            "BudgetYear": 2023,
            "StartDate": "2023-02-01",
            "BudgetPeriodStatus": "OPEN",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D3770000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D3770000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "ControlBudgetId": 300100565544697,
            "EndDate": "2023-03-31",
            "PeriodName": "Mar-23",
            "PeriodNumber": 3,
            "BudgetPeriodStatusId": 100101239985017,
            "BudgetYear": 2023,
            "StartDate": "2023-03-01",
            "BudgetPeriodStatus": "OPEN",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D3790000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D3790000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "ControlBudgetId": 300100565544697,
            "EndDate": "2023-04-30",
            "PeriodName": "Apr-23",
            "PeriodNumber": 4,
            "BudgetPeriodStatusId": 100101239985018,
            "BudgetYear": 2023,
            "StartDate": "2023-04-01",
            "BudgetPeriodStatus": "AVAILABLE_FOR_BUDGETING",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D37A0000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D37A0000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "ControlBudgetId": 300100565544697,
            "EndDate": "2023-05-31",
            "PeriodName": "May-23",
            "PeriodNumber": 5,
            "BudgetPeriodStatusId": 100101239985023,
            "BudgetYear": 2023,
            "StartDate": "2023-05-01",
            "BudgetPeriodStatus": "AVAILABLE_FOR_BUDGETING",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D37F0000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D37F0000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "ControlBudgetId": 300100565544697,
            "EndDate": "2023-06-30",
            "PeriodName": "Jun-23",
            "PeriodNumber": 6,
            "BudgetPeriodStatusId": 100101239985020,
            "BudgetYear": 2023,
            "StartDate": "2023-06-01",
            "BudgetPeriodStatus": "AVAILABLE_FOR_BUDGETING",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D37C0000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D37C0000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "ControlBudgetId": 300100565544697,
            "EndDate": "2023-07-31",
            "PeriodName": "Jul-23",
            "PeriodNumber": 7,
            "BudgetPeriodStatusId": 100101239985019,
            "BudgetYear": 2023,
            "StartDate": "2023-07-01",
            "BudgetPeriodStatus": "AVAILABLE_FOR_BUDGETING",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D37B0000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D37B0000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "ControlBudgetId": 300100565544697,
            "EndDate": "2023-08-31",
            "PeriodName": "Aug-23",
            "PeriodNumber": 8,
            "BudgetPeriodStatusId": 100101239985012,
            "BudgetYear": 2023,
            "StartDate": "2023-08-01",
            "BudgetPeriodStatus": "AVAILABLE_FOR_BUDGETING",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D3740000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D3740000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "ControlBudgetId": 300100565544697,
            "EndDate": "2023-09-30",
            "PeriodName": "Sep-23",
            "PeriodNumber": 9,
            "BudgetPeriodStatusId": 100101239985021,
            "BudgetYear": 2023,
            "StartDate": "2023-09-01",
            "BudgetPeriodStatus": "AVAILABLE_FOR_BUDGETING",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D37D0000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D37D0000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "ControlBudgetId": 300100565544697,
            "EndDate": "2023-10-31",
            "PeriodName": "Oct-23",
            "PeriodNumber": 10,
            "BudgetPeriodStatusId": 100101239985022,
            "BudgetYear": 2023,
            "StartDate": "2023-10-01",
            "BudgetPeriodStatus": "AVAILABLE_FOR_BUDGETING",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D37E0000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D37E0000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "ControlBudgetId": 300100565544697,
            "EndDate": "2023-11-30",
            "PeriodName": "Nov-23",
            "PeriodNumber": 11,
            "BudgetPeriodStatusId": 100101239985016,
            "BudgetYear": 2023,
            "StartDate": "2023-11-01",
            "BudgetPeriodStatus": "AVAILABLE_FOR_BUDGETING",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D3780000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D3780000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "ControlBudgetId": 300100565544697,
            "EndDate": "2023-12-31",
            "PeriodName": "Dec-23",
            "PeriodNumber": 12,
            "BudgetPeriodStatusId": 100101239985013,
            "BudgetYear": 2023,
            "StartDate": "2023-12-01",
            "BudgetPeriodStatus": "AVAILABLE_FOR_BUDGETING",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D3750000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/00020000000EACED0005770800005B0AA2D9D3750000000EACED00057708000110F09B9B2EF9",
                    "name": "controlBudgetPeriodsLOV",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 14,
    "hasMore": false,
    "limit": 5000,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV",
            "name": "controlBudgetPeriodsLOV",
            "kind": "collection"
        }
    ]
}
Back to Top