This documentation has for scope to introduce users to Relotalent Business HR API functionalities.
\nBusiness HR APIs (HR APIs) allow users to perform activitites within a given ReloTalent HR account, such as:
\nThe main purpose of ReloTalent Business HR APIs is to enable integration between client's HRIS systems and ReloTalent, in order to empower their Global Mobility teams to work with their connected Providers (DSP).
\nFor testing / preprod usage, please use the following host: https://thinhdev-publicapi.reloday.com/
\nFor testing / preprod usage, please use the following host: https://public-api.relotalent.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"219743","collectionId":"3502838e-1c70-4dc4-a235-02919571f597","publishedId":"2s935hRSik","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0098ff"},"publishDate":"2023-05-18T10:17:43.000Z"},"item":[{"name":"User","item":[{"name":"User: me","id":"65b007e3-e409-41b2-8cb6-dbc234aac000","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKeyHR}}"}]},"isInherited":false},"method":"GET","header":[{"key":"format","type":"text","value":"{{format}}"}],"url":"{{host}}/business-api-hr/user/me","description":"Get information about current API user.
\n","urlObject":{"path":["business-api-hr","user","me"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"65b007e3-e409-41b2-8cb6-dbc234aac000"},{"name":"User: getAccessKeys","id":"d6d9cc96-1f67-4262-944a-0a85263745da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKeyHR}}"}]},"isInherited":false},"method":"GET","header":[{"key":"format","value":"{{format}}","type":"text"}],"url":"{{host}}/business-api-hr/user/getAccessKeys","description":"Get Authentication Key to be used to call APIs.
\n","urlObject":{"path":["business-api-hr","user","getAccessKeys"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d6d9cc96-1f67-4262-944a-0a85263745da"},{"name":"User: generateAccessKey","id":"35d9df0d-6e78-41c6-8572-682e6c7485f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKeyHR}}"}]},"isInherited":false},"method":"POST","header":[{"key":"format","value":"{{format}}","type":"text"}],"url":"{{host}}/business-api-hr/user/generateAccessKey","description":"Generate Authentication Key to be used to call APIs.
\n","urlObject":{"path":["business-api-hr","user","generateAccessKey"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"35d9df0d-6e78-41c6-8572-682e6c7485f1"}],"id":"d8b8d34a-d59c-4edf-8a50-8532abde68a3","description":"This section details available APIs to:
\nCreate a new Assignee.
\nUpdate an existing Assignee.
\nArchive (soft delete) an existing Assignee.
\nActivate an Assignee.
\nActivating an Assignee is necessary to further be able to give a login in order to allow connection to the Assignee Personal Space.
\nDeactivate an Assignee.
\nCreate login details for an Assignee.
\nGet login details of an Assignee by calling its Uuid.
\nGet Assignees list.
\nPlease note: list is returned with pagination. By default max 50 assignees are returned per page.
\nGet Assignee details by calling its Uuid.
\nGet Assignee details by calling its external_hris ID.
\nThis API allows to get Assignee details by calling their unique reference in another system (e.g. Workday, Bamboo HR, etc.)
\nAdd an Assignee to a Company Office.
\nThis API sets the Assignee as being part of a particular Company Office.
\nAdd an Assignee to a Company Department.
\nThis API sets the Assignee as being part of a particular Company Department.
\nGet list of all documents with type = Visa for an Assignee by calling its Uuid.
\nGet list of all documents with type = Passport for an Assignee by calling its Uuid.
\nGet list of all the Dependants associated to an Assignee by calling its Uuid.
\nPlease note: an Assignee can have multiple dependents associated, but these are not necessarily included in one Assignment. To have Dependants included in an Assignment, the API Assignment: addDependant must be used.
\nThis section details Assignee related APIs available to perform the following actions:
\nCreate a Dependant associated to an Assignee.
\nUpdate a Dependant associated to an Assignee.
\nDelete a Dependant associated to an Assignee.
\nGet a list of all the Dependants for this account.
\nGet details about a Dependant by calling its Uuid.
\nGet list of all documents with type = Visa for a Dependant by calling its Uuid.
\nGet list of all documents with type = Passport for a Dependant by calling its Uuid.
\nThis section details Dependants related APIs available to perform the following actions:
\nPlease note:
\nGet all the Personal Documents for an Assignee/Dependent.
\nGet Personal Document types.
\nDocuments are grouped by type:
\nGet details of a single Personal Document by calling its Uuid.
\nCreate a new Personal Document type = Passport for an Assignee or a Dependant.
\nCreate a new Personal Document type = Visa for an Assignee or a Dependant.
\nCreate a new Personal Document type = Education for an Assignee or a Dependant.
\nCreate a new Personal Document type = Curriculum for an Assignee or a Dependant.
\nCreate a new Personal Document for an Assignee or a Dependant stating its type.
\nUpdate an existing Personal Document for an Assignee/Dependant.
\nRemove/delete a Personal Document of an Assignee/Dependant.
\nAttach a file to an exisiting Personal Document for an Assignee/Dependant.
\nRemove a file attached to a Personal Document.
\nPlease note: this action does not delete the document it simply removes a file attached to it.
\nPlesae note: when referring to Documents it is intended personal documents attached to an Assignee or a Dependant.
\nDocuments are grouped by type:
\nDocuments are not just files, they also contain information such as:
\nCreate an Assignment.
\nUpdate an existing Assignment.
\nGet Assignment details by calling its Uuid.
\nGet Assignments list.
\nPlease note: list is returned with pagination. By default max 50 assignments are returned per page.
\nApprove an Assignment.
\nPlease note: Assignments with statys Rejected or Completed cannot be approved.
\nReject an Assignment.
\nPlease note: Assignments with statys Approved or Completed cannot be rejected.
\nTerminate an Assignment
\nTerminate an Assigment means marking it as Completed.
\nChange Approval status of an Assignment.
\nPlease note: Approval status is different from Assignment status, this because once created an Assignment usually goes through internal validations before it is finally approved and can be considered fully operable.
\nAdd Policy to Assignment.
\nAdd Dependant to Assignment.
\nA Dependant associated to an Assignee needs to be added to the Assignment to be considered as part of the persons included in the move.
\nRemove Dependant from Assignment.
\nRemoving a Dependant from an Assignment does not delete the Dependant itself, it simply removes it from the people included in the move. The Dependant will still exist and be associated to the Assignee.
\nGet all the Internal tasks (part of a workflow or manually created) associated to an Assignment.
\nGet
\nby calling Assignment Uuid.
\nGet details about
\nby calling Assignment Uuid.
\nSet a user as Reporter of an Assignment.
\nSet a user as Owner of an Assignment
\nAdd a user as Viewer of an Assignment.
\nRemove a user from Viewers of an Assignment.
\nGet all users/contacts set as managing contacts of an Assignment (Creator, Reporter, Owner, Viewers).
\nGet the list of all Initiation requests/Service request sent to providers for a single Assignment.
\nGet details of all the Initiated files accepted by Providers and being active Relocations in Provider environment for for a single Assignment.
\nAn Assignment in the system represents the order of mission, data set for moving an employee or a new recrutee from a location to another location for work.
\nAn Assignment is composed of:
\nLaunch Assignment workflow to generate the list of internal tasks associated with an Assignment.
\nLaunch Assignment workflow to generate the list of tasks shared with an Assignee in his/her Personal Space and being associated with an Assignment.
\nGet details of all the Assignment workflows being setup in Settings.
\n","urlObject":{"path":["business-api-hr","workflow","getAssignmentWorkflows"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"49aea109-86c9-4447-a406-9b37d61474d6"},{"name":"Workflow:getWorkflow","event":[{"listen":"prerequest","script":{"id":"bce30ebb-defe-4139-a9ce-35bd34b1596c","exec":["pm.variables.set('workflow_uuid_local', '6f7a86c3-4f32-4f6b-9758-d84c58b3239c');"],"type":"text/javascript"}}],"id":"fa074485-437b-43bf-9228-f51963f3c798","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKeyHR}}"}]},"isInherited":false},"method":"GET","header":[{"key":"format","value":"{{format}}","type":"text"}],"url":"{{host}}/business-api-hr/workflow/get/{{workflow_uuid_local}}","description":"Get full details of an Assignment workflows setup in Settings by calling its Uuid, this includes the tasks setup and all the related details.
\nGet basic details of an Assignment workflows setup in Settings by calling its reference_code.
\nWorkflows are lists of tasks setup in settings, they reflect the organisation of the team for an Assignment and can be launched inside an Assignment in order to allow the team working on the different activities needed to manage the Assignment.
\nShared with Assignee: a list of tasks shared with Assignee in his/her Personal Space.
\nOnce a workflow is launched, this kicks off the process of generation of all the related tasks within the Assignment.
\n","_postman_id":"fe1d0be5-30b5-4f2b-9f4f-99b7f62ad1f0"}],"id":"050947e1-cda4-46c2-adae-07a9f7fa2089","description":"This section details Assignee related APIs available to perform the following actions:
\nPlease note: the system supports multiple initiations requests for multiple providers, the HR can interact with N providers and request services to mulitple Providers for the same Assignment. Each provider must have an account to be able to receive these requests.
\n","_postman_id":"050947e1-cda4-46c2-adae-07a9f7fa2089"},{"name":"Initiation request","item":[{"name":"Initiation: sendRequest","event":[{"listen":"prerequest","script":{"id":"042276cf-56de-4dcc-8541-bdeb93876547","exec":["pm.variables.set('message', 'dW5wYXJhbGxlbGVkIGNvbnRyaWJ1dGlvbiBhbmQgc2FjcmlmaWVz');"],"type":"text/javascript"}}],"id":"50ae0417-5269-403d-9e54-b1aaff2841c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKeyHR}}"}]},"isInherited":false},"method":"POST","header":[{"key":"format","type":"text","value":"{{format}}"}],"body":{"mode":"formdata","formdata":[{"key":"assignment_uuid","value":"ac5c73c2-2d59-478e-b81d-5274fd889cf3","type":"text"},{"key":"gms_company_uuid","value":"d63def8c-5b54-4eaf-9640-4f4ec27886e7","type":"text"},{"key":"po_code","value":"P01212","type":"text"},{"key":"gl_code","value":"s1111","type":"text"},{"key":"message","value":"{{message}}","type":"text"},{"key":"currency","value":"PHP","type":"text"},{"key":"budget","value":"1000","type":"text"},{"key":"upload_type","value":"raw","type":"text"},{"key":"file","type":"file","src":"/Users/expattest01/Downloads/benevolent.xlsx"},{"key":"file1","type":"file","src":"/Users/expattest01/Downloads/ASMT-HALL-HOHA-31669177021.xlsx"}]},"url":"{{host}}/business-api-hr/assignment/sendInitiationRequest","description":"Send an Initiation Request for an Assignment to a Provider.
\nResend an Initiation Request for an Assignment to a Provider.
\nHR account to revoke an Initiation sent to a Provider.
\nGet all the details of an Initiation Request to a Provider.
\nUploading a file to an initiation using RAW method.
\nUploading a file to an initiation using JSON method.
\nGet Initiation files
\nThe process of sending a Request of services to a connected provider, requesting some services to be provided (e.g. Home Search, Visa Renewal, Airport pick-up, etc.). Once the initiation request is accepted by the Provider, the Assignment is shared between the 2 accounts (HR > DSP) and the provider can start working in its dedicated environment.
\nAn initiation contains:
\nAn initiation can be:
\nGet all the Provider Timelogs for a Relocation.
\nThis illustrates how much time was spent by the Provider to work on this case.
\nGet details about the Provider user being set as Owner of a Relocation.
\nGet details about the Provider user being set as Reporter of a Relocation.
\nGet details about the Provider users being set as Viewers of a Relocation.
\nGet Relocation details by calling the Initiation Uuid.
\nGet Relocation details by calling the Relocation Uuid.
\nGet details of all the services performed by Provider on a Relocation.
\nGet all files shared with/by Provider (Relocation included) by calling Initiation Uuid.
\nGet Initiation files by assignment_uuid and gms_company_uuid
\nGet details about the folders shared with/by Provider (Relocation included)Â by calling Initiation Uuid.
\nGet list of all the tasks shared by Provider to HR account.
\nProviders can share tasks with HR account in order to interact with their HR clients.
\nOnce an Initiation is accepted by the Provider it will be used to generate a Relocation. This represents thre working case for a Provider, this is operated by the provider in its dedicated environment and information is shared back to the HR environment to allow the HR users to:
\nCreate a Comment in one Initiation, Task or Cost Projection.
\nEdit a Comment in one Initiation, Task or Cost Projection.
\nDelete a Comment from an Initiation, Task or Cost Projection.
\nGet the list of all Comments related to a Task/Initiation/CostProjection
\nThe system supports comments in multiple objects:
\nGet all Active Contracts
\n","urlObject":{"path":["business-api-hr","contract","search"],"host":["{{host}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"},{"key":"query","value":"ly"}],"variable":[]}},"response":[{"id":"6020a435-c8b1-4225-971a-8d0a712cff9d","name":"Contract: get list PASS","originalRequest":{"method":"GET","header":[{"key":"api-key","type":"text","value":"{{apiKeyHR}}"},{"key":"format","type":"text","value":"{{format}}"},{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/business-api-hr/contract/search?page=1&limit=20&query=ly","host":["{{host}}"],"path":["business-api-hr","contract","search"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"},{"key":"query","value":"ly"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"91e06c90-80ea-4843-abc3-34ddc93259a4","name":"Contract: get list FAIL because of invalid page and limit","originalRequest":{"method":"GET","header":[{"key":"api-key","type":"text","value":"{{apiKeyHR}}"},{"key":"format","type":"text","value":"{{format}}"},{"key":"Authorization","value":"{{Authorization}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/business-api-hr/contract/search?page=-1&limit=a&query=ly","host":["{{host}}"],"path":["business-api-hr","contract","search"],"query":[{"key":"page","value":"-1"},{"key":"limit","value":"a"},{"key":"query","value":"ly"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8215c942-8f84-468f-b8a8-f4723efadc9f"},{"name":"Contract: getDetails","id":"213f4c35-9668-4a47-b22c-d30fa891b4f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"{{apiKeyHR}}"},{"key":"format","type":"text","value":"{{format}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/business-api-hr/contract/get/{{contract_uuid}}","urlObject":{"path":["business-api-hr","contract","get","{{contract_uuid}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"a2b80dd7-8d39-44d7-9df1-3dcab036cf03","name":"Contract: get PASS","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"{{apiKeyHR}}"},{"key":"format","type":"text","value":"{{format}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/business-api-hr/contract/get/f4114c2d-b8b7-4cb8-986b-8ae4c574e042"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"9e210dda-972d-476c-9a63-e88f03d5c169","name":"Contract: get FAIL because of invalid uuid (uuid should have 32 digits)","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"{{apiKeyHR}}"},{"key":"format","type":"text","value":"{{format}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/business-api-hr/contract/get/f4114c2d-b8b7-4cb8-986b-8ae4c574e042dsfdsff"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"213f4c35-9668-4a47-b22c-d30fa891b4f4"}],"id":"560a0ee5-8173-4368-a4ef-3eacd740495d","description":"A contract is the logic binding between an HR account and a Provider account.
\nA contract allows Initiation Requests to be sent, data to be matched and to flow between connected accounts.
\nHere below you can see the elements forming a contract:
\n","_postman_id":"560a0ee5-8173-4368-a4ef-3eacd740495d"},{"name":"Media/Files","item":[{"name":"MediaFile: uploadRAW","id":"057bfc2c-0fc9-40dc-9073-1542f13307e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKeyHR}}"}]},"isInherited":false},"method":"POST","header":[{"key":"format","type":"text","value":"{{format}}"}],"body":{"mode":"formdata","formdata":[{"contentType":"","key":"file","type":"file","src":"/Users/expattest01/Desktop/empricism.png"}]},"url":"{{host}}/business-api-hr/media/upload","description":"Allow the users to browse for a local file to upload
\nUpload file using JSON data
\nSearch files in your library
\nRemove an Attachment
\nFiles can be attached in the system to several objects, the most common objects receiving files are:
\nThe system supports 2 methods to upload files to objects:
\nGet Company details
\n","urlObject":{"path":["business-api-hr","company","get"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"684453f5-3873-47c9-a548-1a4689f25410"}],"id":"9ca1168a-3608-46b4-ac5b-485d17a6ed15","description":"The Company itself will already exist at the moment APIs are used, therefore only getDetails is available.
\n","_postman_id":"9ca1168a-3608-46b4-ac5b-485d17a6ed15"},{"name":"Offices","item":[{"name":"Office: create","event":[{"listen":"prerequest","script":{"id":"32085550-5c47-470e-bdec-a10e8e35805c","exec":["pm.variables.set('external_hris_id_local', '8a0ffa54a15c11eabb370242ac130002'); //id of Office in Workday System","","pm.variables.set('external_hris_id_local', '8bab9952-59d9-4896-aa27-01109a140d81');"],"type":"text/javascript"}}],"id":"55ee9450-5adc-4783-b36e-c71dc0444495","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKeyHR}}"}]},"isInherited":false},"method":"POST","header":[{"key":"format","type":"text","value":"{{format}}"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Berlin Office\",\n\t\"country_iso_code\": \"FR\",\n\t\"address\": \"12423r\",\n\t\"street\": \"\",\n\t\"telephone\": \"358-838-1500\",\n\t\"zipcode\": \"\",\n\t\"state_county\": \"\",\n\t\"currency\": \"EUR\",\n\t\"city\": \"Berlin\",\n \"external_hris_id\": \"{{external_hris_id_local}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/business-api-hr/office/create","description":"Create an Office of HR company
\nGet list of Offices
\nOffices are the 2nd level of a company organisation within the system, they are part of the Company and can have sub-levels such as Departments or Teams.
\n","_postman_id":"8529fd58-cef4-4104-a542-7c1e5fe18b8a"},{"name":"Departments","item":[{"name":"Department: create","event":[{"listen":"prerequest","script":{"id":"20f540fc-398b-4444-8c9c-4387203467e7","exec":["pm.variables.set('external_hris_id_local', 'fb431bbea15abb370242ac132wre'); //id of Department in Workday System","pm.variables.set('external_hris_id_local', 'f1e5a562-e130-4b54-a874-a652446753ad');"],"type":"text/javascript"}}],"id":"62f3b41a-35fe-4874-acf9-dddf2bb4699f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKeyHR}}"}]},"isInherited":false},"method":"POST","header":[{"key":"format","type":"text","value":"{{format}}"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Hai Phong\",\n \"external_hris_id\": \"{{external_hris_id_local}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/business-api-hr/department/create","description":"Create a Department of HR company
\nGet list of Departments
\nDepartments are the 3rd level of a company organisation within the system, they are part of Company > Offices and can have a further sub-level called Teams (not available in APIs in the present documentation).
\n","_postman_id":"9bb6cb48-52c9-47ed-aed3-ff66a1442e17"}],"id":"0816751d-4943-4e18-809c-8623271c1d5f","description":"Company section details the APIs available to retrieve data or manage information about the Company account.
\nThe company organisation is reflected and can contain subsections as:
\nCreate a User/Member.
\nCreate a User/Member with role = Maanger.
\nUpdate a User/Member.
\nActivate a User/Member so that login can be created and can login to the system.
\nDeactivate User/Member so member is no longer able to Login to the system.
\nGet User/Member details.
\nGet list of Users/Members for this account.
\nSystem users can be managed by APIs, here below you will find a collection of the available actions that can be performed by API.
\n","_postman_id":"973f1062-2d99-4568-8281-8d2132016dbd"},{"name":"Policies","item":[{"name":"Policy: getList","id":"80fff6a7-969d-4232-9605-385486fa72bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKeyHR}}"}]},"isInherited":false},"method":"GET","header":[{"key":"format","type":"text","value":"{{format}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/business-api-hr/policy/getList","description":"Get list of all Company policies.
\n","urlObject":{"path":["business-api-hr","policy","getList"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"80fff6a7-969d-4232-9605-385486fa72bc"},{"name":"Policy: getByReference","event":[{"listen":"prerequest","script":{"id":"00022ed9-2f03-4e1b-bcb6-518aee5dcf50","exec":["pm.variables.set('reference_local','12_Hour_Relocation_Only_Expath');"],"type":"text/javascript"}}],"id":"ab59a923-f96c-4dd7-9c0e-51e0e927bf0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKeyHR}}"}]},"isInherited":false},"method":"GET","header":[{"key":"format","type":"text","value":"{{format}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/business-api-hr/policy/search/?reference=reference for Presisent","description":"Get details of a Policy by calling its reference.
\nA policy in the system is meant to flag assignments as being ruled by a specific set of rules or conditions. Policies are very common in industry and are appended to an Assignment when creating or editing it.
\nPolicies cannot currently be created by API, but their details can be retrieved.
\n","_postman_id":"f0f6b682-afab-45c2-9046-8f8d9e269c3a"}],"id":"b8f05333-54dc-4cc6-8f82-fdb44baee209","description":"System settings are also covered by APIs (at least partially), in particular Users and Policies are covered, and APIs users can interact with these objects.
\nUsers
Any team member/user that needs to be part of the account.
Policy
A determined policy managing international mobility or conditions for the moves.
Get list of Countries.
\nThe system provides a list of countries to be used for Assignment generations. Calling this API allows users to retrieve Country details to further pass where required.
\n","_postman_id":"c7eb4376-038b-4653-9057-297344ab4971"},{"name":"Cities","item":[{"name":"City: search","event":[{"listen":"prerequest","script":{"id":"21b165e4-b876-43ba-8d2e-8fb784bc7ea5","exec":["pm.variables.set('employee_dependant_uuid_local', 'd8f27144-3263-4537-b172-44af9529c90a');","","pm.variables.set('employee_dependant_uuid_local', '');"],"type":"text/javascript"}}],"id":"ec24e790-46da-4a26-a90c-1ff49cf2b10d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKeyHR}}"}]},"isInherited":false},"method":"GET","header":[{"key":"format","type":"text","value":"{{format}}"}],"url":"{{host}}/business-api-hr/city/search","description":"Get list of Cities based on Geoname.
\nThe system provides a list of cities based on Geoname to be used for Assignment generations. Calling this API allows users to retrieve City details to further pass where required.
\n","_postman_id":"12c95c48-06a3-4bdf-9267-08531eec4eb6"},{"name":"Attributes, variables and values","item":[{"name":"Setting: getAttributes","id":"86ab1f29-d687-4959-bef0-0bbe9cd1bb68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKeyHR}}"}]},"isInherited":false},"method":"GET","header":[{"key":"format","type":"text","value":"{{format}}"}],"url":"{{host}}/business-api-hr/attribute/getList","description":"Get all system attributes such as:
\nAttributes are available for edition in system settings and can be managed by any user not being restricted to perform such actions.
\nThe system comes with a set of pre-created attributes that can be further edited and customised by users.
\n","urlObject":{"path":["business-api-hr","attribute","getList"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"86ab1f29-d687-4959-bef0-0bbe9cd1bb68"},{"name":"Attributes: getAttributeValue","id":"7af7eb76-d54c-410c-8ad6-2d20ff6678f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{apiKeyHR}}"}]},"isInherited":false},"method":"GET","header":[{"key":"format","type":"text","value":"{{format}}"}],"url":"{{host}}/business-api-hr/attribute/translate/{{value_code}}","description":"Get a specific value for an Attribute.
\nGet all system variables such as:
\nValues are not available for edition in system settings and cannot be managed by any user.
\n","urlObject":{"path":["business-api-hr","setting","getVariables"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6014d0dc-418f-43aa-962e-7197079e4ca5"}],"id":"a31f0bc3-c456-4fa5-a16e-8292978f9c71","description":"Attributes, variables and values need to be used to control objects in the sytem. The following 3 APIs are available to perform these actions:
\nUtilities are a set of APIs available to perform recurrent actions in the system in order to create or run API commands.
\nThe following Utilities APIs are available:
\nCreate a Webhook to receive data updates for a given system event.
\nUpdate a Webhook to receive data updates for a given system event.
\nDelete a webhook.
\nGet details for a given Webhook.
\nGet list of all Webhooks in use.
\n","urlObject":{"path":["business-api-hr","webhook","getList"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e379019-ddf5-4bc1-a0cf-fa62d80d7a5e"}],"id":"834464e8-6955-408d-8ab9-2b34f556a5e9","description":"The system allows users to create Webhooks to return a list of objects for given events occurring. This feature is available for any user not being restricted to do so.
\nPlease note: webhooks are an addon module in the system, to append this addon to the account subscription, please refer to MasterAPI documentation.
\n","_postman_id":"834464e8-6955-408d-8ab9-2b34f556a5e9"}]}