Using ?layout= on GET /search

Forum for users and developers of Bullhorn's API service.

Moderators: StaffingSupport, s.emmons, BullhornSupport

Post Reply
noahvp8
User
Posts: 4
Joined: Tue Sep 22, 2020 12:54 pm

Using ?layout= on GET /search

Post by noahvp8 »

Hi there - I would like to specify an existing layout (saved via the BH UI) for a search request. I see the docs here http://bullhorn.github.io/rest-api-docs ... get-search that say that I can use either ?fields= or ?layout=, but when I try to use ?layout=API_Opp_Report, I get an error back:
{
"errorMessage": "Unknown layout:API_Opp_Report",
"errorCode": 400
}

Is this syntax correct? Should I be able to access a layout saved in the UI this way?
tluczak
User
Posts: 11
Joined: Fri Apr 10, 2020 11:02 am

Re: Using ?layout= on GET /search

Post by tluczak »

You can use the layout to grab the settings against a respective entity for example see this call below:

GET rest-services/[redacted]/meta/JobOrder?layout=ListRow&BhRestToken[redacted]


For example if you ran:
rest-services/[redactred]/meta/Candidate?fields=*

The "names" pulled back can be inserted in place of the your example "API_Opp_Report".
Post Reply