Jump to

• Request
• Response

Get all recruiting event details

get

/hcmRestApi/resources/11.13.18.05/recruitingICEEventDetails

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 the details of a specific recruiting event by its primary key.
    Finder Variables
    • EventId; integer; Unique identifier for the event.
  • findByEventNumber Finds event details based on the event number provided.
    Finder Variables
    • EventNumber; string; Event number to search for specific event details.
• 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:
  

  • DisplayCheckinAction; string; Indicates whether to display the check-in action for the event.
  • EventCategory; string; Event category for the recruiting event.
  • EventCategoryCode; string; Code for the category of the event.
  • EventEndDateString; string; End date of the event.
  • EventFormat; string; Specifies the format of the event.
  • EventFormatCode; string; Indicates the format code of the event.
  • EventId; integer; Code for the format of the event.
  • EventLocation; string; Location of the event.
  • EventName; string; Name of the event.
  • EventNumber; string; Unique identifier for the event. This number distinguishes each event within the system.
  • EventRegistrationAllowed; string; Unique identifier for the event. This number distinguishes each event within the app.
  • EventStartDateHeaderString; string; Indicates whether event registration is allowed.
  • EventStartDateString; string; Indicates whether event registration is allowed.
  • InternalBannerImageUrl; string; URL for the internal banner image of the recruiting event.
  • LastDayToRegisterString; string; Last day to register for the event.
  • ManualRegnConfirmFlag; boolean; Indicates whether manual registration confirmation is required.
  • MaxRegCount; integer; Maximum number of registrations allowed for the event.
  • MeetingURL; string; Meeting URL for the recruiting event.
  • PhaseCode; string; Phase code of the recruiting event.
  • PublishTypeCode; string; Indicates the publish type code of the event.
  • QrCodeCheckinFlag; boolean; Code for the publish type of the event.
  • QuestionnaireId; integer; Unique identifier for the questionnaire associated with the recruiting event.
  • RegisteredCount; integer; Number of candidates registered for 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 : recruitingICEEventDetails

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/recruitingICEEventDetails-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object recruitingICEEventDetails-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/recruitingICEEventDetails-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 : recruitingICEEventDetails-item-response

Type: object

Show Source

• DisplayCheckinAction: string
  Read Only: true

  Maximum Length: 255

  Indicates whether to display the check-in action for the event.
• EventCategory: string
  Title: Event Category

  Read Only: true

  Maximum Length: 255

  Event category for the recruiting event.
• EventCategoryCode: string
  Read Only: true

  Maximum Length: 30

  Code for the category of the event.
• EventEndDateString: string
  Title: End Date and Time

  Read Only: true

  Maximum Length: 255

  End date of the event.
• EventFormat: string
  Title: Event Format

  Read Only: true

  Maximum Length: 255

  Specifies the format of the event.
• EventFormatCode: string
  Read Only: true

  Maximum Length: 30

  Indicates the format code of the event.
• EventId: integer (int64)
  Read Only: true

  Code for the format of the event.
• EventLocation: string
  Title: Location

  Read Only: true

  Maximum Length: 255

  Location of the event.
• EventName: string
  Read Only: true

  Maximum Length: 240

  Name of the event.
• EventNumber: string
  Read Only: true

  Maximum Length: 64

  Unique identifier for the event. This number distinguishes each event within the system.
• EventRegistrationAllowed: string
  Read Only: true

  Maximum Length: 255

  Unique identifier for the event. This number distinguishes each event within the app.
• EventStartDateHeaderString: string
  Read Only: true

  Maximum Length: 255

  Indicates whether event registration is allowed.
• EventStartDateString: string
  Title: Start Date and Time

  Read Only: true

  Maximum Length: 255

  Indicates whether event registration is allowed.
• eventTeamMembers: array Event Team Member Details
  Title: Event Team Member Details

  The eventTeamMembers resource provides details about team members for recruiting events.
• InternalBannerImageUrl: string
  Read Only: true

  Maximum Length: 2048

  URL for the internal banner image of the recruiting event.
• InternalEventDescHtml: string (byte)
  Read Only: true

  Internal event description in HTML format.
• LastDayToRegisterString: string
  Title: Last Day to Register

  Read Only: true

  Maximum Length: 255

  Last day to register for the event.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualRegnConfirmFlag: boolean
  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether manual registration confirmation is required.
• MaxRegCount: integer (int32)
  Read Only: true

  Maximum number of registrations allowed for the event.
• MeetingURL: string
  Read Only: true

  Maximum Length: 255

  Meeting URL for the recruiting event.
• PhaseCode: string
  Read Only: true

  Maximum Length: 64

  Phase code of the recruiting event.
• PublishTypeCode: string
  Read Only: true

  Maximum Length: 30

  Indicates the publish type code of the event.
• QrCodeCheckinFlag: boolean
  Read Only: true

  Maximum Length: 1

  Code for the publish type of the event.
• QuestionnaireId: integer
  Read Only: true

  Unique identifier for the questionnaire associated with the recruiting event.
• RegisteredCount: integer
  Read Only: true

  Number of candidates registered for the event.

{
    "type":"object",
    "properties":{
        "DisplayCheckinAction":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether to display the check-in action for the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventCategory":{
            "title":"Event Category",
            "maxLength":255,
            "type":"string",
            "description":"Event category for the recruiting event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventCategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the category of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventEndDateString":{
            "title":"End Date and Time",
            "maxLength":255,
            "type":"string",
            "description":"End date of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventFormat":{
            "title":"Event Format",
            "maxLength":255,
            "type":"string",
            "description":"Specifies the format of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventFormatCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the format code of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"Code for the format of the event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventLocation":{
            "title":"Location",
            "maxLength":255,
            "type":"string",
            "description":"Location of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Unique identifier for the event. This number distinguishes each event within the system.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventRegistrationAllowed":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier for the event. This number distinguishes each event within the app.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventStartDateHeaderString":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether event registration is allowed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventStartDateString":{
            "title":"Start Date and Time",
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether event registration is allowed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalBannerImageUrl":{
            "maxLength":2048,
            "type":"string",
            "description":"URL for the internal banner image of the recruiting event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalEventDescHtml":{
            "type":"string",
            "description":"Internal event description in HTML format.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastDayToRegisterString":{
            "title":"Last Day to Register",
            "maxLength":255,
            "type":"string",
            "description":"Last day to register for the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManualRegnConfirmFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether manual registration confirmation is required.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "MaxRegCount":{
            "type":"integer",
            "description":"Maximum number of registrations allowed for the event.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MeetingURL":{
            "maxLength":255,
            "type":"string",
            "description":"Meeting URL for the recruiting event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhaseCode":{
            "maxLength":64,
            "type":"string",
            "description":"Phase code of the recruiting event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PublishTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the publish type code of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QrCodeCheckinFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Code for the publish type of the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionnaireId":{
            "type":"integer",
            "description":"Unique identifier for the questionnaire associated with the recruiting event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RegisteredCount":{
            "type":"integer",
            "description":"Number of candidates registered for the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "eventTeamMembers":{
            "title":"Event Team Member Details",
            "type":"array",
            "description":"The eventTeamMembers resource provides details about team members for recruiting events.",
            "items":{
                "$ref":"#/components/schemas/recruitingICEEventDetails-eventTeamMembers-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Event Team Member Details

Type: array

Title: Event Team Member Details

The eventTeamMembers resource provides details about team members for recruiting events.

Show Source

• Array of: object recruitingICEEventDetails-eventTeamMembers-item-response

{
    "title":"Event Team Member Details",
    "type":"array",
    "description":"The eventTeamMembers resource provides details about team members for recruiting events.",
    "items":{
        "$ref":"#/components/schemas/recruitingICEEventDetails-eventTeamMembers-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 : recruitingICEEventDetails-eventTeamMembers-item-response

Type: object

Show Source

• AssignmentId: integer (int64)
  Read Only: true

  Unique identifier for the team member's assignment in the recruiting event.
• DisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name of the team member associated with the recruiting event.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberTypeCode: string
  Read Only: true

  Maximum Length: 30

  Indicates the type of member in the recruiting event team.
• PersonId: integer (int64)
  Read Only: true

  Code for the type of member in the recruiting event team.
• TeamMemberId: integer (int64)
  Read Only: true

  Unique identifier for the team member associated with the recruiting event.

{
    "type":"object",
    "properties":{
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the team member's assignment in the recruiting event.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the team member associated with the recruiting event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of member in the recruiting event team.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Code for the type of member in the recruiting event team.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TeamMemberId":{
            "type":"integer",
            "description":"Unique identifier for the team member associated with the recruiting event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        }
    }
}

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."
        }
    }
}

Back to Top