public interface TemplateDefinitionsClient
| Modifier and Type | Method and Description |
|---|---|
TemplateDefinition |
getTemplateDefinition(ParametersForGetTemplateDefinition parameters)
- Returns a single template definition (including field definitions, if relevant).
- Provide a template definition ID, and get the single template definition associated with that ID. |
TemplateDefinitionCollectionResponse |
listTemplateDefinitions(ParametersForListTemplateDefinitions parameters)
- Returns all template definitions (including field definitions) in the repository.
|
void |
listTemplateDefinitionsForEach(Function<TemplateDefinitionCollectionResponse,Boolean> callback,
Integer maxPageSize,
ParametersForListTemplateDefinitions parameters)
Provides the functionality to iteratively (i.e.
|
TemplateDefinitionCollectionResponse |
listTemplateDefinitionsNextLink(String nextLink,
int maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
TemplateFieldDefinitionCollectionResponse |
listTemplateFieldDefinitionsByTemplateId(ParametersForListTemplateFieldDefinitionsByTemplateId parameters)
- Returns the field definitions assigned to a template definition.
- Provide a template definition ID, and get a paged listing of the field definitions assigned to that template. |
void |
listTemplateFieldDefinitionsByTemplateIdForEach(Function<TemplateFieldDefinitionCollectionResponse,Boolean> callback,
Integer maxPageSize,
ParametersForListTemplateFieldDefinitionsByTemplateId parameters)
Provides the functionality to iteratively (i.e.
|
TemplateFieldDefinitionCollectionResponse |
listTemplateFieldDefinitionsByTemplateIdNextLink(String nextLink,
int maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
TemplateFieldDefinitionCollectionResponse |
listTemplateFieldDefinitionsByTemplateName(ParametersForListTemplateFieldDefinitionsByTemplateName parameters)
- Returns the field definitions assigned to a template definition.
- Provide a template definition name, and get a paged listing of the field definitions assigned to that template. |
void |
listTemplateFieldDefinitionsByTemplateNameForEach(Function<TemplateFieldDefinitionCollectionResponse,Boolean> callback,
Integer maxPageSize,
ParametersForListTemplateFieldDefinitionsByTemplateName parameters)
Provides the functionality to iteratively (i.e.
|
TemplateFieldDefinitionCollectionResponse |
listTemplateFieldDefinitionsByTemplateNameNextLink(String nextLink,
int maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
TemplateDefinitionCollectionResponse listTemplateDefinitions(ParametersForListTemplateDefinitions parameters)
parameters - An object of type ParametersForListTemplateDefinitions which encapsulates the parameters of listTemplateDefinitions method.TemplateDefinitionCollectionResponse The return valueTemplateDefinitionCollectionResponse listTemplateDefinitionsNextLink(String nextLink, int maxPageSize)
nextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.TemplateDefinitionCollectionResponse The return valuevoid listTemplateDefinitionsForEach(Function<TemplateDefinitionCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListTemplateDefinitions parameters)
listTemplateDefinitions, and apply a function on the response of each iteration.callback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.maxPageSize - Optionally specify the maximum number of items to retrieve.parameters - An object of type ParametersForListTemplateDefinitions which encapsulates the parameters of listTemplateDefinitions method.TemplateFieldDefinitionCollectionResponse listTemplateFieldDefinitionsByTemplateName(ParametersForListTemplateFieldDefinitionsByTemplateName parameters)
parameters - An object of type ParametersForListTemplateFieldDefinitionsByTemplateName which encapsulates the parameters of listTemplateFieldDefinitionsByTemplateName method.TemplateFieldDefinitionCollectionResponse The return valueTemplateFieldDefinitionCollectionResponse listTemplateFieldDefinitionsByTemplateNameNextLink(String nextLink, int maxPageSize)
nextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.TemplateFieldDefinitionCollectionResponse The return valuevoid listTemplateFieldDefinitionsByTemplateNameForEach(Function<TemplateFieldDefinitionCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListTemplateFieldDefinitionsByTemplateName parameters)
listTemplateFieldDefinitionsByTemplateName, and apply a function on the response of each iteration.callback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.maxPageSize - Optionally specify the maximum number of items to retrieve.parameters - An object of type ParametersForListTemplateFieldDefinitionsByTemplateName which encapsulates the parameters of listTemplateFieldDefinitionsByTemplateName method.TemplateDefinition getTemplateDefinition(ParametersForGetTemplateDefinition parameters)
parameters - An object of type ParametersForGetTemplateDefinition which encapsulates the parameters of getTemplateDefinition method.TemplateDefinition The return valueTemplateFieldDefinitionCollectionResponse listTemplateFieldDefinitionsByTemplateId(ParametersForListTemplateFieldDefinitionsByTemplateId parameters)
parameters - An object of type ParametersForListTemplateFieldDefinitionsByTemplateId which encapsulates the parameters of listTemplateFieldDefinitionsByTemplateId method.TemplateFieldDefinitionCollectionResponse The return valueTemplateFieldDefinitionCollectionResponse listTemplateFieldDefinitionsByTemplateIdNextLink(String nextLink, int maxPageSize)
nextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.TemplateFieldDefinitionCollectionResponse The return valuevoid listTemplateFieldDefinitionsByTemplateIdForEach(Function<TemplateFieldDefinitionCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListTemplateFieldDefinitionsByTemplateId parameters)
listTemplateFieldDefinitionsByTemplateId, and apply a function on the response of each iteration.callback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.maxPageSize - Optionally specify the maximum number of items to retrieve.parameters - An object of type ParametersForListTemplateFieldDefinitionsByTemplateId which encapsulates the parameters of listTemplateFieldDefinitionsByTemplateId method.Copyright © 2025. All rights reserved.