Jump to

• Request
• Response

View all Resource Plan Projects

get

/api/restapi/resourcePlanningScenario/planProjects/scenario/{scenarioId}

Send a request to this endpoint to view all resource plan projects in the resource planning scenario.

Request

Path Parameters

• scenarioId(required): integer(int64)
  The system-generated identifier of an Resource Plan Scenario.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityResourcePlanProject>

Type: array

Title: List<ApiEntityResourcePlanProject>

Show Source

• Array of: object ApiEntityResourcePlanProject
  Title: ApiEntityResourcePlanProject

{
    "title":"List<ApiEntityResourcePlanProject>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityResourcePlanProject",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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"
            ]
        },
        "totalProposedAllocationUnit":{
            "type":"number",
            "description":"The total units proposed in project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectTotalAllocationDuration":{
            "type":"number",
            "description":"The total duration of the allocation in project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "totalAllocatedUnit":{
            "type":"number",
            "description":"The total units allocated in project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCommittedUnit":{
            "type":"number",
            "description":"The total units committed in project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalAllocatedFTEUnit":{
            "type":"number",
            "description":"The total allocated FTE in project.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "allocationStart":{
            "type":"string",
            "description":"The start date for the allocation in project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "allocationFinish":{
            "type":"string",
            "description":"The finish date for the allocation 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"
            ]
        },
        "committedFinishDate":{
            "type":"string",
            "description":"The end date for the committed data in project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedStartDate":{
            "type":"string",
            "description":"The start date for the proposed data in project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "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"
            ]
        },
        "proposedEndDate":{
            "type":"string",
            "description":"The end date for the proposed data in project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "undistributedAllocation":{
            "type":"number",
            "description":"The total allocated units which are not distributed into any time buckets in project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCommittedFTEUnit":{
            "type":"number",
            "description":"The committed FTE in project.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "totalProposedFTEUnit":{
            "type":"number",
            "description":"The proposed FTE in project.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "totalCommittedDuration":{
            "type":"number",
            "description":"The total duration of the commitment 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
        },
        "totalCommittedCost":{
            "type":"number",
            "description":"The total cost associated with the roles committed units on project.",
            "format":"double",
            "exampleSetFlag":false
        },
        "roleAllocations":{
            "type":"array",
            "description":"The role data associated with plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityResourceRoleData",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "periods":{
            "type":"array",
            "description":"The period data associated with a plan project.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRoleDataPeriod",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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 : 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"
                }
            ]
        },
        "allocatedDataUnits":{
            "type":"number",
            "description":"Allocated units for a period of a role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedDataUnits":{
            "type":"number",
            "description":"Proposed units for a period of a role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "committedDataUnits":{
            "type":"number",
            "description":"Committed 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"
            ]
        },
        "proposedDataUnitsFTE":{
            "type":"number",
            "description":"Proposed 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"
            ]
        },
        "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"
            ]
        },
        "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
        },
        "allocatedCost":{
            "type":"number",
            "description":"Allocated 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 : 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"
            ]
        },
        "resourceName":{
            "type":"string",
            "description":"The name of role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "allocatedCost":{
            "type":"number",
            "description":"The total cost associated with a role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalAllocatedUnit":{
            "type":"number",
            "description":"The total units allocated for role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCommittedUnit":{
            "type":"number",
            "description":"The total units committed for role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalAllocatedFTEUnit":{
            "type":"number",
            "description":"The total allocated FTE for role.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "allocationStart":{
            "type":"string",
            "description":"The start date for the allocation for role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "allocationFinish":{
            "type":"string",
            "description":"The end date for the allocation 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"
            ]
        },
        "committedFinishDate":{
            "type":"string",
            "description":"The end date for the committed data for role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedStartDate":{
            "type":"string",
            "description":"The start date for the proposed data for role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedDuration":{
            "type":"number",
            "description":"Duration of the proposed data for role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "resourceCode":{
            "type":"string",
            "description":"The user-specified identifier of a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedEndDate":{
            "type":"string",
            "description":"The end date for the proposed data for role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "undistributedAllocation":{
            "type":"number",
            "description":"The total allocated units which are not distributed into any time buckets for role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCommittedFTEUnit":{
            "type":"number",
            "description":"The committed FTE for role.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "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
        },
        "proposedUnitFTE":{
            "type":"number",
            "description":"The proposed FTE for role.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "periods":{
            "type":"array",
            "description":"The period data associated with role.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRoleDataPeriod",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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"
    ]
}

204 Response

Successful operation with no content.

404 Response

The requested object does not exist, or you do not have access to it.

Back to Top