TemplatesApi
Summary
public TemplatesDto Templates()
This function will return a list of templates that are available to the user.
public TemplatesDto Templates( TemplatesUriParameterBuilder templatesUriParameterBuilder)
This function will return a TemplatesDto object that contains a list of templates that match the criteria specified in the TemplatesUriParameterBuilder object.
public TemplateDto Template(string collectionName, string templateId)
This function will return a TemplateDto object from the API.
public StatsDto TemplateStats(string collectionName, string templateId)
This function will return a StatsDto object that contains the number of documents that have been indexed using the specified template.
public LogsDto TemplateLogs(string collectionName, string templateId)
This function returns a list of logs for a specific template.
public LogsDto TemplateLogs(string collectionName, string templateId, TemplatesUriParameterBuilder templatesUriParameterBuilder)
This function returns a list of logs for a specific template.
private readonly string _requestUriBase
private Uri TemplatesUri()
It returns a new Uri object that is the base URI for the templates endpoint
private Uri TemplatesUri( TemplatesUriParameterBuilder templatessUriParameterBuilder)
It takes a TemplatesUriParameterBuilder object as a parameter and returns a Uri object.
private Uri TemplateUri(string collectionName, string templateId)
It returns a URI for a specific template in a specific collection
private Uri TemplateStatsUri(string collectionName, string templateId)
This function returns a Uri that can be used to get the stats for a template
private Uri TemplateLogsUri(string collectionName, string templateId)
This function returns a Uri for the logs of a template
private Uri TemplateLogsUri(string collectionName, string templateId, TemplatesUriParameterBuilder templatesUriParameterBuilder)
This function returns a Uri for the logs of a template
Members
public TemplatesDto Templates()
This function will return a list of templates that are available to the user.
Returns
A TemplatesDto object
public TemplatesDto Templates( TemplatesUriParameterBuilder templatesUriParameterBuilder)
This function will return a TemplatesDto object that contains a list of templates that match the criteria specified in the TemplatesUriParameterBuilder object.
Parameters
TemplatesUriParameterBuilderThis is a class that contains all the parameters that can be passed to the API.
Returns
A TemplatesDto object.
public TemplateDto Template(string collectionName, string templateId)
This function will return a TemplateDto object from the API.
Parameters
collectionNameThe name of the collection you want to create the template in.templateIdThe id of the template you want to retrieve.
Returns
A TemplateDto object
public StatsDto TemplateStats(string collectionName, string templateId)
This function will return a StatsDto object that contains the number of documents that have been indexed using the specified template.
Parameters
collectionNameThe name of the collection you want to get the stats for.templateIdThe id of the template you want to get stats for.
Returns
A StatsDto object
public LogsDto TemplateLogs(string collectionName, string templateId)
This function returns a list of logs for a specific template.
Parameters
collectionNameThe name of the collection you want to get the logs for.templateIdThe id of the template you want to get the logs for.
Returns
A list of logs for a specific template.
public LogsDto TemplateLogs(string collectionName, string templateId, TemplatesUriParameterBuilder templatesUriParameterBuilder)
This function returns a list of logs for a specific template.
Parameters
collectionNameThe name of the collection you want to get the logs for.templateIdThe id of the template you want to get the logs for.TemplatesUriParameterBuilderThis is a class that contains all the parameters that can be passed to the API.
Returns
A LogsDto object
private readonly string _requestUriBase
private Uri TemplatesUri()
It returns a new Uri object that is the base URI for the templates endpoint
private Uri TemplatesUri( TemplatesUriParameterBuilder templatessUriParameterBuilder)
It takes a TemplatesUriParameterBuilder object as a parameter and returns a Uri object.
Parameters
TemplatesUriParameterBuilderA class that builds the query string parameters for the templates endpoint.
private Uri TemplateUri(string collectionName, string templateId)
It returns a URI for a specific template in a specific collection
Parameters
collectionNameThe name of the collection that the template belongs to.templateIdThe name of the template you want to use.
private Uri TemplateStatsUri(string collectionName, string templateId)
This function returns a Uri that can be used to get the stats for a template
Parameters
collectionNameThe name of the collection you want to use.templateIdThe template ID of the template you want to get stats for.
private Uri TemplateLogsUri(string collectionName, string templateId)
This function returns a Uri for the logs of a template
Parameters
collectionNameThe name of the collection that the template belongs to.templateIdThe ID of the template you want to get logs for.
private Uri TemplateLogsUri(string collectionName, string templateId, TemplatesUriParameterBuilder templatesUriParameterBuilder)
This function returns a Uri for the logs of a template
Parameters
collectionNameThe name of the collection that the template belongs to.templateIdThe id of the template you want to get logs for.TemplatesUriParameterBuilderThis is a class that builds the query string parameters for the request.
Last updated