Update a control budget setting for a project budget version
patch
/fscmRestApi/resources/11.13.18.05/projectBudgets/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/BudgetaryControlSettings/{BudgetaryControlSettingId}
Request
Path Parameters
-
BudgetaryControlSettingId(required): integer(int64)
Identifier of the budgetary control settings for the project budget.
-
PlanVersionId(required): integer(int64)
Identifier of the project budget version.
-
PlanningOptionId(required): integer(int64)
Unique identifier of the summary level planning option in the project budget version.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BudgetaryControlSettingId: integer
(int64)
Title:
Budgetary Control Setting ID
Identifier of the budgetary control settings for the project budget. -
ControlBudget: string
Title:
Control Budget
Maximum Length:255
Name of the control budget. -
ControlLevel: string
Title:
Control Level
Maximum Length:255
The budgetary control level for the budget version. -
DefaultRateType: string
Title:
Default Rate Type
Maximum Length:255
The default rate type for budgetary control for the budget version. -
TolerancePercentage: number
Title:
Tolerance Percentage
The budgetary control level tolerance percentage.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectBudgets-PlanningOptions-BudgetaryControlSettings-item-response
Type:
Show Source
object
-
BudgetaryControlSettingId: integer
(int64)
Title:
Budgetary Control Setting ID
Identifier of the budgetary control settings for the project budget. -
ControlBudget: string
Title:
Control Budget
Maximum Length:255
Name of the control budget. -
ControlLevel: string
Title:
Control Level
Maximum Length:255
The budgetary control level for the budget version. -
DefaultRateType: string
Title:
Default Rate Type
Maximum Length:255
The default rate type for budgetary control for the budget version. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TolerancePercentage: number
Title:
Tolerance Percentage
The budgetary control level tolerance percentage.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.