Package io.dialob.api.client

Interface DialobFormServiceApi

All Superinterfaces:

ApiClient.Api

@Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen",
           date="2023-03-15T08:57:32.972245Z[Etc/UTC]")
public interface DialobFormServiceApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DialobFormServiceApi.GetFormQueryParams	A convenience class for generating query parameters for the getForm method in a fluent style.
static class	DialobFormServiceApi.GetTagsQueryParams	A convenience class for generating query parameters for the getTags method in a fluent style.
static class	DialobFormServiceApi.PostFormTagQueryParams	A convenience class for generating query parameters for the postFormTag method in a fluent style.
static class	DialobFormServiceApi.PutFormQueryParams	A convenience class for generating query parameters for the putForm method in a fluent style.

Method Summary

Modifier and Type	Method	Description
Response	deleteForm(String formId)	deleteForm
Form	getForm(String formId, String rev)	getForm
Form	getForm(String formId, Map<String,Object> queryParams)	getForm Note, this is equivalent to the other getForm method, but with the query parameters collected into a single Map parameter.
FormTag	getFormTag(String formId, String tagName)	getFormTag
List<FormTag>	getFormTags(String formId)	getFormTags
List<FormTag>	getTags(String formId, String formName, String name)	getTags
List<FormTag>	getTags(Map<String,Object> queryParams)	getTags Note, this is equivalent to the other getTags method, but with the query parameters collected into a single Map parameter.
Form	postForm(Form body)	postForm
Response	postFormTag(FormTag body, String formId, String rev, Boolean snapshot)	postFormTag
Response	postFormTag(FormTag body, String formId, Map<String,Object> queryParams)	postFormTag Note, this is equivalent to the other postFormTag method, but with the query parameters collected into a single Map parameter.
FormPutResponse	putForm(Form body, String formId, Boolean force, String newId, String oldId)	putForm
FormPutResponse	putForm(Form body, String formId, Map<String,Object> queryParams)	putForm Note, this is equivalent to the other putForm method, but with the query parameters collected into a single Map parameter.
Response	putFormTagLatest(FormTag body, String formId)	putFormTagLatest

Method Detail

deleteForm

Response deleteForm(String formId)

deleteForm

Parameters:

formId - formId (required)

Returns:

Response

getForm

Form getForm(String formId,
             String rev)

getForm

Parameters:

formId - formId (required)

rev - rev (optional)

Returns:

Form

getForm

Form getForm(String formId,
             Map<String,Object> queryParams)

getForm Note, this is equivalent to the other getForm 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 DialobFormServiceApi.GetFormQueryParams class that allows for building up this map in a fluent style.

Parameters:

formId - formId (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• rev - rev (optional)

Returns:

Form

getFormTag

FormTag getFormTag(String formId,
                   String tagName)

getFormTag

Parameters:

formId - formId (required)

tagName - tagName (required)

Returns:

FormTag

getFormTags

List<FormTag> getFormTags(String formId)

getFormTags

Parameters:

formId - formId (required)

Returns:

List<FormTag>

getTags

List<FormTag> getTags(String formId,
                      String formName,
                      String name)

getTags

Parameters:

formId - formId (optional)

formName - formName (optional)

name - name (optional)

Returns:

List<FormTag>

getTags

List<FormTag> getTags(Map<String,Object> queryParams)

getTags Note, this is equivalent to the other getTags 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 DialobFormServiceApi.GetTagsQueryParams 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:

• formId - formId (optional)
• formName - formName (optional)
• name - name (optional)

Returns:

List<FormTag>

postForm

Form postForm(Form body)

postForm

Parameters:

body - New form (required)

Returns:

Form

postFormTag

Response postFormTag(FormTag body,
                     String formId,
                     String rev,
                     Boolean snapshot)

postFormTag

Parameters:

body - New tag (required)

formId - formId (required)

rev - rev (optional)

snapshot - snapshot (optional, default to false)

Returns:

Response

postFormTag

Response postFormTag(FormTag body,
                     String formId,
                     Map<String,Object> queryParams)

postFormTag Note, this is equivalent to the other postFormTag 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 DialobFormServiceApi.PostFormTagQueryParams class that allows for building up this map in a fluent style.

Parameters:

body - New tag (required)

formId - formId (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• rev - rev (optional)
• snapshot - snapshot (optional, default to false)

Returns:

Response

putForm

FormPutResponse putForm(Form body,
                        String formId,
                        Boolean force,
                        String newId,
                        String oldId)

putForm

Parameters:

body - New form data (required)

formId - formId (required)

force - Should update ignore revision number check. (forced update) (optional, default to false)

newId - New name for identifier (optional)

oldId - Identifier to rename (optional)

Returns:

FormPutResponse

putForm

FormPutResponse putForm(Form body,
                        String formId,
                        Map<String,Object> queryParams)

putForm Note, this is equivalent to the other putForm 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 DialobFormServiceApi.PutFormQueryParams class that allows for building up this map in a fluent style.

Parameters:

body - New form data (required)

formId - formId (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• force - Should update ignore revision number check. (forced update) (optional, default to false)
• newId - New name for identifier (optional)
• oldId - Identifier to rename (optional)

Returns:

FormPutResponse

putFormTagLatest

Response putFormTagLatest(FormTag body,
                          String formId)

putFormTagLatest

Parameters:

body - param1 (required)

formId - formId (required)

Returns:

Response