REST API - setCandidateQueries

The REST API for setting candidate queries is sub-divided into the following:

Set or update a candidate query to an identified position — Set Candidate Query - Position
Set or update a candidate query to an identified group — Set Candidate Query - Group
Delete a candidate query from an identified position — Delete Candidate Query - Position
Delete a candidate query from an identified group — Delete Candidate Query - Group
Set Candidate Query - Position

Request

Format	PUT <baseurl>/candidatequery/position/<position-guid>/<container-id>/ <search-scope>
Path parameters	position-guid: The unique identifier of the position to which the candidate query is to be assigned. container-id: The identifier of the LDAP container in which the LDAP search is to be performed, and to which generated resources should be assigned. search-scope: The scope on which an LDAP search is to be performed. The valid entries are either: ONELEVEL (only the elements directly within the Base-DN level are searched) or SUBTREE (elements directly within, and below, the Base-DN level are searched).
Query parameters	BaseDN: (optional) The base-DN to which the LDAP search is to be restricted.
Body	Query: The LDAP query that identifies candidate resources.

JSON	If successful, returns 200 OK in the response header, and an empty response body.
XML	If successful, returns 200 OK in the response header, and an empty response body.

Request	PUT <baseurl>/orgmodel/candidatequery/position/_uNjFkFHIEeO_orno_K2qCw/1/ONELEVEL
Body	(objectclass=person)

Set Candidate Query - Group

Format	PUT <baseurl>/candidatequery/group/<group-guid>/<container-id>/ <search-scope>
Path parameters	group-guid: The the unique identifier of the group to which the candidate query is to be assigned. container-id: The identifier of the LDAP container in which the LDAP search is to be performed, and to which generated resources should be assigned. search-scope: The scope on which an LDAP search is to be performed. The valid entries are either: ONELEVEL (only the elements directly within the Base-DN level are searched) or SUBTREE (elements directly within, and below, the Base-DN level are searched).
Query parameters	BaseDN: (optional) The base-DN to which the LDAP search is to be restricted.
Body	Query: The LDAP query that identifies candidate resources.

JSON	If successful, returns 200 OK in the response header, and an empty response body.
XML	If successful, returns 200 OK in the response header, and an empty response body.

Request	PUT <baseurl>/orgmodel/candidatequery/group/_slQukFHHEeO_orno_K2qCw/1/ONELEVEL
Body	(objectclass=person)

Delete Candidate Query - Position

Format	DELETE <baseurl>/candidatequery/position/<position-guid>
Path parameters	position-guid: The unique identifier of the position from which the candidate query is to be removed.

JSON	If successful, returns 200 OK in the response header, and an empty response body.
XML	If successful, returns 200 OK in the response header, and an empty response body.

Request

DELETE <baseurl>/orgmodel/candidatequery/position/_uNjFkFHIEeO_orno_K2qCw

Delete Candidate Query - Group

Format	DELETE <baseurl>/candidatequery/group/<group-guid>
Path parameters	group-guid: The unique identifier of the group from which the candidate query is to be removed.

JSON	If successful, returns 200 OK in the response header, and an empty response body.
XML	If successful, returns 200 OK in the response header, and an empty response body.

Request

DELETE <baseurl>/orgmodel/candidatequery/group/_slQukFHHEeO_orno_K2qCw