API documentation for onboarding workflows appears incomplete?

Posted by JonathanF on February 06, 2024 in General discussion

iCIMS Onboarding documentation makes no reference to the endpoint https://developer-community.icims.com/api/281#post-/onboardworkflows. However, the 'Workflows' documentation - https://developer-community.icims.com/api/246 - does, under the heading "Retrieve basic information from an Onboard workflow" gives the example 'GET /onboardworkflows/'. 

When we try various permutations of the possible path, we get the following errors:

405

https://api.icims.com/customers/{{customerId}}/onboardworkflows
https://api.icims.com/customers/{{customerId}}/onboardworkflows/

```
No operation matching request path "/api/rest/onboardworkflows/" is found, Relative Path: /, HTTP Method: GET, ContentType: application/json, Accept: */*,. Please enable FINE/TRACE log level for more details.
```

404

https://api.icims.com/onboardworkflows/
https://api.icims.com/onboardworkflows
 

Submitted by JonB on February 21, 2024 Permalink

Are you trying to get data about an onboarding workflow? If so, try https://api.icims.com/customers/{customerID}/onboardworkflows/{onboardingWorkflowID} using a GET