通过自定义应用程序使用 RESTful API
REST 插件提供的 REST API 让您能够向视觉系统发送请求，并查询视觉系统中的信息。这是通过 HTTP 端点完成的，这些端点由预定义的（基本）URL 和 HTTP 方法组成。您可以构建一个根据您的用例自定义的应用程序，并向可用的端点发送请求，以查询视觉系统中的信息，并通过触发操作来控制它。
REST API 提供两种不同类型的 HTTP 方法：GET 和 POST。GET 方法用于查询视觉系统中的信息，例如，获取可用配方的列表或获取执行结果。POST 方法用于触发特定操作，例如准备配方或启动执行。
以下部分显示哪些端点由 REST API 提供，以及每个端点可以用于什么目的。总的来说，它们可用于以下目的：
- 获取系统状态并将操作发送到视觉系统。
- 准备和取消准备配方。
- 开始运行工作，即单次或连续执行。
- 获取有关配方、正在运行的工作、事件和错误的信息。
- 获取结果。
可用端点
下表概述了 REST API 的可用端点，从而概述资源的 API 存储语义。
|
URI |
HTTP 方法 |
描述 |
|---|---|---|
|
/state_machine |
GET |
返回系统的当前状态。 |
|
/state_machine/actions |
POST |
向视觉系统发送操作。 |
|
/state_machine/actions/{action_id}/status |
GET |
返回指定操作的状态。 |
|
/recipes |
GET |
返回可用配方列表。 |
|
/recipes/actions |
POST |
发送特定配方的操作。 |
|
/recipes/actions/{action_id}/status |
GET |
返回特定配方的特定操作的状态。 |
|
/jobs |
GET |
按时间倒序返回所有已知工作的列表。 |
|
/jobs/{job_id} |
GET |
返回有关特定配方的特定工作的信息。 |
|
/recipes/{recipe_id}/jobs |
GET |
按时间倒序返回为特定配方启动的所有工作的列表。 |
|
/events |
GET |
按时间倒序返回事件列表。 |
|
/events/{event_id} |
GET |
返回有关特定事件的信息。 |
|
/results |
GET |
按时间倒序返回结果列表。 |
|
/recipes/{recipe_id}/results |
GET |
按时间倒序返回特定配方的结果列表。 |
|
/jobs/{job_id}/results |
GET |
按时间倒序返回与某个工作相关的结果列表。 |
|
/errors |
GET |
按时间倒序返回错误列表。 |
|
/errors/{error_id} |
GET |
返回特定错误 ID 的错误信息。 |
有关 REST API 和可用端点的更多信息，请参阅 REST API 的说明文档，该文档可在内置 web 应用程序中通过“API Docs”菜单项访问。
