Get a Person Assignment Labor Schedule header.
get
/fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}
Request
Path Parameters
-
LaborScheduleId(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=
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:
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 : personAssignmentLaborSchedules-item-response
Type:
Show Source
object
-
AssignmentDepartment: string
Title:
Assignment Department
Read Only:true
Maximum Length:240
The department of the assignment. -
AssignmentId: integer
(int64)
Unique identifier of the assignment for this Person Assignment Labor Schedule header.
-
AssignmentName: string
Maximum Length:
255
Name of the assignment for this Person Assignment Labor Schedule header. -
AssignmentNumber: string
Maximum Length:
255
Number of the assignment for this Person Assignment Labor Schedule header. -
BusinessUnitId: integer
(int64)
Unique identifier of the business unit that's used for Element Level labor schedules only.
-
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit that's associated to the Element Level labor schedule. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the record was created. -
LaborScheduleId: integer
(int64)
The unique identifier of the Person Assignment Labor Schedule header.
-
LaborScheduleName: string
Maximum Length:
240
The name of the labor schedule header. -
LaborScheduleType: string
Maximum Length:
80
The name for the labor schedule type that identifies the attributes that drive the distributions. -
LaborScheduleTypeCode: string
Maximum Length:
30
The code for the labor schedule type. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LegislativeDataGroupId: integer
Unique identifier of the legislative data group for the pay element.
-
LegislativeDataGroupName: string
Name of the legislative data group associated to the pay element.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayElement: string
Title:
Element Name
Maximum Length:80
The payroll element code for this labor schedule. Applies to labor schedules of type element. -
PayElementId: integer
(int64)
The payroll element identifier for this labor schedule. Applies to labor schedules of type element.
-
PayElementName: string
Maximum Length:
80
The payroll element name for this labor schedule. Applies to labor schedules of type element. -
PersonEmail: string
Title:
Email
Read Only:true
Maximum Length:240
Email of the person. -
PersonId: integer
(int64)
Unique identifier of the person.
-
PersonName: string
Title:
Name
Maximum Length:240
Full name, first then last, of the person. -
PersonNumber: string
Title:
Person Number
Maximum Length:30
Human Resources number of the person. -
RuleSource: string
Maximum Length:
20
Source of the labor schedule creation. Either UI, REST, or FBDI. -
versions: array
Person Assignment Labor Schedule Versions
Title:
Person Assignment Labor Schedule Versions
The versions resource is used as a child of the Person Assignment Labor Schedules resource to view and manage the versions of labor schedules for a person and assignment combination.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Person Assignment Labor Schedule Versions
Type:
array
Title:
Person Assignment Labor Schedule Versions
The versions resource is used as a child of the Person Assignment Labor Schedules resource to view and manage the versions of labor schedules for a person and assignment combination.
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.
Nested Schema : personAssignmentLaborSchedules-versions-item-response
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
The business unit identifier derived from the person assignment.
-
BusinessUnitLedger: integer
(int64)
Read Only:
true
GL Account for this distribution, if the rule is to a GL account. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the record was created. -
distributionRules: array
Person Assignment Labor Schedule Version Rules
Title:
Person Assignment Labor Schedule Version Rules
The DistributionRule services is used as a child of the Person Assignment Version resource to view and manage the distribution rules for a certain version. -
LaborScheduleId: integer
(int64)
Title:
Labor Schedule ID
Read Only:true
The unique identifier of the Person Assignment Labor Schedule header. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
VersionComments: string
Title:
Version Comments
Maximum Length:4000
Free form comments associated to the labor schedule version. -
VersionEndDate: string
(date)
Title:
Version End Date
The end date of the labor schedule version. -
VersionId: integer
(int64)
Title:
Version ID
The unique identifier of the labor schedule version. -
VersionName: string
Title:
Version Name
Maximum Length:300
The name of the labor schedule version. -
VersionStartDate: string
(date)
Title:
Version Start Date
The start date of the labor schedule version. -
VersionStatus: string
Title:
Status
Maximum Length:80
The labor schedule version status, such as New, Active or Inactive. -
VersionStatusCode: string
Title:
Version Status Code
Maximum Length:30
The code associated to the labor schedule version status.
Nested Schema : Person Assignment Labor Schedule Version Rules
Type:
array
Title:
Person Assignment Labor Schedule Version Rules
The DistributionRule services is used as a child of the Person Assignment Version resource to view and manage the distribution rules for a certain version.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personAssignmentLaborSchedules-versions-distributionRules-item-response
Type:
Show Source
object
-
BillableFlag: boolean
Maximum Length:
1
Identifies if the charge is billable or not. -
CapitalizableFlag: boolean
Maximum Length:
1
Information that indicates if a project-related item is eligible for capitalization. -
ChartOfAccountsId: integer
GL Account for this distribution, if the rule is to a GL account.
-
ContextCategory: string
Maximum Length:
40
Default Value:PJC_Labor_Distribution
Identifies the descriptive flexfield application context for project-related standardized cost collection. -
ContractId: integer
(int64)
Identifier of contract, used with Oracle Contract Billing or Oracle Grants Management.
-
ContractLineId: integer
(int64)
Tracks contract line information. Not used currently.
-
ContractName: string
Title:
Contract Name
Maximum Length:300
Name associated to the contract ID. -
ContractNumber: string
Title:
Contract Number
Maximum Length:120
Number associated to the contract ID. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date the record was created. -
DistributionRuleId: integer
(int64)
Primary key of distribution rule concatenated with the Line Number to make it unique.
-
ExpenditureItemDate: string
(date-time)
Date on which a project-related transaction is incurred.
-
ExpenditureOrganizationId: integer
(int64)
Identifier for expenditure organization used to build the transaction descriptive flexfield for project-related transaction distributions.
-
ExpenditureOrganizationName: string
Title:
Expenditure Organization
Maximum Length:240
Name for expenditure organization. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type
Expenditure type used to build the transaction descriptive flexfield for project-related transaction distributions. -
ExpenditureTypeName: string
Title:
Expenditure Type
Maximum Length:240
Name of the expenditure type for this cost distribution. -
FundingAllocationId: integer
(int64)
Specifies the name of the project funding override. Not used currently.
-
FundingSourceId: string
Maximum Length:
150
Identifier of the funding source for this distribution. -
FundingSourceName: string
Title:
Funding Source Name
Maximum Length:360
Funding source name. -
FundingSourceNumber: string
Title:
Funding Source Number
Maximum Length:50
Funding source number associated to this distribution. -
GLAccount: string
GL Account for this distribution, if the rule is to a GL account.
-
GLAccountCombinationId: integer
(int64)
The GL Account code combination identifier, if the rule is set to a GL account.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LineNumber: integer
Primary key of distribution rule concatenated with the DistributionRuleID to make it unique.
-
LinePercent: number
Default Value:
0
The percentage for this distribution rule, to be applied to the total cost for distribution. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectId: integer
(int64)
Identifier of the project for this distribution rule, if it's a project distribution.
-
ProjectName: string
Title:
Project Name
Maximum Length:240
Name of the project associated to this distribution if it's a project distribution. -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
Number of the project associated to this distribution if it's a project distribution. -
TaskId: integer
(int64)
Title:
Task
Identifier of the task for this distribution rule, if it's a project distribution. -
TaskName: string
Title:
Task Name
Maximum Length:255
Name of the task associated to this distribution if it's a project distribution. -
TaskNumber: string
Title:
Task Number
Maximum Length:100
Task number associated with this distribution. -
WorkTypeId: integer
(int64)
Identifier for project-related classification of the worked performed.
-
WorkTypeName: string
Title:
Work Type
Read Only:true
Maximum Length:240
Name for project-related classification of the worked performed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- copyVersion
-
Parameters:
- LaborScheduleId:
$request.path.LaborScheduleId
Copy a version to create a duplicate. - LaborScheduleId:
- versions
-
Operation: /fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/{LaborScheduleId}/child/versionsParameters:
- LaborScheduleId:
$request.path.LaborScheduleId
The versions resource is used as a child of the Person Assignment Labor Schedules resource to view and manage the versions of labor schedules for a person and assignment combination. - LaborScheduleId:
Examples
The following example shows how to get a person assignment labor schedule header 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/personAssignmentLaborSchedules/300100185256941
Response Body Example
The following shows an example of the response body in JSON format of all project templates.
{ "LaborScheduleId": 300100185256941, "LaborScheduleName": "MW PMan - Element Updated", "PersonId": 300100170330656, "PersonNumber": "955160008191117", "PersonName": "Malvin Wiley", "PersonEmail": "malvin_wiley_grp@oracle.com", "AssignmentId": 300100170330674, "AssignmentNumber": "E955160008191117", "AssignmentName": "Consultant", "AssignmentDepartment": "Vision City Administration", "CreatedBy": "Ldboth", "CreationDate": "2020-03-27T21:21:58+00:00", "LastUpdateDate": "2020-03-30T07:59:22+00:00", "LastUpdatedBy": "Ldboth", "links": [ { "rel": "self", "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/300100185256941", "name": "personAssignmentLaborSchedules", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/300100185256941", "name": "personAssignmentLaborSchedules", "kind": "item" }, { "rel": "child", "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/300100185256941/child/versions", "name": "versions", "kind": "collection" } ] }