Update a version in burden schedule.
patch
/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules/{BurdenScheduleId}/child/Versions/{VersionId}
Request
Path Parameters
-
AwardId(required): integer(int64)
Unique identifier of the award.
-
AwardProjectId(required): integer(int64)
Unique identifier of the award project.
-
BurdenScheduleId(required): integer(int64)
Identifier of the burden schedule.
-
VersionId(required): integer(int64)
The identifier of the version of a set of burden multipliers.
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
-
BurdenScheduleId(required): integer
(int64)
Title:
Burden Schedule ID
Identifier of the burden schedule. -
BurdenStructureName: string
Title:
Burden Structure
Maximum Length:30
The name of a burden structure which is assigned to a burden schedule version. A burden structure determines how cost bases are grouped and what types of burden costs are applied to the cost bases. -
HierarchyStartOrganizationId: integer
(int64)
Title:
Hierarchy Start Organization ID
The identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule version. -
HierarchyStartOrganizationName: string
Title:
Hierarchy Start Organization
Maximum Length:240
The top-level organization of the organization hierarchy that is assigned to the burden schedule version. -
HierarchyVersionId: string
Title:
Hierarchy Version ID
Maximum Length:32
The identifier of the version of the organization hierarchy that is assigned to the burden schedule version. -
HierarchyVersionName: string
Title:
Hierarchy Version
Maximum Length:80
The version of the organization hierarchy that is assigned to the burden schedule version. -
HoldVersionFromBuildFlag: boolean
Title:
Hold Version from Build
Maximum Length:1
Indicates that the build rate schedule process will skip the schedule version even if it has been built. -
Multipliers: array
Multipliers
Title:
Multipliers
The Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project. -
OrganizationClassificationCode: string
Title:
Organization Classification Code
The internal code for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. -
OrganizationClassificationName: string
Title:
Organization Classification
The name for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. -
OrganizationHierarchyCode: string
Title:
Organization Hierarchy Code
Maximum Length:30
The internal code of the structure that determines the relationships between organizations. -
OrganizationHierarchyName: string
Title:
Organization Hierarchy
Maximum Length:80
A structure that determines the relationships between organizations like which organizations are subordinate to other organizations. -
VersionEndDate: string
(date)
Title:
To Date
The date after which a burden schedule version is no longer active. -
VersionName(required): string
Title:
Version
Maximum Length:30
A version of a burden schedule is a set of burden multipliers. One burden schedule can have many versions. -
VersionStartDate(required): string
(date)
Title:
From Date
The date from which a burden schedule version is active.
Nested Schema : Multipliers
Type:
array
Title:
Multipliers
The Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
MultiplierNumber: number
Title:
Multiplier
A numeric multiplier associated with an organization and burden cost code combinations for burden schedule versions. The costing process applies this multiplier to raw cost to calculate burden cost amounts. -
OrganizationClassificationCode: string
Title:
Organization Classification Code
The internal code for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. -
OrganizationClassificationName: string
Title:
Organization Classification
The name for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. -
OrganizationName: string
Title:
Organization
Maximum Length:240
The organization to which a burden multiplier is assigned for a particular burden cost code.
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 : awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-item-response
Type:
Show Source
object
-
BuildStatus: string
Title:
Build Status
Read Only:true
Maximum Length:80
The current state of a burden schedule version in relation to build processing. The status can be New, Active, or Active with Unbuilt Changes. -
BurdenScheduleId: integer
(int64)
Title:
Burden Schedule ID
Identifier of the burden schedule. -
BurdenStructureName: string
Title:
Burden Structure
Maximum Length:30
The name of a burden structure which is assigned to a burden schedule version. A burden structure determines how cost bases are grouped and what types of burden costs are applied to the cost bases. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
HierarchyStartOrganizationId: integer
(int64)
Title:
Hierarchy Start Organization ID
The identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule version. -
HierarchyStartOrganizationName: string
Title:
Hierarchy Start Organization
Maximum Length:240
The top-level organization of the organization hierarchy that is assigned to the burden schedule version. -
HierarchyVersionId: string
Title:
Hierarchy Version ID
Maximum Length:32
The identifier of the version of the organization hierarchy that is assigned to the burden schedule version. -
HierarchyVersionName: string
Title:
Hierarchy Version
Maximum Length:80
The version of the organization hierarchy that is assigned to the burden schedule version. -
HoldVersionFromBuildFlag: boolean
Title:
Hold Version from Build
Maximum Length:1
Indicates that the build rate schedule process will skip the schedule version even if it has been built. -
LastActiveBuildDate: string
(date)
Title:
Last Active Build Date
Read Only:true
The date on which a burden schedule version most recently underwent successful build processing. Because the processing was successful, the multipliers on the version are available for use. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the record was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Multipliers: array
Multipliers
Title:
Multipliers
The Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project. -
OrganizationClassificationCode: string
Title:
Organization Classification Code
The internal code for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. -
OrganizationClassificationName: string
Title:
Organization Classification
The name for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. -
OrganizationHierarchyCode: string
Title:
Organization Hierarchy Code
Maximum Length:30
The internal code of the structure that determines the relationships between organizations. -
OrganizationHierarchyName: string
Title:
Organization Hierarchy
Maximum Length:80
A structure that determines the relationships between organizations like which organizations are subordinate to other organizations. -
VersionEndDate: string
(date)
Title:
To Date
The date after which a burden schedule version is no longer active. -
VersionId: integer
(int64)
Title:
Version ID
Read Only:true
The identifier of the version of a set of burden multipliers. -
VersionName: string
Title:
Version
Maximum Length:30
A version of a burden schedule is a set of burden multipliers. One burden schedule can have many versions. -
VersionStartDate: string
(date)
Title:
From Date
The date from which a burden schedule version is active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Multipliers
Type:
array
Title:
Multipliers
The Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project.
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.
Nested Schema : awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-Multipliers-item-response
Type:
Show Source
object
-
BurdenCostCode: string
Title:
Burden Cost Code
Maximum Length:30
The name of a burden cost code for which you are defining multipliers on a burden schedule version. A burden cost code is a classification of overhead costs and it represents the type of burden cost you want to apply to raw cost. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the record was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MultiplierId: integer
(int64)
Title:
Multiplier ID
Read Only:true
Identifier of the burden multiplier. -
MultiplierNumber: number
Title:
Multiplier
A numeric multiplier associated with an organization and burden cost code combinations for burden schedule versions. The costing process applies this multiplier to raw cost to calculate burden cost amounts. -
OrganizationClassificationCode: string
Title:
Organization Classification Code
The internal code for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. -
OrganizationClassificationName: string
Title:
Organization Classification
The name for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. -
OrganizationId: integer
(int64)
Title:
Organization ID
Identifier of the organization to which a burden multiplier is assigned for a particular burden cost code. -
OrganizationName: string
Title:
Organization
Maximum Length:240
The organization to which a burden multiplier is assigned for a particular burden cost code. -
VersionId: integer
(int64)
Title:
Version ID
The identifier of the version of a set of burden multipliers.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Multipliers
-
Parameters:
- AwardId:
$request.path.AwardId
- AwardProjectId:
$request.path.AwardProjectId
- BurdenScheduleId:
$request.path.BurdenScheduleId
- VersionId:
$request.path.VersionId
The Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project. - AwardId: