Ai APIs¶
Start Work Order By ID¶
HTTP Request
PUT /api/ai/activities/start_work_order/execute/{id}
📋 Description: Initiates the execution of a work order identified by the specified ID, facilitating the commencement of associated activities within the operational workflow.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Pass Work Order By ID¶
HTTP Request
PUT /api/ai/activities/pass_work_order/execute/{id}
📋 Description: Executes the specified work order identified by the given ID, facilitating the efficient management and tracking of AI-driven activities within the operational workflow.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Fail Work Order By ID¶
HTTP Request
PUT /api/ai/activities/fail_work_order/execute/{id}
📋 Description: Updates the status of a specific work order to ‘failed’ based on the provided identifier, enabling effective tracking and management of work order performance.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Enable Work Order By ID¶
HTTP Request
PUT /api/ai/activities/enable_work_order/execute/{id}
📋 Description: Enables a specific work order identified by the provided ID, allowing for the activation of associated activities within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Enable Request By ID¶
HTTP Request
PUT /api/ai/activities/enable_request/execute/{id}
📋 Description: Enables the execution of a specific AI activity request identified by the provided ID, facilitating streamlined operations within the AI management framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Enable Part By ID¶
HTTP Request
PUT /api/ai/activities/enable_part/execute/{id}
📋 Description: Enables a specific activity part identified by the provided ID, allowing for the execution of associated tasks within the AI activities framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Enable Asset By ID¶
HTTP Request
PUT /api/ai/activities/enable_asset/execute/{id}
📋 Description: Enables the specified asset by executing the corresponding action identified by the provided ID, facilitating enhanced operational efficiency within the AI activities framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Disable Work Order By ID¶
HTTP Request
PUT /api/ai/activities/disable_work_order/execute/{id}
📋 Description: Disables a specified work order by executing the operation identified by the provided ID, ensuring that the work order is no longer active within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Disable Request By ID¶
HTTP Request
PUT /api/ai/activities/disable_request/execute/{id}
📋 Description: Disables a specific AI activity request identified by the provided ID, ensuring that the request is no longer processed or executed within the system. This operation is essential for maintaining control over active AI activities and optimizing resource allocation.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Disable Part By ID¶
HTTP Request
PUT /api/ai/activities/disable_part/execute/{id}
📋 Description: Disables a specific part of an AI activity identified by the provided ID, ensuring that the activity can no longer utilize the specified component for operational processes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Disable Asset By ID¶
HTTP Request
PUT /api/ai/activities/disable_asset/execute/{id}
📋 Description: Disables a specified asset by executing the operation identified by the provided ID, ensuring that the asset is no longer active within the system. This operation is essential for maintaining accurate asset management and operational efficiency.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Complete Work Order By ID¶
HTTP Request
PUT /api/ai/activities/complete_work_order/execute/{id}
📋 Description: Executes the completion of a specified work order identified by the provided ID, facilitating efficient task management and workflow optimization within the enterprise.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get Search Work Order View¶
HTTP Request
GET /api/ai/activities/search_work_order_view/execute
📋 Description: Executes a search for work order views, enabling users to efficiently retrieve relevant activity data associated with specific work orders.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
string |
Example Responses
1"string"
Search Work Order By Name¶
HTTP Request
GET /api/ai/activities/search_work_order/execute/{name}
📋 Description: Executes a search for work orders based on the specified name, enabling users to efficiently locate and manage relevant activities within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
name |
path |
string |
true |
Name of the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]
Response Schema
Get Search Request View¶
HTTP Request
GET /api/ai/activities/search_request_view/execute
📋 Description: Executes a search request to retrieve AI activity insights, enabling users to access relevant data for informed decision-making.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
string |
Example Responses
1"string"
Search Request By Name¶
HTTP Request
GET /api/ai/activities/search_request/execute/{name}
📋 Description: Executes a search request for AI activities based on the specified name, enabling users to efficiently access relevant data and insights for informed decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
name |
path |
string |
true |
Name of the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]
Response Schema
Get Search Part View¶
HTTP Request
GET /api/ai/activities/search_part_view/execute
📋 Description: Executes a search for specific activity details within the AI framework, enabling users to access relevant insights and analytics efficiently.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
string |
Example Responses
1"string"
Search Part By Name¶
HTTP Request
GET /api/ai/activities/search_part/execute/{name}
📋 Description: Executes a search for specific AI activities based on the provided name, enabling users to quickly access relevant information for informed decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
name |
path |
string |
true |
Name of the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]
Response Schema
Get Search Asset View¶
HTTP Request
GET /api/ai/activities/search_asset_view/execute
📋 Description: Executes a search for asset views within the AI activities framework, allowing users to access relevant data efficiently and enhance decision-making processes.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
string |
Example Responses
1"string"
Search Asset By Name¶
HTTP Request
GET /api/ai/activities/search_asset/execute/{name}
📋 Description: Executes a search for specific assets based on the provided name, enabling users to efficiently locate and access relevant asset information within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
name |
path |
string |
true |
Name of the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]