Package org.bonitasoft.web.client.api

Interface ProcessInstanceDocumentApi

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

  • Method Details

    • createProcessInstanceDocument

      ProcessInstanceDocument createProcessInstanceDocument(ProcessInstanceDocumentCreateRequest body)
      Create the ProcessInstanceDocument Create the ProcessInstanceDocument. Use a POST method to add a document to a process instances. You can upload a document from the local file system or by URL. Specify the process instance id and the document name in the payload. The document description is optional: if you do not specify a description, the description in the response is empty. The response contains a version, which is managed automatically. You cannot currently retrieve a specific version of a document, only the most recent version. To retrieve earlier versions of a ProcessInstanceDocument, use the archivedProcessInstanceDocument resource.
      Parameters:
      body - Partial ProcessInstanceDocument description (required)
      Returns:
      ProcessInstanceDocument

    • createProcessInstanceDocumentWithHttpInfo

      ApiResponse<ProcessInstanceDocument> createProcessInstanceDocumentWithHttpInfo(ProcessInstanceDocumentCreateRequest body)
      Create the ProcessInstanceDocument Similar to createProcessInstanceDocument but it also returns the http response headers . Create the ProcessInstanceDocument. Use a POST method to add a document to a process instances. You can upload a document from the local file system or by URL. Specify the process instance id and the document name in the payload. The document description is optional: if you do not specify a description, the description in the response is empty. The response contains a version, which is managed automatically. You cannot currently retrieve a specific version of a document, only the most recent version. To retrieve earlier versions of a ProcessInstanceDocument, use the archivedProcessInstanceDocument resource.
      Parameters:
      body - Partial ProcessInstanceDocument description (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • deleteProcessInstanceDocumentById

      void deleteProcessInstanceDocumentById(String id)
      Delete the ProcessInstanceDocument by ID Delete the single ProcessInstanceDocument for the given ID
      Parameters:
      id - ID of the ProcessInstanceDocument to delete (required)

    • deleteProcessInstanceDocumentByIdWithHttpInfo

      ApiResponse<Void> deleteProcessInstanceDocumentByIdWithHttpInfo(String id)
      Delete the ProcessInstanceDocument by ID Similar to deleteProcessInstanceDocumentById but it also returns the http response headers . Delete the single ProcessInstanceDocument for the given ID
      Parameters:
      id - ID of the ProcessInstanceDocument to delete (required)

    • getProcessInstanceDocumentById

      ProcessInstanceDocument getProcessInstanceDocumentById(String id)
      Finds the ProcessInstanceDocument by ID Returns the single ProcessInstanceDocument for the given ID. Use a GET method to get a document from a process instances. First you get the document information, then you download the content. To get the document information, specify the document id in the URL. The document id is created when you upload a document to a process instances. There is no payload.
      Parameters:
      id - ID of the ProcessInstanceDocument to return (required)
      Returns:
      ProcessInstanceDocument

    • getProcessInstanceDocumentByIdWithHttpInfo

      ApiResponse<ProcessInstanceDocument> getProcessInstanceDocumentByIdWithHttpInfo(String id)
      Finds the ProcessInstanceDocument by ID Similar to getProcessInstanceDocumentById but it also returns the http response headers . Returns the single ProcessInstanceDocument for the given ID. Use a GET method to get a document from a process instances. First you get the document information, then you download the content. To get the document information, specify the document id in the URL. The document id is created when you upload a document to a process instances. There is no payload.
      Parameters:
      id - ID of the ProcessInstanceDocument to return (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchProcessInstanceDocuments

      List<ProcessInstanceDocument> searchProcessInstanceDocuments(Integer p, Integer c, List<String> f, String o)
      Finds ProcessInstanceDocuments Finds ProcessInstanceDocuments with pagination params and filters It is possible to filter on three parameters: `submittedBy`, `name` and `description`. * `submittedBy=\"id\"`: search for documents that were submitted by the user with the specified identifier. * `name=\"string\"`: search for documents with names that contain _string_. Depending on the setting for [word-based search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_ at the start of the name or the start of a word in the name. * `description=\"string\"`: search for documents with descriptions that contain _string_. Depending on the setting for [word-based search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_ at the start of the description or the start of a word in the description.
      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)
      o - can order on attributes (optional)
      Returns:
      List<ProcessInstanceDocument>

    • searchProcessInstanceDocumentsWithHttpInfo

      ApiResponse<List<ProcessInstanceDocument>> searchProcessInstanceDocumentsWithHttpInfo(Integer p, Integer c, List<String> f, String o)
      Finds ProcessInstanceDocuments Similar to searchProcessInstanceDocuments but it also returns the http response headers . Finds ProcessInstanceDocuments with pagination params and filters It is possible to filter on three parameters: `submittedBy`, `name` and `description`. * `submittedBy=\"id\"`: search for documents that were submitted by the user with the specified identifier. * `name=\"string\"`: search for documents with names that contain _string_. Depending on the setting for [word-based search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_ at the start of the name or the start of a word in the name. * `description=\"string\"`: search for documents with descriptions that contain _string_. Depending on the setting for [word-based search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_ at the start of the description or the start of a word in the description.
      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)
      o - can order on attributes (optional)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchProcessInstanceDocuments

      List<ProcessInstanceDocument> searchProcessInstanceDocuments(ProcessInstanceDocumentApi.SearchProcessInstanceDocumentsQueryParams queryParams)
      Finds ProcessInstanceDocuments Finds ProcessInstanceDocuments with pagination params and filters It is possible to filter on three parameters: `submittedBy`, `name` and `description`. * `submittedBy=\"id\"`: search for documents that were submitted by the user with the specified identifier. * `name=\"string\"`: search for documents with names that contain _string_. Depending on the setting for [word-based search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_ at the start of the name or the start of a word in the name. * `description=\"string\"`: search for documents with descriptions that contain _string_. Depending on the setting for [word-based search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_ at the start of the description or the start of a word in the description. Note, this is equivalent to the other searchProcessInstanceDocuments 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 ProcessInstanceDocumentApi.SearchProcessInstanceDocumentsQueryParams 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)
      • o - can order on attributes (optional)
      Returns:
      List<ProcessInstanceDocument>

    • searchProcessInstanceDocumentsWithHttpInfo

      ApiResponse<List<ProcessInstanceDocument>> searchProcessInstanceDocumentsWithHttpInfo(ProcessInstanceDocumentApi.SearchProcessInstanceDocumentsQueryParams queryParams)
      Finds ProcessInstanceDocuments Finds ProcessInstanceDocuments with pagination params and filters It is possible to filter on three parameters: `submittedBy`, `name` and `description`. * `submittedBy=\"id\"`: search for documents that were submitted by the user with the specified identifier. * `name=\"string\"`: search for documents with names that contain _string_. Depending on the setting for [word-based search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_ at the start of the name or the start of a word in the name. * `description=\"string\"`: search for documents with descriptions that contain _string_. Depending on the setting for [word-based search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_ at the start of the description or the start of a word in the description. Note, this is equivalent to the other searchProcessInstanceDocuments 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)
      • o - can order on attributes (optional)
      Returns:
      List<ProcessInstanceDocument>

    • updateProcessInstanceDocumentById

      void updateProcessInstanceDocumentById(String id, ProcessInstanceDocumentUpdateRequest processInstanceDocumentUpdateRequest)
      Update the ProcessInstanceDocument by ID Update the ProcessInstanceDocument for the given ID You update a document in a process instance by uploading a new version of the document using a PUT method. You can upload a document version from the local file system or by URL. The document name will be used in all the process instances of the process, but the combination of process instance id and document name is unique. In the URL, you specify to supply the document id. This is included in the response when you first add a document to a process instances. The response to PUT methods is the same as for POST methods.
      Parameters:
      id - ID of the ProcessInstanceDocument to return (required)
      processInstanceDocumentUpdateRequest - Partial ProcessInstanceDocument description (required)

    • updateProcessInstanceDocumentByIdWithHttpInfo

      ApiResponse<Void> updateProcessInstanceDocumentByIdWithHttpInfo(String id, ProcessInstanceDocumentUpdateRequest processInstanceDocumentUpdateRequest)
      Update the ProcessInstanceDocument by ID Similar to updateProcessInstanceDocumentById but it also returns the http response headers . Update the ProcessInstanceDocument for the given ID You update a document in a process instance by uploading a new version of the document using a PUT method. You can upload a document version from the local file system or by URL. The document name will be used in all the process instances of the process, but the combination of process instance id and document name is unique. In the URL, you specify to supply the document id. This is included in the response when you first add a document to a process instances. The response to PUT methods is the same as for POST methods.
      Parameters:
      id - ID of the ProcessInstanceDocument to return (required)
      processInstanceDocumentUpdateRequest - Partial ProcessInstanceDocument description (required)