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

Get a labor schedule cost.

get

/fscmRestApi/resources/11.13.18.05/laborSchedulesCosts/{LdInterfaceId}

Request

Path Parameters
  • 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
  • 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>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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-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
laborSchedulesCostDistributions
Parameters:
  • LdInterfaceId: $request.path.LdInterfaceId
The Labor Schedule Cost Distributions resource used to see the distributions associated to a project, task, or raw labor cost.
Back to Top

Examples

The following example shows how to get a labor schedule cost 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/10081

Response Body Example

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

{
      "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