1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Labor Schedule Costs

Get many labor schedule costs.

get

/fscmRestApi/resources/11.13.18.05/laborSchedulesCosts

Request

Query Parameters
  • 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).
  • 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
  • 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 labor schedule cost with the specified primary key.
      Finder Variables
      • LdInterfaceId; integer; The unique identifier of the labor cost.
    • findLaborScheduleCosts Finds labor schedule costs for a standard set of variables.
      Finder Variables
      • assignmentId; integer; Finds labor schedule costs associated with the assignment identifier passed.
      • awardId; integer; Finds labor schedule costs associated with the award identifier passed.
      • awardNumber; string; Finds labor schedule costs associated with the award number passed.
      • batchName; string; Finds labor schedule costs with the associated batch name.
      • organizationId; integer; Finds labor schedule costs associated to the entered business unit.
      • originalTransactionReference; string; Finds labor schedule costs associated with the original transaction reference value passed.
      • payElementId; string; Finds labor schedule costs associated with the pay element type identifier passed.
      • payPeriodStartFrom; string; The pay period start date for the labor cost.
      • payPeriodStartTo; string; The pay period start date for the labor cost.
      • payrollId; string; Finds labor schedule costs associated with the payroll identifier passed.
      • payrollName; string; Finds labor schedule costs associated with the payroll name passed.
      • personEmail; string; Finds labor schedule costs using the associated email address.
      • personId; integer; Finds labor schedule costs associated to the person identifier passed.
      • personName; string; Finds labor schedule costs associated to the person name passed.
      • personNumber; string; Finds labor schedule costs associated to the person number passed.
      • projectId; integer; Finds labor schedule costs associated to the project identifier passed.
      • projectNumber; string; Finds labor schedule costs associated to the project number passed.
      • statusCode; string; Finds labor schedule costs associated to the status code passed.
      • transactionSource; string; Finds labor schedule costs associated with the transaction source code passed.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AssignmentId; integer; Unique identifier of the assignment for this Person Assignment Labor Schedule header.
    • AssignmentName; string; Name of the assignment for this Person Assignment Labor Schedule header.
    • AssignmentNumber; string; Number of the assignment for this Person Assignment Labor Schedule header.
    • BatchName; string; The user created batch name for this labor cost.
    • CurrencyCode; string; The currency for this labor cost.
    • DocumentCode; string; The document code associated with this cost. This will be Payroll_Costs if the cost is imported directly from Oracle Cloud Payroll.
    • DocumentId; integer; The unique identifier of the transaction document associated with this cost.
    • LdInterfaceId; integer; The unique identifier of the labor cost. This value can be used to connect the labor schedule costs and distributions rest services to get all distributions excluding the original distributions that were adjusted. To get all distributions including all adjustment records use the original reference value.
    • NetZeroAdjustmentFlag; boolean; Indicates whether this cost is offsetting another cost and resulting in a total of zero. This is used for costs imported directly from Oracle Cloud Payroll.
    • OrganizationId; integer; The business unit identifier derived from the person assignment.
    • OriginalTransactionReference; string; A unique identifier for this cost from the generating source. This field should be used to connect the cost and all distributed costs on the labor schedules cost distributions rest service, including any adjustments that have been done.
    • PayAmount; number; The amount of the labor cost.
    • PayElement; string; The pay element for the labor cost.
    • PayElementId; integer; The unique identifier of the payroll cost pay element type used in a labor schedule distributed cost.
    • PayPeriodEndDate; string; The pay period end date for the labor cost.
    • PayPeriodStartDate; string; The pay period start date for the labor cost.
    • PayrollId; integer; The unique identifier of the payroll associated with this cost. This value will exist if this cost is imported directly from Oracle Cloud Payroll.
    • PayrollName; string; The payroll name associated with this cost. This value will exist if this cost is imported directly from Oracle Cloud Payroll.
    • PersonEmail; string; Email of the person.
    • PersonId; integer; Unique identifier of the person.
    • PersonName; string; Full name, first then last, of the person.
    • PersonNumber; string; Human Resources number of the person.
    • Status; string; The status value of the labor cost based on the distribution through the labor schedule.
    • StatusCode; string; The status code of the labor cost based on distributing through the labor schedule.
    • StatusSummary; string; The summary status for all error and success status codes.
    • TransactionSource; string; The transaction source code associated with the cost.
    • TransactionSourceId; integer; The unique identifier of the transaction source associated with this cost.
    • UserTransactionSource; string; The transaction source name associated with the cost.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : laborSchedulesCosts
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : laborSchedulesCosts-item-response
Type: object
Show Source
  • Read Only: true
    Unique identifier of the assignment for this Person Assignment Labor Schedule header.
  • Read Only: true
    Maximum Length: 80
    Name of the assignment for this Person Assignment Labor Schedule header.
  • Read Only: true
    Maximum Length: 50
    Number of the assignment for this Person Assignment Labor Schedule header.
  • Read Only: true
    Maximum Length: 200
    The user created batch name for this labor cost.
  • Read Only: true
    Maximum Length: 15
    The currency for this labor cost.
  • Read Only: true
    Maximum Length: 20
    The document code associated with this cost. This will be Payroll_Costs if the cost is imported directly from Oracle Cloud Payroll.
  • Read Only: true
    The unique identifier of the transaction document associated with this cost.
  • Labor Schedule Cost Distributions
    Title: Labor Schedule Cost Distributions
    The Labor Schedule Cost Distributions resource used to see the distributions associated to a project, task, or raw labor cost.
  • Read Only: true
    The unique identifier of the labor cost. This value can be used to connect the labor schedule costs and distributions rest services to get all distributions excluding the original distributions that were adjusted. To get all distributions including all adjustment records use the original reference value.
  • Links
  • Read Only: true
    Maximum Length: 1
    Indicates whether this cost is offsetting another cost and resulting in a total of zero. This is used for costs imported directly from Oracle Cloud Payroll.
  • Read Only: true
    The business unit identifier derived from the person assignment.
  • Title: Original Transaction Reference
    Read Only: true
    Maximum Length: 120
    A unique identifier for this cost from the generating source. This field should be used to connect the cost and all distributed costs on the labor schedules cost distributions rest service, including any adjustments that have been done.
  • Read Only: true
    The amount of the labor cost.
  • Read Only: true
    Maximum Length: 80
    The pay element for the labor cost.
  • Read Only: true
    The unique identifier of the payroll cost pay element type used in a labor schedule distributed cost.
  • Read Only: true
    The pay period end date for the labor cost.
  • Read Only: true
    The pay period start date for the labor cost.
  • Read Only: true
    The unique identifier of the payroll associated with this cost. This value will exist if this cost is imported directly from Oracle Cloud Payroll.
  • Read Only: true
    Maximum Length: 80
    The payroll name associated with this cost. This value will exist if this cost is imported directly from Oracle Cloud Payroll.
  • Read Only: true
    Maximum Length: 240
    Email of the person.
  • Read Only: true
    Unique identifier of the person.
  • Read Only: true
    Maximum Length: 240
    Full name, first then last, of the person.
  • Read Only: true
    Maximum Length: 30
    Human Resources number of the person.
  • Read Only: true
    Maximum Length: 3
    The status value of the labor cost based on the distribution through the labor schedule.
  • Read Only: true
    Maximum Length: 3
    The status code of the labor cost based on distributing through the labor schedule.
  • Read Only: true
    Maximum Length: 80
    The summary status for all error and success status codes.
  • Read Only: true
    Maximum Length: 30
    The transaction source code associated with the cost.
  • Read Only: true
    The unique identifier of the transaction source associated with this cost.
  • Read Only: true
    Maximum Length: 240
    The transaction source name associated with the cost.
Nested Schema : Labor Schedule Cost Distributions
Type: array
Title: Labor Schedule Cost Distributions
The Labor Schedule Cost Distributions resource used to see the distributions associated to a project, task, or raw labor cost.
Show Source
Nested Schema : laborSchedulesCosts-laborSchedulesCostDistributions-item-response
Type: object
Show Source
Nested Schema : Labor Schedule Cost Distribution Errors
Type: array
Title: Labor Schedule Cost Distribution Errors
The Labor Schedule Cost Distribution Errors resource used to see the errors associated to distributions for resolution.
Show Source
Nested Schema : laborSchedulesCosts-laborSchedulesCostDistributions-costDistributionErrors-item-response
Type: object
Show Source
Links
deleteErrors
Delete one or more labor costs in Error status depending on the parameters passed. If multiple parameters are provided they will be combined to filter the set of labor costs in Error status.
Back to Top

Examples

The following example shows how to get many labor schedule costs 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/laborSchedulesCosts

Response Body Example

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

{
  "items": [
    {
      "AssignmentId": 300100185241843,
      "AssignmentName": "Project Manager",
      "AssignmentNumber": "E955160008191829",
      "BatchName": "multi-BU-Diff1",
      "CurrencyCode": "USD",
      "PersonEmail": null,
      "LdInterfaceId": 10081,
      "OrganizationId": 204,
      "OriginalTransactionReference": "BUTEST1",
      "PayAmount": 4211.11,
      "PayElement": "Regular Salary",
      "PayPeriodEndDate": "2017-01-31",
      "PayPeriodStartDate": "2017-01-01",
      "PersonId": 300100185241828,
      "PersonName": "Eric Puls",
      "PersonNumber": "955160008191829",
      "StatusCode": "RS",
      "Status": "Release success",
      "StatusSummary": "Success",
      "links": [
        {
          "rel": "self",
          "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/laborSchedulesCosts/10081",
          "name": "laborSchedulesCosts",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/laborSchedulesCosts/10081",
          "name": "laborSchedulesCosts",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/laborSchedulesCosts/10081/child/laborSchedulesCostDistributions",
          "name": "laborSchedulesCostDistributions",
          "kind": "collection"
        }
      ]
    }
}
Back to Top