Jump to

• Request
• Response

Update a multiplier in burden schedule version.

patch

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

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.
• MultiplierId(required): integer(int64)
  Identifier of the burden multiplier.
• VersionId(required): integer(int64)
  The identifier of the version of a set of burden multipliers.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• MultiplierNumber: number
  Title: Multiplier

  A numeric multiplier associated with an organization and burden cost code combinations for burden schedule versions. The costing process applies this multiplier to raw cost to calculate burden cost amounts.
• OrganizationClassificationCode: string
  Title: Organization Classification Code

  The internal code for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks.
• OrganizationClassificationName: string
  Title: Organization Classification

  The name for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks.
• OrganizationName: string
  Title: Organization

  Maximum Length: 240

  The organization to which a burden multiplier is assigned for a particular burden cost code.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "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-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"
    }
}

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

Back to Top