REST API for Oracle Fusion Cloud Project Management

Update a project resource actual hour record

patch

/fscmRestApi/resources/11.13.18.05/projectResourceActualHours/{TransactionId}

Request

Path Parameters

TransactionId(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=

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: object

Show Source

BillableUtilizationFlag: boolean

Title: Billable Utilization Indicator

Maximum Length: 1

Default Value: true

Indicates whether the actual hours reported will be included in billable resource utilization calculation. Valid values are Y or N. If no value is provided, it will default to Y if ActualHoursWorkedCategoryCode is PROJECT_WORK and to N if ActualHoursWorkedCategoryCode is PTO,TRAINING or OTHER.
TransactionId: integer (int64)

Title: Transaction ID

Unique identifier of the actual hours record.
UtilizationFlag: boolean

Title: Resource Utilization Indicator

Maximum Length: 1

Default Value: true

Indicates whether the actual hours reported are eligible to be included in utilization calculations for the resource. Valid values are Y or N. It will default to Y if ActualHoursWorkedCategoryCode is PROJECT_WORK and to N if ActualHoursWorkedCategoryCode is PTO,TRAINING or OTHER.

{
    "type":"object",
    "properties":{
        "UtilizationFlag":{
            "title":"Resource Utilization Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the actual hours reported are eligible to be included in utilization calculations for the resource. Valid values are Y or N. It will default to Y if ActualHoursWorkedCategoryCode is PROJECT_WORK and to N if ActualHoursWorkedCategoryCode is PTO,TRAINING or OTHER.",
            "nullable":true,
            "default":true
        },
        "BillableUtilizationFlag":{
            "title":"Billable Utilization Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the actual hours reported will be included in billable resource utilization calculation. Valid values are Y or N. If no value is provided, it will default to Y if ActualHoursWorkedCategoryCode is PROJECT_WORK and to N if ActualHoursWorkedCategoryCode is PTO,TRAINING or OTHER.",
            "nullable":true,
            "default":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"Unique identifier of the actual hours record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

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.

Root Schema : projectResourceActualHours-item-response

Type: object

Show Source

ActualHoursWorkedCategory: string

Title: Actual Hours Worked Category

Maximum Length: 80

Type of activity that's represented by the actual hours. Examples are Project Work, Paid Time Off, Training, and Other.
ActualHoursWorkedCategoryCode: string

Title: Actual Hours Worked Category Code

Maximum Length: 80

Code for the type of activity that's represented by the actual hours. Examples are PROJECT_WORK, PTO, TRAINING, and OTHER.
AdjustedTransactionReference: string

Title: Adjusted Transaction Reference

Maximum Length: 120

Reference to the original transaction that this transaction adjusts, if this transaction is for an adjustment. This is an optional value even for an adjustment transaction.
AdjustmentEntryFlag: boolean

Title: Adjustment Entry Indicator

Maximum Length: 1

Default Value: false

Indicates if the actual hours reported represent an adjustment to existing actual hours for a resource. This attribute is set to N during POST operation if no value is specified.
BillableUtilizationFlag: boolean

Title: Billable Utilization Indicator

Maximum Length: 1

Default Value: true

Indicates whether the actual hours reported will be included in billable resource utilization calculation. Valid values are Y or N. If no value is provided, it will default to Y if ActualHoursWorkedCategoryCode is PROJECT_WORK and to N if ActualHoursWorkedCategoryCode is PTO,TRAINING or OTHER.
Comments: string

Title: Comments

Maximum Length: 240

Information about the actual hours reported.
HCMPersonId: integer (int64)

Title: Resource Person ID

Read Only: true

HCM Person identifier of the project enterprise resource for which actual hours are reported.
links: array Links

Title: Links

The link relations associated with the resource instance.
OriginalTransactionReference: string

Title: Original Transaction Reference

Maximum Length: 120

Reference to the transaction details in the originating source system.
ProjectId: integer (int64)

Title: Project ID

Identifier of the project for which the project enterprise resource reported the actual hours worked.
ProjectName: string

Title: Project Name

Maximum Length: 240

Name of the project for which the project enterprise resource reported the actual hours worked.
ProjectNumber: string

Title: Project Number

Maximum Length: 25

Number of the project for which the project enterprise resource reported the actual hours worked.
Quantity: number

Title: Quantity

Total actual hours worked that the resource reports for a day. The actual hours worked can be positive or negative with a maximum of two decimal places.
ResourceEmail: string

Title: Resource Email

Maximum Length: 240

Email of the project enterprise resource who reported actual hours worked.
ResourceId: integer (int64)

Title: Resource ID

Identifier of the project enterprise resource who reported actual hours worked.
ResourceName: string

Title: Resource Name

Read Only: true

Maximum Length: 240

Name of the project enterprise resource who reported actual hours worked.
TaskId: integer (int64)

Title: Task ID

Identifier of the task for which the project enterprise resource reported actual hours worked.
TaskName: string

Title: Task Name

Maximum Length: 255

Name of the task for which the project enterprise resource reported actual hours worked.
TransactionId: integer (int64)

Title: Transaction ID

Unique identifier of the actual hours record.
UtilizationDate: string (date)

Title: Utilization Date

Date that's associated with the actual hours worked for utilization reporting purposes. If no value is specified, then the utilization date is based on the work date.
UtilizationFlag: boolean

Title: Resource Utilization Indicator

Maximum Length: 1

Default Value: true

Indicates whether the actual hours reported are eligible to be included in utilization calculations for the resource. Valid values are Y or N. It will default to Y if ActualHoursWorkedCategoryCode is PROJECT_WORK and to N if ActualHoursWorkedCategoryCode is PTO,TRAINING or OTHER.
WorkDate: string (date)

Title: Work Date

Date on which the project enterprise resource worked.

{
    "type":"object",
    "properties":{
        "UtilizationDate":{
            "title":"Utilization Date",
            "type":"string",
            "description":"Date that's associated with the actual hours worked for utilization reporting purposes. If no value is specified, then the utilization date is based on the work date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Identifier of the task for which the project enterprise resource reported actual hours worked.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProjectName":{
            "title":"Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project for which the project enterprise resource reported the actual hours worked.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AdjustmentEntryFlag":{
            "title":"Adjustment Entry Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the actual hours reported represent an adjustment to existing actual hours for a resource. This attribute is set to N during POST operation if no value is specified.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "HCMPersonId":{
            "title":"Resource Person ID",
            "type":"integer",
            "description":"HCM Person identifier of the project enterprise resource for which actual hours are reported.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project enterprise resource who reported actual hours worked.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"Number of the project for which the project enterprise resource reported the actual hours worked.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"240",
            "type":"string",
            "description":"Information about the actual hours reported.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Identifier of the project for which the project enterprise resource reported the actual hours worked.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActualHoursWorkedCategoryCode":{
            "title":"Actual Hours Worked Category Code",
            "maxLength":"80",
            "type":"string",
            "description":"Code for the type of activity that's represented by the actual hours. Examples are PROJECT_WORK, PTO, TRAINING, and OTHER.",
            "nullable":false,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Total actual hours worked that the resource reports for a day. The actual hours worked can be positive or negative with a maximum of two decimal places.",
            "nullable":false,
            "x-queryable":true
        },
        "BillableUtilizationFlag":{
            "title":"Billable Utilization Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the actual hours reported will be included in billable resource utilization calculation. Valid values are Y or N. If no value is provided, it will default to Y if ActualHoursWorkedCategoryCode is PROJECT_WORK and to N if ActualHoursWorkedCategoryCode is PTO,TRAINING or OTHER.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"Unique identifier of the actual hours record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AdjustedTransactionReference":{
            "title":"Adjusted Transaction Reference",
            "maxLength":"120",
            "type":"string",
            "description":"Reference to the original transaction that this transaction adjusts, if this transaction is for an adjustment. This is an optional value even for an adjustment transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"Identifier of the project enterprise resource who reported actual hours worked.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the task for which the project enterprise resource reported actual hours worked.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ActualHoursWorkedCategory":{
            "title":"Actual Hours Worked Category",
            "maxLength":"80",
            "type":"string",
            "description":"Type of activity that's represented by the actual hours. Examples are Project Work, Paid Time Off, Training, and Other.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "WorkDate":{
            "title":"Work Date",
            "type":"string",
            "description":"Date on which the project enterprise resource worked.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UtilizationFlag":{
            "title":"Resource Utilization Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the actual hours reported are eligible to be included in utilization calculations for the resource. Valid values are Y or N. It will default to Y if ActualHoursWorkedCategoryCode is PROJECT_WORK and to N if ActualHoursWorkedCategoryCode is PTO,TRAINING or OTHER.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "ResourceEmail":{
            "title":"Resource Email",
            "maxLength":"240",
            "type":"string",
            "description":"Email of the project enterprise resource who reported actual hours worked.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OriginalTransactionReference":{
            "title":"Original Transaction Reference",
            "maxLength":"120",
            "type":"string",
            "description":"Reference to the transaction details in the originating source system.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Examples

The following example shows how to update a project resource actual hour record 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.18.05/projectResourceActualHours/300100211631583

Request Body Example

The following shows an example of the request body in JSON format.

{
   "UtilizationFlag": true,
  "BillableUtilizationFlag": false
}

Response Body Example

The following shows an example of the response body in JSON format.

{
  "TransactionId": 300100211631583,
  "ResourceId": 300100024326422,
  "ResourceEmail": "Wolfgang.Beura@oracle.com",
  "HCMPersonId": 300100012548630,
  "ResourceName": "Wolfgang Beura",
  "WorkDate": "2020-12-01",
  "UtilizationDate": "2020-12-01",
  "ProjectId": 300100025404031,
  "ProjectNumber": "300100025404031",
  "ProjectName": "zBIQA_Rel8_RM7",
  "TaskId": null,
  "TaskName": null,
  "ActualHoursWorkedCategory": "Project work",
  "ActualHoursWorkedCategoryCode": "PROJECT_WORK",
  "Quantity": 2,
  "Comments": "No Comments",
  "UtilizationFlag": true,
  "BillableUtilizationFlag": false,
  "OriginalTransactionReference": null,
  "AdjustmentEntryFlag": false,
  "AdjustedTransactionReference": null,
  "links": [
    {
      "rel": "self",
      "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/projectResourceActualHours/300100211631583",
      "name": "projectResourceActualHours",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
      }
    },
    {
      "rel": "canonical",
      "href": "https://your_organization:port/fscmRestApi/resources/11.13.18.05/projectResourceActualHours/300100211631583",
      "name": "projectResourceActualHours",
      "kind": "item"
    }
  ]
}