Class RestApiTemplate.Builder
java.lang.Object
com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
- Enclosing class:
- RestApiTemplate
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddMethod(RestApiTemplate.Method method) addMethod(String name, String displayName, String description, String httpMethod, String path, Map<String, String> queryParams, String bodyTemplate) Adds a method with full configuration including displayName, description, and body template.Marks this as a template definition (includes isTemplate, templateVersion, requiredFields in JSON).auth(AuthConfig auth) build()description(String description) displayName(String displayName) requiredField(String fieldName) Adds a required field that users must fill when using this template.requiredFields(String... fields) Adds multiple required fields (varargs version).requiredFields(List<String> fields) Adds multiple required fields.templateVersion(String version) Sets the template version (default: "2.0").timeoutMs(int timeoutMs) verifySsl(boolean verifySsl)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
name
-
displayName
-
description
-
baseUrl
-
timeoutMs
-
verifySsl
-
auth
-
header
-
headers
-
addMethod
-
addMethod
-
addMethod
-
addMethod
public RestApiTemplate.Builder addMethod(String name, String displayName, String description, String httpMethod, String path, Map<String, String> queryParams, String bodyTemplate) Adds a method with full configuration including displayName, description, and body template.- Parameters:
name- Method identifierdisplayName- Human-readable namedescription- Method descriptionhttpMethod- HTTP method (GET, POST, PUT, DELETE, PATCH)path- Endpoint path (can include placeholders like {{id}})queryParams- Query parameters (can include placeholders)bodyTemplate- Body template (can include placeholders like {{field}})- Returns:
- this builder
-
asTemplate
Marks this as a template definition (includes isTemplate, templateVersion, requiredFields in JSON).- Returns:
- this builder
-
templateVersion
Sets the template version (default: "2.0").- Parameters:
version- Template version string- Returns:
- this builder
-
requiredField
Adds a required field that users must fill when using this template.- Parameters:
fieldName- Name of the required field (e.g., "baseUrl", "token", "username")- Returns:
- this builder
-
requiredFields
Adds multiple required fields.- Parameters:
fields- List of required field names- Returns:
- this builder
-
requiredFields
Adds multiple required fields (varargs version).- Parameters:
fields- Required field names- Returns:
- this builder
-
build
-