Create a burden schedule for an award project.
post
/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules
Request
Path Parameters
-
AwardId(required): integer(int64)
Unique identifier of the award.
-
AwardProjectId(required): integer(int64)
Unique identifier of the award project.
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.
-
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
Root Schema : schema
Type:
Show Source
object-
AwardId: integer
(int64)
Title:
Award IDIdentifier of the award. -
AwardProjectId: integer
(int64)
Title:
Award Project IDIdentifier of the award project. -
BurdenScheduleDescription: string
Title:
DescriptionMaximum Length:250The description of a burden schedule which is set of burden multipliers that is maintained for use across projects. -
BurdenScheduleName(required): string
Title:
Burden ScheduleMaximum Length:30The name of a burden schedule which is set of burden multipliers that is maintained for use across projects. -
DefaultBurdenStructureName(required): string
Title:
Default Burden StructureMaximum Length:30The name of a burden structure which is assigned as the default burden structure on a burden schedule. A burden structure determines how cost bases are grouped and what types of burden costs are applied to the cost bases. -
DefaultOrganizationHierarchyCode(required): string
Title:
Default Organization Hierarchy CodeMaximum Length:30The internal code of the structure that determines the relationships between organizations. -
DefaultOrganizationHierarchyName: string
Title:
Default Organization HierarchyMaximum Length:80A structure that determines the relationships between organizations like which organizations are subordinate to other organizations. This hierarchy is the default hierarchy for burden schedule versions. -
HierarchyStartOrganizationId(required): integer
(int64)
Title:
Hierarchy Start Organization IDThe identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule. -
HierarchyStartOrganizationName: string
Title:
Hierarchy Start OrganizationMaximum Length:240The top-level organization of the organization hierarchy that is assigned to the burden schedule. -
HierarchyVersionId(required): string
Title:
Hierarchy Version IDMaximum Length:32The identifier of the version of the organization hierarchy that is assigned to the burden schedule. -
HierarchyVersionName: string
Title:
Hierarchy VersionMaximum Length:80The version of the organization hierarchy that is assigned to the burden schedule. -
OrganizationClassificationCode: string
Title:
Organization Classification CodeThe 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 ClassificationThe 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. -
Versions: array
Versions
Title:
VersionsThe Versions resource is used to view and create versions for the override burden schedule assigned to the award project.
Nested Schema : Versions
Type:
arrayTitle:
VersionsThe Versions resource is used to view and create versions for the override burden schedule assigned to the award project.
Show Source
Nested Schema : schema
Type:
Show Source
object-
BurdenScheduleId(required): integer
(int64)
Title:
Burden Schedule IDIdentifier of the burden schedule. -
BurdenStructureName: string
Title:
Burden StructureMaximum Length:30The 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 IDThe identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule version. -
HierarchyStartOrganizationName: string
Title:
Hierarchy Start OrganizationMaximum Length:240The top-level organization of the organization hierarchy that is assigned to the burden schedule version. -
HierarchyVersionId: string
Title:
Hierarchy Version IDMaximum Length:32The identifier of the version of the organization hierarchy that is assigned to the burden schedule version. -
HierarchyVersionName: string
Title:
Hierarchy VersionMaximum Length:80The version of the organization hierarchy that is assigned to the burden schedule version. -
HoldVersionFromBuildFlag: boolean
Title:
Hold Version from BuildMaximum Length:1Indicates that the build rate schedule process will skip the schedule version even if it has been built. -
Multipliers: array
Multipliers
Title:
MultipliersThe Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project. -
OrganizationClassificationCode: string
Title:
Organization Classification CodeThe 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 ClassificationThe 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 CodeMaximum Length:30The internal code of the structure that determines the relationships between organizations. -
OrganizationHierarchyName: string
Title:
Organization HierarchyMaximum Length:80A structure that determines the relationships between organizations like which organizations are subordinate to other organizations. -
VersionEndDate: string
(date)
Title:
To DateThe date after which a burden schedule version is no longer active. -
VersionName(required): string
Title:
VersionMaximum Length:30A version of a burden schedule is a set of burden multipliers. One burden schedule can have many versions. -
VersionStartDate(required): string
(date)
Title:
From DateThe date from which a burden schedule version is active.
Nested Schema : Multipliers
Type:
arrayTitle:
MultipliersThe 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-
BurdenCostCode: string
Title:
Burden Cost CodeMaximum Length:30The 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. -
MultiplierNumber: number
Title:
MultiplierA 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 CodeThe 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 ClassificationThe 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 IDIdentifier of the organization to which a burden multiplier is assigned for a particular burden cost code. -
OrganizationName: string
Title:
OrganizationMaximum Length:240The organization to which a burden multiplier is assigned for a particular burden cost code. -
VersionId: integer
(int64)
Title:
Version IDThe identifier of the version of a set of burden multipliers.
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.
Root Schema : awards-AwardProject-AwardProjectOverrideBurdenSchedules-item-response
Type:
Show Source
object-
AwardId: integer
(int64)
Title:
Award IDIdentifier of the award. -
AwardProjectId: integer
(int64)
Title:
Award Project IDIdentifier of the award project. -
BurdenScheduleDescription: string
Title:
DescriptionMaximum Length:250The description of a burden schedule which is set of burden multipliers that is maintained for use across projects. -
BurdenScheduleId: integer
(int64)
Title:
Burden Schedule IDRead Only:trueIdentifier of the burden schedule. -
BurdenScheduleName: string
Title:
Burden ScheduleMaximum Length:30The name of a burden schedule which is set of burden multipliers that is maintained for use across projects. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DefaultBurdenStructureName: string
Title:
Default Burden StructureMaximum Length:30The name of a burden structure which is assigned as the default burden structure on a burden schedule. A burden structure determines how cost bases are grouped and what types of burden costs are applied to the cost bases. -
DefaultOrganizationHierarchyCode: string
Title:
Default Organization Hierarchy CodeMaximum Length:30The internal code of the structure that determines the relationships between organizations. -
DefaultOrganizationHierarchyName: string
Title:
Default Organization HierarchyMaximum Length:80A structure that determines the relationships between organizations like which organizations are subordinate to other organizations. This hierarchy is the default hierarchy for burden schedule versions. -
HierarchyStartOrganizationId: integer
(int64)
Title:
Hierarchy Start Organization IDThe identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule. -
HierarchyStartOrganizationName: string
Title:
Hierarchy Start OrganizationMaximum Length:240The top-level organization of the organization hierarchy that is assigned to the burden schedule. -
HierarchyVersionId: string
Title:
Hierarchy Version IDMaximum Length:32The identifier of the version of the organization hierarchy that is assigned to the burden schedule. -
HierarchyVersionName: string
Title:
Hierarchy VersionMaximum Length:80The version of the organization hierarchy that is assigned to the burden schedule. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe user who last updated the record. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The date when the record was last updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationClassificationCode: string
Title:
Organization Classification CodeThe 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 ClassificationThe 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. -
Versions: array
Versions
Title:
VersionsThe Versions resource is used to view and create versions for the override burden schedule assigned to the award project.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Versions
Type:
arrayTitle:
VersionsThe Versions resource is used to view and create versions for the override burden schedule assigned to the award project.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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-item-response
Type:
Show Source
object-
BuildStatus: string
Title:
Build StatusRead Only:trueMaximum Length:80The 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 IDIdentifier of the burden schedule. -
BurdenStructureName: string
Title:
Burden StructureMaximum Length:30The 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 ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
HierarchyStartOrganizationId: integer
(int64)
Title:
Hierarchy Start Organization IDThe identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule version. -
HierarchyStartOrganizationName: string
Title:
Hierarchy Start OrganizationMaximum Length:240The top-level organization of the organization hierarchy that is assigned to the burden schedule version. -
HierarchyVersionId: string
Title:
Hierarchy Version IDMaximum Length:32The identifier of the version of the organization hierarchy that is assigned to the burden schedule version. -
HierarchyVersionName: string
Title:
Hierarchy VersionMaximum Length:80The version of the organization hierarchy that is assigned to the burden schedule version. -
HoldVersionFromBuildFlag: boolean
Title:
Hold Version from BuildMaximum Length:1Indicates that the build rate schedule process will skip the schedule version even if it has been built. -
LastActiveBuildDate: string
(date)
Title:
Last Active Build DateRead Only:trueThe 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 DateRead Only:trueThe user who last updated the record. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The date when the record was last updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Multipliers: array
Multipliers
Title:
MultipliersThe Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project. -
OrganizationClassificationCode: string
Title:
Organization Classification CodeThe 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 ClassificationThe 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 CodeMaximum Length:30The internal code of the structure that determines the relationships between organizations. -
OrganizationHierarchyName: string
Title:
Organization HierarchyMaximum Length:80A structure that determines the relationships between organizations like which organizations are subordinate to other organizations. -
VersionEndDate: string
(date)
Title:
To DateThe date after which a burden schedule version is no longer active. -
VersionId: integer
(int64)
Title:
Version IDRead Only:trueThe identifier of the version of a set of burden multipliers. -
VersionName: string
Title:
VersionMaximum Length:30A version of a burden schedule is a set of burden multipliers. One burden schedule can have many versions. -
VersionStartDate: string
(date)
Title:
From DateThe date from which a burden schedule version is active.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Multipliers
Type:
arrayTitle:
MultipliersThe Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project.
Show Source
Nested Schema : awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-Multipliers-item-response
Type:
Show Source
object-
BurdenCostCode: string
Title:
Burden Cost CodeMaximum Length:30The 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 ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe user who last updated the record. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The date when the record was last updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MultiplierId: integer
(int64)
Title:
Multiplier IDRead Only:trueIdentifier of the burden multiplier. -
MultiplierNumber: number
Title:
MultiplierA 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 CodeThe 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 ClassificationThe 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 IDIdentifier of the organization to which a burden multiplier is assigned for a particular burden cost code. -
OrganizationName: string
Title:
OrganizationMaximum Length:240The organization to which a burden multiplier is assigned for a particular burden cost code. -
VersionId: integer
(int64)
Title:
Version IDThe identifier of the version of a set of burden multipliers.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- Versions
-
Parameters:
- AwardId:
$request.path.AwardId - AwardProjectId:
$request.path.AwardProjectId - BurdenScheduleId:
$request.path.BurdenScheduleId
The Versions resource is used to view and create versions for the override burden schedule assigned to the award project. - AwardId: