Jump to

• Request
• Response
• Examples

Create a version in burden schedule.

post

/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules/{BurdenScheduleId}/child/Versions

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.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "required":[
        "BurdenScheduleId",
        "VersionName",
        "VersionStartDate"
    ],
    "type":"object",
    "properties":{
        "OrganizationHierarchyCode":{
            "title":"Organization Hierarchy Code",
            "maxLength":"30",
            "type":"string",
            "description":"The internal code of the structure that determines the relationships between organizations.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "HierarchyVersionId":{
            "title":"Hierarchy Version ID",
            "maxLength":"32",
            "type":"string",
            "description":"The identifier of the version of the organization hierarchy that is assigned to the burden schedule version.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "OrganizationHierarchyCode",
                    "TreeStructureCode"
                ]
            }
        },
        "OrganizationClassificationCode":{
            "title":"Organization Classification Code",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Multipliers":{
            "title":"Multipliers",
            "type":"array",
            "description":"The Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project.",
            "items":{
                "$ref":"#/components/schemas/awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-Multipliers-item-post-request"
            }
        },
        "HierarchyVersionName":{
            "title":"Hierarchy Version",
            "maxLength":"80",
            "type":"string",
            "description":"The version of the organization hierarchy that is assigned to the burden schedule version.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "HierarchyVersionId",
                    "OrganizationHierarchyCode",
                    "OrganizationHierarchyName"
                ]
            }
        },
        "HierarchyStartOrganizationName":{
            "title":"Hierarchy Start Organization",
            "maxLength":"240",
            "type":"string",
            "description":"The top-level organization of the organization hierarchy that is assigned to the burden schedule version.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "HierarchyStartOrganizationId",
                    "HierarchyVersionId",
                    "HierarchyVersionName",
                    "OrganizationHierarchyCode",
                    "OrganizationHierarchyName"
                ]
            }
        },
        "VersionEndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date after which a burden schedule version is no longer active.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"date"
            }
        },
        "BurdenScheduleId":{
            "title":"Burden Schedule ID",
            "type":"integer",
            "description":"Identifier of the burden schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "OrganizationClassificationName":{
            "title":"Organization Classification",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "HoldVersionFromBuildFlag":{
            "title":"Hold Version from Build",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the build rate schedule process will skip the schedule version even if it has been built.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ReadyToCompileFlag"
                ]
            }
        },
        "HierarchyStartOrganizationId":{
            "title":"Hierarchy Start Organization ID",
            "type":"integer",
            "description":"The identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18",
                "dependencies":[
                    "HierarchyVersionId"
                ]
            }
        },
        "VersionName":{
            "title":"Version",
            "maxLength":"30",
            "type":"string",
            "description":"A version of a burden schedule is a set of burden multipliers. One burden schedule can have many versions.",
            "nullable":false
        },
        "BurdenStructureName":{
            "title":"Burden Structure",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "VersionStartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The date from which a burden schedule version is active.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "controlType":"date"
            }
        },
        "OrganizationHierarchyName":{
            "title":"Organization Hierarchy",
            "maxLength":"80",
            "type":"string",
            "description":"A structure that determines the relationships between organizations like which organizations are subordinate to other organizations.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "OrganizationHierarchyCode"
                ]
            }
        }
    }
}

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

• Array of: object schema

{
    "title":"Multipliers",
    "type":"array",
    "description":"The Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project.",
    "items":{
        "$ref":"#/components/schemas/awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-Multipliers-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• 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.

{
    "type":"object",
    "properties":{
        "VersionId":{
            "title":"Version ID",
            "type":"integer",
            "description":"The identifier of the version of a set of burden multipliers.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "OrganizationName":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"The organization to which a burden multiplier is assigned for a particular burden cost code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OrganizationId"
                ]
            }
        },
        "MultiplierNumber":{
            "title":"Multiplier",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "precision":"22",
                "scale":"5"
            }
        },
        "OrganizationClassificationCode":{
            "title":"Organization Classification Code",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Identifier of the organization to which a burden multiplier is assigned for a particular burden cost code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "BurdenCostCode":{
            "title":"Burden Cost Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "OrganizationClassificationName":{
            "title":"Organization Classification",
            "type":"string",
            "description":"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.",
            "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 : awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "VersionId":{
            "title":"Version ID",
            "type":"integer",
            "description":"The identifier of the version of a set of burden multipliers.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date when the record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "OrganizationHierarchyCode":{
            "title":"Organization Hierarchy Code",
            "maxLength":"30",
            "type":"string",
            "description":"The internal code of the structure that determines the relationships between organizations.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "HierarchyVersionId":{
            "title":"Hierarchy Version ID",
            "maxLength":"32",
            "type":"string",
            "description":"The identifier of the version of the organization hierarchy that is assigned to the burden schedule version.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "OrganizationHierarchyCode",
                    "TreeStructureCode"
                ]
            },
            "x-queryable":true
        },
        "OrganizationClassificationCode":{
            "title":"Organization Classification Code",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Multipliers":{
            "title":"Multipliers",
            "type":"array",
            "description":"The Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project.",
            "items":{
                "$ref":"#/components/schemas/awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-Multipliers-item-response"
            }
        },
        "LastActiveBuildDate":{
            "title":"Last Active Build Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HierarchyVersionName":{
            "title":"Hierarchy Version",
            "maxLength":"80",
            "type":"string",
            "description":"The version of the organization hierarchy that is assigned to the burden schedule version.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "HierarchyVersionId",
                    "OrganizationHierarchyCode",
                    "OrganizationHierarchyName"
                ]
            },
            "x-queryable":true
        },
        "HierarchyStartOrganizationName":{
            "title":"Hierarchy Start Organization",
            "maxLength":"240",
            "type":"string",
            "description":"The top-level organization of the organization hierarchy that is assigned to the burden schedule version.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "HierarchyStartOrganizationId",
                    "HierarchyVersionId",
                    "HierarchyVersionName",
                    "OrganizationHierarchyCode",
                    "OrganizationHierarchyName"
                ]
            },
            "x-queryable":true
        },
        "VersionEndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date after which a burden schedule version is no longer active.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "BurdenScheduleId":{
            "title":"Burden Schedule ID",
            "type":"integer",
            "description":"Identifier of the burden schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationClassificationName":{
            "title":"Organization Classification",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "HoldVersionFromBuildFlag":{
            "title":"Hold Version from Build",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the build rate schedule process will skip the schedule version even if it has been built.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ReadyToCompileFlag"
                ]
            },
            "x-queryable":true
        },
        "HierarchyStartOrganizationId":{
            "title":"Hierarchy Start Organization ID",
            "type":"integer",
            "description":"The identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18",
                "dependencies":[
                    "HierarchyVersionId"
                ]
            },
            "x-queryable":true
        },
        "BuildStatus":{
            "title":"Build Status",
            "maxLength":"80",
            "type":"string",
            "description":"The current state of a burden schedule version in relation to build processing. The status can be New, Active, or Active with Unbuilt Changes.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "VersionName":{
            "title":"Version",
            "maxLength":"30",
            "type":"string",
            "description":"A version of a burden schedule is a set of burden multipliers. One burden schedule can have many versions.",
            "nullable":false,
            "x-queryable":true
        },
        "BurdenStructureName":{
            "title":"Burden Structure",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "VersionStartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The date from which a burden schedule version is active.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "OrganizationHierarchyName":{
            "title":"Organization Hierarchy",
            "maxLength":"80",
            "type":"string",
            "description":"A structure that determines the relationships between organizations like which organizations are subordinate to other organizations.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "OrganizationHierarchyCode"
                ]
            },
            "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 : 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

• Array of: object awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-Multipliers-item-response

{
    "title":"Multipliers",
    "type":"array",
    "description":"The Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project.",
    "items":{
        "$ref":"#/components/schemas/awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-Multipliers-item-response"
    }
}

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."
        }
    }
}

Nested Schema : awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-Multipliers-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date when the record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "VersionId":{
            "title":"Version ID",
            "type":"integer",
            "description":"The identifier of the version of a set of burden multipliers.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"The organization to which a burden multiplier is assigned for a particular burden cost code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OrganizationId"
                ]
            },
            "x-queryable":true
        },
        "MultiplierNumber":{
            "title":"Multiplier",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "precision":"22",
                "scale":"5"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "OrganizationClassificationCode":{
            "title":"Organization Classification Code",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Identifier of the organization to which a burden multiplier is assigned for a particular burden cost code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "BurdenCostCode":{
            "title":"Burden Cost Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationClassificationName":{
            "title":"Organization Classification",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MultiplierId":{
            "title":"Multiplier ID",
            "type":"integer",
            "description":"Identifier of the burden multiplier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "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"
    }
}

Links

Multipliers

Operation: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectOverrideBurdenSchedules/{BurdenScheduleId}/child/Versions/{VersionId}/child/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.

Back to Top

Examples

The following example shows how to create a version in burden schedule by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100047723874/child/AwardProject/300100043916343/child/AwardProjectOverrideBurdenSchedules/300100176954395/child/Versions

Request Body Example

The following shows an example of the request body in JSON format.

{
            "VersionName": "sr_REST_Ver3",
            "BurdenStructureName": "CP Buildup Structure",
            "VersionStartDate": "2028-12-31",
            "OrganizationHierarchyName": "PRJ Tree Code",
            "HierarchyVersionName": "PRJ Tree Code",
            "HierarchyStartOrganizationName": "Vision Corporation Enterprise"
            }

Response Body Example

The following shows an example of the response body in JSON format.

{
    "VersionName": "sr_REST_Ver3",
    "VersionId": 300100176968393,
    "BurdenScheduleId": 300100176954395,
    "VersionStartDate": "2028-12-31",
    "VersionEndDate": null,
    "BurdenStructureName": "CP Buildup Structure",
    "OrganizationHierarchyName": "PRJ Tree Code",
    "OrganizationHierarchyCode": "PRJ Tree Code",
    "HierarchyVersionName": "PRJ Tree Code",
    "HierarchyVersionId": "26D7D8EF39285ADAE053A8D0F00A9EF1",
    "HierarchyStartOrganizationName": "Vision Corporation Enterprise",
    "HierarchyStartOrganizationId": 202,
    "HoldVersionFromBuildFlag": false,
    "BuildStatus": "New",
    "LastActiveBuildDate": null,
    "CreatedBy": "ABRAHAM.MASON",
    "CreationDate": "2019-04-18T11:07:37.002+00:00",
    "LastUpdateDate": "2019-04-18T11:07:37.544+00:00",
    "LastUpdatedBy": "ABRAHAM.MASON",
    "OrganizationClassificationName": null,
    "OrganizationClassificationCode": null,
    "links": [
        {
            "rel": "self",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100047723874/child/AwardProject/300100043916343/child/AwardProjectOverrideBurdenSchedules/300100176954395/child/Versions/300100176968393",
            "name": "Versions",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100047723874/child/AwardProject/300100043916343/child/AwardProjectOverrideBurdenSchedules/300100176954395/child/Versions/300100176968393",
            "name": "Versions",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100047723874/child/AwardProject/300100043916343/child/AwardProjectOverrideBurdenSchedules/300100176954395",
            "name": "AwardProjectOverrideBurdenSchedules",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100047723874/child/AwardProject/300100043916343/child/AwardProjectOverrideBurdenSchedules/300100176954395/child/Versions/300100176968393/lov/OrgClassificationPVOForLOVVA",
            "name": "OrgClassificationPVOForLOVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100047723874/child/AwardProject/300100043916343/child/AwardProjectOverrideBurdenSchedules/300100176954395/child/Versions/300100176968393/lov/ProjectOrgTreePVOForNameLOVVA",
            "name": "ProjectOrgTreePVOForNameLOVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100047723874/child/AwardProject/300100043916343/child/AwardProjectOverrideBurdenSchedules/300100176954395/child/Versions/300100176968393/lov/ProjectOrgTreeVersionPVOForNameLOVVA",
            "name": "ProjectOrgTreeVersionPVOForNameLOVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100047723874/child/AwardProject/300100043916343/child/AwardProjectOverrideBurdenSchedules/300100176954395/child/Versions/300100176968393/lov/ProjectOrgTreeRESTVVOForOrgLOVVA",
            "name": "ProjectOrgTreeRESTVVOForOrgLOVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100047723874/child/AwardProject/300100043916343/child/AwardProjectOverrideBurdenSchedules/300100176954395/child/Versions/300100176968393/lov/ProjectOrgTreePVOForCodeLOVVA",
            "name": "ProjectOrgTreePVOForCodeLOVVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100047723874/child/AwardProject/300100043916343/child/AwardProjectOverrideBurdenSchedules/300100176954395/child/Versions/300100176968393/child/Multipliers",
            "name": "Multipliers",
            "kind": "collection"
        }
    ]
}

Back to Top