Jump to

• Request
• Response
• Examples

Get the burden schedule override for the award project.

get

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  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).
• fields: string
  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
• finder: string
  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:
  
  

  • PrimaryKey: Finds the burden schedule with the specified burden schedule ID.
    Finder Variables:
    • BurdenScheduleId; integer; Identifier of the burden schedule.
• limit: integer
  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.
• links: string
  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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • AwardId; integer; Identifier of the award.
  • AwardProjectId; integer; Identifier of the award project.
  • BurdenScheduleDescription; string; The description of a burden schedule which is set of burden multipliers that is maintained for use across projects.
  • BurdenScheduleId; integer; Identifier of the burden schedule.
  • BurdenScheduleName; string; The name of a burden schedule which is set of burden multipliers that is maintained for use across projects.
  • CreatedBy; string; The user who created the record.
  • CreationDate; string; The date when the record was created.
  • DefaultBurdenStructureName; string; The 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; The internal code of the structure that determines the relationships between organizations.
  • DefaultOrganizationHierarchyName; string; A 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; The identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule.
  • HierarchyStartOrganizationName; string; The top-level organization of the organization hierarchy that is assigned to the burden schedule.
  • HierarchyVersionId; string; The identifier of the version of the organization hierarchy that is assigned to the burden schedule.
  • HierarchyVersionName; string; The version of the organization hierarchy that is assigned to the burden schedule.
  • LastUpdateDate; string; The user who last updated the record.
  • LastUpdatedBy; string; The date when the record was last updated.
  • OrganizationClassificationCode; string; 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; 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.
• totalResults: boolean
  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

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

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/awards-AwardProject-AwardProjectOverrideBurdenSchedules-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/awards-AwardProject-AwardProjectOverrideBurdenSchedules-item-response"
    },
    "x-cardinality":"1"
}

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 : awards-AwardProject-AwardProjectOverrideBurdenSchedules-item-response

Type: object

Show Source

• AwardId: integer (int64)
  Title: Award ID

  Identifier of the award.
• AwardProjectId: integer (int64)
  Title: Award Project ID

  Identifier of the award project.
• BurdenScheduleDescription: string
  Title: Description

  Maximum Length: 250

  The description of a burden schedule which is set of burden multipliers that is maintained for use across projects.
• BurdenScheduleId: integer (int64)
  Title: Burden Schedule ID

  Read Only: true

  Identifier of the burden schedule.
• BurdenScheduleName: string
  Title: Burden Schedule

  Maximum Length: 30

  The name of a burden schedule which is set of burden multipliers that is maintained for use across projects.
• 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.
• DefaultBurdenStructureName: string
  Title: Default Burden Structure

  Maximum Length: 30

  The 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 Code

  Maximum Length: 30

  The internal code of the structure that determines the relationships between organizations.
• DefaultOrganizationHierarchyName: string
  Title: Default Organization Hierarchy

  Maximum Length: 80

  A 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 ID

  The identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule.
• HierarchyStartOrganizationName: string
  Title: Hierarchy Start Organization

  Maximum Length: 240

  The top-level organization of the organization hierarchy that is assigned to the burden schedule.
• 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.
• HierarchyVersionName: string
  Title: Hierarchy Version

  Maximum Length: 80

  The version of the organization hierarchy that is assigned to the burden schedule.
• 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.
• 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.
• Versions: array Versions
  Title: Versions

  The Versions resource is used to view and create versions for the override burden schedule assigned to the award project.

{
    "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
        },
        "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
        },
        "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.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "DefaultOrganizationHierarchyCode",
                    "DefaultOrganizationHierarchyName",
                    "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
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"Identifier of the award.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "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.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "DefaultOrganizationHierarchyCode",
                    "DefaultOrganizationHierarchyName",
                    "HierarchyVersionId",
                    "TreeStructureCode"
                ]
            },
            "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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DefaultOrganizationHierarchyCode",
                    "DefaultOrganizationHierarchyName",
                    "HierarchyStartOrganizationId",
                    "HierarchyVersionId",
                    "HierarchyVersionName",
                    "TreeStructureCode"
                ]
            },
            "x-queryable":true
        },
        "DefaultOrganizationHierarchyName":{
            "title":"Default Organization Hierarchy",
            "maxLength":"80",
            "type":"string",
            "description":"A 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.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "DefaultOrganizationHierarchyCode"
                ]
            },
            "x-queryable":true
        },
        "BurdenScheduleId":{
            "title":"Burden Schedule ID",
            "type":"integer",
            "description":"Identifier of the burden schedule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "BurdenScheduleDescription":{
            "title":"Description",
            "maxLength":"250",
            "type":"string",
            "description":"The description of a burden schedule which is set of burden multipliers that is maintained for use across projects.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultOrganizationHierarchyCode":{
            "title":"Default 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
        },
        "Versions":{
            "title":"Versions",
            "type":"array",
            "description":"The Versions resource is used to view and create versions for the override burden schedule assigned to the award project.",
            "items":{
                "$ref":"#/components/schemas/awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-item-response"
            }
        },
        "BurdenScheduleName":{
            "title":"Burden Schedule",
            "maxLength":"30",
            "type":"string",
            "description":"The name of a burden schedule which is set of burden multipliers that is maintained for use across projects.",
            "nullable":false,
            "x-queryable":true
        },
        "DefaultBurdenStructureName":{
            "title":"Default Burden Structure",
            "maxLength":"30",
            "type":"string",
            "description":"The 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.",
            "nullable":false,
            "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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18",
                "dependencies":[
                    "DefaultOrganizationHierarchyCode",
                    "DefaultOrganizationHierarchyName",
                    "HierarchyVersionId",
                    "HierarchyVersionName",
                    "TreeStructureCode"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AwardProjectId":{
            "title":"Award Project ID",
            "type":"integer",
            "description":"Identifier of the award project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18",
                "dependencies":[
                    "AwardId"
                ]
            },
            "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
        }
    }
}

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 : Versions

Type: array

Title: Versions

The Versions resource is used to view and create versions for the override burden schedule assigned to the award project.

Show Source

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

{
    "title":"Versions",
    "type":"array",
    "description":"The Versions resource is used to view and create versions for the override burden schedule assigned to the award project.",
    "items":{
        "$ref":"#/components/schemas/awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-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-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 : 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"
    }
}

Back to Top

Examples

The following example shows how to get all the burden schedule override for the award project by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100043712585/child/AwardProject/300100043492147/child/AwardProjectOverrideBurdenSchedules

Response Body Example

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

{
    "items": [
        {
            "BurdenScheduleId": 300100176954397,
            "AwardId": 300100043712585,
            "AwardProjectId": 300100043492137,
            "BurdenScheduleName": "sr_Override12",
            "BurdenScheduleDescription": null,
            "DefaultBurdenStructureName": "CP Buildup Structure",
            "DefaultOrganizationHierarchyName": "PRJ Tree Code",
            "DefaultOrganizationHierarchyCode": "PRJ Tree Code",
            "HierarchyVersionName": "PRJ Tree Code",
            "HierarchyVersionId": "26D7D8EF39285ADAE053A8D0F00A9EF1",
            "HierarchyStartOrganizationName": "Vision Corporation Enterprise",
            "HierarchyStartOrganizationId": 202,
            "CreatedBy": "ABRAHAM.MASON",
            "CreationDate": "2019-04-18T04:50:19+00:00",
            "LastUpdateDate": "2019-04-18T04:50:19.110+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/
300100043712585/child/AwardProject/300100043492147/child/AwardProjectOverrideBurdenSchedules/300100176954397",
                    "name": "AwardProjectOverrideBurdenSchedules",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E74656
7657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100043712585/child/AwardProject/300100043492147/child/AwardProjectOverrideBurdenSchedules/300100176954397",
                    "name": "AwardProjectOverrideBurdenSchedules",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100043712585/child/AwardProject/300100043492147",
                    "name": "AwardProject",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100043712585/child/AwardProject/300100043492147/child/AwardProjectOverrideBurdenSchedules/300100176954397/lov/OrgClassificationPVOForLOVVA",
                    "name": "OrgClassificationPVOForLOVVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100043712585/child/AwardProject/300100043492147/child/AwardProjectOverrideBurdenSchedules/300100176954397/lov/ProjectOrgTreePVOForNameLOVVA",
                    "name": "ProjectOrgTreePVOForNameLOVVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100043712585/child/AwardProject/300100043492147/child/AwardProjectOverrideBurdenSchedules/300100176954397/lov/ProjectOrgTreeVersionPVOForNameLOVVA",
                    "name": "ProjectOrgTreeVersionPVOForNameLOVVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100043712585/child/AwardProject/300100043492147/child/AwardProjectOverrideBurdenSchedules/300100176954397/lov/ProjectOrgTreeRESTVVOForOrgLOVVA",
                    "name": "ProjectOrgTreeRESTVVOForOrgLOVVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100043712585/child/AwardProject/300100043492147/child/AwardProjectOverrideBurdenSchedules/300100176954397/lov/ProjectOrgTreePVOForCodeLOVVA",
                    "name": "ProjectOrgTreePVOForCodeLOVVA",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100043712585/child/AwardProject/300100043492147/child/AwardProjectOverrideBurdenSchedules/300100176954397/child/Versions",
                    "name": "Versions",
                    "kind": "collection"
                }
            ]
        }  
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100043712585/child/AwardProject/300100043492147/child/AwardProjectOverrideBurdenSchedules",
            "name": "AwardProjectOverrideBurdenSchedules",
            "kind": "collection"
        }
    ]
} 

Back to Top