Jump to

• Request
• Response

View all Resource Demands by Project ID

get

/api/restapi/resourceDemand/project/{projectId}

This endpoint returns resource demands that meet the following requirements:

• The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.

Request

Path Parameters

• projectId(required): integer(int64)
  The system-generated identifier of a project.

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<ApiEntityResourceDemand>

Type: array

Title: List<ApiEntityResourceDemand>

Show Source

• Array of: object ApiEntityResourceDemand
  Title: ApiEntityResourceDemand

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

Nested Schema : ApiEntityResourceDemand

Type: object

Title: ApiEntityResourceDemand

Show Source

• allocationPercentage: number (double)
  The allocation of the current role, displayed as a percentage of the availability of the role.
• commitDuration: number (double)
  The total duration of the commitments.
• commitEndDate: string (date-time)
  The finish date of the allocation commitment.
• commitFTE: number
  The total committed FTE. Calculated as total commitment units divided by total commitment duration.
• commitStartDate: string (date-time)
  The start date of the allocation commitment.
• committedUnits: integer (int64)
  The sum of committed units for a given project - role demand.
• demandFTE: number
  The total demand FTE. Calculated as total demand units divided by total demand duration.
• demandUnits: integer (int64)
  The sum of the demand units entered for a single role.
• duration: number (double)
  The total expected duration of the demand.
• endDate: string (date-time)
  The finish date for the demand.
  Calculated as Start plus Total Demand.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• periodId: integer (int64)
  The unique identifier for the period.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• proposedAllocationUnits: integer (int64)
  The total role allocation units proposed.
• proposedDuration: number (double)
  The total duration of the proposed role allocation units.
• proposedEndDate: string (date-time)
  The finish date of the proposed role allocations.
• proposedFTE: number
  The total proposed allocation FTE. Calculated as total proposed role allocation units divided by the total proposed role allocation duration.
• proposedStartDate: string (date-time)
  The start date of the proposed role allocations.
• requesterId: integer (int64)
  The unique identifier of the user who submitted the demand.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class identifies the item as a resource or a role.
• resourceCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the resource or role.
• resourceDemandCost: resourceDemandCost
  The total cost associated with the role's demand. This is calculated based on the standard role rates.
• resourceDemandData: array resourceDemandData
  Data about demand for the resource.
• resourceDemandId: integer (int64)
  The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.
• resourceId: integer (int64)
  The unique identifier for the resource.The resource object can also be identified by its unique criteria.
• sequenceNumber: integer (int32)
  Determines the order of appearance of demands in a list.
• startDate: string (date-time)
  The start date for the demand.
• status: string
  Allowed Values: [ "DRAFT", "COMMITTED", "NEW", "REVISED", "REVIEWED" ]

  The status of the current demand.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityResourceDemand",
    "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"
            ]
        },
        "duration":{
            "type":"number",
            "description":"The total expected duration of the demand.",
            "format":"double",
            "exampleSetFlag":false
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"Determines the order of appearance of demands in a list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "status":{
            "type":"string",
            "description":"The status of the current demand.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "COMMITTED",
                "NEW",
                "REVISED",
                "REVIEWED"
            ]
        },
        "demandUnits":{
            "type":"integer",
            "description":"The sum of the demand units entered for a single role.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "allocationPercentage":{
            "type":"number",
            "description":"The allocation of the current role, displayed as a percentage of the availability of the role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "commitStartDate":{
            "type":"string",
            "description":"The start date of the allocation commitment.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "commitEndDate":{
            "type":"string",
            "description":"The finish date of the allocation commitment.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceDemandId":{
            "type":"integer",
            "description":"The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "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 for the demand.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class identifies the item as a resource or a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "periodId":{
            "type":"integer",
            "description":"The unique identifier for the period.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "endDate":{
            "type":"string",
            "description":"The finish date for the demand. <br />Calculated as Start plus Total Demand.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedStartDate":{
            "type":"string",
            "description":"The start date of the proposed role allocations.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "requesterId":{
            "type":"integer",
            "description":"The unique identifier of the user who submitted the demand.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceDemandData":{
            "type":"array",
            "description":"Data about demand for the resource.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityResourceDemandData",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "proposedAllocationUnits":{
            "type":"integer",
            "description":"The total role allocation units proposed.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "proposedEndDate":{
            "type":"string",
            "description":"The finish date of the proposed role allocations.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "proposedDuration":{
            "type":"number",
            "description":"The total duration of the proposed role allocation units.",
            "format":"double",
            "exampleSetFlag":false
        },
        "demandFTE":{
            "type":"number",
            "description":"The total demand FTE. Calculated as total demand units divided by total demand duration.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "commitFTE":{
            "type":"number",
            "description":"The total committed FTE. Calculated as total commitment units divided by total commitment duration.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "proposedFTE":{
            "type":"number",
            "description":"The total proposed allocation FTE. Calculated as total proposed role allocation units divided by the total proposed role allocation duration.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "commitDuration":{
            "type":"number",
            "description":"The total duration of the commitments.",
            "format":"double",
            "exampleSetFlag":false
        },
        "committedUnits":{
            "type":"integer",
            "description":"The sum of committed units for a given project - role demand.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "resourceDemandCost":{
            "description":"The total cost associated with the role's demand. This is calculated based on the standard role rates.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityResourceDemandCost"
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : resourceDemandCost

The total cost associated with the role's demand. This is calculated based on the standard role rates.

Match All

Show Source

• object ApiEntityResourceDemandCost
  Title: ApiEntityResourceDemandCost

{
    "description":"The total cost associated with the role's demand. This is calculated based on the standard role rates.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityResourceDemandCost"
        }
    ]
}

Nested Schema : resourceDemandData

Type: array

Data about demand for the resource.

Show Source

• Array of: object ApiEntityResourceDemandData
  Title: ApiEntityResourceDemandData

{
    "type":"array",
    "description":"Data about demand for the resource.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityResourceDemandData",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityResourceDemandCost

Type: object

Title: ApiEntityResourceDemandCost

Show Source

• committedCost: number (double)
  The total cost associated with the role's committed units. This is calculated based on the standard role rates. This field is in base currency and is calculated from committedCostProject field based on the specified exchange rate.
• committedCostProject: number (double)
  The total cost associated with the role's committed units in a project. This is calculated based on the standard role rates. This value is based on the project currency.
• demandCost: number (double)
  The total cost associated with the role's demand. This is calculated based on the standard role rates. This field is in base currency and is calculated from demandCostProject field based on the specified exchange rate.
• demandCostProject: number (double)
  The total cost associated with the role's demand in a project. This is calculated based on the standard role rates. This value is based on the project currency.
• demandId: integer (int64)
  The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectId: integer (int64)
  The unique identifier for the project.
• proposedCost: number (double)
  The total cost associated with the role's proposed allocation units. This is calculated based on the standard role rates. This field is in base currency and is calculated from proposedCostProject field based on the specified exchange rate.
• proposedCostProject: number (double)
  The total cost associated with the role's proposed allocation units in a project. This is calculated based on the standard role rates. This value is based on the project currency.
• resourceId: integer (int64)
  The unique identifier of the assigned role.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityResourceDemandCost",
    "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"
            ]
        },
        "demandCost":{
            "type":"number",
            "description":"The total cost associated with the role's demand. This is calculated based on the standard role rates. This field is in base currency and is calculated from demandCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "committedCost":{
            "type":"number",
            "description":"The total cost associated with the role's committed units. This is calculated based on the standard role rates. This field is in base currency and is calculated from committedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedCost":{
            "type":"number",
            "description":"The total cost associated with the role's proposed allocation units. This is calculated based on the standard role rates. This field is in base currency and is calculated from proposedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "demandCostProject":{
            "type":"number",
            "description":"The total cost associated with the role's demand in a project. This is calculated based on the standard role rates. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "committedCostProject":{
            "type":"number",
            "description":"The total cost associated with the role's committed units in a project. This is calculated based on the standard role rates. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedCostProject":{
            "type":"number",
            "description":"The total cost associated with the role's proposed allocation units in a project. This is calculated based on the standard role rates. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "demandId":{
            "type":"integer",
            "description":"The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier of the assigned role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityResourceDemandData

Type: object

Title: ApiEntityResourceDemandData

Show Source

• allocatedUnits: integer (int64)
  The unit allocation for the current role.
• commitDate: string (date-time)
  The commitment date for the demand.
• committedFlag: boolean
  Indicates whether the weekly demand data is committed.
• committedUnits: integer (int64)
  The total committed units of the weekly demand data.
• demandDataId: integer (int64)
  The unique identifier for the weekly demand data.
• demandUnits: integer (int64)
  The demand units entered for a single role.
• duration: number (double)
  The total expected duration of the weekly demand data.
• endDate: string (date-time)
  The finish date for the weekly demand data.
  Calculated as Start plus Total Demand.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• proposedAllocationUnits: integer (int64)
  The total proposed duration of the demand.
• proposedDuration: number (double)
  The total role allocation units proposed.
• resourceDemandDataCost: resourceDemandDataCost
  The total cost associated with the role's demand. This is calculated based on the standard role rates.
• resourceDemandId: integer (int64)
  The unique identifier for the demand.
• startDate: string (date-time)
  The start date for the weekly demand data.
• startOfMonth: string (date-time)
  The month in which the demand starts.
• status: string
  Allowed Values: [ "DRAFT", "COMMITTED", "NEW", "REVISED", "REVIEWED" ]

  The status of the current weekly demand data.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityResourceDemandData",
    "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"
            ]
        },
        "duration":{
            "type":"number",
            "description":"The total expected duration of the weekly demand data.",
            "format":"double",
            "exampleSetFlag":false
        },
        "status":{
            "type":"string",
            "description":"The status of the current weekly demand data.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "COMMITTED",
                "NEW",
                "REVISED",
                "REVIEWED"
            ]
        },
        "demandUnits":{
            "type":"integer",
            "description":"The demand units entered for a single role.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "resourceDemandId":{
            "type":"integer",
            "description":"The unique identifier for the demand.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "allocatedUnits":{
            "type":"integer",
            "description":"The unit allocation for the current role.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "committedFlag":{
            "type":"boolean",
            "description":"Indicates whether the weekly demand data is committed.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "commitDate":{
            "type":"string",
            "description":"The commitment date for the demand.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "startOfMonth":{
            "type":"string",
            "description":"The month in which the demand starts.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "demandDataId":{
            "type":"integer",
            "description":"The unique identifier for the weekly demand data.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"The start date for the weekly demand data.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "endDate":{
            "type":"string",
            "description":"The finish date for the weekly demand data. <br />Calculated as Start plus Total Demand.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceDemandDataCost":{
            "description":"The total cost associated with the role's demand. This is calculated based on the standard role rates.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityResourceDemandDataCost"
                }
            ]
        },
        "proposedAllocationUnits":{
            "type":"integer",
            "description":"The total proposed duration of the demand.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "proposedDuration":{
            "type":"number",
            "description":"The total role allocation units proposed.",
            "format":"double",
            "exampleSetFlag":false
        },
        "committedUnits":{
            "type":"integer",
            "description":"The total committed units of the weekly demand data.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : resourceDemandDataCost

The total cost associated with the role's demand. This is calculated based on the standard role rates.

Match All

Show Source

• object ApiEntityResourceDemandDataCost
  Title: ApiEntityResourceDemandDataCost

{
    "description":"The total cost associated with the role's demand. This is calculated based on the standard role rates.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityResourceDemandDataCost"
        }
    ]
}

Nested Schema : ApiEntityResourceDemandDataCost

Type: object

Title: ApiEntityResourceDemandDataCost

Show Source

• committedCost: number (double)
  The total cost associated with the role's committed units. This is calculated based on the standard role rates. This field is in base currency and is calculated from committedCostProject field based on the specified exchange rate.
• committedCostProject: number (double)
  The total cost associated with the role's committed units in a project. This is calculated based on the standard role rates. This value is based on the project currency.
• demandCost: number (double)
  The total cost associated with the role's demand. This is calculated based on the standard role rates. This field is in base currency and is calculated from demandCostProject field based on the specified exchange rate.
• demandCostProject: number (double)
  The total cost associated with the role's demand in a project. This is calculated based on the standard role rates. This value is based on the project currency.
• demandDataId: integer (int64)
  The unique identifier for the weekly demand data.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• proposedCost: number (double)
  The total cost associated with the role's proposed allocation units. This is calculated based on the standard role rates.?? This field is in base currency and is calculated from proposedCostProject field based on the specified exchange rate.
• proposedCostProject: number (double)
  The total cost associated with the role's proposed allocation units in a project. This is calculated based on the standard role rates. This value is based on the project currency.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityResourceDemandDataCost",
    "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"
            ]
        },
        "demandCost":{
            "type":"number",
            "description":"The total cost associated with the role's demand. This is calculated based on the standard role rates. This field is in base currency and is calculated from demandCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "committedCost":{
            "type":"number",
            "description":"The total cost associated with the role's committed units. This is calculated based on the standard role rates. This field is in base currency and is calculated from committedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedCost":{
            "type":"number",
            "description":"The total cost associated with the role's proposed allocation units. This is calculated based on the standard role rates.?? This field is in base currency and is calculated from proposedCostProject field based on the specified exchange rate. ",
            "format":"double",
            "exampleSetFlag":false
        },
        "demandCostProject":{
            "type":"number",
            "description":"The total cost associated with the role's demand in a project. This is calculated based on the standard role rates. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "committedCostProject":{
            "type":"number",
            "description":"The total cost associated with the role's committed units in a project. This is calculated based on the standard role rates. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "demandDataId":{
            "type":"integer",
            "description":"The unique identifier for the weekly demand data.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "proposedCostProject":{
            "type":"number",
            "description":"The total cost associated with the role's proposed allocation units in a project. This is calculated based on the standard role rates. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

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

Back to Top