Update a project transaction control
patch
/fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/ProjectTransactionControls/{ProjectTransactionControlsUniqID}
Request
Path Parameters
-
ProjectId(required): integer(int64)
Unique identifier of the project.
-
ProjectTransactionControlsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Project Transaction Controls resource and used to uniquely identify an instance of Project Transaction Controls. The client should not generate the hash key value. Instead, the client should query on the Project Transaction Controls collection resource in order to navigate to a specific instance of Project Transaction Controls to get the hash key.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Billable: string
Title:
Billable Code
Maximum Length:1
Indicates that transactions charged to the project can be billed to customers. This attribute is applicable for billable projects. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable or both of them. Default value is T. -
BillableHint: string
Title:
Billable
Maximum Length:80
Indicates that transactions charged to the project can be billed to customers. This attribute is applicable for billable projects. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable Code or both of them. Default value is Task. -
Capitalizable: string
Title:
Capitalizable Code
Maximum Length:1
Indicates the code for the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable or both of them. Default value is T. -
CapitalizableHint: string
Title:
Capitalizable
Maximum Length:80
Indicates the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable Code or both of them. Default value is Task. -
Chargeable: string
Title:
Chargeable Code
Maximum Length:1
Indicates that something is eligible to be charged to the project. A list of accepted values - Y and N - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable or both of them. Default value is N. -
ChargeableHint: string
Title:
Chargeable
Maximum Length:80
Indicates that something is eligible to be charged to the project. A list of accepted values - Yes and No - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable Code or both of them. Default value is No. -
EmailAddress: string
Title:
Email
Maximum Length:240
Email address of the person. You can enter either this attribute, Person ID, Person Number, or Person Name, or a combination of these attributes. -
EndDateActive: string
(date)
Title:
To Date
The date after which the transaction control is no longer effective. -
ExpenditureCategoryId: integer
(int64)
Title:
Expenditure Category ID
Identifier of the expenditure category. You can enter either this attribute or Expenditure Category or both of them. -
ExpenditureCategoryName: string
Title:
Expenditure Category
Maximum Length:240
A grouping of expenditure types by type of cost. For example, an expenditure category with a name such as Labor refers to the cost of labor. You can enter either this attribute or Expenditure Category ID or both of them. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type ID
Identifier of the expenditure type. You can enter either this attribute or Expenditure Type or both of them. -
ExpenditureTypeName: string
Title:
Expenditure Type
Maximum Length:240
A classification of cost that is assigned to each project cost transaction. Expenditure types are grouped into cost groups (expenditure categories) and revenue groups (revenue categories). You can enter either this attribute or Expenditure Type ID or both of them. -
Job: string
Title:
Job
Maximum Length:240
The job that is being performed by the person that incurred the cost that was charged to the task. You can enter either this attribute or Job ID or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute. -
JobId: integer
(int64)
Title:
Job ID
Identifier of the job. You can enter either this attribute or Job or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute. -
NonLaborResourceId: integer
(int64)
Title:
Nonlabor Resource ID
Identifier of the nonlabor resource. You can enter either this attribute or Nonlabor Resource or both of them. -
NonLaborResourceName: string
Title:
Nonlabor Resource
Maximum Length:240
An implementation defined asset or pool of assets. These assets may represent actual pieces of equipment whose time is consumed, or an asset whose output is consumed. For example, you can define a nonlabor resource with a name of Training Room to track the usage of a physical room and the associated costs. The actual usage of the room is tracked in hours. You can enter either this attribute or Nonlabor Resource ID or both of them. -
Organization: string
Title:
Organization
Maximum Length:240
The name of the organization to which the person job belongs. You can enter either this attribute or Organization ID or both of them. You must enter the person and job attributes if you enter a value for this attribute. -
OrganizationId: integer
(int64)
Title:
Organization ID
Identifier of the organization to which the person job belongs. You can enter either this attribute or Organization or both of them. You must enter the person and job attributes if you enter a value for this attribute. -
PersonId: integer
(int64)
Title:
Person ID
Identifier of the person. You can enter either this attribute, Person Name, Person Number, or Email, or a combination of these attributes. -
PersonName: string
Title:
Person Name
Maximum Length:240
The name of an individual human team member. You can enter either this attribute, Person ID, Person Number, or Email or a combination of these attributes. -
PersonNumber: string
Title:
Person Number
Maximum Length:30
Number that uniquely identifies a person. This number refers to the Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component. You can enter either this attribute, Person ID, Person Name, or Email, or a combination of these attributes. -
PersonType: string
Title:
Person Type Code
Maximum Length:20
Indicates the code of the type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - EMP and CWK - is defined in the lookup type PJF_PERSON_TYPE. You can enter either this attribute or Person Type or both of them. -
PersonTypeHint: string
Title:
Person Type
Maximum Length:80
The type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - Employee and Contingent Worker - is defined in the lookup type PJF_PERSON_TYPE. You can enter either this attribute or Person Type Code or both of them. -
StartDateActive: string
(date)
Title:
From Date
The date from which the transaction control is effective. Default value is the project start date.
Response
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 : projects-ProjectTransactionControls-item-response
Type:
Show Source
object
-
Billable: string
Title:
Billable Code
Maximum Length:1
Indicates that transactions charged to the project can be billed to customers. This attribute is applicable for billable projects. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable or both of them. Default value is T. -
BillableHint: string
Title:
Billable
Maximum Length:80
Indicates that transactions charged to the project can be billed to customers. This attribute is applicable for billable projects. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable Code or both of them. Default value is Task. -
Capitalizable: string
Title:
Capitalizable Code
Maximum Length:1
Indicates the code for the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable or both of them. Default value is T. -
CapitalizableHint: string
Title:
Capitalizable
Maximum Length:80
Indicates the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable Code or both of them. Default value is Task. -
Chargeable: string
Title:
Chargeable Code
Maximum Length:1
Indicates that something is eligible to be charged to the project. A list of accepted values - Y and N - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable or both of them. Default value is N. -
ChargeableHint: string
Title:
Chargeable
Maximum Length:80
Indicates that something is eligible to be charged to the project. A list of accepted values - Yes and No - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable Code or both of them. Default value is No. -
EmailAddress: string
Title:
Email
Maximum Length:240
Email address of the person. You can enter either this attribute, Person ID, Person Number, or Person Name, or a combination of these attributes. -
EndDateActive: string
(date)
Title:
To Date
The date after which the transaction control is no longer effective. -
ExpenditureCategoryId: integer
(int64)
Title:
Expenditure Category ID
Identifier of the expenditure category. You can enter either this attribute or Expenditure Category or both of them. -
ExpenditureCategoryName: string
Title:
Expenditure Category
Maximum Length:240
A grouping of expenditure types by type of cost. For example, an expenditure category with a name such as Labor refers to the cost of labor. You can enter either this attribute or Expenditure Category ID or both of them. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type ID
Identifier of the expenditure type. You can enter either this attribute or Expenditure Type or both of them. -
ExpenditureTypeName: string
Title:
Expenditure Type
Maximum Length:240
A classification of cost that is assigned to each project cost transaction. Expenditure types are grouped into cost groups (expenditure categories) and revenue groups (revenue categories). You can enter either this attribute or Expenditure Type ID or both of them. -
Job: string
Title:
Job
Maximum Length:240
The job that is being performed by the person that incurred the cost that was charged to the task. You can enter either this attribute or Job ID or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute. -
JobId: integer
(int64)
Title:
Job ID
Identifier of the job. You can enter either this attribute or Job or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NonLaborResourceId: integer
(int64)
Title:
Nonlabor Resource ID
Identifier of the nonlabor resource. You can enter either this attribute or Nonlabor Resource or both of them. -
NonLaborResourceName: string
Title:
Nonlabor Resource
Maximum Length:240
An implementation defined asset or pool of assets. These assets may represent actual pieces of equipment whose time is consumed, or an asset whose output is consumed. For example, you can define a nonlabor resource with a name of Training Room to track the usage of a physical room and the associated costs. The actual usage of the room is tracked in hours. You can enter either this attribute or Nonlabor Resource ID or both of them. -
Organization: string
Title:
Organization
Maximum Length:240
The name of the organization to which the person job belongs. You can enter either this attribute or Organization ID or both of them. You must enter the person and job attributes if you enter a value for this attribute. -
OrganizationId: integer
(int64)
Title:
Organization ID
Identifier of the organization to which the person job belongs. You can enter either this attribute or Organization or both of them. You must enter the person and job attributes if you enter a value for this attribute. -
PersonId: integer
(int64)
Title:
Person ID
Identifier of the person. You can enter either this attribute, Person Name, Person Number, or Email, or a combination of these attributes. -
PersonName: string
Title:
Person Name
Maximum Length:240
The name of an individual human team member. You can enter either this attribute, Person ID, Person Number, or Email or a combination of these attributes. -
PersonNumber: string
Title:
Person Number
Maximum Length:30
Number that uniquely identifies a person. This number refers to the Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component. You can enter either this attribute, Person ID, Person Name, or Email, or a combination of these attributes. -
PersonType: string
Title:
Person Type Code
Maximum Length:20
Indicates the code of the type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - EMP and CWK - is defined in the lookup type PJF_PERSON_TYPE. You can enter either this attribute or Person Type or both of them. -
PersonTypeHint: string
Title:
Person Type
Maximum Length:80
The type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - Employee and Contingent Worker - is defined in the lookup type PJF_PERSON_TYPE. You can enter either this attribute or Person Type Code or both of them. -
ProjectId: integer
(int64)
Title:
Project ID
Read Only:true
Identifier of the project. Default value is the identifier of the project for which the transaction control is created. -
RuleNumber: integer
(int64)
Title:
Rule Number
Read Only:true
Identifier of the transaction control within a project or task. Default value is the successor of the maximum existing rule number. -
StartDateActive: string
(date)
Title:
From Date
The date from which the transaction control is effective. Default value is the project start date. -
TransactionControlId: integer
(int64)
Title:
Transaction Control ID
Read Only:true
Identifier of the transaction control.
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 update a project transaction control by submitting a PATCH request on the REST resource using cURL.
curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.0.0/projects/100000016918492/child/ProjectTransactionControls/300100111103363
Example of Request Body
The following example shows the request body to update the start and end dates of the transaction control with transaction control ID 300100074907408 assigned to the project with project ID 100000016918492.
{ "StartDateActive" : "2013-12-22", "EndDateActive" : "2018-12-28" }
Example of Response Body
The following example shows the contents of the response body in JSON format, including the updated start and end dates of the project transaction control.
{ "Billable": "T", "Chargeable": "Y", "EndDateActive": "2018-12-28", "ExpenditureCategoryId": null, "ExpenditureCategoryName": null, "ExpenditureTypeId": null, "ExpenditureTypeName": null, "Job": null, "JobId": null, "NonLaborResourceId": null, "NonLaborResourceName": null, "Organization": null, "OrganizationId": null, "PersonId": 300100018520271, "PersonName": "Jay, Alan", "PersonType": null, "ProjectId": 100000016918492, "StartDateActive": "2013-12-22", "TransactionControlId": 300100111103363, }