ResultId |
0:TrimmedString |
|
System-wide unique identifier, which is assigned by the system. This ID can be used for fetching exactly this result using the method GetResultById and it is identical to the ResultId of the ResultReadyEventType.
If the system does not manage resultIds, it should always be set to “NA”.
|
HasTransferableDataOnFile |
0:Boolean |
Yes |
Indicates that additional data for this result can be retrieved by temporary file transfer.
If not provided, it is assumed that no file is available.
|
IsPartial |
0:Boolean |
Yes |
Indicates whether the result is the partial result of a total result. When not all samples are finished yet the result is 'partial'.
If not provided, it is assumed to be a total result.
|
IsSimulated |
0:Boolean |
Yes |
Indicates whether the result was created in simulation mode.
Simulation mode implies that the result is only generated for testing purposes and not based on real production data.
If not provided, it is assumed to not be simulated.
|
ResultState |
0:Int32 |
Yes |
ResultState provides information about the current state of the process or measurement creating a result.
Applications may use negative values for application-specific states. All other values shall only be used as defined in the following:
0 – Undefined initial value
1 – Completed: Processing was carried out completely
2 – Processing: Processing has not been finished yet
3 – Aborted: Processing was stopped at some point before completion
4 – Failed: Processing failed in some way
|
StepId |
0:TrimmedString |
Yes |
Identifies the step which produced the result.
Although the system-wide unique JobId would be sufficient to identify the job which the result belongs to, this makes for easier filtering without keeping track of JobIds.
This specification does not define how the stepId is transmitted to the system. Typically, it is provided by the client when starting an execution. |
PartId |
0:TrimmedString |
Yes |
Identifies the part used to produce the result.
Although the system-wide unique JobId would be sufficient to identify the job which the result belongs to, this makes for easier filtering without keeping track of JobIds.
This specification does not define how the partId is transmitted to the system. Typically, it is provided by the client when starting the job. |
ExternalRecipeId |
0:TrimmedString |
Yes |
External ID of the recipe in use which produced the result. The External ID is managed by the environment.
This specification does not define how the externalRecipeId is transmitted to the system. Typically, it is provided by the client. |
InternalRecipeId |
0:TrimmedString |
Yes |
Internal ID of the recipe in use which produced the result. This ID is system-wide unique and it is assigned by the system. |
ProductId |
0:TrimmedString |
Yes |
Identifies the product used to produce the result.
This specification does not define how the externalRecipeId is transmitted to the system. Typically, it is provided by the client. |
ExternalConfigurationId |
0:TrimmedString |
Yes |
External ID of the Configuration in use while the result was produced.
It is managed by the Environment.
This specification does not define how the externalConfigurationId is transmitted to the system. Typically, it is provided by the client. |
InternalConfigurationId |
0:TrimmedString |
Yes |
Internal ID of the Configuration in use while the result was produced. This ID is system-wide unique and it is assigned by the system. |
JobId |
0:TrimmedString |
Yes |
Identifies the job which produced the result.
This ID is system-wide unique and it is assigned by the system.
|
CreationTime |
0:UtcTime |
Yes |
CreationTime indicates the time when the result was created. Creation time on the measurement system (not the receive time of the server).
It is recommended to always provide the creationTime.
|
ProcessingTimes |
1:ProcessingTimesDataType |
Yes |
Collection of different processing times that were needed to create the result. |
ResultUri |
0:UriString[] |
Yes |
Path to the actual measured result, managed external to the server. |
ResultEvaluation |
1:ResultEvaluationEnum |
Yes |
The ResultEvaluation indicates whether the result was in tolerance. |
ResultEvaluationCode |
0:Int64 |
Yes |
Vendor-specific code describing more details on resultEvaluation. |
ResultEvaluationDetails |
0:LocalizedText |
Yes |
The optional EvaluationDetails provides high level status information in a user-friendly text. This can be left empty for successful operations. |
FileFormat |
0:String[] |
Yes |
The format in which the measurement results are available (e.g. QDAS, CSV, …) using the ResultTransfer Object. If multiple file formats are provided, the GenerateFileForRead of ResultTransfer should contain corresponding transferOptions, to select the file format. This specification does not define those transferOptions. |