Create an award personnel
post
/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardPersonnel
Request
Path Parameters
-
AwardId(required): integer(int64)
Unique identifier of the award.
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
-
AwardId(required): integer
(int64)
Title:
Award ID
The unique identifier of the award. -
AwardPersonnelDFF: array
Award Personnel Descriptive Flexfields
Title:
Award Personnel Descriptive Flexfields
A list of all the descriptive flexfields available for award personnel. -
AwardPersonnelId: integer
(int64)
Title:
Award Personnel
The unique identifier for award personnel association. -
CreditPercent: number
Credit percentage value associate for the selected person.
-
EmailAddress: string
Title:
Email
Email Address for the selected person from Human Resources. -
EndDate: string
(date)
Title:
End Date
End date of the duration for the award person associateion. -
InternalFlag: boolean
Title:
Internal
Maximum Length:1
Default Value:true
Indicates whether the selected person is internal or external. -
JobTitle: string
Title:
Primary Job
Job Title of the person selected from Human Resources. -
OrganizationName: string
Title:
Primary Organization
Name of the Organization of the selected person. -
PartyId: integer
(int64)
The unique identifier of the selected external person.
-
PersonId: integer
(int64)
The unique identifier of the selected internal person from Human Resources.
-
PersonName: string
Title:
Person Name
Name of the person in HCM. -
PersonNumber: string
Title:
Person Number
Person number of the person. -
PhoneNumber: string
Title:
Phone
Phone number of the person selected from Human Resources to administer and manage awards. -
Role: string
Title:
Role
Maximum Length:240
The role performed by the selected person. -
RoleId: integer
(int64)
Unique identifier of the selected role of the person.
-
StartDate(required): string
(date)
Title:
Start Date
Start date of the duration for the award person association.
Nested Schema : Award Personnel Descriptive Flexfields
Type:
array
Title:
Award Personnel Descriptive Flexfields
A list of all the descriptive flexfields available for award personnel.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Structure definition of the Award Personnel Descriptive Flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Id: integer
(int64)
System-generated primary key column.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : awards-AwardPersonnel-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
The unique identifier of the award. -
AwardPersonnelDFF: array
Award Personnel Descriptive Flexfields
Title:
Award Personnel Descriptive Flexfields
A list of all the descriptive flexfields available for award personnel. -
AwardPersonnelId: integer
(int64)
Title:
Award Personnel
The unique identifier for award personnel association. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award personnel. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award personnel was created. -
CreditPercent: number
Credit percentage value associate for the selected person.
-
EmailAddress: string
Title:
Email
Email Address for the selected person from Human Resources. -
EndDate: string
(date)
Title:
End Date
End date of the duration for the award person associateion. -
InternalFlag: boolean
Title:
Internal
Maximum Length:1
Default Value:true
Indicates whether the selected person is internal or external. -
JobTitle: string
Title:
Primary Job
Job Title of the person selected from Human Resources. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award personnel was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award personnel. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationName: string
Title:
Primary Organization
Name of the Organization of the selected person. -
PartyId: integer
(int64)
The unique identifier of the selected external person.
-
PersonId: integer
(int64)
The unique identifier of the selected internal person from Human Resources.
-
PersonName: string
Title:
Person Name
Name of the person in HCM. -
PersonNumber: string
Title:
Person Number
Person number of the person. -
PhoneNumber: string
Title:
Phone
Phone number of the person selected from Human Resources to administer and manage awards. -
Role: string
Title:
Role
Maximum Length:240
The role performed by the selected person. -
RoleId: integer
(int64)
Unique identifier of the selected role of the person.
-
StartDate: string
(date)
Title:
Start Date
Start date of the duration for the award person association.
Nested Schema : Award Personnel Descriptive Flexfields
Type:
array
Title:
Award Personnel Descriptive Flexfields
A list of all the descriptive flexfields available for award personnel.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardPersonnel-AwardPersonnelDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Structure definition of the Award Personnel Descriptive Flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Id: integer
(int64)
System-generated primary key column.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Links
- AwardPersonnelDFF
-
Parameters:
- AwardId:
$request.path.AwardId
- AwardPersonnelId:
$request.path.AwardPersonnelId
A list of all the descriptive flexfields available for award personnel. - AwardId: