Jump to

• Request
• Response

Create a Resource Planning Scenario

post

/api/restapi/resourcePlanningScenario

Send a request to this endpoint to create Resource Planning Scenario. An application object will be created using the JSON data provided in the request body.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityResourcePlanningScenarioInput

Type: object

Title: ApiEntityResourcePlanningScenarioInput

Show Source

• capitalPortfolioId: integer (int64)
  Deprecated. As of 25.8.
  The system-generated identifier of the Portfolio.
• capitalPortfolioName: string
  Deprecated. As of 25.8.
  The name of the Portfolio.
• hidden: boolean
  The flag indicating whether the scenario is visible or hidden.
• planPeriod: integer (int32)
  The period during which resources are allocated to projects within the plan. This value determines the year in which resource planning timescales start. You can set the planning period to either the current or following year. For example, if the year is 2025, the latest planning period you can set is 2026. After the planning period for a resource plan has been set it cannot be changed.
• scenarioDescription: string
  The description of a scenario.
• scenarioId: integer (int64)
  The system-generated identifier of the Resource Plan Scenario.
• scenarioName: string
  The name of Resource Plan Scenario.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ApiEntityResourcePlanningScenarioInput",
    "type":"object",
    "properties":{
        "scenarioId":{
            "type":"integer",
            "description":"The system-generated identifier of the Resource Plan Scenario.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scenarioName":{
            "type":"string",
            "description":"The name of Resource Plan Scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "planPeriod":{
            "type":"integer",
            "description":"The period during which resources are allocated to projects within the plan. This value determines the year in which resource planning timescales start. You can set the planning period to either the current or following year. For example, if the year is 2025, the latest planning period you can set is 2026. After the planning period for a resource plan has been set it cannot be changed.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "hidden":{
            "type":"boolean",
            "description":"The flag indicating whether the scenario is visible or hidden.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "scenarioDescription":{
            "type":"string",
            "description":"The description of a scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "capitalPortfolioId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>25.8</i>.</br>The system-generated identifier of the Portfolio.",
            "format":"int64",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "capitalPortfolioName":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>25.8</i>.</br>The name of the Portfolio.",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityResourcePlanningScenario

Type: object

Title: ApiEntityResourcePlanningScenario

Show Source

• allocatedCost: number (double)
  The total cost associated with the roles allocations made on the scenario. This is calculated based on the standard role rates.
• allocationDuration: number (double)
  The total duration of the allocation in scenario.
• allocationFinish: string (date-time)
  The end date for the allocation in scenario.
• allocationStart: string (date-time)
  The start date for the allocation in scenario.
• capitalPortfolioId: integer (int64)
  Deprecated. As of 25.8.
  The system-generated identifier of the Portfolio.
• capitalPortfolioName: string
  Deprecated. As of 25.8.
  The name of the Portfolio.
• committedCost: number (double)
  The total cost associated with the roles committed units on the scenario. This is calculated based on the standard role rates.
• committedDuration: number (double)
  The total duration of the commitment in scenario.
• committedFinishDate: string (date-time)
  The end date for the committed data in scenario.
• committedStartDate: string (date-time)
  The start date for the committed data in scenario.
• createDate: string (date-time)
  The created date of the Resource Plan Scenario .
• createdBy: string
  The scenario created username.
• hidden: boolean
  The flag indicating whether the scenario is visible or hidden.
• lastRefreshDate: string (date-time)
  The date a refresh was last performed on the portfolio resource plan scenario.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• owner: string
  The owner of Resource Plan Scenario.
• periods: array periods
  The period data associated with resource plan scenario.
• planPeriod: integer (int32)
  The period during which resources are allocated to projects within the plan. This value determines the year in which resource planning timescales start. You can set the planning period to either the current or following year. For example, if the year is 2025, the latest planning period you can set is 2026. After the planning period for a resource plan has been set it cannot be changed.
• projectCount: integer (int32)
  The total number of projects included in a resource plan scenario.
• projects: array projects
  The plan projects associated with a scenario.
• proposedCost: number (double)
  The total cost associated with the roles proposed units on the scenario. This is calculated based on the standard role rates.
• proposedDuration: number (double)
  The total duration of the proposed data in scenario.
• proposedFinishDate: string (date-time)
  TThe start date for the proposed data in scenario.
• proposedStartDate: string (date-time)
  The start date for the proposed data in scenario.
• resourcePlanId: integer (int64)
  The system-generated identifier of the Resource Plan.
• resourcePlanStatus: string
  Allowed Values: [ "IN_PLANNING", "CLOSED", "APPROVED", "REVISING" ]

  The current resource status of a portfolio. In Planning: The portfolio is currently going through the resource planning process and contains one or more scenarios in planning. This status is set based on the status of scenarios and cannot be edited manually. In Planning is the default resource status. Revising: The portfolio currently has one scenario with a status of approved and another with a status of Under Review, Shared, or Under Approval. This status is set based on the status of scenarios and cannot be edited manually. Approved: The portfolio contains a scenario that has gone through the approval process and has been approved. This status is set based on the status of scenarios and cannot be edited manually.
• scenarioDescription: string
  The description of a scenario.
• scenarioId: integer (int64)
  The system-generated identifier of the Resource Plan Scenario.
• scenarioName: string
  The name of Resource Plan Scenario.
• scenarioStatus: string
  Allowed Values: [ "APPROVED", "UNDER_REVIEW", "IN_PLANNING", "UNDER_APPROVAL", "RETIRED", "SHARED", "PENDING_APPROVAL", "PENDING_SHARED", "PENDING_IN_PLANNING" ]

  The status of Resource Plan Scenario.
• totalAllocatedFTEUnit: number
  The total allocated FTE for a scenario. Calculated as Total Allocation divided by Allocation Duration.
• totalAllocatedUnit: number (double)
  The total units allocated for a scenario.
• totalCommittedFTEUnits: number
  The committed FTE in a scenario.
• totalCommittedUnit: number (double)
  The total units committed in scenario.
• totalProposedFTEUnits: number
  The proposed FTE in scenario.
• totalProposedUnit: number (double)
  The total cost associated with the roles committed units on the scenario. This is calculated based on the standard role rates.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ApiEntityResourcePlanningScenario",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCount":{
            "type":"integer",
            "description":"The total number of projects included in a resource plan scenario.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "owner":{
            "type":"string",
            "description":"The owner of Resource Plan Scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createDate":{
            "type":"string",
            "description":"The created date of the Resource Plan Scenario .",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "scenarioId":{
            "type":"integer",
            "description":"The system-generated identifier of the Resource Plan Scenario.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scenarioName":{
            "type":"string",
            "description":"The name of Resource Plan Scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scenarioStatus":{
            "type":"string",
            "description":"The status of Resource Plan Scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "APPROVED",
                "UNDER_REVIEW",
                "IN_PLANNING",
                "UNDER_APPROVAL",
                "RETIRED",
                "SHARED",
                "PENDING_APPROVAL",
                "PENDING_SHARED",
                "PENDING_IN_PLANNING"
            ]
        },
        "planPeriod":{
            "type":"integer",
            "description":"The period during which resources are allocated to projects within the plan. This value determines the year in which resource planning timescales start. You can set the planning period to either the current or following year. For example, if the year is 2025, the latest planning period you can set is 2026. After the planning period for a resource plan has been set it cannot be changed.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "hidden":{
            "type":"boolean",
            "description":"The flag indicating whether the scenario is visible or hidden.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "lastRefreshDate":{
            "type":"string",
            "description":"The date a refresh was last performed on the portfolio resource plan scenario.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "createdBy":{
            "type":"string",
            "description":"The scenario created username.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scenarioDescription":{
            "type":"string",
            "description":"The description of a scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projects":{
            "type":"array",
            "description":"The plan projects associated with a scenario.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityResourcePlanProject",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "periods":{
            "type":"array",
            "description":"The period data associated with resource plan scenario.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRoleDataPeriod",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "capitalPortfolioId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>25.8</i>.</br>The system-generated identifier of the Portfolio.",
            "format":"int64",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "committedFinishDate":{
            "type":"string",
            "description":"The end date for the committed data in scenario.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "committedDuration":{
            "type":"number",
            "description":"The total duration of the commitment in scenario.",
            "format":"double",
            "exampleSetFlag":false
        },
        "committedStartDate":{
            "type":"string",
            "description":"The start date for the committed data in scenario.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "allocationDuration":{
            "type":"number",
            "description":"The total duration of the allocation in scenario.",
            "format":"double",
            "exampleSetFlag":false
        },
        "resourcePlanStatus":{
            "type":"string",
            "description":"The current resource status of a portfolio. In Planning: The portfolio is currently going through the resource planning process and contains one or more scenarios in planning. This status is set based on the status of scenarios and cannot be edited manually. In Planning is the default resource status. Revising: The portfolio currently has one scenario with a status of approved and another with a status of Under Review, Shared, or Under Approval. This status is set based on the status of scenarios and cannot be edited manually. Approved: The portfolio contains a scenario that has gone through the approval process and has been approved. This status is set based on the status of scenarios and cannot be edited manually.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "IN_PLANNING",
                "CLOSED",
                "APPROVED",
                "REVISING"
            ]
        },
        "capitalPortfolioName":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>25.8</i>.</br>The name of the Portfolio.",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "totalCommittedUnit":{
            "type":"number",
            "description":"The total units committed in scenario.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalProposedUnit":{
            "type":"number",
            "description":"The total cost associated with the roles committed units on the scenario. This is calculated based on the standard role rates.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCommittedFTEUnits":{
            "type":"number",
            "description":"The committed FTE in a scenario.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "totalAllocatedUnit":{
            "type":"number",
            "description":"The total units allocated for a scenario.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedDuration":{
            "type":"number",
            "description":"The total duration of the proposed data in scenario.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocationFinish":{
            "type":"string",
            "description":"The end date for the allocation in scenario.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "totalAllocatedFTEUnit":{
            "type":"number",
            "description":"The total allocated FTE for a scenario. Calculated as Total Allocation divided by Allocation Duration.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "totalProposedFTEUnits":{
            "type":"number",
            "description":"The proposed FTE in scenario.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "resourcePlanId":{
            "type":"integer",
            "description":"The system-generated identifier of the Resource Plan.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "allocatedCost":{
            "type":"number",
            "description":"The total cost associated with the roles allocations made on the scenario. This is calculated based on the standard role rates.",
            "format":"double",
            "exampleSetFlag":false
        },
        "committedCost":{
            "type":"number",
            "description":"The total cost associated with the roles committed units on the scenario. This is calculated based on the standard role rates.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocationStart":{
            "type":"string",
            "description":"The start date for the allocation in scenario.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedCost":{
            "type":"number",
            "description":"The total cost associated with the roles proposed units on the scenario. This is calculated based on the standard role rates.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedStartDate":{
            "type":"string",
            "description":"The start date for the proposed data in scenario.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedFinishDate":{
            "type":"string",
            "description":"TThe start date for the proposed data in scenario.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : periods

Type: array

The period data associated with resource plan scenario.

Show Source

• Array of: object ApiEntityRoleDataPeriod
  Title: ApiEntityRoleDataPeriod

{
    "type":"array",
    "description":"The period data associated with resource plan scenario.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityRoleDataPeriod",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : projects

Type: array

The plan projects associated with a scenario.

Show Source

• Array of: object ApiEntityResourcePlanProject
  Title: ApiEntityResourcePlanProject

{
    "type":"array",
    "description":"The plan projects associated with a scenario.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityResourcePlanProject",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityRoleDataPeriod

Type: object

Title: ApiEntityRoleDataPeriod

Show Source

• allocatedDataUnits: number (double)
  Allocated units for a period of a role.
• allocatedDataUnitsFTE: number
  Allocated FTE for a period of a role.
• committedDataUnits: number (double)
  Committed units for a period of a role.
• committedDataUnitsFTE: number
  Committed FTE for a period of a role.
• end: string (date-time)
  End date of a individual period.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• proposedDataUnits: number (double)
  Proposed units for a period of a role.
• proposedDataUnitsFTE: number
  Proposed FTE for a period of a role
• roleDataPerDataPeriodCost: roleDataPerDataPeriodCost
  Associated costs for a period of a role.
• start: string (date-time)
  Start date of a individual period.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityRoleDataPeriod",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "start":{
            "type":"string",
            "description":"Start date of a individual period.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "roleDataPerDataPeriodCost":{
            "description":"Associated costs for a period of a role.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityRoleDataPeriodCost"
                }
            ]
        },
        "proposedDataUnits":{
            "type":"number",
            "description":"Proposed units for a period of a role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedDataUnitsFTE":{
            "type":"number",
            "description":"Proposed FTE for a period of a role",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "allocatedDataUnits":{
            "type":"number",
            "description":"Allocated units for a period of a role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedDataUnitsFTE":{
            "type":"number",
            "description":"Allocated FTE for a period of a role.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "committedDataUnitsFTE":{
            "type":"number",
            "description":"Committed FTE for a period of a role.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "committedDataUnits":{
            "type":"number",
            "description":"Committed units for a period of a role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "end":{
            "type":"string",
            "description":"End date of a individual period.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : roleDataPerDataPeriodCost

Associated costs for a period of a role.

Match All

Associated costs for a period of a role.

Show Source

• object ApiEntityRoleDataPeriodCost
  Title: ApiEntityRoleDataPeriodCost

{
    "description":"Associated costs for a period of a role.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityRoleDataPeriodCost"
        }
    ]
}

Nested Schema : ApiEntityRoleDataPeriodCost

Type: object

Title: ApiEntityRoleDataPeriodCost

Show Source

• allocatedCost: number (double)
  Allocated cost for a period for a role.
• committedCost: number (double)
  Committed cost for a period for a role.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• proposedCost: number (double)
  Proposed cost for a period for a role.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityRoleDataPeriodCost",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "allocatedCost":{
            "type":"number",
            "description":"Allocated cost for a period for a role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "committedCost":{
            "type":"number",
            "description":"Committed cost for a period for a role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedCost":{
            "type":"number",
            "description":"Proposed cost for a period for a role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityResourcePlanProject

Type: object

Title: ApiEntityResourcePlanProject

Show Source

• allocationFinish: string (date-time)
  The finish date for the allocation in project.
• allocationStart: string (date-time)
  The start date for the allocation in project.
• committedFinishDate: string (date-time)
  The end date for the committed data in project.
• committedStartDate: string (date-time)
  The start date for the committed data in project.
• description: string
  The description of a project.
• finishDate: string (date-time)
  The finish date of a plan project.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• periods: array periods
  The period data associated with a plan project.
• projectCode: string
  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier of a project.
• projectName: string
  The name of a plan project associated with a scenario.
• projectTotalAllocationDuration: number (double)
  The total duration of the allocation in project.
• proposedEndDate: string (date-time)
  The end date for the proposed data in project.
• proposedStartDate: string (date-time)
  The start date for the proposed data in project.
• roleAllocations: array roleAllocations
  The role data associated with plan project.
• startDate: string (date-time)
  The start date of a plan project.
• state: string
  Allowed Values: [ "SELECTED", "UNSELECTED", "FORCED_IN", "FORCED_OUT" ]

  The state of capital plan project. Allowed Values:[ "SELECTED","UNSELECTED","FORCED_IN","FORCED_OUT"]
• totalAllocatedCost: number (double)
  The total cost associated with the roles allocations made on project.
• totalAllocatedFTEUnit: number
  The total allocated FTE in project.
• totalAllocatedUnit: number (double)
  The total units allocated in project.
• totalCommittedCost: number (double)
  The total cost associated with the roles committed units on project.
• totalCommittedDuration: number (double)
  The total duration of the commitment in project.
• totalCommittedFTEUnit: number
  The committed FTE in project.
• totalCommittedUnit: number (double)
  The total units committed in project.
• totalProposedAllocationUnit: number (double)
  The total units proposed in project.
• totalProposedCost: number (double)
  The total cost associated with the roles proposed units on project.
• totalProposedDuration: number (double)
  The total duration of the proposed data in project.
• totalProposedFTEUnit: number
  The proposed FTE in project.
• undistributedAllocation: number (double)
  The total allocated units which are not distributed into any time buckets in project.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ApiEntityResourcePlanProject",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "state":{
            "type":"string",
            "description":"The state of capital plan project. Allowed Values:[ \"SELECTED\",\"UNSELECTED\",\"FORCED_IN\",\"FORCED_OUT\"]",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SELECTED",
                "UNSELECTED",
                "FORCED_IN",
                "FORCED_OUT"
            ]
        },
        "periods":{
            "type":"array",
            "description":"The period data associated with a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRoleDataPeriod",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "description":{
            "type":"string",
            "description":"The description of a project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectName":{
            "type":"string",
            "description":"The name of a plan project associated with a scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "committedFinishDate":{
            "type":"string",
            "description":"The end date for the committed data in project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "committedStartDate":{
            "type":"string",
            "description":"The start date for the committed data in project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "totalCommittedUnit":{
            "type":"number",
            "description":"The total units committed in project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalAllocatedUnit":{
            "type":"number",
            "description":"The total units allocated in project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocationFinish":{
            "type":"string",
            "description":"The finish date for the allocation in project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "totalAllocatedFTEUnit":{
            "type":"number",
            "description":"The total allocated FTE in project.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "totalCommittedFTEUnit":{
            "type":"number",
            "description":"The committed FTE in project.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "undistributedAllocation":{
            "type":"number",
            "description":"The total allocated units which are not distributed into any time buckets in project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectTotalAllocationDuration":{
            "type":"number",
            "description":"The total duration of the allocation in project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCommittedCost":{
            "type":"number",
            "description":"The total cost associated with the roles committed units on project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalProposedFTEUnit":{
            "type":"number",
            "description":"The proposed FTE in project.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "totalProposedAllocationUnit":{
            "type":"number",
            "description":"The total units proposed in project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalProposedDuration":{
            "type":"number",
            "description":"The total duration of the proposed data in project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalAllocatedCost":{
            "type":"number",
            "description":"The total cost associated with the roles allocations made on project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalProposedCost":{
            "type":"number",
            "description":"The total cost associated with the roles proposed units on project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCommittedDuration":{
            "type":"number",
            "description":"The total duration of the commitment in project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocationStart":{
            "type":"string",
            "description":"The start date for the allocation in project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedEndDate":{
            "type":"string",
            "description":"The end date for the proposed data in project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "roleAllocations":{
            "type":"array",
            "description":"The role data associated with plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityResourceRoleData",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "proposedStartDate":{
            "type":"string",
            "description":"The start date for the proposed data in project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"The start date of a plan project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "finishDate":{
            "type":"string",
            "description":"The finish date of a plan project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : periods

Type: array

The period data associated with a plan project.

Show Source

• Array of: object ApiEntityRoleDataPeriod
  Title: ApiEntityRoleDataPeriod

{
    "type":"array",
    "description":"The period data associated with a plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityRoleDataPeriod",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : roleAllocations

Type: array

The role data associated with plan project.

Show Source

• Array of: object ApiEntityResourceRoleData
  Title: ApiEntityResourceRoleData

{
    "type":"array",
    "description":"The role data associated with plan project.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityResourceRoleData",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityResourceRoleData

Type: object

Title: ApiEntityResourceRoleData

Show Source

• allocatedCost: number (double)
  The total cost associated with a role.
• allocationFinish: string (date-time)
  The end date for the allocation for role.
• allocationStart: string (date-time)
  The start date for the allocation for role.
• allocattedDuration: number (double)
  Duration of the allocation for role.
• committedFinishDate: string (date-time)
  The end date for the committed data for role.
• committedStartDate: string (date-time)
  The start date for the committed data for role.
• id: integer (int64)
  The unique identifier of a role.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• periods: array periods
  The period data associated with role.
• proposedAllocationUnits: number (double)
  The total units proposed for role.
• proposedDuration: number (double)
  Duration of the proposed data for role.
• proposedEndDate: string (date-time)
  The end date for the proposed data for role.
• proposedStartDate: string (date-time)
  The start date for the proposed data for role.
• proposedUnitFTE: number
  The proposed FTE for role.
• resourceCode: string
  The user-specified identifier of a role.
• resourceName: string
  The name of role.
• totalAllocatedFTEUnit: number
  The total allocated FTE for role.
• totalAllocatedUnit: number (double)
  The total units allocated for role.
• totalCommittedDuration: number (double)
  The total duration of the commitment for role.
• totalCommittedFTEUnit: number
  The committed FTE for role.
• totalCommittedUnit: number (double)
  The total units committed for role.
• undistributedAllocation: number (double)
  The total allocated units which are not distributed into any time buckets for role.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityResourceRoleData",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The unique identifier of a role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "periods":{
            "type":"array",
            "description":"The period data associated with role.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRoleDataPeriod",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "resourceName":{
            "type":"string",
            "description":"The name of role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "committedFinishDate":{
            "type":"string",
            "description":"The end date for the committed data for role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "committedStartDate":{
            "type":"string",
            "description":"The start date for the committed data for role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "totalCommittedUnit":{
            "type":"number",
            "description":"The total units committed for role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalAllocatedUnit":{
            "type":"number",
            "description":"The total units allocated for role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedDuration":{
            "type":"number",
            "description":"Duration of the proposed data for role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocationFinish":{
            "type":"string",
            "description":"The end date for the allocation for role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "totalAllocatedFTEUnit":{
            "type":"number",
            "description":"The total allocated FTE for role.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "totalCommittedFTEUnit":{
            "type":"number",
            "description":"The committed FTE for role.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "undistributedAllocation":{
            "type":"number",
            "description":"The total allocated units which are not distributed into any time buckets for role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCommittedDuration":{
            "type":"number",
            "description":"The total duration of the commitment for role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocattedDuration":{
            "type":"number",
            "description":"Duration of the allocation for role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedAllocationUnits":{
            "type":"number",
            "description":"The total units proposed for role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocatedCost":{
            "type":"number",
            "description":"The total cost associated with a role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "allocationStart":{
            "type":"string",
            "description":"The start date for the allocation for role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedEndDate":{
            "type":"string",
            "description":"The end date for the proposed data for role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedUnitFTE":{
            "type":"number",
            "description":"The proposed FTE for role.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "resourceCode":{
            "type":"string",
            "description":"The user-specified identifier of a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedStartDate":{
            "type":"string",
            "description":"The start date for the proposed data for role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : periods

Type: array

The period data associated with role.

Show Source

• Array of: object ApiEntityRoleDataPeriod
  Title: ApiEntityRoleDataPeriod

{
    "type":"array",
    "description":"The period data associated with role.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityRoleDataPeriod",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

400 Response

Invalid input for the Resource Planning Scenario service. Verify the request contains valid data, then resubmit the request.

Back to Top