Jump to

• Request
• Response

Get all event details

get

/hcmRestApi/resources/11.13.18.05/recruitingUIEventDetails

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds event details by the primary key.
    Finder Variables
    • EventId; integer; Event details provided by the primary key event identifier.
  • findByEventId Finds event details by event identifier.
    Finder Variables
    • EventId; integer; Event details provided by the event identifier parameter.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ApplyFlowId; integer; Apply flow identifier for the event.
  • EnableInterviewFlag; boolean; Flag indicating whether interviews are enabled for the event.
  • EventCategoryCode; string; Category code for the event.
  • EventCreationMode; string; Mode in which the event was created.
  • EventEndDate; string; End date of the event.
  • EventId; integer; Unique identifier for the event.
  • EventLastRegDate; string; The last registration date for the event.
  • EventLastUpdateDate; string; Date the event was last updated.
  • EventName; string; Name of the event.
  • EventNotes; string; Notes associated with the event.
  • EventNumber; string; Event number identifier.
  • EventOwnerId; integer; The owner identifier of the event.
  • EventPurpose; string; Purpose of the event.
  • EventStartDate; string; Start date of the event.
  • EventTimezoneCode; string; Time zone code for the event.
  • EventVisibilityCode; string; Visibility code of the event.
  • ExistingEventId; integer; Unique identifier of an existing event used to create a new event.
  • ManualRegnConfirmFlag; boolean; Flag for manual registration confirmation for the event
  • MaxRegCount; integer; Maximum number of registrations allowed for the event.
  • PhaseCode; string; Phase code for the event.
  • PublishEndDate; string; End date for publishing the event.
  • PublishStartDate; string; Start date for publishing the event.
  • PublishStatusCode; string; Status code for publishing the event.
  • PublishTimezoneCode; string; Time zone code for publishing the event.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  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: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• 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.

Body ()

Root Schema : recruitingUIEventDetails

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIEventDetails-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object recruitingUIEventDetails-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIEventDetails-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingUIEventDetails-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "EventDescHtml":{
            "type":"string",
            "description":"HTML description of the event.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "EventVisibilityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Visibility code of the event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "attachments":{
            "title":"Candidate Attachments",
            "type":"array",
            "description":"The InternalAttachments resource provides information about files attached by the recruiting team.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIEventDetails-attachments-item-response"
            }
        },
        "EventOwnerId":{
            "type":"integer",
            "description":"The owner identifier of the event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventTimezoneCode":{
            "maxLength":50,
            "type":"string",
            "description":"Time zone code for the event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventCategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Category code for the event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "eventTeam":{
            "title":"Event Team Members",
            "type":"array",
            "description":"The event team resources provides the team members assigned to the recruiting event.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIEventDetails-eventTeam-item-response"
            }
        },
        "EventShortDesc":{
            "type":"string",
            "description":"Short description of the event.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "EnableInterviewFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Flag indicating whether interviews are enabled for the event.",
            "nullable":true,
            "x-queryable":true
        },
        "eventMedia":{
            "title":"Event Media Resources",
            "type":"array",
            "description":"The event media resource provides media assets related to an event.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIEventDetails-eventMedia-item-response"
            }
        },
        "EventPurpose":{
            "maxLength":512,
            "type":"string",
            "description":"Purpose of the event.",
            "nullable":true,
            "x-queryable":true
        },
        "ManualRegnConfirmFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Flag for manual registration confirmation for the event",
            "nullable":true,
            "x-queryable":true
        },
        "PublishEndDate":{
            "type":"string",
            "description":"End date for publishing the event.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EventEndDate":{
            "type":"string",
            "description":"End date of the event.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EventStartDate":{
            "type":"string",
            "description":"Start date of the event.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "eventLanguages":{
            "title":"Available Languages",
            "type":"array",
            "description":"The event languages resource provides the language-specific translations of event details for multilingual recruiting events.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIEventDetails-eventLanguages-item-response"
            }
        },
        "eventTranslation":{
            "title":"Event Translations",
            "type":"array",
            "description":"The event translations resource provides the translations of event details for multilingual recruiting events.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIEventDetails-eventTranslation-item-response"
            }
        },
        "EventId":{
            "type":"integer",
            "description":"Unique identifier for the event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ApplyFlowId":{
            "type":"integer",
            "description":"Apply flow identifier for the event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PublishStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status code for publishing the event.",
            "nullable":true,
            "x-queryable":true
        },
        "eventLocation":{
            "title":"Recruiting Event Location",
            "type":"array",
            "description":"The event location resource provides event location related details.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIEventDetails-eventLocation-item-response"
            }
        },
        "EventName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the event.",
            "nullable":true,
            "x-queryable":true
        },
        "EventNotes":{
            "maxLength":1000,
            "type":"string",
            "description":"Notes associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "EventCreationMode":{
            "maxLength":30,
            "type":"string",
            "description":"Mode in which the event was created.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhaseCode":{
            "maxLength":64,
            "type":"string",
            "description":"Phase code for the event.",
            "nullable":true,
            "x-queryable":true
        },
        "interviewDetails":{
            "title":"Event Interview Details",
            "type":"array",
            "description":"The interview resource provides the interview details related to recruiting events.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIEventDetails-interviewDetails-item-response"
            }
        },
        "PublishTimezoneCode":{
            "maxLength":50,
            "type":"string",
            "description":"Time zone code for publishing the event.",
            "nullable":true,
            "x-queryable":true
        },
        "eventCareerSites":{
            "title":"Career Sites Associated with an Event",
            "type":"array",
            "description":"The career sites resource provides the association of the recruiting event with external career sites.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIEventDetails-eventCareerSites-item-response"
            }
        },
        "EventLastRegDate":{
            "type":"string",
            "description":"The last registration date for the event.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "MaxRegCount":{
            "type":"integer",
            "description":"Maximum number of registrations allowed for the event.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EventNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Event number identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExistingEventId":{
            "type":"integer",
            "description":"Unique identifier of an existing event used to create a new event.",
            "nullable":true,
            "x-queryable":true
        },
        "PublishStartDate":{
            "type":"string",
            "description":"Start date for publishing the event.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EventLastUpdateDate":{
            "type":"string",
            "description":"Date the event was last updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Candidate Attachments

Type: array

Title: Candidate Attachments

The InternalAttachments resource provides information about files attached by the recruiting team.

Show Source

• Array of: object recruitingUIEventDetails-attachments-item-response

{
    "title":"Candidate Attachments",
    "type":"array",
    "description":"The InternalAttachments resource provides information about files attached by the recruiting team.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIEventDetails-attachments-item-response"
    }
}

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

• Array of: object recruitingUIEventDetails-eventCareerSites-item-response

{
    "title":"Career Sites Associated with an Event",
    "type":"array",
    "description":"The career sites resource provides the association of the recruiting event with external career sites.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIEventDetails-eventCareerSites-item-response"
    }
}

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

• Array of: object recruitingUIEventDetails-eventLanguages-item-response

{
    "title":"Available Languages",
    "type":"array",
    "description":"The event languages resource provides the language-specific translations of event details for multilingual recruiting events.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIEventDetails-eventLanguages-item-response"
    }
}

Nested Schema : Recruiting Event Location

Type: array

Title: Recruiting Event Location

The event location resource provides event location related details.

Show Source

• Array of: object recruitingUIEventDetails-eventLocation-item-response

{
    "title":"Recruiting Event Location",
    "type":"array",
    "description":"The event location resource provides event location related details.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIEventDetails-eventLocation-item-response"
    }
}

Nested Schema : Event Media Resources

Type: array

Title: Event Media Resources

The event media resource provides media assets related to an event.

Show Source

• Array of: object recruitingUIEventDetails-eventMedia-item-response

{
    "title":"Event Media Resources",
    "type":"array",
    "description":"The event media resource provides media assets related to an event.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIEventDetails-eventMedia-item-response"
    }
}

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

• Array of: object recruitingUIEventDetails-eventTeam-item-response

{
    "title":"Event Team Members",
    "type":"array",
    "description":"The event team resources provides the team members assigned to the recruiting event.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIEventDetails-eventTeam-item-response"
    }
}

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

• Array of: object recruitingUIEventDetails-eventTranslation-item-response

{
    "title":"Event Translations",
    "type":"array",
    "description":"The event translations resource provides the translations of event details for multilingual recruiting events.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIEventDetails-eventTranslation-item-response"
    }
}

Nested Schema : Event Interview Details

Type: array

Title: Event Interview Details

The interview resource provides the interview details related to recruiting events.

Show Source

• Array of: object recruitingUIEventDetails-interviewDetails-item-response

{
    "title":"Event Interview Details",
    "type":"array",
    "description":"The interview resource provides the interview details related to recruiting events.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIEventDetails-interviewDetails-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingUIEventDetails-attachments-item-response

Type: object

Show Source

• 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
  Title: Shared

  Indicates where the attachment is shared. If True, the attachment is shared.
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attachment. System generated primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"File content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Name of the user who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"File length of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who last updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status message for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"User name associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates data type code of attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DocumentPreviewURL":{
            "maxLength":255,
            "type":"string",
            "description":"Attachment context.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Name of the user who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates where the attachment is shared. If True, the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date and time of the attachment content.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the attachment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : recruitingUIEventDetails-eventCareerSites-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "SiteId":{
            "type":"integer",
            "description":"Unique identifier for the career site.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SiteName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the career site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SiteCode":{
            "maxLength":255,
            "type":"string",
            "description":"Site code for the career site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"Unique identifier for the event in career sites.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SiteNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Career site number identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventSiteId":{
            "type":"integer",
            "description":"Unique identifier for the career site.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingUIEventDetails-eventLanguages-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "IsBaseFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Flag indicating if this is the base language for the event.",
            "nullable":true,
            "x-queryable":true
        },
        "LanguageCode":{
            "maxLength":4,
            "type":"string",
            "description":"Code for the event language.",
            "nullable":false,
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"Unique identifier for the event in multiple languages.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EventLanguageId":{
            "type":"integer",
            "description":"Unique identifier for the event language.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingUIEventDetails-eventLocation-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Building":{
            "maxLength":255,
            "type":"string",
            "description":"Building name or number for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Floor number of the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "EventFormatCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the format of the event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"Postal code for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "WebConfLink":{
            "maxLength":300,
            "type":"string",
            "description":"Web conferencing link for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":30,
            "type":"string",
            "description":"Phone area code for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Candidate's phone country code in the recruiting tax credits.",
            "nullable":true,
            "x-queryable":true
        },
        "TownOrCity":{
            "maxLength":255,
            "type":"string",
            "description":"Town or city for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddlAddressAttribute5":{
            "maxLength":255,
            "type":"string",
            "description":"Additional address attribute 5 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type code for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddlAddressAttribute4":{
            "maxLength":255,
            "type":"string",
            "description":"Additional address attribute 4 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddlAddressAttribute3":{
            "maxLength":255,
            "type":"string",
            "description":"Additional address attribute 3 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"Unique identifier for the event in event locations.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddressId":{
            "type":"integer",
            "description":"Unique identifier for the address of the event location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MaxCapacity":{
            "type":"integer",
            "description":"Maximum capacity for the event location.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PhoneLegislationCode":{
            "maxLength":4,
            "type":"string",
            "description":"Candidate's phone country code in the recruiting tax credits.",
            "nullable":true,
            "x-queryable":true
        },
        "LongPostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"Extended postal code for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier for the location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Region1":{
            "maxLength":255,
            "type":"string",
            "description":"Region 1 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddlAddressAttribute2":{
            "maxLength":255,
            "type":"string",
            "description":"Additional address attribute 2 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AccessCode":{
            "maxLength":30,
            "type":"string",
            "description":"Access code for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddlAddressAttribute1":{
            "maxLength":255,
            "type":"string",
            "description":"Additional address attribute 1 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationUsageId":{
            "type":"integer",
            "description":"Unique identifier for the usage of the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Region3":{
            "maxLength":255,
            "type":"string",
            "description":"Region 3 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "Region2":{
            "maxLength":255,
            "type":"string",
            "description":"Region 2 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine3":{
            "maxLength":255,
            "type":"string",
            "description":"Address line 3 of the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine2":{
            "maxLength":255,
            "type":"string",
            "description":"Address line 2 of the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine1":{
            "maxLength":255,
            "type":"string",
            "description":"Address line 1 of the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine4":{
            "maxLength":255,
            "type":"string",
            "description":"Address line 4 of the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "MeetingId":{
            "maxLength":60,
            "type":"string",
            "description":"Unique identifier for the meeting location.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Phone number for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":255,
            "type":"string",
            "description":"Country for the event location.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingUIEventDetails-eventMedia-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "EventMediaId":{
            "type":"integer",
            "description":"Unique identifier for the event media.",
            "nullable":true,
            "x-queryable":true
        },
        "ThumbnailURL":{
            "maxLength":255,
            "type":"string",
            "description":"URL for the thumbnail image of the event media.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence number for the event media.",
            "nullable":true,
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"Unique identifier for the event for event media.",
            "nullable":true,
            "x-queryable":true
        },
        "Title":{
            "maxLength":255,
            "type":"string",
            "description":"Title of the event media.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MediaLinkId":{
            "type":"integer",
            "description":"Unique identifier for the media link.",
            "nullable":true,
            "x-queryable":true
        },
        "MediaTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Type code for the event media.",
            "nullable":true,
            "x-queryable":true
        },
        "URL":{
            "maxLength":255,
            "type":"string",
            "description":"URL for the event media.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingUIEventDetails-eventTeam-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"Object type for the event team member.",
            "nullable":false,
            "x-queryable":true
        },
        "TeamMemberId":{
            "type":"integer",
            "description":"Unique identifier for the event team member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier for the person in the event team.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Object identifier for the event team member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the event team assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CollaboratorRespTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Collaborator responsibility type code for the event team.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MemberTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type code for the event team member.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingUIEventDetails-eventTranslation-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "EventDescHtml":{
            "type":"string",
            "description":"HTML description of the event translation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LanguageDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the language for the event translation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language code for the event translation.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language for the event translation.",
            "nullable":false,
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"Unique identifier for the event in translations.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EventName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the event in the translation.",
            "nullable":true,
            "x-queryable":true
        },
        "EventShortDesc":{
            "type":"string",
            "description":"Short description of the event in the translation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "EventNotes":{
            "maxLength":1000,
            "type":"string",
            "description":"Notes associated with the event translation.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLanguageDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the source language for the event translation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventPurpose":{
            "maxLength":500,
            "type":"string",
            "description":"Purpose of the event in the translation.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingUIEventDetails-interviewDetails-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "EventId":{
            "type":"integer",
            "description":"Unique identifier for the event in interview details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "eventInterviewers":{
            "title":"Event Interviewers",
            "type":"array",
            "description":"The event interviewers resource provies the details of the recruiting event interviewers.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIEventDetails-interviewDetails-eventInterviewers-item-response"
            }
        },
        "InterviewDetailsId":{
            "type":"integer",
            "description":"Unique identifier for the interview details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Event Interviewers

Type: array

Title: Event Interviewers

The event interviewers resource provies the details of the recruiting event interviewers.

Show Source

• Array of: object recruitingUIEventDetails-interviewDetails-eventInterviewers-item-response

{
    "title":"Event Interviewers",
    "type":"array",
    "description":"The event interviewers resource provies the details of the recruiting event interviewers.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIEventDetails-interviewDetails-eventInterviewers-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingUIEventDetails-interviewDetails-eventInterviewers-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "DisplayName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the event interviewer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InterviewerPersonId":{
            "type":"integer",
            "description":"Person ID in recruiting job requisitions collaborators.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InterviewMemberId":{
            "type":"integer",
            "description":"Unique identifier for the event interviewer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNameId":{
            "type":"integer",
            "description":"Unique identifier for the interviewer name.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InterviewDetailsId":{
            "type":"integer",
            "description":"Unique identifier for the interview details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

executeAction

Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIEventDetails/action/executeAction

Executes a specific action for event details.

fetchEventMetaData

Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIEventDetails/action/fetchEventMetaData

Event information response that's returned as part of the payload response.

fetchSectionsByFlowId

Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIEventDetails/action/fetchSectionsByFlowId

Retrieves sections by the flow identifier for an event.

getCareerSitesForEvents

Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIEventDetails/action/getCareerSitesForEvents

Retrieves career sites linked to events.

Back to Top