Messages
Data models used across requests/responses.CountTestMeasurementsRequest
Request message for CountTestMeasurements| Field | Type | Label | Description |
|---|---|---|---|
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are measurement_id, measurement_type, name, test_step_id, test_report_id, numeric_value, string_value, boolean_value, passed, timestamp, created_date, and modified_date. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional. |
CountTestMeasurementsResponse
Response message for CountTestMeasurements| Field | Type | Label | Description |
|---|---|---|---|
| count | int64 | The total count of test measurements matching the filter |
CountTestStepsRequest
Request message for CountTestSteps| Field | Type | Label | Description |
|---|---|---|---|
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are test_step_id, test_report_id, parent_step_id, name, description, step_type, step_path, status, start_time, end_time, error_code, error_message, created_date, and modified_date. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional. |
CountTestStepsResponse
Response message for CountTestSteps| Field | Type | Label | Description |
|---|---|---|---|
| count | int64 | The total count of test steps matching the filter |
CreateTestMeasurementRequest
Request message for CreateTestMeasurement| Field | Type | Label | Description |
|---|---|---|---|
| test_measurement | TestMeasurement | The test measurement to create |
CreateTestMeasurementResponse
Response message for CreateTestMeasurement| Field | Type | Label | Description |
|---|---|---|---|
| test_measurement | TestMeasurement | The created test measurement |
CreateTestMeasurementsRequest
Request message for CreateTestMeasurements| Field | Type | Label | Description |
|---|---|---|---|
| test_measurements | TestMeasurement | repeated | The test measurements to create |
CreateTestMeasurementsResponse
Response message for CreateTestMeasurementsCreateTestReportRequest
Request message for CreateTestReport| Field | Type | Label | Description |
|---|---|---|---|
| status | TestStatus | The status of the test run | |
| name | string | The name of the test run | |
| test_system_name | string | The name of the test system | |
| test_case | string | The test case that was run | |
| start_time | google.protobuf.Timestamp | The start time of the test run | |
| end_time | google.protobuf.Timestamp | The end time of the test run | |
| metadata | sift.metadata.v1.MetadataValue | repeated | The metadata values associated with this test run |
| serial_number | string | The serial number for the DUT | |
| part_number | string | The part number for the DUT | |
| system_operator | string | Unique identifier for user owner | |
| run_id | string | The run ID for the test report |
CreateTestReportResponse
Response message for CreateTestReport| Field | Type | Label | Description |
|---|---|---|---|
| test_report | TestReport | The created test report |
CreateTestStepRequest
Request message for CreateTestStep| Field | Type | Label | Description |
|---|---|---|---|
| test_step | TestStep | The test step to create |
CreateTestStepResponse
Response message for CreateTestStep| Field | Type | Label | Description |
|---|---|---|---|
| test_step | TestStep | The created test step |
DeleteTestMeasurementRequest
Request message for DeleteTestMeasurement| Field | Type | Label | Description |
|---|---|---|---|
| measurement_id | string | The ID of the test measurement to delete |
DeleteTestMeasurementResponse
Response message for DeleteTestMeasurement Empty response indicating successful deletion This message has no fields.DeleteTestReportRequest
Request message for DeleteTestReport| Field | Type | Label | Description |
|---|---|---|---|
| test_report_id | string | The ID of the test report to delete |
DeleteTestReportResponse
Response message for DeleteTestReport Empty response indicating successful deletion This message has no fields.DeleteTestStepRequest
Request message for DeleteTestStep| Field | Type | Label | Description |
|---|---|---|---|
| test_step_id | string | The ID of the test step to delete |
DeleteTestStepResponse
Response message for DeleteTestStep Empty response indicating successful deletion This message has no fields.ErrorInfo
No description provided.GetTestReportRequest
Request message for GetTestReport| Field | Type | Label | Description |
|---|---|---|---|
| test_report_id | string | The ID of the test report to get |
GetTestReportResponse
Response message for GetTestReport| Field | Type | Label | Description |
|---|---|---|---|
| test_report | TestReport | The test report |
ImportTestReportRequest
Request message for ImportTestReport| Field | Type | Label | Description |
|---|---|---|---|
| remote_file_id | string | The remote file ID containing the XML test data |
ImportTestReportResponse
Response message for ImportTestReport| Field | Type | Label | Description |
|---|---|---|---|
| test_report | TestReport | The imported test report |
ListTestMeasurementsRequest
Request message for ListTestMeasurements| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of test measurements to return. The service may return fewer than this value. If unspecified, at most 50 test measurements will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | |
| page_token | string | A page token, received from a previous ListTestMeasurements call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTestMeasurements must match the call that provided the page token. | |
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are measurement_id, measurement_type, name, test_step_id, test_report_id, numeric_value, string_value, boolean_value, passed, timestamp, created_date, and modified_date. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional. | |
| order_by | string | How to order the retrieved test measurements. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are measurement_id, name, measurement_type, test_step_id, test_report_id, passed, timestamp, created_date, and modified_date. If left empty, items are ordered by timestamp in ascending order. For more information about the format of this field, read this Example: “timestamp asc,name” |
ListTestMeasurementsResponse
Response message for ListTestMeasurements| Field | Type | Label | Description |
|---|---|---|---|
| test_measurements | TestMeasurement | repeated | The list of test measurements |
| next_page_token | string | The next page token for pagination |
ListTestReportsRequest
Request message for ListTestReports| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of test reports to return. The service may return fewer than this value. If unspecified, at most 50 test reports will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | |
| page_token | string | A page token, received from a previous ListTestReports call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTestReports must match the call that provided the page token. | |
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are test_report_id, status, name, test_system_name, test_case, start_time, end_time, serial_number, created_by_user_id, modified_by_user_id, part_number, system_operator, run_id, archived_date, and metadata. Metadata can be used in filters by using metadata.{metadata_key_name} as the field name. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional. | |
| order_by | string | How to order the retrieved test reports. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are test_report_id, name, test_system_name, test_case, start_time, end_time, created_date, and modified_date. If left empty, items are ordered by start_time in descending order (newest-first). For more information about the format of this field, read this Example: “start_time desc,name” |
ListTestReportsResponse
Response message for ListTestReports| Field | Type | Label | Description |
|---|---|---|---|
| test_reports | TestReport | repeated | The list of test reports |
| next_page_token | string | The next page token for pagination |
ListTestStepsRequest
Request message for ListTestSteps| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of test steps to return. The service may return fewer than this value. If unspecified, at most 50 test steps will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | |
| page_token | string | A page token, received from a previous ListTestSteps call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTestSteps must match the call that provided the page token. | |
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are test_step_id, test_report_id, parent_step_id, name, description, step_type, step_path, status, start_time, end_time, error_code, error_message, created_date, and modified_date. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional. | |
| order_by | string | How to order the retrieved test steps. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are test_step_id, name, step_type, step_path, status, start_time, end_time, created_date, and modified_date. If left empty, items are ordered by step_path in ascending order. For more information about the format of this field, read this Example: “step_path asc,start_time desc” |
ListTestStepsResponse
Response message for ListTestStepsNumericBounds
No description provided.StringBounds
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| expected_value | string |
TestMeasurement
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| measurement_id | string | ||
| measurement_type | TestMeasurementType | ||
| name | string | ||
| test_step_id | string | ||
| test_report_id | string | ||
| oneof value. numeric_value | double | ||
| oneof value. string_value | string | ||
| oneof value. boolean_value | bool | ||
| unit | sift.unit.v2.Unit | ||
| oneof bounds. numeric_bounds | NumericBounds | ||
| oneof bounds. string_bounds | StringBounds | ||
| passed | bool | ||
| timestamp | google.protobuf.Timestamp |
TestReport
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| test_report_id | string | Unique identifier for the run | |
| status | TestStatus | The status of the test run | |
| name | string | The name of the test run | |
| test_system_name | string | The name of the test system | |
| test_case | string | The test case that was run | |
| start_time | google.protobuf.Timestamp | The start time of the test run | |
| end_time | google.protobuf.Timestamp | The end time of the test run | |
| metadata | sift.metadata.v1.MetadataValue | repeated | The metadata values associated with this test run |
| serial_number | string | The serial number for the DUT | |
| part_number | string | The part number for the DUT | |
| system_operator | string | Unique identifier for user owner | |
| archived_date | google.protobuf.Timestamp | The date and time the test run was archived (internal) | |
| is_archived | bool | Whether the test run is archived (externally exposed) | |
| run_id | string | The run ID for the test run |
TestStep
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| test_step_id | string | unique identifier for the step | |
| test_report_id | string | pointer to overall test run | |
| parent_step_id | string | pointer to parent step, if any | |
| name | string | Name of the test step for display | |
| description | string | Description of the test step from test controller | |
| step_type | TestStepType | Semantic type of the test step | |
| step_path | string | Hierarchical path (e.g., “1”, “1.1”, “1.2.3”) | |
| status | TestStatus | Status of the test step | |
| start_time | google.protobuf.Timestamp | Start time of the test step | |
| end_time | google.protobuf.Timestamp | End time of the test step | |
| error_info | ErrorInfo | Error information of the test step |
UpdateTestMeasurementRequest
Request message for UpdateTestMeasurement| Field | Type | Label | Description |
|---|---|---|---|
| test_measurement | TestMeasurement | The test measurement to update | |
| update_mask | google.protobuf.FieldMask | The field mask specifying which fields to update. The fields available to be updated are name, measurement_type, numeric_value, string_value, boolean_value, unit, numeric_bounds, string_bounds, passed, and timestamp. |
UpdateTestMeasurementResponse
Response message for UpdateTestMeasurement| Field | Type | Label | Description |
|---|---|---|---|
| test_measurement | TestMeasurement | The updated test measurement |
UpdateTestReportRequest
Request message for UpdateTestReport| Field | Type | Label | Description |
|---|---|---|---|
| test_report | TestReport | The test report to update | |
| update_mask | google.protobuf.FieldMask | The field mask specifying which fields to update. The fields available to be updated are status, name, test_system_name, test_case, start_time, end_time, serial_number, part_number, system_operator, run_id, and is_archived. |
UpdateTestReportResponse
Response message for UpdateTestReport| Field | Type | Label | Description |
|---|---|---|---|
| test_report | TestReport | The updated test report |
UpdateTestStepRequest
Request message for UpdateTestStep| Field | Type | Label | Description |
|---|---|---|---|
| test_step | TestStep | The test step to update | |
| update_mask | google.protobuf.FieldMask | The field mask specifying which fields to update. The fields available to be updated are name, description, step_type, step_path, test_case, status, start_time, end_time, and error_info. |
UpdateTestStepResponse
Response message for UpdateTestStep| Field | Type | Label | Description |
|---|---|---|---|
| test_step | TestStep | The updated test step |
Enums
Allowed constant values used in message fields.TestMeasurementType
No description provided.| Name | Number | Description |
|---|---|---|
| TEST_MEASUREMENT_TYPE_UNSPECIFIED | 0 | |
| TEST_MEASUREMENT_TYPE_DOUBLE | 1 | |
| TEST_MEASUREMENT_TYPE_STRING | 3 | |
| TEST_MEASUREMENT_TYPE_BOOLEAN | 4 | |
| TEST_MEASUREMENT_TYPE_LIMIT | 5 |
TestStatus
No description provided.| Name | Number | Description |
|---|---|---|
| TEST_STATUS_UNSPECIFIED | 0 | |
| TEST_STATUS_DRAFT | 1 | Barebones test report created, waiting for file processing |
| TEST_STATUS_PASSED | 2 | |
| TEST_STATUS_FAILED | 3 | |
| TEST_STATUS_ABORTED | 4 | |
| TEST_STATUS_ERROR | 5 | |
| TEST_STATUS_IN_PROGRESS | 6 | |
| TEST_STATUS_SKIPPED | 7 |
TestStepType
No description provided.| Name | Number | Description |
|---|---|---|
| TEST_STEP_TYPE_UNSPECIFIED | 0 | |
| TEST_STEP_TYPE_SEQUENCE | 1 | ResultSet/MainSequence - top-level test sequence |
| TEST_STEP_TYPE_GROUP | 2 | TestGroup - logical grouping of test steps |
| TEST_STEP_TYPE_ACTION | 3 | SessionAction - individual executable action |
| TEST_STEP_TYPE_FLOW_CONTROL | 4 | Flow control elements (While, If, etc.) |
Services
RPC methods exposed by this API.TestReportService
No description provided.| Method | Request | Response | Description |
|---|---|---|---|
| ImportTestReport | ImportTestReportRequest | ImportTestReportResponse | Imports a test report from an already-uploaded file |
| CreateTestReport | CreateTestReportRequest | CreateTestReportResponse | Creates a test report |
| GetTestReport | GetTestReportRequest | GetTestReportResponse | Gets a single test report |
| ListTestReports | ListTestReportsRequest | ListTestReportsResponse | Lists test reports with optional filtering |
| UpdateTestReport | UpdateTestReportRequest | UpdateTestReportResponse | Updates a test report |
| DeleteTestReport | DeleteTestReportRequest | DeleteTestReportResponse | Deletes a test report |
| CreateTestStep | CreateTestStepRequest | CreateTestStepResponse | Creates a test step |
| ListTestSteps | ListTestStepsRequest | ListTestStepsResponse | Lists test steps with optional filtering |
| UpdateTestStep | UpdateTestStepRequest | UpdateTestStepResponse | Updates a test step |
| DeleteTestStep | DeleteTestStepRequest | DeleteTestStepResponse | Deletes a test step |
| CreateTestMeasurement | CreateTestMeasurementRequest | CreateTestMeasurementResponse | Creates a test measurement |
| CreateTestMeasurements | CreateTestMeasurementsRequest | CreateTestMeasurementsResponse | Creates multiple test measurements in a single request |
| ListTestMeasurements | ListTestMeasurementsRequest | ListTestMeasurementsResponse | Lists test measurements with optional filtering |
| CountTestSteps | CountTestStepsRequest | CountTestStepsResponse | Counts test steps with optional filtering |
| CountTestMeasurements | CountTestMeasurementsRequest | CountTestMeasurementsResponse | Counts test measurements with optional filtering |
| UpdateTestMeasurement | UpdateTestMeasurementRequest | UpdateTestMeasurementResponse | Updates a test measurement |
| DeleteTestMeasurement | DeleteTestMeasurementRequest | DeleteTestMeasurementResponse | Deletes a test measurement |