Parameter Name
|
Base Type
|
Description
|
Result
|
modelName
|
String
|
Specifies the name of the model. If a fileURL is specified, then the model name should be the file name without the extension.
|
Returns the ID of the model. Throws an exception if there are any errors, such as invalid fileURL, model not found, and so on.
|
description
|
String
|
Specifies the model description.
|
|
providerName
|
String
|
Specifies the name of the provider.
|
|
fileURL
|
Hyperlink
|
Specifies the URL to the model file, which must be uploaded to the TW.AnalysisServices.ModelRepository folder, a ThingWorx repository. Use the following format: /Thingworx/FileRepositories/TW.AnalysisServices.ModelRepository/<AnalysisProviderName>/<FileName>
|
|
inputsToResultsCardinality
|
String
|
Depending on how you want to configure the analysis model, specify the inputs to results relationship as one of the following:
• Any — Creates multiple results from multiple inputs. The number of results is not equal to the number of inputs.
• NxN — Creates multiple results from multiple inputs. The number of results must be equal to the number of inputs.
• Nx1 — Creates a single result from multiple inputs.
• 1xN — Creates multiple results from a single input.
• 1x1 — Creates a single result from a single input.
The default value is Any.
|
|
customData
|
Infotable
|
Specifies any additional information that is customer-specific about a model.
|
Parameter Name
|
Base Type
|
Description
|
Result
|
modelName
|
String
|
Specifies the name of the model.
|
Returns the ID of the model. Throws an exception if the input JSON or result JSON is not provided.
|
description
|
String
|
Specifies the model description.
|
|
providerName
|
String
|
Specifies the name of the provider.
|
|
inputDatashapeJson
|
JSON
|
Specifies a JSON array representing the input data shape. See the format of the JSON below the table.
|
|
outputDatashapeJson
|
JSON
|
Specifies a JSON array representing the result data shape.
|
|
inputsToResultsCardinality
|
String
|
Depending on how you want to configure the analysis model, specify the inputs to results relationship as one of the following:
• Any — Creates multiple results from multiple inputs. The number of results is not equal to the number of inputs.
• NxN — Creates multiple results from multiple inputs. The number of results must be equal to the number of inputs.
• Nx1 — Creates a single result from multiple inputs.
• 1xN — Creates multiple results from a single input.
• 1x1 — Creates a single result from a single input.
The default value is Any.
|
|
customData
|
Infotable
|
Specifies any additional information that is customer-specific about a model.
|
Parameter Name
|
Base Type
|
Description
|
Result
|
modelName
|
String
|
Specifies the name of the model.
|
Returns the ID of the model. Throws an exception if the input JSON or result JSON is not provided.
|
description
|
String
|
Specifies the model description.
|
|
providerName
|
String
|
Specifies the name of the provider.
|
|
fileURL
|
Hyperlink
|
Specifies the URL to the model file, which must be uploaded to the TW.AnalysisServices.ModelRepository folder, a ThingWorx repository. Use the following format: /Thingworx/FileRepositories/TW.AnalysisServices.ModelRepository/<AnalysisProviderName>/<FileName>
|
|
inputDatashapeJson
|
JSON
|
Specifies a JSON array representing the input data shape. See the format of the JSON below the table.
|
|
outputDatashapeJson
|
JSON
|
Specifies a JSON array representing the result data shape.
|
|
inputsToResultsCardinality
|
String
|
Depending on how you want to configure the analysis model, specify the inputs to results relationship as one of the following:
• Any — Creates multiple results from multiple inputs. The number of results is not equal to the number of inputs.
• NxN — Creates multiple results from multiple inputs. The number of results must be equal to the number of inputs.
• Nx1 — Creates a single result from multiple inputs.
• 1xN — Creates multiple results from a single input.
• 1x1 — Creates a single result from a single input.
The default value is Any.
|
|
customData
|
Infotable
|
Specifies any additional information that is customer-specific about a model.
|
Parameter Name
|
Base Type
|
Description
|
Result
|
modelName
|
String
|
Specifies the name of the model.
|
Returns the name of the thing that is created.
Throws an exception if the thing exists, and is not inherited from the thing template.
|
providerName
|
String
|
Specifies the name of the provider.
|
|
templateName
|
String
|
Specifies the name of the thing template from which the thing inherits the input and result data shape properties.
|
|
forceUpdate
|
Boolean
|
If the thing exists, and the properties or data shapes of the model have changed, set the value of forceUpdate to true to update the thing.
If there is a name or type conflict on the input properties, the old property on the thing is deleted and recreated. If there is a name or type conflict on the result properties, a warning is displayed and the property is created with a _result suffix.
If forceUpdate is set to true, and the name conflict is not across inputs and results, then the old property is deleted and recreated.
If properties exist on the thing, and the value of forceUpdate is set to false, the operation fails, and the service throws an exception.
|
|
prefixInputsAndResults
|
Boolean
|
Set to true so that the input properties on the thing are prefixed with ia, and the result properties are prefixed with ra.
|
Parameter Name
|
Base Type
|
Description
|
Result
|
modelName
|
String
|
Specifies the name of the model.
|
Returns the name of the thing shape that is created.
|
providerName
|
String
|
Specifies the name of the provider.
|
|
forceUpdate
|
Boolean
|
If the thing shape exists, and the properties or data shapes of the model have changed, set the value of forceUpdate to true to update the thing shape.
If there is a name or type conflict on the input properties, the old property on the thing shape is deleted and recreated. If there is a name or type conflict on the result properties, a warning is displayed and the property is created with a _result suffix.
If forceUpdate is set to true, and the name conflict is not across inputs and results, then the old property is deleted and recreated.
If properties exist on the thing shape, and the value of forceUpdate is set to false, the operation fails, and the service throws an exception.
|
|
prefixInputsAndResults
|
Boolean
|
Set to true so that the input properties on the thing shape are prefixed with ia, and the result properties are prefixed with ra.
|
Parameter Name
|
Base Type
|
Description
|
Result
|
modelName
|
String
|
Specifies the name of the model.
|
Returns the name of the thing that is created.
Throws an exception if the thing exists, and is not inherited from the thing shape.
|
providerName
|
String
|
Specifies the name of the provider.
|
|
templateName
|
String
|
Specifies the name of the thing template from which the thing inherits the input and result data shape properties.
|
|
forceUpdate
|
Boolean
|
If the thing shape exists, and the properties or data shapes of the model have changed, set the value of forceUpdate to true to update the thing shape.
If there is a name or type conflict on the input properties, the old property on the thing shape is deleted and recreated. If there is a name or type conflict on the result properties, a warning is displayed and the property is created with a _result suffix.
If forceUpdate is set to true, and the name conflict is not across inputs and results, then the old property is deleted and recreated.
If properties exist on the thing template, and the value of forceUpdate is set to false, the operation fails, and the service throws an exception.
|
|
prefixInputsAndResults
|
Boolean
|
Set to true so that the input properties on the thing shape are prefixed with ia, and the result properties are prefixed with ra.
|
Parameter Name
|
Base Type
|
Description
|
Result
|
modelName
|
String
|
Specifies the name of the model.
|
Returns the name of the thing template that is created.
Throws an exception if the thing template exists.
|
providerName
|
String
|
Specifies the name of the provider.
|
|
forceUpdate
|
Boolean
|
If the thing template exists, and the properties or data shapes of the model have changed, set the value of forceUpdate to true to update the thing template.
If there is a name or type conflict on the input properties, the old property on the thing template is deleted and recreated. If there is a name or type conflict on the result properties, a warning is displayed and the property is created with a _result suffix.
If forceUpdate is set to true, and the name conflict is not across inputs and results, then the old property is deleted and recreated.
If properties exist on the thing template, and the value of forceUpdate is set to false, the operation fails, and the service throws an exception.
|
|
prefixInputsAndResults
|
Boolean
|
Set to true so that the input properties on the thing template are prefixed with ia, and the result properties are prefixed with ra.
|
Parameter Name
|
Base Type
|
Description
|
Result
|
modelName
|
String
|
Specifies the name of the model.
|
Returns the name of the thing that is created.
Throws an exception if the thing exists, and is not inherited from the thing template.
|
providerName
|
String
|
Specifies the name of the provider.
|
|
forceUpdate
|
Boolean
|
If the thing template exists, and the properties or data shapes of the model have changed, set the value of forceUpdate to true to update the thing template.
If there is a name or type conflict on the input properties, the old property on the thing template is deleted and recreated. If there is a name or type conflict on the result properties, a warning is displayed and the property is created with a _result suffix.
If forceUpdate is set to true, and the name conflict is not across inputs and results, then the old property is deleted and recreated.
If properties exist on the thing template, and the value of forceUpdate is set to false, the operation fails, and the service throws an exception.
|
|
prefixInputsAndResults
|
Boolean
|
Set to true so that the input properties on the thing template are prefixed with ia, and the result properties are prefixed with ra.
|
Parameter Name
|
Base Type
|
Description
|
Result
|
modelName
|
String
|
Specifies the name of the model.
|
Returns a message that states the successful completion or errors that occur during the execution of the service.
|
providerName
|
String
|
Specifies the name of the provider.
|
Parameter Name
|
Base Type
|
Description
|
Result
|
modelName
|
String
|
Specifies the name of the model.
|
Returns a message that states the successful completion or errors that occur during the execution of the service.
|
providerName
|
String
|
Specifies the name of the provider.
|
Parameter Name
|
Base Type
|
Description
|
Result
|
modelName
|
String
|
Specifies the name of the model. If a fileURL is specified, then the model name should be the file name without the extension.
|
Returns the ID of the model.
|
description
|
String
|
Specifies the model description.
|
|
providerName
|
String
|
Specifies the name of the provider.
|
|
inputDatashapeJson
|
JSON
|
This parameter is optional. It is required only if the input data shape is to be edited. A JSON array represents the input data shape. See the format of the JSON below the table.
|
|
outputDatashapeJson
|
JSON
|
This parameter is optional. It is required only if the result data shape is to be edited. A JSON array represents the result data shape.
|
|
inputsToResultsCardinality
|
String
|
Depending on how you want to configure the analysis model, specify the inputs to results relationship as one of the following:
• Any — Creates multiple results from multiple inputs. The number of results is not equal to the number of inputs.
• NxN — Creates multiple results from multiple inputs. The number of results must be equal to the number of inputs.
• Nx1 — Creates a single result from multiple inputs.
• 1xN — Creates multiple results from a single input.
• 1x1 — Creates a single result from a single input.
The default value is Any.
|
|
customData
|
Infotable
|
Specifies any additional information that is customer-specific about a model.
|
Parameter Name
|
Base Type
|
Description
|
Result
|
modelName
|
String
|
Specifies the name of the model.
|
Returns the ID of the model. Throws an exception if there are any errors, such as invalid fileURL, model not found, and so on.
|
description
|
String
|
Specifies the model description.
|
|
providerName
|
String
|
Specifies the name of the provider.
|
|
fileURL
|
Hyperlink
|
Specifies the URL to the model file, which must be uploaded to the TW.AnalysisServices.ModelRepository folder, a ThingWorx repository. Use the following format: /Thingworx/FileRepositories/TW.AnalysisServices.ModelRepository/<AnalysisProviderName>/<FileName>
|
|
inputsToResultsCardinality
|
String
|
Depending on how you want to configure the analysis model, specify the inputs to results relationship as one of the following:
• Any — Creates an undefined inputs to results relationship.
• NxN — Creates multiple results from multiple inputs.
• Nx1 — Creates a single result from multiple inputs.
• 1xN — Creates multiple results from a single input.
• 1x1 — Creates a single result from a single input.
The default value is Any.
|
|
customData
|
Infotable
|
Specifies any additional information that is customer-specific about a model.
|
Parameter Name
|
Base Type
|
Description
|
Result
|
modelName
|
String
|
Specifies the name of the model.
|
Returns a message that states the successful completion or errors that occur during the execution of the service.
|
providerName
|
String
|
Specifies the name of the provider.
|
Parameter Name
|
Base Type
|
Description
|
Result
|
modelName
|
String
|
Specifies the name of the model.
|
Returns information about the model in the form of an infotable that has the TW.AnalysisServices.ModelDataShape data shape.
|
providerName
|
String
|
Specifies the name of the provider.
|
|
Provide inputs for either the values or query parameter.
|
Parameter Name
|
Base Type
|
Description
|
Result
|
values
|
Infotable
|
Specifies the attributes of the model in the form of a collection of multiple value rows.
|
Returns information about the model in the form of an infotable that has the TW.AnalysisServices.ModelDataShape data shape.
|
query
|
Query
|
Specifies the query that includes what information is required about a particular model.
|