Package org.camunda.community.rest.client.api

Class DecisionRequirementsDefinitionApi

java.lang.Object
org.camunda.community.rest.client.api.DecisionRequirementsDefinitionApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class DecisionRequirementsDefinitionApi extends Object

  • Constructor Details

    • DecisionRequirementsDefinitionApi

      public DecisionRequirementsDefinitionApi()

    • DecisionRequirementsDefinitionApi

      public DecisionRequirementsDefinitionApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getDecisionRequirementsDefinitionById

      public DecisionRequirementsDefinitionDto getDecisionRequirementsDefinitionById(String id) throws ApiException
      Get Decision Requirements Definition by ID Retrieves a decision requirements definition according to the `DecisionRequirementsDefinition` interface in the engine.
      Parameters:
      id - The id of the decision requirements definition to be retrieved. (required)
      Returns:
      DecisionRequirementsDefinitionDto
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionById

      public DecisionRequirementsDefinitionDto getDecisionRequirementsDefinitionById(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Decision Requirements Definition by ID Retrieves a decision requirements definition according to the `DecisionRequirementsDefinition` interface in the engine.
      Parameters:
      id - The id of the decision requirements definition to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      DecisionRequirementsDefinitionDto
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionByKey

      public DecisionRequirementsDefinitionDto getDecisionRequirementsDefinitionByKey(String key) throws ApiException
      Get Decision Requirements Definition by Key Retrieves a decision requirements definition according to the `DecisionRequirementsDefinition` interface in the engine. Returns the latest version of the decision requirements definition which belongs to no tenant.
      Parameters:
      key - The key of the decision requirements definition (the latest version thereof) to be retrieved. (required)
      Returns:
      DecisionRequirementsDefinitionDto
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionByKey

      public DecisionRequirementsDefinitionDto getDecisionRequirementsDefinitionByKey(String key, Map<String,String> additionalHeaders) throws ApiException
      Get Decision Requirements Definition by Key Retrieves a decision requirements definition according to the `DecisionRequirementsDefinition` interface in the engine. Returns the latest version of the decision requirements definition which belongs to no tenant.
      Parameters:
      key - The key of the decision requirements definition (the latest version thereof) to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      DecisionRequirementsDefinitionDto
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionByKeyAndTenantId

      public DecisionRequirementsDefinitionDto getDecisionRequirementsDefinitionByKeyAndTenantId(String key, String tenantId) throws ApiException
      Get Decision Requirements Definition by Key and Tenant ID Retrieves a decision requirements definition according to the `DecisionRequirementsDefinition` interface in the engine. Returns the latest version of the decision requirements definition for a tenant.
      Parameters:
      key - The key of the decision requirements definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant to which the decision requirements definition belongs to. (required)
      Returns:
      DecisionRequirementsDefinitionDto
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionByKeyAndTenantId

      public DecisionRequirementsDefinitionDto getDecisionRequirementsDefinitionByKeyAndTenantId(String key, String tenantId, Map<String,String> additionalHeaders) throws ApiException
      Get Decision Requirements Definition by Key and Tenant ID Retrieves a decision requirements definition according to the `DecisionRequirementsDefinition` interface in the engine. Returns the latest version of the decision requirements definition for a tenant.
      Parameters:
      key - The key of the decision requirements definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant to which the decision requirements definition belongs to. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      DecisionRequirementsDefinitionDto
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionDiagramById

      public File getDecisionRequirementsDefinitionDiagramById(String id) throws ApiException
      Get Decision Requirements Diagram by ID Retrieves the diagram of a decision requirements definition.
      Parameters:
      id - The id of the decision requirements definition. (required)
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionDiagramById

      public File getDecisionRequirementsDefinitionDiagramById(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Decision Requirements Diagram by ID Retrieves the diagram of a decision requirements definition.
      Parameters:
      id - The id of the decision requirements definition. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionDiagramByKey

      public File getDecisionRequirementsDefinitionDiagramByKey(String key) throws ApiException
      Get Decision Requirements Diagram by Key Retrieves the diagram of a decision requirements definition. Returns the diagram for the latest version of the decision requirements definition which belongs to no tenant.
      Parameters:
      key - The key of the decision requirements definition (the latest version thereof) to be retrieved. (required)
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionDiagramByKey

      public File getDecisionRequirementsDefinitionDiagramByKey(String key, Map<String,String> additionalHeaders) throws ApiException
      Get Decision Requirements Diagram by Key Retrieves the diagram of a decision requirements definition. Returns the diagram for the latest version of the decision requirements definition which belongs to no tenant.
      Parameters:
      key - The key of the decision requirements definition (the latest version thereof) to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionDiagramByKeyAndTenantId

      public File getDecisionRequirementsDefinitionDiagramByKeyAndTenantId(String key, String tenantId) throws ApiException
      Get Decision Requirements Diagram by Key and Tenant ID Retrieves the diagram of a decision requirements definition. Returns the diagram of the latest version of the decision requirements definition for a tenant.
      Parameters:
      key - The key of the decision requirements definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant to which the decision requirements definition belongs to. (required)
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionDiagramByKeyAndTenantId

      public File getDecisionRequirementsDefinitionDiagramByKeyAndTenantId(String key, String tenantId, Map<String,String> additionalHeaders) throws ApiException
      Get Decision Requirements Diagram by Key and Tenant ID Retrieves the diagram of a decision requirements definition. Returns the diagram of the latest version of the decision requirements definition for a tenant.
      Parameters:
      key - The key of the decision requirements definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant to which the decision requirements definition belongs to. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionDmnXmlById

      public DecisionRequirementsDefinitionXmlDto getDecisionRequirementsDefinitionDmnXmlById(String id) throws ApiException
      Get DMN XML by ID Retrieves the DMN XML of a decision requirements definition.
      Parameters:
      id - The id of the decision requirements definition. (required)
      Returns:
      DecisionRequirementsDefinitionXmlDto
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionDmnXmlById

      public DecisionRequirementsDefinitionXmlDto getDecisionRequirementsDefinitionDmnXmlById(String id, Map<String,String> additionalHeaders) throws ApiException
      Get DMN XML by ID Retrieves the DMN XML of a decision requirements definition.
      Parameters:
      id - The id of the decision requirements definition. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      DecisionRequirementsDefinitionXmlDto
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionDmnXmlByKey

      public DecisionRequirementsDefinitionXmlDto getDecisionRequirementsDefinitionDmnXmlByKey(String key) throws ApiException
      Get DMN XML by Key Retrieves the DMN XML of a decision requirements definition. Returns the XML for the latest version of the decision requirements definition which belongs to no tenant.
      Parameters:
      key - The key of the decision requirements definition (the latest version thereof) to be retrieved. (required)
      Returns:
      DecisionRequirementsDefinitionXmlDto
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionDmnXmlByKey

      public DecisionRequirementsDefinitionXmlDto getDecisionRequirementsDefinitionDmnXmlByKey(String key, Map<String,String> additionalHeaders) throws ApiException
      Get DMN XML by Key Retrieves the DMN XML of a decision requirements definition. Returns the XML for the latest version of the decision requirements definition which belongs to no tenant.
      Parameters:
      key - The key of the decision requirements definition (the latest version thereof) to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      DecisionRequirementsDefinitionXmlDto
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionDmnXmlByKeyAndTenantId

      public DecisionRequirementsDefinitionXmlDto getDecisionRequirementsDefinitionDmnXmlByKeyAndTenantId(String key, String tenantId) throws ApiException
      Get DMN XML by Key and Tenant ID Retrieves the DMN XML of a decision requirements definition. Returns the XML of the latest version of the decision requirements definition for a tenant.
      Parameters:
      key - The key of the decision requirements definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant to which the decision requirements definition belongs to. (required)
      Returns:
      DecisionRequirementsDefinitionXmlDto
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionDmnXmlByKeyAndTenantId

      public DecisionRequirementsDefinitionXmlDto getDecisionRequirementsDefinitionDmnXmlByKeyAndTenantId(String key, String tenantId, Map<String,String> additionalHeaders) throws ApiException
      Get DMN XML by Key and Tenant ID Retrieves the DMN XML of a decision requirements definition. Returns the XML of the latest version of the decision requirements definition for a tenant.
      Parameters:
      key - The key of the decision requirements definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant to which the decision requirements definition belongs to. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      DecisionRequirementsDefinitionXmlDto
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitions

      public List<DecisionRequirementsDefinitionDto> getDecisionRequirementsDefinitions(String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionIdIn, String name, String nameLike, String deploymentId, String key, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String tenantIdIn, Boolean withoutTenantId, Boolean includeDecisionRequirementsDefinitionsWithoutTenantId, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) throws ApiException
      Get Decision Requirements Definitions Queries for decision requirements definitions that fulfill given parameters. Parameters may be the properties of decision requirements definitions, such as the name, key or version. The size of the result set can be retrieved by using the [Get Decision Requirements Definition Count](https://docs.camunda.org/manual/7.21/reference/rest/decision-requirements-definition/get-query-count/) method.
      Parameters:
      decisionRequirementsDefinitionId - Filter by decision requirements definition id. (optional)
      decisionRequirementsDefinitionIdIn - Filter by decision requirements definition ids. (optional)
      name - Filter by decision requirements definition name. (optional)
      nameLike - Filter by decision requirements definition names that the parameter is a substring of. (optional)
      deploymentId - Filter by the id of the deployment a decision requirement definition belongs to. (optional)
      key - Filter by decision requirements definition key, i.e., the id in the DMN 1.3 XML. Exact match. (optional)
      keyLike - Filter by decision requirements definition keys that the parameter is a substring of. (optional)
      category - Filter by decision requirements definition category. Exact match. (optional)
      categoryLike - Filter by decision requirements definition categories that the parameter is a substring of. (optional)
      version - Filter by decision requirements definition version. (optional)
      latestVersion - Only include those decision requirements definitions that are latest versions. Value may only be `true`, as `false` is the default behavior. (optional)
      resourceName - Filter by the name of the decision requirements definition resource. Exact match. (optional)
      resourceNameLike - Filter by names of those decision requirements definition resources that the parameter is a substring of. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A decision requirements definition must have one of the given tenant ids. (optional)
      withoutTenantId - Only include decision requirements definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      includeDecisionRequirementsDefinitionsWithoutTenantId - Include decision requirements definitions which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional)
      sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
      sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
      firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
      maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
      Returns:
      List<DecisionRequirementsDefinitionDto>
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitions

      public List<DecisionRequirementsDefinitionDto> getDecisionRequirementsDefinitions(String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionIdIn, String name, String nameLike, String deploymentId, String key, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String tenantIdIn, Boolean withoutTenantId, Boolean includeDecisionRequirementsDefinitionsWithoutTenantId, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders) throws ApiException
      Get Decision Requirements Definitions Queries for decision requirements definitions that fulfill given parameters. Parameters may be the properties of decision requirements definitions, such as the name, key or version. The size of the result set can be retrieved by using the [Get Decision Requirements Definition Count](https://docs.camunda.org/manual/7.21/reference/rest/decision-requirements-definition/get-query-count/) method.
      Parameters:
      decisionRequirementsDefinitionId - Filter by decision requirements definition id. (optional)
      decisionRequirementsDefinitionIdIn - Filter by decision requirements definition ids. (optional)
      name - Filter by decision requirements definition name. (optional)
      nameLike - Filter by decision requirements definition names that the parameter is a substring of. (optional)
      deploymentId - Filter by the id of the deployment a decision requirement definition belongs to. (optional)
      key - Filter by decision requirements definition key, i.e., the id in the DMN 1.3 XML. Exact match. (optional)
      keyLike - Filter by decision requirements definition keys that the parameter is a substring of. (optional)
      category - Filter by decision requirements definition category. Exact match. (optional)
      categoryLike - Filter by decision requirements definition categories that the parameter is a substring of. (optional)
      version - Filter by decision requirements definition version. (optional)
      latestVersion - Only include those decision requirements definitions that are latest versions. Value may only be `true`, as `false` is the default behavior. (optional)
      resourceName - Filter by the name of the decision requirements definition resource. Exact match. (optional)
      resourceNameLike - Filter by names of those decision requirements definition resources that the parameter is a substring of. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A decision requirements definition must have one of the given tenant ids. (optional)
      withoutTenantId - Only include decision requirements definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      includeDecisionRequirementsDefinitionsWithoutTenantId - Include decision requirements definitions which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional)
      sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
      sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
      firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
      maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<DecisionRequirementsDefinitionDto>
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionsCount

      public CountResultDto getDecisionRequirementsDefinitionsCount(String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionIdIn, String name, String nameLike, String deploymentId, String key, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String tenantIdIn, Boolean withoutTenantId, Boolean includeDecisionRequirementsDefinitionsWithoutTenantId) throws ApiException
      Get Decision Requirements Definition Count Requests the number of decision requirements definitions that fulfill the query criteria. Takes the same filtering parameters as the [Get Decision Requirements Definitions](https://docs.camunda.org/manual/7.21/reference/rest/decision-requirements-definition/get-query/) method.
      Parameters:
      decisionRequirementsDefinitionId - Filter by decision requirements definition id. (optional)
      decisionRequirementsDefinitionIdIn - Filter by decision requirements definition ids. (optional)
      name - Filter by decision requirements definition name. (optional)
      nameLike - Filter by decision requirements definition names that the parameter is a substring of. (optional)
      deploymentId - Filter by the id of the deployment a decision requirement definition belongs to. (optional)
      key - Filter by decision requirements definition key, i.e., the id in the DMN 1.3 XML. Exact match. (optional)
      keyLike - Filter by decision requirements definition keys that the parameter is a substring of. (optional)
      category - Filter by decision requirements definition category. Exact match. (optional)
      categoryLike - Filter by decision requirements definition categories that the parameter is a substring of. (optional)
      version - Filter by decision requirements definition version. (optional)
      latestVersion - Only include those decision requirements definitions that are latest versions. Value may only be `true`, as `false` is the default behavior. (optional)
      resourceName - Filter by the name of the decision requirements definition resource. Exact match. (optional)
      resourceNameLike - Filter by names of those decision requirements definition resources that the parameter is a substring of. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A decision requirements definition must have one of the given tenant ids. (optional)
      withoutTenantId - Only include decision requirements definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      includeDecisionRequirementsDefinitionsWithoutTenantId - Include decision requirements definitions which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getDecisionRequirementsDefinitionsCount

      public CountResultDto getDecisionRequirementsDefinitionsCount(String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionIdIn, String name, String nameLike, String deploymentId, String key, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String tenantIdIn, Boolean withoutTenantId, Boolean includeDecisionRequirementsDefinitionsWithoutTenantId, Map<String,String> additionalHeaders) throws ApiException
      Get Decision Requirements Definition Count Requests the number of decision requirements definitions that fulfill the query criteria. Takes the same filtering parameters as the [Get Decision Requirements Definitions](https://docs.camunda.org/manual/7.21/reference/rest/decision-requirements-definition/get-query/) method.
      Parameters:
      decisionRequirementsDefinitionId - Filter by decision requirements definition id. (optional)
      decisionRequirementsDefinitionIdIn - Filter by decision requirements definition ids. (optional)
      name - Filter by decision requirements definition name. (optional)
      nameLike - Filter by decision requirements definition names that the parameter is a substring of. (optional)
      deploymentId - Filter by the id of the deployment a decision requirement definition belongs to. (optional)
      key - Filter by decision requirements definition key, i.e., the id in the DMN 1.3 XML. Exact match. (optional)
      keyLike - Filter by decision requirements definition keys that the parameter is a substring of. (optional)
      category - Filter by decision requirements definition category. Exact match. (optional)
      categoryLike - Filter by decision requirements definition categories that the parameter is a substring of. (optional)
      version - Filter by decision requirements definition version. (optional)
      latestVersion - Only include those decision requirements definitions that are latest versions. Value may only be `true`, as `false` is the default behavior. (optional)
      resourceName - Filter by the name of the decision requirements definition resource. Exact match. (optional)
      resourceNameLike - Filter by names of those decision requirements definition resources that the parameter is a substring of. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A decision requirements definition must have one of the given tenant ids. (optional)
      withoutTenantId - Only include decision requirements definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      includeDecisionRequirementsDefinitionsWithoutTenantId - Include decision requirements definitions which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call