Package org.bonitasoft.web.client.api

Interface ProfileApi

    • Method Detail

      • createProfile

        Profile createProfile​(ProfileCreateRequest body)
        Create the Profile Create the Profile
        Parameters:
        body - Partial Profile description (required)
        Returns:
        Profile

      • createProfileWithHttpInfo

        ApiResponse<Profile> createProfileWithHttpInfo​(ProfileCreateRequest body)
        Create the Profile Similar to createProfile but it also returns the http response headers . Create the Profile
        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

        void importProfiles​(String profilesDataUpload,
                    String importPolicy)
        Import profiles Import profiles
        Parameters:
        profilesDataUpload - Uploaded file (optional)
        importPolicy - Import policy (optional)

      • importProfilesWithHttpInfo

        ApiResponse<Void> importProfilesWithHttpInfo​(String profilesDataUpload,
                                             String importPolicy)
        Import profiles Similar to importProfiles but it also returns the http response headers . Import profiles
        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​(Map<String,​Object> 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​(Map<String,​Object> 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

        void updateProfileById​(String id,
                       ProfileUpdateRequest profileUpdateRequest)
        Update the Profile by ID Update the Profile for the given ID
        Parameters:
        id - ID of the Profile to return (required)
        profileUpdateRequest - Partial Profile description (required)

      • updateProfileByIdWithHttpInfo

        ApiResponse<Void> updateProfileByIdWithHttpInfo​(String id,
                                                ProfileUpdateRequest profileUpdateRequest)
        Update the Profile by ID Similar to updateProfileById but it also returns the http response headers . Update the Profile for the given ID
        Parameters:
        id - ID of the Profile to return (required)
        profileUpdateRequest - Partial Profile description (required)

      • uploadprofiles

        String uploadprofiles​(File file)
        Upload profiles Upload profiles
        Parameters:
        file - (optional)
        Returns:
        String

      • uploadprofilesWithHttpInfo

        ApiResponse<String> uploadprofilesWithHttpInfo​(File file)
        Upload profiles Similar to uploadprofiles but it also returns the http response headers . Upload profiles
        Parameters:
        file - (optional)
        Returns:
        A ApiResponse that wraps the response boyd and the http headers.