### Get a questionnaire setup Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/Benefits__Eligibility_Objects.html Retrieves the setup details for a specific questionnaire. ```APIDOC ## GET /questionnaires/{questionnaireId}/setup ### Description Retrieves the setup details for a specific questionnaire. ### Method GET ### Endpoint /questionnaires/{questionnaireId}/setup ### Parameters #### Path Parameters - **questionnaireId** (string) - Required - The ID of the questionnaire. ``` -------------------------------- ### GET /op-recruitingoppmktsettings Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingoppmktsettings-settingkey-get.html Retrieves all settings for the Opportunity Marketplace. ```APIDOC ## GET /op-recruitingoppmktsettings ### Description Retrieves a list of all settings configured for the Opportunity Marketplace. ### Method GET ### Endpoint /op-recruitingoppmktsettings ``` -------------------------------- ### GET /recruitingOppMktSettings/{settingKey} Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingoppmktsettings-settingkey-get.html Retrieves the details of a specific opportunity marketplace setting. ```APIDOC ## GET /recruitingOppMktSettings/{settingKey} ### Description Retrieves the value and details of a specific setting in the opportunity marketplace. ### Method GET ### Endpoint /recruitingOppMktSettings/{settingKey} ### Parameters #### Path Parameters - **settingKey** (string) - Required - The unique key of the setting to retrieve. ### Response #### Success Response (200) - **SettingKey** (string) - Key of a setting in opportunity marketplace. - **SettingValue** (string) - Value of a setting in opportunity marketplace. - **links** (array) - The link relations associated with the resource instance. ``` -------------------------------- ### Response Header Example Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-disabilityorganizationslov-get.html Example of the HTTP response header for the GET request. ```http Status: HTTP/1.1 200 OK Content-Type: application/vnd.oracle.adf.resourceitem+json ``` -------------------------------- ### Get a questionnaire setup Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-child-completiondetails-completiondetailsuniqid-child-relatedmaterials-attacheddocumentid-enclosure-filecontents-put.html Retrieves the setup details for a questionnaire of an employee event. ```APIDOC ## GET /employee-events/{eventId}/questionnaires/{questionnaireId}/setup ### Description Retrieves the setup configuration for a specific questionnaire of an employee event. ### Method GET ### Endpoint /employee-events/{eventId}/questionnaires/{questionnaireId}/setup ### Parameters #### Path Parameters - **eventId** (string) - Required - The unique identifier of the employee event. - **questionnaireId** (string) - Required - The unique identifier of the questionnaire. ### Response #### Success Response (200 OK) - **setupDetails** (object) - The setup details for the questionnaire. ``` -------------------------------- ### GET /op-recruitingoppmktsettings/{settingKey} Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingoppmktsettings-settingkey-get.html Retrieves a specific setting for the Opportunity Marketplace by its key. ```APIDOC ## GET /op-recruitingoppmktsettings/{settingKey} ### Description Retrieves the details of a specific setting for the Opportunity Marketplace using the provided setting key. ### Method GET ### Endpoint /op-recruitingoppmktsettings/{settingKey} ### Parameters #### Path Parameters - **settingKey** (string) - Required - The unique identifier for the setting. ``` -------------------------------- ### Get all installed Slack applications Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-3-child-completiondetails-completiondetailsuniqid2-child-classrooms-classroomsuniqid2-child-attachments-attacheddocumentid-delete.html Retrieves a list of all installed Slack applications. ```APIDOC ## GET /slack-applications/installations ### Description Retrieves a list of all installed Slack applications. ### Method GET ### Endpoint /slack-applications/installations ``` -------------------------------- ### Get all settings Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/GET.html Retrieves all settings in recruitingCESites. ```APIDOC ## Get all settings ### Description Retrieves all settings in recruitingCESites. ### Method GET ### Endpoint /websites/oracle_en_cloud_saas_human-resources_farws/recruitingCESites/settings ``` -------------------------------- ### Get all settings Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/api-recruiting-job-site-candidate-extra-information-dictionary.html Retrieves all settings for the recruiting job site. ```APIDOC ## Get all settings in recruitingCESites ### Description Retrieves all settings configured for the recruiting job site. ### Method GET ### Endpoint /websites/recruitingCESites/settings ### Response #### Success Response (200) - **settings** (array) - A list of all settings. - **id** (string) - The ID of the setting. - **name** (string) - The name of the setting. - **value** (string) - The value of the setting. #### Response Example { "settings": [ { "id": "primaryColor", "name": "Primary Color", "value": "#007bff" }, { "id": "logoUrl", "name": "Logo URL", "value": "/images/logo.png" } ] } ``` -------------------------------- ### GET /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID} Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-useraccounts-guid-get.html Retrieves the user account details associated with the specified GUID. ```APIDOC ## GET /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID} ### Description Retrieves the details of a specific user account identified by its GUID. ### Method GET ### Endpoint https://:/hcmRestApi/resources/11.13.18.05/userAccounts/{GUID} ### Parameters #### Path Parameters - **GUID** (string) - Required - The unique identifier of the user account. ### Response #### Success Response (200) - **UserId** (integer) - The internal ID of the user. - **Username** (string) - The username of the account. - **SuspendedFlag** (boolean) - Indicates if the account is suspended. - **PersonId** (integer) - The associated person ID. - **PersonNumber** (string) - The associated person number. - **CredentialsEmailSentFlag** (boolean) - Indicates if credentials email was sent. - **GUID** (string) - The unique identifier of the user account. - **CreatedBy** (string) - The user who created the account. - **CreationDate** (string) - The date the account was created. - **LastUpdatedBy** (string) - The user who last updated the account. - **LastUpdateDate** (string) - The date the account was last updated. #### Response Example { "UserId": 60, "Username": "CUST_CONTRACT_MGR_OPERATIONS", "SuspendedFlag": false, "PersonId": 100010024201426, "PersonNumber": "10024201426", "CredentialsEmailSentFlag": true, "GUID": "5A25572D96277A00C0547E3A715EF682", "CreatedBy": "0", "CreationDate": "2009-05-25T00:00:00+00:00", "LastUpdatedBy": "FUSION", "LastUpdateDate": "2019-01-10T14:21:50.341+00:00" } ``` -------------------------------- ### GET /recruitingCandidateExperiencePrefillResponses (All) Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-workerjourneys-workerjourneyid-child-tasks-tasksuniqid-child-questionnaireresponses-questionnaireresponseid-child-questionresponses-get.html Retrieves all responses to questions in a questionnaire. ```APIDOC ## GET /recruitingCandidateExperiencePrefillResponses ### Description Retrieves all responses to questions in a questionnaire. ### Method GET ### Endpoint /recruitingCandidateExperiencePrefillResponses ``` -------------------------------- ### Recruiting Events - Start Date Range Facets - Get all start date facets Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/api-gig-details.html Retrieves all start date facets for recruiting events. ```APIDOC ## GET /recruiting-events/facets/start-date-ranges ### Description Retrieves all start date facets for recruiting events. ### Method GET ### Endpoint /recruiting-events/facets/start-date-ranges ``` -------------------------------- ### Get a start date facet Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-communicateuicampaigndetails-campaignid-child-categories-campcategoryid-get.html Retrieves a specific start date facet for recruiting events. ```APIDOC ## GET /recruiting-events/facets/start-date/{dateFacetId} ### Description Retrieves a specific start date facet for recruiting events. ### Method GET ### Endpoint /recruiting-events/facets/start-date/{dateFacetId} ### Parameters #### Path Parameters - **dateFacetId** (string) - Required - The ID of the start date facet. ``` -------------------------------- ### GET /recruitingCandidateExperienceQuestions Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingtnapplicationquestions-questionid-get.html Retrieves a list of all recruiting candidate experience questions. ```APIDOC ## GET /recruitingCandidateExperienceQuestions ### Description Retrieves details of all recruiting candidate experience questions. ### Method GET ### Endpoint /recruitingCandidateExperienceQuestions ``` -------------------------------- ### Get all start date facets Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-communicateuicampaigndetails-campaignid-child-audiencedetails-audienceid-child-attachments-attachmentsuniqid-enclosure-filecontents-get.html Retrieves all available start date facets for recruiting events. ```APIDOC ## GET /recruiting-events/facets/start-date-ranges ### Description Retrieves all available start date facets for recruiting events. ### Method GET ### Endpoint /recruiting-events/facets/start-date-ranges ``` -------------------------------- ### Get All Product Settings for Opportunity Marketplace Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/Absence_Management__Absences.html Retrieves all settings for the opportunity marketplace. ```APIDOC ## GET All Product Settings for Opportunity Marketplace ### Description Retrieves all settings for the opportunity marketplace. ### Method GET ### Endpoint /productSettings/opportunityMarketplace ``` -------------------------------- ### Submit all settings Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/GET.html Submits all settings in recruitingCESites. ```APIDOC ## Submit all settings ### Description Submits all settings in recruitingCESites. ### Method POST ### Endpoint /websites/oracle_en_cloud_saas_human-resources_farws/recruitingCESites/settings/submit ``` -------------------------------- ### Get source offer start date Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/api-recruiting-copy-job-offers.html Retrieves the start date of the source job offer. ```APIDOC ## POST /hcmRestApi/resources/11.13.18.05/recruitingUICopyJobOffers/action/getSourceOfferStartDate ### Description Fetches the start date from the original source job offer. ### Method POST ### Endpoint /hcmRestApi/resources/11.13.18.05/recruitingUICopyJobOffers/action/getSourceOfferStartDate ``` -------------------------------- ### Get Default Offer Start Date Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/api-recruiting-copy-job-offers.html Retrieves the default start date for a job offer. ```APIDOC ## GET /recruiting/job-offers/default-start-date ### Description Retrieves the default start date for a job offer. ### Method GET ### Endpoint /recruiting/job-offers/default-start-date ### Response #### Success Response (200) - **defaultStartDate** (string) - The default start date for the offer (e.g., YYYY-MM-DD). #### Response Example { "defaultStartDate": "2023-10-27" } ``` -------------------------------- ### GET /recruitingInterviewManagementSettings Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitinguiinterviewmanagementsettings-get.html Retrieves a list of all interview management settings. ```APIDOC ## GET /recruitingInterviewManagementSettings ### Description Retrieves all available interview management settings. ### Method GET ### Endpoint /recruitingInterviewManagementSettings ``` -------------------------------- ### Get all settings Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-allocatedchecklists-allocatedchecklistsuniqid-delete.html Retrieves a list of all recruiting settings. Note: This operation is explicitly marked as not supported in the source. ```APIDOC ## GET /recruiting/settings ### Description Retrieves a list of all recruiting settings. Note: This operation is explicitly marked as not supported in the source. ### Method GET ### Endpoint /recruiting/settings ``` -------------------------------- ### GET /userAccounts/{guid} Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-useraccounts-guid-get.html Retrieves the details of a specific user account identified by the provided GUID. ```APIDOC ## GET /userAccounts/{guid} ### Description Retrieves the details of a specific user account identified by the provided GUID. ### Method GET ### Endpoint /userAccounts/{guid} ### Parameters #### Path Parameters - **guid** (string) - Required - Globally unique identifier for the user account. ### Response #### Success Response (200) - **CreatedBy** (string) - User who created the user account. - **CreationDate** (string) - Date and time when the user account was created. - **CredentialsEmailSentFlag** (boolean) - Indicates whether the user name and password credentials were sent to the user. - **GUID** (string) - Globally unique identifier for the user account. - **LastUpdateDate** (string) - Date and time when the user account was last updated. - **LastUpdatedBy** (string) - User who last updated the user account. - **links** (array) - The link relations associated with the resource instance. - **PersonId** (integer) - Unique identifier of the person record linked to the user account. - **PersonNumber** (string) - Person number of the person record linked to the user account. - **SuspendedFlag** (boolean) - Indicates whether the user is suspended. - **userAccountRoles** (array) - The user account roles associated with the user. - **UserId** (integer) - Unique identifier for the user. - **Username** (string) - User name, a unique identifier for a user's account. ``` -------------------------------- ### Get all values for the configuration Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/Date_Effective_GET.html Retrieves all values for a recruiting activity center configuration. ```APIDOC ## GET /recruitingActivityCenterConfigurations/{configId}/values ### Description Retrieves all values for a recruiting activity center configuration. ### Method GET ### Endpoint /recruitingActivityCenterConfigurations/{configId}/values ### Parameters #### Path Parameters - **configId** (string) - Required - The ID of the configuration. ### Response #### Success Response (200) - **values** (array) - A list of value objects. #### Response Example { "values": [ { "id": "val1", "name": "Configuration Value A" }, { "id": "val2", "name": "Configuration Value B" } ] } ``` -------------------------------- ### Recruiting Events - Start Date Range Facets - Get a start date facet Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/api-gig-details.html Retrieves a specific start date facet for recruiting events. ```APIDOC ## GET /recruiting-events/facets/start-date-ranges/{facetId} ### Description Retrieves a specific start date facet for recruiting events. ### Method GET ### Endpoint /recruiting-events/facets/start-date-ranges/{facetId} ### Parameters #### Path Parameters - **facetId** (string) - Required - The ID of the start date facet. ``` -------------------------------- ### GET /recruitingContentLibraryItemsDescriptionsLOV Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingtncontentitemslov-get.html Retrieves a collection of recruiting content library item descriptions. ```APIDOC ## GET /recruitingContentLibraryItemsDescriptionsLOV ### Description Retrieves all descriptions associated with recruiting content library items. ### Method GET ### Endpoint /recruitingContentLibraryItemsDescriptionsLOV ``` -------------------------------- ### Get Start Date Range Facets Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-child-questionnaireresponses-questionnaireresponseid8-child-questionresponses-questionresponseid1-enclosure-answerlargeobject-get.html Retrieves all start date range facets for recruiting events. ```APIDOC ## GET /recruitingevents/facets/startdaterange ### Description Retrieves all start date range facets for recruiting events. ### Method GET ### Endpoint /recruitingevents/facets/startdaterange #### Response #### Success Response (200) - **startDateFacets** (array) - A list of start date range facet objects. ``` -------------------------------- ### Get a Slack application installation Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/api-slack-application-installed-slack-application.html Retrieves details of a specific Slack application installation using its IDs. ```APIDOC ## Get a Slack application installation ### Description Retrieves details of a specific Slack application installation. ### Method GET ### Endpoint `/hcmRestApi/resources/11.13.18.05/communicateUISlackApps/{CampSlackAPPId}/child/installedSlackApps/{CampSlackAPPInstId}` ### Parameters #### Path Parameters - **CampSlackAPPId** (string) - Required - The ID of the Slack application. - **CampSlackAPPInstId** (string) - Required - The ID of the Slack application installation to retrieve. ``` -------------------------------- ### Get All Plan Options Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/api-learner-learning-records-completion-details-primary-selected-course-offering-completion-details-classrooms-enrollment-related-materials.html Retrieves a list of all plan options. ```APIDOC ## GET /eligible-options ### Description Retrieves a list of all plan options. ### Method GET ### Endpoint /eligible-options ### Parameters #### Query Parameters None ### Response #### Success Response (200) - **planOptions** (array) - A list of plan options. ``` -------------------------------- ### Get all values for the configuration Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/api-recruiting-job-applications-secondary-job-submissions.html Retrieves a list of all configuration values. ```APIDOC ## Get all values for the configuration ### Description Retrieves a list of all configuration values. ### Method GET ### Endpoint /configurations ``` -------------------------------- ### GET /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID} Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-useraccounts-guid-get.html Retrieves a specific user account resource item identified by the provided GUID. ```APIDOC ## GET /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID} ### Description Retrieves a specific user account resource item. The GUID is a unique identifier for the resource. ### Method GET ### Endpoint /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID} ### Parameters #### Path Parameters - **GUID** (string) - Required - The unique identifier for the user account resource. #### Query Parameters - **dependency** (string) - Optional - Specifies dependencies to be set before and rolled back after generating the response. - **expand** (string) - Optional - Includes specified child resources in the payload. - **fields** (string) - Optional - Filters the resource fields to be returned. - **links** (string) - Optional - Shows only specific links for the resource. - **onlyData** (boolean) - Optional - Filters the payload to contain only data, excluding links. #### Header Parameters - **Metadata-Context** (string) - Optional - Used to isolate from runtime customizations or interact with specific versions. - **REST-Framework-Version** (string) - Optional - Specifies the protocol version between the client and service. ### Response #### Success Response (200) - **userAccounts-item-response** (object) - The user account resource details. ``` -------------------------------- ### Get Visibility Options cURL Request Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-personnotesvisibilityoptions-get.html Example of retrieving visibility options using a cURL GET request. ```bash curl -i -u ":" -X GET "http://host:port/hcmCoreApi/resources/11.13.18.05/personNotesVisibilityOptions" ``` -------------------------------- ### Submit all settings Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-12-delete.html Submits all settings for a recruiting site for processing. ```APIDOC ## SUBMIT /settings/all ### Description Submits all settings in recruitingCESites for processing. ### Method POST ### Endpoint /settings/all ```