Jump to

• Request
• Response

Create an amount type option for a project forecast version

post

/fscmRestApi/resources/11.13.18.05/projectForecasts/{PlanVersionId}/child/PlanningOptions/{PlanningOptionId}/child/AmountTypes

Request

Path Parameters

• PlanVersionId(required): integer(int64)
  Identifier of the forecast version.
• PlanningOptionId(required): integer(int64)
  Identifier of the summary level planning option in the project forecast version.

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

• AmountTypeId: integer (int64)
  Title: Amount Type ID

  Identifier of the project forecast version amount types.
• BillRateFlag: boolean
  Title: Bill rate

  Indicates whether the revenue rate is editable.
• BurdenedCostFlag: boolean
  Title: Burdened Cost

  Indicates whether the burdened cost amounts for a forecast version are editable.
• BurdenedCostRateFlag: boolean
  Title: Burdened Cost Rate

  Indicates whether the burdened cost rate is editable.
• QuantityFlag: boolean
  Title: Quantity

  Maximum Length: 255

  Indicates whether the quantity is editable on a budget or forecast version.
• RawCostFlag: boolean
  Title: Raw Cost

  Indicates whether the raw cost amounts for a forecast version are editable.
• RawCostRateFlag: boolean
  Title: Raw Cost Rate

  Indicates whether the raw cost rate is editable.
• RevenueFlag: boolean
  Title: Revenue

  Indicates whether the revenue for a forecast version is editable.

{
    "type":"object",
    "properties":{
        "RawCostRateFlag":{
            "title":"Raw Cost Rate",
            "type":"boolean",
            "description":"Indicates whether the raw cost rate is editable. ",
            "nullable":true
        },
        "BurdenedCostRateFlag":{
            "title":"Burdened Cost Rate",
            "type":"boolean",
            "description":"Indicates whether the burdened cost rate is editable. ",
            "nullable":true
        },
        "BillRateFlag":{
            "title":"Bill rate",
            "type":"boolean",
            "description":"Indicates whether the revenue rate is editable. ",
            "nullable":true
        },
        "RawCostFlag":{
            "title":"Raw Cost",
            "type":"boolean",
            "description":"Indicates whether the raw cost amounts for a forecast version are editable.",
            "nullable":true
        },
        "RevenueFlag":{
            "title":"Revenue",
            "type":"boolean",
            "description":"Indicates whether the revenue for a forecast version is editable. ",
            "nullable":true
        },
        "BurdenedCostFlag":{
            "title":"Burdened Cost",
            "type":"boolean",
            "description":"Indicates whether the burdened cost amounts for a forecast version are editable.",
            "nullable":true
        },
        "QuantityFlag":{
            "title":"Quantity",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether the quantity is editable on a budget or forecast version.",
            "nullable":true
        },
        "AmountTypeId":{
            "title":"Amount Type ID",
            "type":"integer",
            "description":"Identifier of the project forecast version amount types.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : projectForecasts-PlanningOptions-AmountTypes-item-response

Type: object

Show Source

• AmountTypeId: integer (int64)
  Title: Amount Type ID

  Identifier of the project forecast version amount types.
• BillRateFlag: boolean
  Title: Bill rate

  Indicates whether the revenue rate is editable.
• BurdenedCostFlag: boolean
  Title: Burdened Cost

  Indicates whether the burdened cost amounts for a forecast version are editable.
• BurdenedCostRateFlag: boolean
  Title: Burdened Cost Rate

  Indicates whether the burdened cost rate is editable.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuantityFlag: boolean
  Title: Quantity

  Maximum Length: 255

  Indicates whether the quantity is editable on a budget or forecast version.
• RawCostFlag: boolean
  Title: Raw Cost

  Indicates whether the raw cost amounts for a forecast version are editable.
• RawCostRateFlag: boolean
  Title: Raw Cost Rate

  Indicates whether the raw cost rate is editable.
• RevenueFlag: boolean
  Title: Revenue

  Indicates whether the revenue for a forecast version is editable.

{
    "type":"object",
    "properties":{
        "RawCostRateFlag":{
            "title":"Raw Cost Rate",
            "type":"boolean",
            "description":"Indicates whether the raw cost rate is editable. ",
            "nullable":true,
            "x-queryable":true
        },
        "BurdenedCostRateFlag":{
            "title":"Burdened Cost Rate",
            "type":"boolean",
            "description":"Indicates whether the burdened cost rate is editable. ",
            "nullable":true,
            "x-queryable":true
        },
        "BillRateFlag":{
            "title":"Bill rate",
            "type":"boolean",
            "description":"Indicates whether the revenue rate is editable. ",
            "nullable":true,
            "x-queryable":true
        },
        "RawCostFlag":{
            "title":"Raw Cost",
            "type":"boolean",
            "description":"Indicates whether the raw cost amounts for a forecast version are editable.",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueFlag":{
            "title":"Revenue",
            "type":"boolean",
            "description":"Indicates whether the revenue for a forecast version is editable. ",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BurdenedCostFlag":{
            "title":"Burdened Cost",
            "type":"boolean",
            "description":"Indicates whether the burdened cost amounts for a forecast version are editable.",
            "nullable":true,
            "x-queryable":true
        },
        "QuantityFlag":{
            "title":"Quantity",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether the quantity is editable on a budget or forecast version.",
            "nullable":true,
            "x-queryable":true
        },
        "AmountTypeId":{
            "title":"Amount Type ID",
            "type":"integer",
            "description":"Identifier of the project forecast version amount types.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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