Get all allocations for a project
get
/fscmRestApi/resources/11.13.18.05/projectInsights/{ProjectId}/child/TeamAllocations
Request
Path Parameters
-
ProjectId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds the resource allocation with the specified primary key.
Finder Variables- ResourceId; integer; The unique identifier of the project enterprise labor resource.
- findByResourceId Finds the resource allocation with the specified resource identifier.
Finder Variables- ResourceId; integer; The unique identifier of the project enterprise labor resource.
- PrimaryKey Finds the resource allocation with the specified primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdatedBy; string; The user who last updated the record.
- ResourceId; integer; The unique identifier of the project enterprise labor resource.
- ResourceName; string; The name of the project enterprise labor resource.
- WeekEightAllocatedHours; number; The number of hours allocated to the resource for the week of the project that starts in seven weeks.
- WeekEightAssignedHours; number; The number of hours assigned to the resource for the week of the project that starts in seven weeks.
- WeekEightVariance; number; The variance between the allocated and assigned hours for the week of the project that starts in seven weeks.
- WeekElevenAllocatedHours; number; The number of hours allocated to the resource for the week of the project that starts in ten weeks.
- WeekElevenAssignedHours; number; The number of hours assigned to the resource for the week of the project that starts in ten weeks.
- WeekElevenVariance; number; The variance between the allocated and assigned hours for the week of the project that starts in ten weeks.
- WeekFiveAllocatedHours; number; The number of hours allocated to the resource for the week of the project that starts in four weeks.
- WeekFiveAssignedHours; number; The number of hours assigned to the resource for the week of the project that starts in four weeks.
- WeekFiveToEightAllocatedHours; number; The number of hours allocated to the resource for the four weeks of the project that start in four weeks.
- WeekFiveToEightAssignedHours; number; The number of hours assigned to the resource for the four weeks of the project that start in four weeks.
- WeekFiveToEightVariance; number; The variance between the allocated and assigned hours for the four weeks of the project that start in four weeks.
- WeekFiveVariance; number; The variance between the allocated and assigned hours for the week of the project that starts in four weeks.
- WeekFourAllocatedHours; number; The number of hours allocated to the resource for the week of the project that starts in three weeks.
- WeekFourAssignedHours; number; The number of hours assigned to the resource for the week of the project that starts in three weeks.
- WeekFourVariance; number; The variance between the allocated and assigned hours for the week of the project that starts in three weeks.
- WeekNineAllocatedHours; number; The number of hours allocated to the resource for the week of the project that starts in eight weeks.
- WeekNineAssignedHours; number; The number of hours assigned to the resource for the week of the project that starts in eight weeks.
- WeekNineToTwelveAllocatedHours; number; The number of hours allocated to the resource for the four weeks of the project that start in eight weeks.
- WeekNineToTwelveAssignedHours; number; The number of hours assigned to the resource for the four weeks of the project that start in eight weeks.
- WeekNineToTwelveVariance; number; The variance between the allocated and assigned hours for the four weeks of the project that start in eight weeks.
- WeekNineVariance; number; The variance between the allocated and assigned hours for the week of the project that starts in eight weeks.
- WeekOneAllocatedHours; number; The number of hours allocated to the resource for the current week of the project.
- WeekOneAssignedHours; number; The number of hours assigned to the resource for the current week of the project.
- WeekOneToFourAllocatedHours; number; The number of hours allocated to the resource for the four weeks of the project that start with the current week.
- WeekOneToFourAssignedHours; number; The number of hours assigned to the resource for the four weeks of the project that start with the current week.
- WeekOneToFourVariance; number; The variance between the allocated and assigned hours for the four weeks of the project that start with the current week.
- WeekOneVariance; number; The variance between the allocated and assigned hours for the current week of the project.
- WeekSevenAllocatedHours; number; The number of hours allocated to the resource for the week of the project that starts in six weeks.
- WeekSevenAssignedHours; number; The number of hours assigned to the resource for the week of the project that starts in six weeks.
- WeekSevenVariance; number; The variance between the allocated and assigned hours for the week of the project that starts in six weeks.
- WeekSixAllocatedHours; number; The number of hours allocated to the resource for the week of the project that starts in five weeks.
- WeekSixAssignedHours; number; The number of hours assigned to the resource for the week of the project that starts in five weeks.
- WeekSixVariance; number; The variance between the allocated and assigned hours for the week of the project that starts in five weeks.
- WeekTenAllocatedHours; number; The number of hours allocated to the resource for the week of the project that starts in nine weeks.
- WeekTenAssignedHours; number; The number of hours assigned to the resource for the week of the project that starts in nine weeks.
- WeekTenVariance; number; The variance between the allocated and assigned hours for the week of the project that starts in nine weeks.
- WeekThreeAllocatedHours; number; The number of hours allocated to the resource for the week of the project that starts in two weeks.
- WeekThreeAssignedHours; number; The number of hours assigned to the resource for the week of the project that starts in two weeks.
- WeekThreeVariance; number; The variance between the allocated and assigned hours for the week of the project that starts in two weeks.
- WeekTwelveAllocatedHours; number; The number of hours allocated to the resource for the week of the project that starts in eleven weeks.
- WeekTwelveAssignedHours; number; The number of hours assigned to the resource for the week of the project that starts in eleven weeks.
- WeekTwelveVariance; number; The variance between the allocated and assigned hours for the week of the project that starts in eleven weeks.
- WeekTwoAllocatedHours; number; The number of hours allocated to the resource for the week of the project that starts next Sunday.
- WeekTwoAssignedHours; number; The number of hours assigned to the resource for the week of the project that starts next Sunday.
- WeekTwoVariance; number; The variance between the allocated and assigned hours for the week of the project that starts next Sunday.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectInsights-TeamAllocations
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectInsights-TeamAllocations-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
The date when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated By
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the project enterprise labor resource. -
ResourceName: string
Title:
Resource
Read Only:true
Maximum Length:240
The name of the project enterprise labor resource. -
WeekEightAllocatedHours: number
Title:
Week Eight Allocated Hours
The number of hours allocated to the resource for the week of the project that starts in seven weeks. -
WeekEightAssignedHours: number
The number of hours assigned to the resource for the week of the project that starts in seven weeks.
-
WeekEightVariance: number
Title:
Week Eight Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in seven weeks. -
WeekElevenAllocatedHours: number
The number of hours allocated to the resource for the week of the project that starts in ten weeks.
-
WeekElevenAssignedHours: number
The number of hours assigned to the resource for the week of the project that starts in ten weeks.
-
WeekElevenVariance: number
Title:
Week Eleven Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in ten weeks. -
WeekFiveAllocatedHours: number
Title:
Week Five Allocated Hours
The number of hours allocated to the resource for the week of the project that starts in four weeks. -
WeekFiveAssignedHours: number
The number of hours assigned to the resource for the week of the project that starts in four weeks.
-
WeekFiveToEightAllocatedHours: number
Title:
Weeks Five to Eight Allocated Hours
Read Only:true
The number of hours allocated to the resource for the four weeks of the project that start in four weeks. -
WeekFiveToEightAssignedHours: number
Read Only:
true
The number of hours assigned to the resource for the four weeks of the project that start in four weeks. -
WeekFiveToEightVariance: number
Title:
Weeks Five to Eight Allocation Variance
The variance between the allocated and assigned hours for the four weeks of the project that start in four weeks. -
WeekFiveVariance: number
Title:
Week Five Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in four weeks. -
WeekFourAllocatedHours: number
Title:
Week Four Allocated Hours
The number of hours allocated to the resource for the week of the project that starts in three weeks. -
WeekFourAssignedHours: number
The number of hours assigned to the resource for the week of the project that starts in three weeks.
-
WeekFourVariance: number
Title:
Week Four Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in three weeks. -
WeekNineAllocatedHours: number
Title:
Week Nine Allocated Hours
The number of hours allocated to the resource for the week of the project that starts in eight weeks. -
WeekNineAssignedHours: number
The number of hours assigned to the resource for the week of the project that starts in eight weeks.
-
WeekNineToTwelveAllocatedHours: number
Read Only:
true
The number of hours allocated to the resource for the four weeks of the project that start in eight weeks. -
WeekNineToTwelveAssignedHours: number
Read Only:
true
The number of hours assigned to the resource for the four weeks of the project that start in eight weeks. -
WeekNineToTwelveVariance: number
Title:
Weeks Nine to Twelve Allocation Variance
The variance between the allocated and assigned hours for the four weeks of the project that start in eight weeks. -
WeekNineVariance: number
Title:
Week Nine Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in eight weeks. -
WeekOneAllocatedHours: number
Title:
Week One Allocated Hours
The number of hours allocated to the resource for the current week of the project. -
WeekOneAssignedHours: number
The number of hours assigned to the resource for the current week of the project.
-
WeekOneToFourAllocatedHours: number
Title:
Weeks One to Four Allocated Hours
Read Only:true
The number of hours allocated to the resource for the four weeks of the project that start with the current week. -
WeekOneToFourAssignedHours: number
Read Only:
true
The number of hours assigned to the resource for the four weeks of the project that start with the current week. -
WeekOneToFourVariance: number
Title:
Weeks One to Four Allocation Variance
The variance between the allocated and assigned hours for the four weeks of the project that start with the current week. -
WeekOneVariance: number
Title:
Week One Allocation Variance
The variance between the allocated and assigned hours for the current week of the project. -
WeekSevenAllocatedHours: number
Title:
Week Seven Allocated Hours
The number of hours allocated to the resource for the week of the project that starts in six weeks. -
WeekSevenAssignedHours: number
The number of hours assigned to the resource for the week of the project that starts in six weeks.
-
WeekSevenVariance: number
Title:
Week Seven Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in six weeks. -
WeekSixAllocatedHours: number
Title:
Week Six Allocated Hours
The number of hours allocated to the resource for the week of the project that starts in five weeks. -
WeekSixAssignedHours: number
The number of hours assigned to the resource for the week of the project that starts in five weeks.
-
WeekSixVariance: number
Title:
Week Six Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in five weeks. -
WeekTenAllocatedHours: number
Title:
Week Ten Allocated Hours
The number of hours allocated to the resource for the week of the project that starts in nine weeks. -
WeekTenAssignedHours: number
The number of hours assigned to the resource for the week of the project that starts in nine weeks.
-
WeekTenVariance: number
Title:
Week Ten Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in nine weeks. -
WeekThreeAllocatedHours: number
Title:
Week Three Assigned Hours
The number of hours allocated to the resource for the week of the project that starts in two weeks. -
WeekThreeAssignedHours: number
The number of hours assigned to the resource for the week of the project that starts in two weeks.
-
WeekThreeVariance: number
Title:
Week Three Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in two weeks. -
WeekTwelveAllocatedHours: number
The number of hours allocated to the resource for the week of the project that starts in eleven weeks.
-
WeekTwelveAssignedHours: number
The number of hours assigned to the resource for the week of the project that starts in eleven weeks.
-
WeekTwelveVariance: number
Title:
Week Twelve Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in eleven weeks. -
WeekTwoAllocatedHours: number
Title:
Week Two Allocated Hours
The number of hours allocated to the resource for the week of the project that starts next Sunday. -
WeekTwoAssignedHours: number
The number of hours assigned to the resource for the week of the project that starts next Sunday.
-
WeekTwoVariance: number
Title:
Week Two Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts next Sunday.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to get all allocations for a project by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectInsights/300100061807448/child/TeamAllocations
Response Body Example
The following shows an example of the response body in JSON format of all project templates.
{ "items": [ { "ResourceId": 300100024322233, "ResourceName": "Monica Suchet", "WeekOneVariance": -8, "WeekTwoVariance": -16, "WeekThreeVariance": 0, "WeekFourVariance": 0, "WeekOneToFourVariance": -24, "WeekFiveVariance": 0, "WeekSixVariance": 0, "WeekSevenVariance": 0, "WeekEightVariance": 0, "WeekFiveToEightVariance": 0, "WeekNineVariance": 0, "WeekTenVariance": 0, "WeekElevenVariance": 0, "WeekTwelveVariance": 0, "WeekNineToTwelveVariance": 0, "WeekOneAllocatedHours": 40, "WeekTwoAllocatedHours": 40, "WeekThreeAllocatedHours": 40, "WeekFourAllocatedHours": 40, "WeekOneToFourAllocatedHours": 160, "WeekFiveAllocatedHours": 40, "WeekSixAllocatedHours": 40, "WeekSevenAllocatedHours": 40, "WeekEightAllocatedHours": 40, "WeekFiveToEightAllocatedHours": 160, "WeekNineAllocatedHours": 40, "WeekTenAllocatedHours": 40, "WeekElevenAllocatedHours": 40, "WeekTwelveAllocatedHours": 40, "WeekNineToTwelveAllocatedHours": 160, "WeekOneAssignedHours": 32, "WeekTwoAssignedHours": 24, "WeekThreeAssignedHours": 40, "WeekFourAssignedHours": 40, "WeekOneToFourAssignedHours": 136, "WeekFiveAssignedHours": 40, "WeekSixAssignedHours": 40, "WeekSevenAssignedHours": 40, "WeekEightAssignedHours": 40, "WeekFiveToEightAssignedHours": 160, "WeekNineAssignedHours": 40, "WeekTenAssignedHours": 40, "WeekElevenAssignedHours": 40, "WeekTwelveAssignedHours": 40, "WeekNineToTwelveAssignedHours": 160, "CreatedBy": "Lisa.Williams", "CreationDate": "2019-09-08T00:26:15+00:00", "LastUpdatedBy": "Lisa.Williams", "LastUpdateDate": "2019-09-08T00:26:15+00:00", "links": [ ??? ] }, { "ResourceId": 300100024326749, "ResourceName": "Ravi Patel", "WeekOneVariance": 16, "WeekTwoVariance": 16, "WeekThreeVariance": -8, "WeekFourVariance": 0, "WeekOneToFourVariance": 24, "WeekFiveVariance": 0, "WeekSixVariance": 0, "WeekSevenVariance": 0, "WeekEightVariance": 0, "WeekFiveToEightVariance": 0, "WeekNineVariance": 0, "WeekTenVariance": 0, "WeekElevenVariance": 0, "WeekTwelveVariance": 0, "WeekNineToTwelveVariance": 0, "WeekOneAllocatedHours": 40, "WeekTwoAllocatedHours": 40, "WeekThreeAllocatedHours": 40, "WeekFourAllocatedHours": 40, "WeekOneToFourAllocatedHours": 160, "WeekFiveAllocatedHours": 40, "WeekSixAllocatedHours": 40, "WeekSevenAllocatedHours": 40, "WeekEightAllocatedHours": 40, "WeekFiveToEightAllocatedHours": 160, "WeekNineAllocatedHours": 40, "WeekTenAllocatedHours": 40, "WeekElevenAllocatedHours": 40, "WeekTwelveAllocatedHours": 40, "WeekNineToTwelveAllocatedHours": 160, "WeekOneAssignedHours": 56, "WeekTwoAssignedHours": 56, "WeekThreeAssignedHours": 32, "WeekFourAssignedHours": 40, "WeekOneToFourAssignedHours": 184, "WeekFiveAssignedHours": 40, "WeekSixAssignedHours": 40, "WeekSevenAssignedHours": 40, "WeekEightAssignedHours": 40, "WeekFiveToEightAssignedHours": 160, "WeekNineAssignedHours": 40, "WeekTenAssignedHours": 40, "WeekElevenAssignedHours": 40, "WeekTwelveAssignedHours": 40, "WeekNineToTwelveAssignedHours": 160, "CreatedBy": "Lisa.Williams", "CreationDate": "2019-09-08T00:26:15+00:00", "LastUpdatedBy": "Lisa.Williams", "LastUpdateDate": "2019-09-08T00:26:15+00:00", "links": [ ???. ] } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ ???. ] }