Scenario API
4.2 Use Case API¶
4.2.1 Create a Use Case¶
Path： /api-asset/cases
Method： POST
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| requestBody | body | Request body | Yes | CaseCreateRequest extends PartialCaseDef |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | GeneralResponse |
4.2.2 Save a Completed Task as a Use Case¶
Path： /api-asset/cases/vr
Method： POST
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| requestBody | body | Request body | Yes | CaseCreateRequest |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | GeneralResponse |
4.2.3 Update a Use Case¶
Path： /api-asset/cases/update
Method： POST
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| requestBody | body | Request body | Yes | CaseSaveRequest |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | CaseSaveResponse |
4.2.4 Clone a Use Case¶
Path： /api-asset/cases/clone
Method： POST
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| requestBody | body | Request body | Yes | CaseCloneRequest |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | CaseCloneResponse |
4.2.5 Move a Use Case¶
Path： /api-asset/cases/move
Method： POST
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| requestBody | body | Request body | Yes | CaseMoveRequest |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | CaseMoveResponse |
4.2.6 Export Use Cases¶
Path： /api-asset/cases/export
Method： POST
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| requestBody | body | Request body | Yes | CaseExportRequest |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | GeneralResponse |
4.2.7 Import Use Cases¶
Path： /api-asset/cases/import
Method： POST
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| requestBody | body | Request body | Yes | CaseImportRequest |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | CaseImportResponse |
4.2.8 Get Use Cases with Sensor Overload¶
Path： /api-asset/cases/checkSensors
Method： POST
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| requestBody | body | Request body | Yes | CheckSensorsRequest |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | Ok | [ { "id": string, "name": string } ] |
4.2.9 Delete Use Cases¶
Path： /api-case/cases/trash
Method： POST
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| requestBody | body | Request body | Yes | { "ids": [string] } |
Response¶
| Code | Description | Type |
|---|---|---|
| 204 or 200 | Ok | {} |