Apiled - Employee Onboarding Process API | RAML Definition

This API serves as a design for API Led Connectivity approach of running an enterprise. The API is a Process API for saving information about Ids from different systems.

The API is designed as a REST API using RAML definition and uses JSON as an exchange format. Included are example requests and responses.

Implemented endpoints:

POST /employees: This endpoint will start generation of the Employee onboarding process. The generation is done asynchronously using queue for requests. The process aggregates the ids of each system API response using a lookup process API. The lookup process API RAML you can find in main/resources/api/ directory. The lookup process API implementation of that RAML is client specific and should use persistent storage to preserve a mapping data. Responses are get from three source instances(Workday, Netsuite and Salesforce) using API Led Connectivity System APIs.

GET /employees/{id}:This endpoint returns Employee ids aggregation identified by unique ID. If the process does not exist or haven't been finished yet, the request ends up with "Resource not found" message.

GET /queue/{id}:This endpoint returns the status of the queued Employee onboarding process identified by unique ID.