Get a task for which the projects user can charge expenditures
get
/fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ChargeableFinancialTasks/{ChargeableFinancialTasksUniqID}
Request
Path Parameters
-
ChargeableFinancialTasksUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ProjectId and AssignmentId ---for the Chargeable Tasks resource and used to uniquely identify an instance of Chargeable Tasks. The client should not generate the hash key value. Instead, the client should query on the Chargeable Tasks collection resource with a filter on the primary key values in order to navigate to a specific instance of Chargeable Tasks.
For example: ChargeableFinancialTasks?q=ProjectId=<value1>;AssignmentId=<value2> -
ResourceId(required): integer(int64)
The unique identifier of the resource assigned to the task.
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : projectsUsers-ChargeableFinancialTasks-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Read Only:
true
The unique identifier of the organization assignment of the projects user. -
AssignmentNumber: string
Read Only:
true
Maximum Length:50
The unique reference of the organization assignment of the projects user. -
DefaultExpenditureTypeId: integer
(int64)
Read Only:
true
The unique identifier of the default expenditure type set for a resource class in a project unit. -
DefaultExpenditureTypeName: string
Read Only:
true
Maximum Length:240
Name of the default expenditure type for a resource class in a project unit. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryAssignment: string
Read Only:
true
Maximum Length:30
Indicates whether an assignment is the primary assignment of the projects user. -
ProjectId: integer
(int64)
Read Only:
true
The unique identifier of a project. -
ProjectName: string
Read Only:
true
Maximum Length:240
Name of the project. -
ProjectUnitId: integer
(int64)
Read Only:
true
The unique identifier of a project unit. -
TaskFinishDate: string
(date)
Read Only:
true
Planning finish date of the financial task as per financial project plan. -
TaskId: integer
(int64)
Read Only:
true
The unique identifier of a task. -
TaskManagerId: integer
(int64)
Read Only:
true
The unique identifier of the resource who manages the task. -
TaskManagerName: string
Read Only:
true
Maximum Length:240
The resource who manages the task. -
TaskName: string
Read Only:
true
Maximum Length:255
Name of the task. -
TaskNumber: string
Read Only:
true
Maximum Length:100
Number of the task. -
TaskOrganizationName: string
Read Only:
true
Maximum Length:240
The organization that owns the task. -
TaskStartDate: string
(date)
Read Only:
true
Planning start date of the financial task as per financial project plan. -
TransactionCompletionDate: string
(date)
Read Only:
true
Date upto which transactions can be reported for task. -
TransactionStartDate: string
(date)
Read Only:
true
Date from which transactions can be reported for task.
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 a task for which the projects user can charge expenditures 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/projectsUsers/300100024326751/child/ChargeableFinancialTasks/00020000000EACED00057708000110F08469C5F70000000EACED0005770800005AF56676D3B3
Response Body Example
The following shows an example of the response body in JSON format.
{ "ProjectId": 300100176430583, "TaskId": 100100107265393, "TaskNumber": "1.1", "TaskName": "Footer", "TransactionStartDate": null, "TransactionCompletionDate": null, "TaskStartDate": "2017-01-01", "TaskFinishDate": "2019-12-31", "TaskManagerId": null, "TaskManagerName": null, "TaskOrganizationName": "Vision Operations", "ProjectName": "AZ-OTBI-008", "ProjectUnitId": 100010023900163, "AssignmentNumber": "10032550833", "AssignmentId": 100010032550835, "PrimaryAssignment": "Y", "DefaultExpenditureTypeName": "Miscellaneous Labor", "DefaultExpenditureTypeId": 100000010058006, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectsUsers/300100024326751/child/ChargeableFinancialTasks/00020000000EACED00057708000110F08469C5F70000000EACED0005770800005AF56676D3B3", "name": "ChargeableFinancialTasks", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectsUsers/300100024326751/child/ChargeableFinancialTasks/00020000000EACED00057708000110F08469C5F70000000EACED0005770800005AF56676D3B3", "name": "ChargeableFinancialTasks", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectsUsers/300100024326751", "name": "projectsUsers", "kind": "item" } ] }