Package org.bonitasoft.web.client.api

Interface ProfileEntryApi

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

  • Method Details

    • createProfileEntry

      @Deprecated ProfileEntry createProfileEntry(ProfileEntryCreateRequest body)
      Deprecated.
      Create the ProfileEntry Create the ProfileEntry Warning: Since Bonita 7.13, ProfileEntry is deprecated
      Parameters:
      body - Partial ProfileEntry description (required)
      Returns:
      ProfileEntry

    • createProfileEntryWithHttpInfo

      @Deprecated ApiResponse<ProfileEntry> createProfileEntryWithHttpInfo(ProfileEntryCreateRequest body)
      Deprecated.
      Create the ProfileEntry Similar to createProfileEntry but it also returns the http response headers . Create the ProfileEntry Warning: Since Bonita 7.13, ProfileEntry is deprecated
      Parameters:
      body - Partial ProfileEntry description (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • deleteProfileEntryById

      @Deprecated void deleteProfileEntryById(String id)
      Deprecated.
      Delete the ProfileEntry by ID Delete the single ProfileEntry for the given ID
      Parameters:
      id - ID of the ProfileEntry to delete (required)

    • deleteProfileEntryByIdWithHttpInfo

      @Deprecated ApiResponse<Void> deleteProfileEntryByIdWithHttpInfo(String id)
      Deprecated.
      Delete the ProfileEntry by ID Similar to deleteProfileEntryById but it also returns the http response headers . Delete the single ProfileEntry for the given ID
      Parameters:
      id - ID of the ProfileEntry to delete (required)

    • getProfileEntryById

      @Deprecated ProfileEntry getProfileEntryById(String id)
      Deprecated.
      Finds the ProfileEntry by ID Returns the single ProfileEntry for the given ID Warning: Since Bonita 7.13, ProfileEntry is deprecated
      Parameters:
      id - ID of the ProfileEntry to return (required)
      Returns:
      ProfileEntry

    • getProfileEntryByIdWithHttpInfo

      @Deprecated ApiResponse<ProfileEntry> getProfileEntryByIdWithHttpInfo(String id)
      Deprecated.
      Finds the ProfileEntry by ID Similar to getProfileEntryById but it also returns the http response headers . Returns the single ProfileEntry for the given ID Warning: Since Bonita 7.13, ProfileEntry is deprecated
      Parameters:
      id - ID of the ProfileEntry to return (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchProfileEntries

      @Deprecated List<ProfileEntry> searchProfileEntries(Integer p, Integer c, List<String> f, String s)
      Deprecated.
      Finds ProfileEntries Finds ProfileEntries with pagination params and filters - can search on `name` - can filter on `page`,`name` and `parent_id` Warning: Since Bonita 7.13, ProfileEntry is deprecated
      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)
      Returns:
      List<ProfileEntry>

    • searchProfileEntriesWithHttpInfo

      @Deprecated ApiResponse<List<ProfileEntry>> searchProfileEntriesWithHttpInfo(Integer p, Integer c, List<String> f, String s)
      Deprecated.
      Finds ProfileEntries Similar to searchProfileEntries but it also returns the http response headers . Finds ProfileEntries with pagination params and filters - can search on `name` - can filter on `page`,`name` and `parent_id` Warning: Since Bonita 7.13, ProfileEntry is deprecated
      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)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchProfileEntries

      @Deprecated List<ProfileEntry> searchProfileEntries(ProfileEntryApi.SearchProfileEntriesQueryParams queryParams)
      Deprecated.
      Finds ProfileEntries Finds ProfileEntries with pagination params and filters - can search on `name` - can filter on `page`,`name` and `parent_id` Warning: Since Bonita 7.13, ProfileEntry is deprecated Note, this is equivalent to the other searchProfileEntries 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 ProfileEntryApi.SearchProfileEntriesQueryParams 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)
      Returns:
      List<ProfileEntry>

    • searchProfileEntriesWithHttpInfo

      @Deprecated ApiResponse<List<ProfileEntry>> searchProfileEntriesWithHttpInfo(ProfileEntryApi.SearchProfileEntriesQueryParams queryParams)
      Deprecated.
      Finds ProfileEntries Finds ProfileEntries with pagination params and filters - can search on `name` - can filter on `page`,`name` and `parent_id` Warning: Since Bonita 7.13, ProfileEntry is deprecated Note, this is equivalent to the other searchProfileEntries 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)
      Returns:
      List<ProfileEntry>

    • updateProfileEntryById

      @Deprecated void updateProfileEntryById(String id, ProfileEntryUpdateRequest profileEntryUpdateRequest)
      Deprecated.
      Update the ProfileEntry by ID Update the ProfileEntry for the given ID Warning: Since Bonita 7.13, ProfileEntry is deprecated
      Parameters:
      id - ID of the ProfileEntry to return (required)
      profileEntryUpdateRequest - Partial ProfileEntry description (required)

    • updateProfileEntryByIdWithHttpInfo

      @Deprecated ApiResponse<Void> updateProfileEntryByIdWithHttpInfo(String id, ProfileEntryUpdateRequest profileEntryUpdateRequest)
      Deprecated.
      Update the ProfileEntry by ID Similar to updateProfileEntryById but it also returns the http response headers . Update the ProfileEntry for the given ID Warning: Since Bonita 7.13, ProfileEntry is deprecated
      Parameters:
      id - ID of the ProfileEntry to return (required)
      profileEntryUpdateRequest - Partial ProfileEntry description (required)