Create a project enterprise labor resource
post
/fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BillRate: number
Title:
Bill Rate
The amount paid to a business by its customer for a unit of work completed by the project enterprise resource. -
BillRateCurrencyCode: string
Title:
Bill Rate Currency Code
Maximum Length:15
Code of the currency used to define the bill rate of the project enterprise resource. If no value is passed, the default value is set to the Default Currency field value from the Project Management Implementation Options setup page. -
CalendarId: integer
(int64)
Title:
Calendar ID
Identifier of the calendar that establishes the normal working days, hours, and exceptions for a project enterprise resource. If no value is passed, the default value is set to the Resource Calendar field value from the Project Management Implementation Options setup page. -
CalendarName: string
Title:
Calendar
Name of the calendar that establishes the normal working days, hours, and exceptions for a project enterprise resource. -
CostRate: number
Title:
Cost Rate
The cost of a unit of work by the project enterprise resource. -
CostRateCurrencyCode: string
Title:
Cost Rate Currency Code
Maximum Length:15
Code of the currency used to define the cost rate of the project enterprise resource. If no value is passed, the default value is set to the Default Currency field value from the Project Management Implementation Options setup page. -
Email: string
Title:
Email
Maximum Length:240
Email address of the project enterprise resource. Mandatory for POST operation if the resource isn't created from an existing HCM person. -
ExternalId: string
Title:
External ID
Maximum Length:240
Identifier of the project enterprise resource in the external application. -
FirstName: string
Title:
First Name
Maximum Length:150
First name of the project enterprise resource. In POST operation, if the resource isn't created from an existing HCM person, then either pass First Name and Last Name or the Resource Name. -
FromDate: string
(date)
Title:
From Date
The date from which you can assign the project enterprise resource to a project. -
HCMPersonName: string
Title:
HCM Person
Maximum Length:240
Name of the person in HCM for the project enterprise resource. -
LastName: string
Title:
Last Name
Maximum Length:150
Last name of the project enterprise resource. In POST operation, if the resource isn't created from an existing HCM person, then either pass First Name and Last Name or the Resource Name. -
ManagerEmail: string
Title:
Manager Email
Maximum Length:240
Email address of the person who is the manager of the project enterprise resource. -
ManageResourceStaffingFlag: boolean
Title:
Manage Resource Staffing Indicator
Maximum Length:1
Indicates whether the project enterprise resource is eligible for staffing. The valid values are Y and N. -
ManagerId: integer
(int64)
Title:
Manager ID
Identifier of the person who is the manager of the project enterprise resource. -
ManagerName: string
Title:
Manager
Maximum Length:240
Name of the person who is the manager of the project enterprise resource. -
PersonAssignmentDetails: array
Project Enterprise Resource HCM Assignment Details
Title:
Project Enterprise Resource HCM Assignment Details
The Project Enterprise Resource HCM Assignment Details resource is used to view primary HCM assignment details such as business unit, organization, job, or manager related to the enterprise labor resource. -
PersonId: integer
(int64)
Title:
Person ID
Identifier of the HCM person associated with the project enterprise resource. You can provide the Person ID or the Person Number in the POST operation to create a resource from an existing HCM person. Person ID takes precedence over Person Number. -
PersonNumber: string
Title:
Person Number
Unique number of the person associated with the project enterprise resource. You can provide the Person ID or the Person Number in the POST operation to create a resource from an existing HCM person. Person ID takes precedence over Person Number. -
PhoneNumber: string
Title:
Phone
Maximum Length:240
The phone number of the project enterprise resource. -
PoolMembershipFromDate: string
(date)
Title:
Membership From Date
Start date of the resource pool membership for the project enterprise resource. You can pass a value only if ManageResourceScheduleFlag is passed as Y. The default value is set to system date if no value is passed. -
PrimaryProjectRoleId: integer
(int64)
Title:
Primary Project Role ID
Default Value:13
Identifier of the primary role for the project enterprise resource. -
PrimaryProjectRoleName: string
Title:
Primary Project Role
Maximum Length:240
Name of the primary role for the project enterprise resource. -
ProjectEnterpriseResourceImage: array
Project Enterprise Resource Image
Title:
Project Enterprise Resource Image
The Project Enterprise Resource Image is used to view and create project enterprise resource image. -
ProjectId: integer
(int64)
Title:
Project ID
Identifier of the project associated to the project enterprise resource. -
ResourceCalendars: array
Project Enterprise Resource Calendars
Title:
Project Enterprise Resource Calendars
The Project Enterprise Resource Calendars resource is used to view calendars of a Project Enterprise Resource which are single workday pattern and single shift. A calendar is used when scheduling or staffing a Project Enterprise Resource. -
ResourceId: integer
(int64)
Title:
Resource ID
Identifier of the project enterprise resource. -
ResourceName: string
Title:
Resource Name
Maximum Length:240
Name of the project enterprise resource. Mandatory for POST operation if the resource isn't created from an existing HCM person and if First Name and Last Name are not populated. -
ResourcePoolId(required): integer
(int64)
Title:
Resource Pool ID
Identifier of the resource pool for the resource pool membership. You can pass a value only if ManageResourceScheduleFlag is passed as Y. The default value is set to Resources with No Pool Membership if no resource pool ID is passed. -
ResourcePoolMembership: array
Project Enterprise Resource Pool Membership
Title:
Project Enterprise Resource Pool Membership
The Project Enterprise Resource Pool Membership resource is used to view resource pools where the Project Enterprise Resource has present, past, or future memberships. -
ResourcePoolName: string
Title:
Resource Pool
Name of the resource pool for the resource pool membership. -
ToDate: string
(date)
Title:
To Date
The last date that you can assign the project enterprise resource to a project.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Project Enterprise Resource HCM Assignment Details
Type:
array
Title:
Project Enterprise Resource HCM Assignment Details
The Project Enterprise Resource HCM Assignment Details resource is used to view primary HCM assignment details such as business unit, organization, job, or manager related to the enterprise labor resource.
Show Source
Nested Schema : Project Enterprise Resource Image
Type:
array
Title:
Project Enterprise Resource Image
The Project Enterprise Resource Image is used to view and create project enterprise resource image.
Show Source
Nested Schema : Project Enterprise Resource Calendars
Type:
array
Title:
Project Enterprise Resource Calendars
The Project Enterprise Resource Calendars resource is used to view calendars of a Project Enterprise Resource which are single workday pattern and single shift. A calendar is used when scheduling or staffing a Project Enterprise Resource.
Show Source
Nested Schema : Project Enterprise Resource Pool Membership
Type:
array
Title:
Project Enterprise Resource Pool Membership
The Project Enterprise Resource Pool Membership resource is used to view resource pools where the Project Enterprise Resource has present, past, or future memberships.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
Nested Schema : projectEnterpriseLaborResources-PersonAssignmentDetails-item-post-request
Type:
Show Source
object
Nested Schema : schema
Type:
Show Source
object
-
Image: string
(byte)
Title:
Image
Image of the project enterprise resource. -
ImageId: integer
(int64)
Title:
Image ID
Identifier of the project enterprise resource image. -
ResourceId: integer
(int64)
Identifier of the project enterprise resource.
Nested Schema : projectEnterpriseLaborResources-ResourceCalendars-item-post-request
Type:
Show Source
object
-
CalendarExceptions: array
Project Enterprise Resource Calendar Exceptions
Title:
Project Enterprise Resource Calendar Exceptions
The Project Enterprise Resource Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.
Nested Schema : Project Enterprise Resource Calendar Exceptions
Type:
array
Title:
Project Enterprise Resource Calendar Exceptions
The Project Enterprise Resource Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.
Show Source
Nested Schema : projectEnterpriseLaborResources-ResourceCalendars-CalendarExceptions-item-post-request
Type:
Show Source
object
Nested Schema : projectEnterpriseLaborResources-ResourcePoolMembership-item-post-request
Type:
Show Source
object
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 : projectEnterpriseLaborResources-item-response
Type:
Show Source
object
-
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BillRate: number
Title:
Bill Rate
The amount paid to a business by its customer for a unit of work completed by the project enterprise resource. -
BillRateCurrencyCode: string
Title:
Bill Rate Currency Code
Maximum Length:15
Code of the currency used to define the bill rate of the project enterprise resource. If no value is passed, the default value is set to the Default Currency field value from the Project Management Implementation Options setup page. -
CalendarId: integer
(int64)
Title:
Calendar ID
Identifier of the calendar that establishes the normal working days, hours, and exceptions for a project enterprise resource. If no value is passed, the default value is set to the Resource Calendar field value from the Project Management Implementation Options setup page. -
CalendarName: string
Title:
Calendar
Name of the calendar that establishes the normal working days, hours, and exceptions for a project enterprise resource. -
CostRate: number
Title:
Cost Rate
The cost of a unit of work by the project enterprise resource. -
CostRateCurrencyCode: string
Title:
Cost Rate Currency Code
Maximum Length:15
Code of the currency used to define the cost rate of the project enterprise resource. If no value is passed, the default value is set to the Default Currency field value from the Project Management Implementation Options setup page. -
Email: string
Title:
Email
Maximum Length:240
Email address of the project enterprise resource. Mandatory for POST operation if the resource isn't created from an existing HCM person. -
ExternalId: string
Title:
External ID
Maximum Length:240
Identifier of the project enterprise resource in the external application. -
FirstName: string
Title:
First Name
Maximum Length:150
First name of the project enterprise resource. In POST operation, if the resource isn't created from an existing HCM person, then either pass First Name and Last Name or the Resource Name. -
FromDate: string
(date)
Title:
From Date
The date from which you can assign the project enterprise resource to a project. -
HCMPersonName: string
Title:
HCM Person
Maximum Length:240
Name of the person in HCM for the project enterprise resource. -
HCMPersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Number of the HCM person associated with the project enterprise resource. -
LastName: string
Title:
Last Name
Maximum Length:150
Last name of the project enterprise resource. In POST operation, if the resource isn't created from an existing HCM person, then either pass First Name and Last Name or the Resource Name. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerEmail: string
Title:
Manager Email
Maximum Length:240
Email address of the person who is the manager of the project enterprise resource. -
ManageResourceStaffingFlag: boolean
Title:
Manage Resource Staffing Indicator
Maximum Length:1
Indicates whether the project enterprise resource is eligible for staffing. The valid values are Y and N. -
ManagerId: integer
(int64)
Title:
Manager ID
Identifier of the person who is the manager of the project enterprise resource. -
ManagerName: string
Title:
Manager
Maximum Length:240
Name of the person who is the manager of the project enterprise resource. -
PersonAssignmentDetails: array
Project Enterprise Resource HCM Assignment Details
Title:
Project Enterprise Resource HCM Assignment Details
The Project Enterprise Resource HCM Assignment Details resource is used to view primary HCM assignment details such as business unit, organization, job, or manager related to the enterprise labor resource. -
PersonId: integer
(int64)
Title:
Person ID
Identifier of the HCM person associated with the project enterprise resource. You can provide the Person ID or the Person Number in the POST operation to create a resource from an existing HCM person. Person ID takes precedence over Person Number. -
PersonNumber: string
Title:
Person Number
Unique number of the person associated with the project enterprise resource. You can provide the Person ID or the Person Number in the POST operation to create a resource from an existing HCM person. Person ID takes precedence over Person Number. -
PhoneNumber: string
Title:
Phone
Maximum Length:240
The phone number of the project enterprise resource. -
PoolMembershipFromDate: string
(date)
Title:
Membership From Date
Start date of the resource pool membership for the project enterprise resource. You can pass a value only if ManageResourceScheduleFlag is passed as Y. The default value is set to system date if no value is passed. -
PoolName: string
Title:
Resource Pool
Read Only:true
Maximum Length:240
Name of the resource pool associated to the project enterprise resource. -
PrimaryProjectRoleId: integer
(int64)
Title:
Primary Project Role ID
Default Value:13
Identifier of the primary role for the project enterprise resource. -
PrimaryProjectRoleName: string
Title:
Primary Project Role
Maximum Length:240
Name of the primary role for the project enterprise resource. -
ProjectEnterpriseResourceImage: array
Project Enterprise Resource Image
Title:
Project Enterprise Resource Image
The Project Enterprise Resource Image is used to view and create project enterprise resource image. -
ProjectId: integer
(int64)
Title:
Project ID
Identifier of the project associated to the project enterprise resource. -
ProjectName: string
Title:
Project Name
Read Only:true
Maximum Length:240
Name of the project associated to the project enterprise resource. -
ResourceCalendars: array
Project Enterprise Resource Calendars
Title:
Project Enterprise Resource Calendars
The Project Enterprise Resource Calendars resource is used to view calendars of a Project Enterprise Resource which are single workday pattern and single shift. A calendar is used when scheduling or staffing a Project Enterprise Resource. -
ResourceId: integer
(int64)
Title:
Resource ID
Identifier of the project enterprise resource. -
ResourceName: string
Title:
Resource Name
Maximum Length:240
Name of the project enterprise resource. Mandatory for POST operation if the resource isn't created from an existing HCM person and if First Name and Last Name are not populated. -
ResourcePoolId: integer
(int64)
Title:
Resource Pool ID
Identifier of the resource pool for the resource pool membership. You can pass a value only if ManageResourceScheduleFlag is passed as Y. The default value is set to Resources with No Pool Membership if no resource pool ID is passed. -
ResourcePoolMembership: array
Project Enterprise Resource Pool Membership
Title:
Project Enterprise Resource Pool Membership
The Project Enterprise Resource Pool Membership resource is used to view resource pools where the Project Enterprise Resource has present, past, or future memberships. -
ResourcePoolName: string
Title:
Resource Pool
Name of the resource pool for the resource pool membership. -
ToDate: string
(date)
Title:
To Date
The last date that you can assign the project enterprise resource to a project.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Project Enterprise Resource HCM Assignment Details
Type:
array
Title:
Project Enterprise Resource HCM Assignment Details
The Project Enterprise Resource HCM Assignment Details resource is used to view primary HCM assignment details such as business unit, organization, job, or manager related to the enterprise labor resource.
Show Source
Nested Schema : Project Enterprise Resource Image
Type:
array
Title:
Project Enterprise Resource Image
The Project Enterprise Resource Image is used to view and create project enterprise resource image.
Show Source
Nested Schema : Project Enterprise Resource Calendars
Type:
array
Title:
Project Enterprise Resource Calendars
The Project Enterprise Resource Calendars resource is used to view calendars of a Project Enterprise Resource which are single workday pattern and single shift. A calendar is used when scheduling or staffing a Project Enterprise Resource.
Show Source
Nested Schema : Project Enterprise Resource Pool Membership
Type:
array
Title:
Project Enterprise Resource Pool Membership
The Project Enterprise Resource Pool Membership resource is used to view resource pools where the Project Enterprise Resource has present, past, or future memberships.
Show Source
Nested Schema : projectEnterpriseLaborResources-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
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.
Nested Schema : projectEnterpriseLaborResources-PersonAssignmentDetails-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Title:
Assignment ID
Read Only:true
Unique identifier for the HCM person assignment. -
AssignmentName: string
Title:
Assignment Name
Read Only:true
Maximum Length:80
Translated name of the HCM person assignment. -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Number identifying the person assignment. -
AssignmentStatusType: string
Title:
Assignment Status Type
Read Only:true
Maximum Length:30
HR status of the HCM person assignment, such as Active, Inactive, and Suspended. -
AssignmentType: string
Title:
Assignment Type
Read Only:true
Maximum Length:30
Assignment type. The valid values are E for employee and C for contingent worker. -
BusinessUnitId: integer
(int64)
Title:
Business Unit Id
Read Only:true
Unique identifier for the business unit. -
BusinessUnitName: string
Title:
Business Unit Name
Read Only:true
Maximum Length:240
Translated name of the business unit. -
DepartmentName: string
Title:
Department Name
Read Only:true
Maximum Length:240
Translated name of the department. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Read Only:true
End date of the period within which the HCM resource assignment is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Read Only:true
Start date of the period within which the HCM resource assignment is effective. -
JobId: integer
(int64)
Title:
Job Id
Read Only:true
Unique identifier of the job. -
JobName: string
Title:
Job Name
Read Only:true
Maximum Length:240
Name of the job. -
LineManagerName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the person who is the line manager of the project enterprise resource. -
LineManagerPersonId: integer
(int64)
Read Only:
true
Identifier of the person who is the line manager of the project enterprise resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Read Only:
true
Unique identifier for location -
LocationName: string
Title:
Location Name
Read Only:true
Maximum Length:240
Name of location -
OrganizationId: integer
(int64)
Title:
Organization ID
Read Only:true
Unique identifier of the department. -
UserPersonType: string
Title:
User Person Type
Read Only:true
Maximum Length:80
Unique identifier of the employment type. The valid values are E for employees and C for the contingent workers.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectEnterpriseLaborResources-ProjectEnterpriseResourceImage-item-response
Type:
Show Source
object
-
Image: string
(byte)
Title:
Image
Image of the project enterprise resource. -
ImageId: integer
(int64)
Title:
Image ID
Identifier of the project enterprise resource image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResourceId: integer
(int64)
Identifier of the project enterprise resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectEnterpriseLaborResources-ResourceCalendars-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active Indicator
Read Only:true
Indicates if the calendar is active. -
CalendarExceptions: array
Project Enterprise Resource Calendar Exceptions
Title:
Project Enterprise Resource Calendar Exceptions
The Project Enterprise Resource Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used to define holidays or exceptional working days on a weekend. A calendar could have many exceptions. -
CalendarId: integer
(int64)
Title:
Calendar ID
Read Only:true
Unique identifier of the calendar. -
CategoryCode: string
Title:
Calendar Category Code
Read Only:true
Maximum Length:30
The category used for the calendar. -
Description: string
Title:
Calendar Description
Read Only:true
Maximum Length:2000
Description of the calendar. -
EffectiveFromDate: string
(date)
Title:
Effective from Date
Read Only:true
The date from which the calendar is effective. -
EffectiveToDate: string
(date)
Title:
Effective to Date
Read Only:true
The inclusive last date of the effectivity of the calendar. -
FirstDayOfWeek: integer
Title:
First Day of Week for Calendar
Read Only:true
The index of the first day in the week: 1 for Sunday, 2 for Monday, 3 for Tuesday, and so on. The default value is 2. -
FridayWorkFlag: boolean
Title:
Friday Work Indicator
Read Only:true
Indicates if Fridays are workable. True if it's workable, False if it's not. -
HoursPerDay: number
Title:
Hours per Day
Read Only:true
Number of working hours in a day. Value depends on the number of hours in the shift. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MondayWorkFlag: boolean
Title:
Monday Work Indicator
Read Only:true
Indicates if Mondays are workable. True if it is workable, False if it is not. -
Name: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the calendar. -
QuaterlyTypeCode: string
Title:
Quarterly Type Code
Read Only:true
Maximum Length:30
Indicates the quarter type of the calendar. -
SaturdayWorkFlag: boolean
Title:
Saturday Work Indicator
Read Only:true
Indicates if Saturdays are workable. True if it is workable, False if it is not. -
SundayWorkFlag: boolean
Title:
Sunday Work Indicator
Read Only:true
Indicates if Sundays are workable. True if it is workable, False if it is not. -
ThursdayWorkFlag: boolean
Title:
Thursday Work Indicator
Read Only:true
Indicates if Thursdays are workable. True if it is workable, False if it is not. -
TuesdayWorkFlag: boolean
Title:
Tuesday Work Indicator
Read Only:true
Indicates if Tuesdays are workable. True if it is workable, False if it is not. -
WednesdayWorkFlag: boolean
Title:
Wednesday Work Indicator
Read Only:true
Indicates if Wednesdays are workable. True if it is workable, False if it is not.
Nested Schema : Project Enterprise Resource Calendar Exceptions
Type:
array
Title:
Project Enterprise Resource Calendar Exceptions
The Project Enterprise Resource Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectEnterpriseLaborResources-ResourceCalendars-CalendarExceptions-item-response
Type:
Show Source
object
-
AllDayFlag: boolean
Title:
All Day Exception Indicator
Read Only:true
Maximum Length:1
Default Value:true
Indicates if the calendar exception is for the whole day. -
CategoryCode: string
Title:
Calendar Exception Category Code
Read Only:true
Maximum Length:30
Category code in which the exception falls. -
Code: string
Title:
Calendar Exception Code
Read Only:true
Maximum Length:3
Code to identify the exception. -
Description: string
Title:
Calendar Exception Description
Read Only:true
Maximum Length:2000
Description of the exception. -
EndDate: string
(date-time)
Title:
Calendar Exception End Date
Read Only:true
The inclusive end date of the calendar exception. Value contains time component if the exception is not for all day long. -
ExceptionId: integer
(int64)
Title:
Calendar Exception ID
Read Only:true
Unique identifier of the exception in the calendar. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Calendar Exception Name
Read Only:true
Maximum Length:240
Name of the exception. -
PeriodType: string
Title:
Calendar Exception Period Type
Read Only:true
Maximum Length:30
Indicates if the calendar exception is a workable period or not. Valid values are OFF_PERIOD and WORK_PERIOD. -
StartDate: string
(date-time)
Title:
Calendar Exception Start Date
Read Only:true
The date on which the calendar exception begins. Value contains time component if the exception is not for all day long.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectEnterpriseLaborResources-ResourcePoolMembership-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PoolMembershipFromDate: string
(date)
Title:
Pool Membership From Date
Read Only:true
Start date of the resource pool membership. -
PoolMembershipToDate: string
(date)
Title:
Pool Membership To Date
Read Only:true
Last date of the resource pool membership. -
PoolOwnerResourceId: integer
(int64)
Title:
Pool Owner Resource ID
Read Only:true
Identifier of the project enterprise resource, who is the project resource pool owner. -
ResourcePoolId: integer
(int64)
Title:
Resource Pool ID
Read Only:true
Unique identifier of the project resource pool. -
ResourcePoolMembershipId: integer
(int64)
Title:
Resource Pool Membership ID
Read Only:true
Unique identifier of the project resource pool membership. -
ResourcePoolName: string
Title:
Resource Pool Name
Read Only:true
Maximum Length:240
Name of the project resource pool.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Parameters:
- projectEnterpriseLaborResourcesUniqID:
$request.path.projectEnterpriseLaborResourcesUniqID
The attachments resource is used to view, create, and update attachments. - projectEnterpriseLaborResourcesUniqID:
- PersonAssignmentDetails
-
Parameters:
- projectEnterpriseLaborResourcesUniqID:
$request.path.projectEnterpriseLaborResourcesUniqID
The Project Enterprise Resource HCM Assignment Details resource is used to view primary HCM assignment details such as business unit, organization, job, or manager related to the enterprise labor resource. - projectEnterpriseLaborResourcesUniqID:
- ProjectEnterpriseResourceImage
-
Parameters:
- projectEnterpriseLaborResourcesUniqID:
$request.path.projectEnterpriseLaborResourcesUniqID
The Project Enterprise Resource Image is used to view and create project enterprise resource image. - projectEnterpriseLaborResourcesUniqID:
- ResourceCalendars
-
Parameters:
- projectEnterpriseLaborResourcesUniqID:
$request.path.projectEnterpriseLaborResourcesUniqID
The Project Enterprise Resource Calendars resource is used to view calendars of a Project Enterprise Resource which are single workday pattern and single shift. A calendar is used when scheduling or staffing a Project Enterprise Resource. - projectEnterpriseLaborResourcesUniqID:
- ResourcePoolMembership
-
Parameters:
- projectEnterpriseLaborResourcesUniqID:
$request.path.projectEnterpriseLaborResourcesUniqID
The Project Enterprise Resource Pool Membership resource is used to view resource pools where the Project Enterprise Resource has present, past, or future memberships. - projectEnterpriseLaborResourcesUniqID:
Examples
The following example shows how to create an labor resource by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources
Request Body Example
The following shows an example of the request body in JSON format.
{ "FirstName" : "Steve" , "LastName" : "Williams" , "Email" : "Steve.Williams@oracle.com" , "FromDate" : "2017-01-01", "CalendarName" : "PJT Standard US Calendar", "PrimaryProjectRoleName" : "Oracle DBA", "BillRate" : 200, "BillRateCurrencyCode" : "USD", "CostRate" : 200, "CostRateCurrencyCode" : "USD", "ManageResourceStaffingFlag" : "Y", "ResourcePoolName" : "Development Resources", "PoolMembershipFromDate" : "2017-06-06" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "ResourceId" : 300100125268001, "PersonId" : null, "PersonNumber" : null, "HCMPersonName" : null, "FirstName" : "Steve", "LastName" : "Williams", "ResourceName" : "Steve Williams", "Email" : "Steve.Williams@oracle.com", "FromDate" : "2017-01-01", "ToDate" : null, "PhoneNumber" : null, "ManagerId" : null, "ManagerName" : null, "ManagerEmail" : null, "CalendarId" : 300100010293735, "CalendarName" : "PJT Standard US Calendar", "PrimaryProjectRoleId" : 300100025498083, "PrimaryProjectRoleName" : "Oracle DBA", "BillRate" : 200, "BillRateCurrencyCode" : "USD", "CostRate" : 200, "CostRateCurrencyCode" : "USD", "ManageResourceStaffingFlag" : true, "ResourcePoolId" : null, "ResourcePoolName" : null, "PoolMembershipFromDate" : null, "ProjectId" : null, "ProjectName" : null, "ExternalId" : null }