Package org.bonitasoft.web.client.api

Interface ProfileApi

All Superinterfaces:

ApiClient.Api

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.12.0")
public interface ProfileApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProfileApi.SearchProfilesQueryParams	A convenience class for generating query parameters for the searchProfiles method in a fluent style.

Method Summary

Modifier and Type	Method	Description
Profile	createProfile(ProfileCreateRequest body)	Deprecated.
ApiResponse<Profile>	createProfileWithHttpInfo(ProfileCreateRequest body)	Deprecated.
void	deleteProfileById(String id)	Delete the Profile by ID Delete the single Profile for the given ID
ApiResponse<Void>	deleteProfileByIdWithHttpInfo(String id)	Delete the Profile by ID Similar to deleteProfileById but it also returns the http response headers .
Profile	getProfileById(String id)	Finds the Profile by ID Returns the single Profile for the given ID
ApiResponse<Profile>	getProfileByIdWithHttpInfo(String id)	Finds the Profile by ID Similar to getProfileById but it also returns the http response headers .
void	importProfiles(String profilesDataUpload, String importPolicy)	Deprecated.
ApiResponse<Void>	importProfilesWithHttpInfo(String profilesDataUpload, String importPolicy)	Deprecated.
List<Profile>	searchProfiles(Integer p, Integer c, List<String> f, String s, String o)	Finds Profiles Finds Profiles with pagination params and filters - can search on `name` - can filter on `name`,`hasNavigation` - can order on `name`
List<Profile>	searchProfiles(ProfileApi.SearchProfilesQueryParams queryParams)	Finds Profiles Finds Profiles with pagination params and filters - can search on `name` - can filter on `name`,`hasNavigation` - can order on `name` Note, this is equivalent to the other searchProfiles method, but with the query parameters collected into a single Map parameter.
ApiResponse<List<Profile>>	searchProfilesWithHttpInfo(Integer p, Integer c, List<String> f, String s, String o)	Finds Profiles Similar to searchProfiles but it also returns the http response headers .
ApiResponse<List<Profile>>	searchProfilesWithHttpInfo(ProfileApi.SearchProfilesQueryParams queryParams)	Finds Profiles Finds Profiles with pagination params and filters - can search on `name` - can filter on `name`,`hasNavigation` - can order on `name` Note, this is equivalent to the other searchProfiles that receives the query parameters as a map, but this one also exposes the Http response headers
void	updateProfileById(String id, ProfileUpdateRequest profileUpdateRequest)	Deprecated.
ApiResponse<Void>	updateProfileByIdWithHttpInfo(String id, ProfileUpdateRequest profileUpdateRequest)	Deprecated.
String	uploadprofiles(File file)	Deprecated.
ApiResponse<String>	uploadprofilesWithHttpInfo(File file)	Deprecated.

Method Details

createProfile

@Deprecated
Profile createProfile(ProfileCreateRequest body)

Deprecated.

Create the Profile  Create the Profile Warning: as of 9.0.0, creating profiles using this API is deprecated.

Parameters:

body - Partial Profile description (required)

Returns:

Profile

createProfileWithHttpInfo

@Deprecated
ApiResponse<Profile> createProfileWithHttpInfo(ProfileCreateRequest body)

Deprecated.

Create the Profile Similar to createProfile but it also returns the http response headers .  Create the Profile Warning: as of 9.0.0, creating profiles using this API is deprecated.

Parameters:

body - Partial Profile description (required)

Returns:

A ApiResponse that wraps the response boyd and the http headers.

deleteProfileById

void deleteProfileById(String id)

Delete the Profile by ID Delete the single Profile for the given ID

Parameters:

id - ID of the Profile to delete (required)

deleteProfileByIdWithHttpInfo

ApiResponse<Void> deleteProfileByIdWithHttpInfo(String id)

Delete the Profile by ID Similar to deleteProfileById but it also returns the http response headers . Delete the single Profile for the given ID

Parameters:

id - ID of the Profile to delete (required)

getProfileById

Profile getProfileById(String id)

Finds the Profile by ID Returns the single Profile for the given ID

Parameters:

id - ID of the Profile to return (required)

Returns:

Profile

getProfileByIdWithHttpInfo

ApiResponse<Profile> getProfileByIdWithHttpInfo(String id)

Finds the Profile by ID Similar to getProfileById but it also returns the http response headers . Returns the single Profile for the given ID

Parameters:

id - ID of the Profile to return (required)

Returns:

A ApiResponse that wraps the response boyd and the http headers.

importProfiles

@Deprecated
void importProfiles(String profilesDataUpload,
 String importPolicy)

Deprecated.

Import profiles Import profiles Warning: as of 9.0.0, importing profiles using this service is deprecated.

Parameters:

profilesDataUpload - Uploaded file (optional)

importPolicy - Import policy (optional)

importProfilesWithHttpInfo

@Deprecated
ApiResponse<Void> importProfilesWithHttpInfo(String profilesDataUpload,
 String importPolicy)

Deprecated.

Import profiles Similar to importProfiles but it also returns the http response headers . Import profiles Warning: as of 9.0.0, importing profiles using this service is deprecated.

Parameters:

profilesDataUpload - Uploaded file (optional)

importPolicy - Import policy (optional)

searchProfiles

List<Profile> searchProfiles(Integer p,
 Integer c,
 List<String> f,
 String s,
 String o)

Finds Profiles Finds Profiles with pagination params and filters - can search on `name` - can filter on `name`,`hasNavigation` - can order on `name`

Parameters:

p - index of the page to display (required)

c - maximum number of elements to retrieve (required)

f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)

s - can search on attributes (optional)

o - can order on attributes (optional)

Returns:

List<Profile>

searchProfilesWithHttpInfo

ApiResponse<List<Profile>> searchProfilesWithHttpInfo(Integer p,
 Integer c,
 List<String> f,
 String s,
 String o)

Finds Profiles Similar to searchProfiles but it also returns the http response headers . Finds Profiles with pagination params and filters - can search on `name` - can filter on `name`,`hasNavigation` - can order on `name`

Parameters:

p - index of the page to display (required)

c - maximum number of elements to retrieve (required)

f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)

s - can search on attributes (optional)

o - can order on attributes (optional)

Returns:

A ApiResponse that wraps the response boyd and the http headers.

searchProfiles

List<Profile> searchProfiles(ProfileApi.SearchProfilesQueryParams queryParams)

Finds Profiles Finds Profiles with pagination params and filters - can search on `name` - can filter on `name`,`hasNavigation` - can order on `name` Note, this is equivalent to the other searchProfiles method, but with the query parameters collected into a single Map parameter. This is convenient for services with optional query parameters, especially when used with the ProfileApi.SearchProfilesQueryParams class that allows for building up this map in a fluent style.

Parameters:

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• p - index of the page to display (required)
• c - maximum number of elements to retrieve (required)
• f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
• s - can search on attributes (optional)
• o - can order on attributes (optional)

Returns:

List<Profile>

searchProfilesWithHttpInfo

ApiResponse<List<Profile>> searchProfilesWithHttpInfo(ProfileApi.SearchProfilesQueryParams queryParams)

Finds Profiles Finds Profiles with pagination params and filters - can search on `name` - can filter on `name`,`hasNavigation` - can order on `name` Note, this is equivalent to the other searchProfiles that receives the query parameters as a map, but this one also exposes the Http response headers

Parameters:

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• p - index of the page to display (required)
• c - maximum number of elements to retrieve (required)
• f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
• s - can search on attributes (optional)
• o - can order on attributes (optional)

Returns:

List<Profile>

updateProfileById

@Deprecated
void updateProfileById(String id,
 ProfileUpdateRequest profileUpdateRequest)

Deprecated.

Update the Profile by ID  Update the Profile for the given ID Warning: as of 9.0.0, updating a profile using this API is deprecated.

Parameters:

id - ID of the Profile to return (required)

profileUpdateRequest - Partial Profile description (required)

updateProfileByIdWithHttpInfo

@Deprecated
ApiResponse<Void> updateProfileByIdWithHttpInfo(String id,
 ProfileUpdateRequest profileUpdateRequest)

Deprecated.

Update the Profile by ID Similar to updateProfileById but it also returns the http response headers .  Update the Profile for the given ID Warning: as of 9.0.0, updating a profile using this API is deprecated.

Parameters:

id - ID of the Profile to return (required)

profileUpdateRequest - Partial Profile description (required)

uploadprofiles

@Deprecated
String uploadprofiles(File file)

Deprecated.

Upload profiles  Upload profiles Warning: as of 9.0.0, uploading profiles using the portal is deprecated.

Parameters:

file - (optional)

Returns:

String

uploadprofilesWithHttpInfo

@Deprecated
ApiResponse<String> uploadprofilesWithHttpInfo(File file)

Deprecated.

Upload profiles Similar to uploadprofiles but it also returns the http response headers .  Upload profiles Warning: as of 9.0.0, uploading profiles using the portal is deprecated.

Parameters:

file - (optional)

Returns:

A ApiResponse that wraps the response boyd and the http headers.