Update event detail
patch
/hcmRestApi/resources/11.13.18.05/recruitingUIEventDetails/{EventId}
Request
Path Parameters
-
EventId(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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ApplyFlowId: integer
(int64)
Apply flow identifier for the event.
-
attachments: array
Candidate Attachments
Title:
Candidate Attachments
The InternalAttachments resource provides information about files attached by the recruiting team. -
EnableInterviewFlag: boolean
Maximum Length:
1
Flag indicating whether interviews are enabled for the event. -
eventCareerSites: array
Career Sites Associated with an Event
Title:
Career Sites Associated with an Event
The career sites resource provides the association of the recruiting event with external career sites. -
EventCategoryCode: string
Maximum Length:
30
Category code for the event. -
EventCreationMode: string
Maximum Length:
30
Mode in which the event was created. -
EventDescHtml: string
(byte)
HTML description of the event.
-
EventEndDate: string
(date-time)
End date of the event.
-
eventLanguages: array
Available Languages
Title:
Available Languages
The event languages resource provides the language-specific translations of event details for multilingual recruiting events. -
EventLastRegDate: string
(date-time)
The last registration date for the event.
-
EventLastUpdateDate: string
(date-time)
Date the event was last updated.
-
eventLocation: array
Recruiting Event Location
Title:
Recruiting Event Location
The event location resource provides event location related details. -
eventMedia: array
Event Media Resources
Title:
Event Media Resources
The event media resource provides media assets related to an event. -
EventName: string
Maximum Length:
240
Name of the event. -
EventNotes: string
Maximum Length:
1000
Notes associated with the event. -
EventOwnerId: integer
(int64)
The owner identifier of the event.
-
EventPurpose: string
Maximum Length:
512
Purpose of the event. -
EventShortDesc: string
(byte)
Short description of the event.
-
EventStartDate: string
(date-time)
Start date of the event.
-
eventTeam: array
Event Team Members
Title:
Event Team Members
The event team resources provides the team members assigned to the recruiting event. -
EventTimezoneCode: string
Maximum Length:
50
Time zone code for the event. -
eventTranslation: array
Event Translations
Title:
Event Translations
The event translations resource provides the translations of event details for multilingual recruiting events. -
EventVisibilityCode: string
Maximum Length:
30
Visibility code of the event. -
ExistingEventId: integer
Unique identifier of an existing event used to create a new event.
-
interviewDetails: array
Event Interview Details
Title:
Event Interview Details
The interview resource provides the interview details related to recruiting events. -
ManualRegnConfirmFlag: boolean
Maximum Length:
1
Flag for manual registration confirmation for the event -
MaxRegCount: integer
(int32)
Maximum number of registrations allowed for the event.
-
PhaseCode: string
Maximum Length:
64
Phase code for the event. -
PublishEndDate: string
(date-time)
End date for publishing the event.
-
PublishStartDate: string
(date-time)
Start date for publishing the event.
-
PublishStatusCode: string
Maximum Length:
30
Status code for publishing the event. -
PublishTimezoneCode: string
Maximum Length:
50
Time zone code for publishing the event.
Nested Schema : Candidate Attachments
Type:
array
Title:
Candidate Attachments
The InternalAttachments resource provides information about files attached by the recruiting team.
Show Source
Nested Schema : Career Sites Associated with an Event
Type:
array
Title:
Career Sites Associated with an Event
The career sites resource provides the association of the recruiting event with external career sites.
Show Source
Nested Schema : Available Languages
Type:
array
Title:
Available Languages
The event languages resource provides the language-specific translations of event details for multilingual recruiting events.
Show Source
Nested Schema : Recruiting Event Location
Type:
array
Title:
Recruiting Event Location
The event location resource provides event location related details.
Show Source
Nested Schema : Event Media Resources
Type:
array
Title:
Event Media Resources
The event media resource provides media assets related to an event.
Show Source
Nested Schema : Event Team Members
Type:
array
Title:
Event Team Members
The event team resources provides the team members assigned to the recruiting event.
Show Source
Nested Schema : Event Translations
Type:
array
Title:
Event Translations
The event translations resource provides the translations of event details for multilingual recruiting events.
Show Source
Nested Schema : Event Interview Details
Type:
array
Title:
Event Interview Details
The interview resource provides the interview details related to recruiting events.
Show Source
Nested Schema : recruitingUIEventDetails-attachments-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates data type code of attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
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
Error status code for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date and time of the attachment content. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
File content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
File length of the attachment. -
UploadedFileName: string
Title:
Uploaded File Name
File name of the attachment. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of the attachment.
Nested Schema : recruitingUIEventDetails-eventCareerSites-item-patch-request
Type:
Show Source
object
-
EventId: integer
(int64)
Unique identifier for the event in career sites.
-
SiteId: integer
(int64)
Unique identifier for the career site.
Nested Schema : recruitingUIEventDetails-eventLanguages-item-patch-request
Type:
Show Source
object
-
EventId: integer
(int64)
Unique identifier for the event in multiple languages.
-
EventLanguageId: integer
(int64)
Unique identifier for the event language.
-
IsBaseFlag: boolean
Maximum Length:
1
Flag indicating if this is the base language for the event. -
LanguageCode: string
Maximum Length:
4
Code for the event language.
Nested Schema : recruitingUIEventDetails-eventLocation-item-patch-request
Type:
Show Source
object
-
AccessCode: string
Maximum Length:
30
Access code for the event location. -
AddlAddressAttribute1: string
Maximum Length:
255
Additional address attribute 1 for the event location. -
AddlAddressAttribute2: string
Maximum Length:
255
Additional address attribute 2 for the event location. -
AddlAddressAttribute3: string
Maximum Length:
255
Additional address attribute 3 for the event location. -
AddlAddressAttribute4: string
Maximum Length:
255
Additional address attribute 4 for the event location. -
AddlAddressAttribute5: string
Maximum Length:
255
Additional address attribute 5 for the event location. -
AddressId: integer
(int64)
Unique identifier for the address of the event location.
-
AddressLine1: string
Maximum Length:
255
Address line 1 of the event location. -
AddressLine2: string
Maximum Length:
255
Address line 2 of the event location. -
AddressLine3: string
Maximum Length:
255
Address line 3 of the event location. -
AddressLine4: string
Maximum Length:
255
Address line 4 of the event location. -
Building: string
Maximum Length:
255
Building name or number for the event location. -
Country: string
Maximum Length:
255
Country for the event location. -
EventFormatCode: string
Maximum Length:
30
Code for the format of the event. -
EventId: integer
(int64)
Unique identifier for the event in event locations.
-
FloorNumber: string
Maximum Length:
255
Floor number of the event location. -
LocationId: integer
(int64)
Unique identifier for the location.
-
LocationTypeCode: string
Maximum Length:
30
Type code for the event location. -
LongPostalCode: string
Maximum Length:
255
Extended postal code for the event location. -
MaxCapacity: integer
(int32)
Maximum capacity for the event location.
-
MeetingId: string
Maximum Length:
60
Unique identifier for the meeting location. -
PhoneAreaCode: string
Maximum Length:
30
Phone area code for the event location. -
PhoneCountryCode: string
Maximum Length:
30
Candidate's phone country code in the recruiting tax credits. -
PhoneLegislationCode: string
Maximum Length:
4
Candidate's phone country code in the recruiting tax credits. -
PhoneNumber: string
Maximum Length:
60
Phone number for the event location. -
PostalCode: string
Maximum Length:
255
Postal code for the event location. -
Region1: string
Maximum Length:
255
Region 1 for the event location. -
Region2: string
Maximum Length:
255
Region 2 for the event location. -
Region3: string
Maximum Length:
255
Region 3 for the event location. -
TownOrCity: string
Maximum Length:
255
Town or city for the event location. -
WebConfLink: string
Maximum Length:
300
Web conferencing link for the event location.
Nested Schema : recruitingUIEventDetails-eventMedia-item-patch-request
Type:
Show Source
object
-
EventId: integer
Unique identifier for the event for event media.
-
EventMediaId: integer
Unique identifier for the event media.
-
MediaLinkId: integer
Unique identifier for the media link.
-
MediaTypeCode: string
Maximum Length:
255
Type code for the event media. -
SequenceNumber: integer
Sequence number for the event media.
-
ThumbnailURL: string
Maximum Length:
255
URL for the thumbnail image of the event media. -
Title: string
Maximum Length:
255
Title of the event media. -
URL: string
Maximum Length:
255
URL for the event media.
Nested Schema : recruitingUIEventDetails-eventTeam-item-patch-request
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Unique identifier for the event team assignment.
-
CollaboratorRespTypeCode: string
Maximum Length:
30
Collaborator responsibility type code for the event team. -
MemberTypeCode: string
Maximum Length:
30
Type code for the event team member. -
ObjectId: integer
(int64)
Object identifier for the event team member.
-
ObjectType: string
Maximum Length:
30
Object type for the event team member. -
PersonId: integer
(int64)
Unique identifier for the person in the event team.
-
TeamMemberId: integer
(int64)
Unique identifier for the event team member.
Nested Schema : recruitingUIEventDetails-eventTranslation-item-patch-request
Type:
Show Source
object
-
EventDescHtml: string
(byte)
HTML description of the event translation.
-
EventName: string
Maximum Length:
240
Name of the event in the translation. -
EventNotes: string
Maximum Length:
1000
Notes associated with the event translation. -
EventPurpose: string
Maximum Length:
500
Purpose of the event in the translation. -
EventShortDesc: string
(byte)
Short description of the event in the translation.
-
SourceLang: string
Maximum Length:
4
Source language for the event translation.
Nested Schema : recruitingUIEventDetails-interviewDetails-item-patch-request
Type:
Show Source
object
-
EventId: integer
(int64)
Unique identifier for the event in interview details.
-
eventInterviewers: array
Event Interviewers
Title:
Event Interviewers
The event interviewers resource provies the details of the recruiting event interviewers.
Nested Schema : Event Interviewers
Type:
array
Title:
Event Interviewers
The event interviewers resource provies the details of the recruiting event interviewers.
Show Source
Nested Schema : recruitingUIEventDetails-interviewDetails-eventInterviewers-item-patch-request
Type:
Show Source
object
-
InterviewDetailsId: integer
(int64)
Unique identifier for the interview details.
-
InterviewerPersonId: integer
(int64)
Person ID in recruiting job requisitions collaborators.
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 : recruitingUIEventDetails-item-response
Type:
Show Source
object
-
ApplyFlowId: integer
(int64)
Apply flow identifier for the event.
-
attachments: array
Candidate Attachments
Title:
Candidate Attachments
The InternalAttachments resource provides information about files attached by the recruiting team. -
EnableInterviewFlag: boolean
Maximum Length:
1
Flag indicating whether interviews are enabled for the event. -
eventCareerSites: array
Career Sites Associated with an Event
Title:
Career Sites Associated with an Event
The career sites resource provides the association of the recruiting event with external career sites. -
EventCategoryCode: string
Maximum Length:
30
Category code for the event. -
EventCreationMode: string
Maximum Length:
30
Mode in which the event was created. -
EventDescHtml: string
(byte)
HTML description of the event.
-
EventEndDate: string
(date-time)
End date of the event.
-
EventId: integer
(int64)
Unique identifier for the event.
-
eventLanguages: array
Available Languages
Title:
Available Languages
The event languages resource provides the language-specific translations of event details for multilingual recruiting events. -
EventLastRegDate: string
(date-time)
The last registration date for the event.
-
EventLastUpdateDate: string
(date-time)
Date the event was last updated.
-
eventLocation: array
Recruiting Event Location
Title:
Recruiting Event Location
The event location resource provides event location related details. -
eventMedia: array
Event Media Resources
Title:
Event Media Resources
The event media resource provides media assets related to an event. -
EventName: string
Maximum Length:
240
Name of the event. -
EventNotes: string
Maximum Length:
1000
Notes associated with the event. -
EventNumber: string
Read Only:
true
Maximum Length:64
Event number identifier. -
EventOwnerId: integer
(int64)
The owner identifier of the event.
-
EventPurpose: string
Maximum Length:
512
Purpose of the event. -
EventShortDesc: string
(byte)
Short description of the event.
-
EventStartDate: string
(date-time)
Start date of the event.
-
eventTeam: array
Event Team Members
Title:
Event Team Members
The event team resources provides the team members assigned to the recruiting event. -
EventTimezoneCode: string
Maximum Length:
50
Time zone code for the event. -
eventTranslation: array
Event Translations
Title:
Event Translations
The event translations resource provides the translations of event details for multilingual recruiting events. -
EventVisibilityCode: string
Maximum Length:
30
Visibility code of the event. -
ExistingEventId: integer
Unique identifier of an existing event used to create a new event.
-
interviewDetails: array
Event Interview Details
Title:
Event Interview Details
The interview resource provides the interview details related to recruiting events. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualRegnConfirmFlag: boolean
Maximum Length:
1
Flag for manual registration confirmation for the event -
MaxRegCount: integer
(int32)
Maximum number of registrations allowed for the event.
-
PhaseCode: string
Maximum Length:
64
Phase code for the event. -
PublishEndDate: string
(date-time)
End date for publishing the event.
-
PublishStartDate: string
(date-time)
Start date for publishing the event.
-
PublishStatusCode: string
Maximum Length:
30
Status code for publishing the event. -
PublishTimezoneCode: string
Maximum Length:
50
Time zone code for publishing the event.
Nested Schema : Candidate Attachments
Type:
array
Title:
Candidate Attachments
The InternalAttachments resource provides information about files attached by the recruiting team.
Show Source
Nested Schema : Career Sites Associated with an Event
Type:
array
Title:
Career Sites Associated with an Event
The career sites resource provides the association of the recruiting event with external career sites.
Show Source
Nested Schema : Available Languages
Type:
array
Title:
Available Languages
The event languages resource provides the language-specific translations of event details for multilingual recruiting events.
Show Source
Nested Schema : Recruiting Event Location
Type:
array
Title:
Recruiting Event Location
The event location resource provides event location related details.
Show Source
Nested Schema : Event Media Resources
Type:
array
Title:
Event Media Resources
The event media resource provides media assets related to an event.
Show Source
Nested Schema : Event Team Members
Type:
array
Title:
Event Team Members
The event team resources provides the team members assigned to the recruiting event.
Show Source
Nested Schema : Event Translations
Type:
array
Title:
Event Translations
The event translations resource provides the translations of event details for multilingual recruiting events.
Show Source
Nested Schema : Event Interview Details
Type:
array
Title:
Event Interview Details
The interview resource provides the interview details related to recruiting events.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUIEventDetails-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
Unique identifier of the attachment. System generated primary key. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates data type code of attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DocumentPreviewURL: string
Read Only:
true
Maximum Length:255
Attachment context. -
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
Error status code for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date and time of the attachment content. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL of the attachment. -
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
Date and time when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the attachment. -
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
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
File content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
File length of the attachment. -
UploadedFileName: string
Title:
Uploaded File Name
File name of the attachment. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name associated with 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 : recruitingUIEventDetails-eventCareerSites-item-response
Type:
Show Source
object
-
EventId: integer
(int64)
Unique identifier for the event in career sites.
-
EventSiteId: integer
(int64)
Unique identifier for the career site.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SiteCode: string
Read Only:
true
Maximum Length:255
Site code for the career site. -
SiteId: integer
(int64)
Unique identifier for the career site.
-
SiteName: string
Read Only:
true
Maximum Length:255
Name of the career site. -
SiteNumber: string
Read Only:
true
Maximum Length:255
Career site number identifier.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUIEventDetails-eventLanguages-item-response
Type:
Show Source
object
-
EventId: integer
(int64)
Unique identifier for the event in multiple languages.
-
EventLanguageId: integer
(int64)
Unique identifier for the event language.
-
IsBaseFlag: boolean
Maximum Length:
1
Flag indicating if this is the base language for the event. -
LanguageCode: string
Maximum Length:
4
Code for the event language. -
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 : recruitingUIEventDetails-eventLocation-item-response
Type:
Show Source
object
-
AccessCode: string
Maximum Length:
30
Access code for the event location. -
AddlAddressAttribute1: string
Maximum Length:
255
Additional address attribute 1 for the event location. -
AddlAddressAttribute2: string
Maximum Length:
255
Additional address attribute 2 for the event location. -
AddlAddressAttribute3: string
Maximum Length:
255
Additional address attribute 3 for the event location. -
AddlAddressAttribute4: string
Maximum Length:
255
Additional address attribute 4 for the event location. -
AddlAddressAttribute5: string
Maximum Length:
255
Additional address attribute 5 for the event location. -
AddressId: integer
(int64)
Unique identifier for the address of the event location.
-
AddressLine1: string
Maximum Length:
255
Address line 1 of the event location. -
AddressLine2: string
Maximum Length:
255
Address line 2 of the event location. -
AddressLine3: string
Maximum Length:
255
Address line 3 of the event location. -
AddressLine4: string
Maximum Length:
255
Address line 4 of the event location. -
Building: string
Maximum Length:
255
Building name or number for the event location. -
Country: string
Maximum Length:
255
Country for the event location. -
EventFormatCode: string
Maximum Length:
30
Code for the format of the event. -
EventId: integer
(int64)
Unique identifier for the event in event locations.
-
FloorNumber: string
Maximum Length:
255
Floor number of the event location. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Unique identifier for the location.
-
LocationTypeCode: string
Maximum Length:
30
Type code for the event location. -
LocationUsageId: integer
(int64)
Unique identifier for the usage of the location.
-
LongPostalCode: string
Maximum Length:
255
Extended postal code for the event location. -
MaxCapacity: integer
(int32)
Maximum capacity for the event location.
-
MeetingId: string
Maximum Length:
60
Unique identifier for the meeting location. -
PhoneAreaCode: string
Maximum Length:
30
Phone area code for the event location. -
PhoneCountryCode: string
Maximum Length:
30
Candidate's phone country code in the recruiting tax credits. -
PhoneLegislationCode: string
Maximum Length:
4
Candidate's phone country code in the recruiting tax credits. -
PhoneNumber: string
Maximum Length:
60
Phone number for the event location. -
PostalCode: string
Maximum Length:
255
Postal code for the event location. -
Region1: string
Maximum Length:
255
Region 1 for the event location. -
Region2: string
Maximum Length:
255
Region 2 for the event location. -
Region3: string
Maximum Length:
255
Region 3 for the event location. -
TownOrCity: string
Maximum Length:
255
Town or city for the event location. -
WebConfLink: string
Maximum Length:
300
Web conferencing link for the event location.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUIEventDetails-eventMedia-item-response
Type:
Show Source
object
-
EventId: integer
Unique identifier for the event for event media.
-
EventMediaId: integer
Unique identifier for the event media.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MediaLinkId: integer
Unique identifier for the media link.
-
MediaTypeCode: string
Maximum Length:
255
Type code for the event media. -
SequenceNumber: integer
Sequence number for the event media.
-
ThumbnailURL: string
Maximum Length:
255
URL for the thumbnail image of the event media. -
Title: string
Maximum Length:
255
Title of the event media. -
URL: string
Maximum Length:
255
URL for the event media.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUIEventDetails-eventTeam-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Unique identifier for the event team assignment.
-
CollaboratorRespTypeCode: string
Maximum Length:
30
Collaborator responsibility type code for the event team. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberTypeCode: string
Maximum Length:
30
Type code for the event team member. -
ObjectId: integer
(int64)
Object identifier for the event team member.
-
ObjectType: string
Maximum Length:
30
Object type for the event team member. -
PersonId: integer
(int64)
Unique identifier for the person in the event team.
-
TeamMemberId: integer
(int64)
Unique identifier for the event team member.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUIEventDetails-eventTranslation-item-response
Type:
Show Source
object
-
EventDescHtml: string
(byte)
HTML description of the event translation.
-
EventId: integer
(int64)
Unique identifier for the event in translations.
-
EventName: string
Maximum Length:
240
Name of the event in the translation. -
EventNotes: string
Maximum Length:
1000
Notes associated with the event translation. -
EventPurpose: string
Maximum Length:
500
Purpose of the event in the translation. -
EventShortDesc: string
(byte)
Short description of the event in the translation.
-
Language: string
Maximum Length:
4
Language code for the event translation. -
LanguageDescription: string
Read Only:
true
Maximum Length:255
Description of the language for the event translation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceLang: string
Maximum Length:
4
Source language for the event translation. -
SourceLanguageDescription: string
Read Only:
true
Maximum Length:255
Description of the source language for the event translation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUIEventDetails-interviewDetails-item-response
Type:
Show Source
object
-
EventId: integer
(int64)
Unique identifier for the event in interview details.
-
eventInterviewers: array
Event Interviewers
Title:
Event Interviewers
The event interviewers resource provies the details of the recruiting event interviewers. -
InterviewDetailsId: integer
(int64)
Unique identifier for the interview details.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Event Interviewers
Type:
array
Title:
Event Interviewers
The event interviewers resource provies the details of the recruiting event interviewers.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUIEventDetails-interviewDetails-eventInterviewers-item-response
Type:
Show Source
object
-
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:240
Display name of the event interviewer. -
InterviewDetailsId: integer
(int64)
Unique identifier for the interview details.
-
InterviewerPersonId: integer
(int64)
Person ID in recruiting job requisitions collaborators.
-
InterviewMemberId: integer
(int64)
Unique identifier for the event interviewer.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonNameId: integer
(int64)
Read Only:
true
Unique identifier for the interviewer name.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- EventCategoryCodeLookUpTypeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_IRC_REC_EVT_CATEGORY
The following properties are defined on the LOV link relation:- Source Attribute: EventCategoryCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EventCreationModeLookUpTypeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_IRC_REC_EVT_CRE_MODE
The following properties are defined on the LOV link relation:- Source Attribute: EventCreationMode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EventVisibilityCodeLookUpTypeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_IRC_REC_EVT_VISIBILITY
The following properties are defined on the LOV link relation:- Source Attribute: EventVisibilityCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RecruitingTimezoneLOVVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: EventTimezoneCode; Target Attribute: TimezoneId
- Display Attribute: TimezoneDisplayName
- attachments
-
Parameters:
- EventId:
$request.path.EventId
The InternalAttachments resource provides information about files attached by the recruiting team. - EventId:
- eventCareerSites
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIEventDetails/{EventId}/child/eventCareerSitesParameters:
- EventId:
$request.path.EventId
The career sites resource provides the association of the recruiting event with external career sites. - EventId:
- eventLanguages
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIEventDetails/{EventId}/child/eventLanguagesParameters:
- EventId:
$request.path.EventId
The event languages resource provides the language-specific translations of event details for multilingual recruiting events. - EventId:
- eventLocation
-
Parameters:
- EventId:
$request.path.EventId
The event location resource provides event location related details. - EventId:
- eventMedia
-
Parameters:
- EventId:
$request.path.EventId
The event media resource provides media assets related to an event. - EventId:
- eventTeam
-
Parameters:
- EventId:
$request.path.EventId
The event team resources provides the team members assigned to the recruiting event. - EventId:
- eventTranslation
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIEventDetails/{EventId}/child/eventTranslationParameters:
- EventId:
$request.path.EventId
The event translations resource provides the translations of event details for multilingual recruiting events. - EventId:
- interviewDetails
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIEventDetails/{EventId}/child/interviewDetailsParameters:
- EventId:
$request.path.EventId
The interview resource provides the interview details related to recruiting events. - EventId: