Salesforce

Go API endpoint: FlowApi

« Go Back
Information
Go API endpoint: FlowApi
000004382
Public
Product Selection
aiWare - API
Article Details

All URIs are relative to https://api.aiware.com/edge/v1

MethodHTTP requestDescription
CleanAutomateRequestsGet /flowaction/requests/cleanClean old automate requests.
CreateNodeRedContainerInfoPost /flow/nrcontainer/createCreate node-red container information
DeleteAutomateContainerPost /flow/delete/{ContainerID}Delete automate container.
GetAutomateContainersGet /automate/containersGet automate containers info.
UpdateAutomateRequestStatusPost /flow/request/updatePut this automate request into update status mode. This automate request will be updated to new status.
UpdateAutomateStatusPost /flow/{HostID}/updatestatusGet updated information to launch node-red container, terminate node-red container.

CleanAutomateRequests

AdminOperationResponse CleanAutomateRequests(ctx, ) Clean old automate requests.

Required Parameters

This endpoint does not need any parameter.

Return type

AdminOperationResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

CreateNodeRedContainerInfo

AdminOperationResponse CreateNodeRedContainerInfo(ctx, createNodRedContainerDetail, optional)

Create node-red container information

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
createNodRedContainerDetailCreateNodRedContainerDetailNode-RED container info
optional*CreateNodeRedContainerInfoOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateNodeRedContainerInfoOpts struct

NameTypeDescriptionNotes
xCorrelationIdoptional.StringCorrelation Id that can be passed, traced in the server and will be returned in the response if present in the request

Return type

AdminOperationResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

DeleteAutomateContainer

AdminOperationResponse DeleteAutomateContainer(ctx, containerID)

Delete automate container.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
containerIDstringContainerID of node-red container

Return type

AdminOperationResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

GetAutomateContainers

[]CreateNodRedContainerDetail GetAutomateContainers(ctx, )

Get automate containers info.

Required Parameters

This endpoint does not need any parameter.

Return type

[]CreateNodRedContainerDetail

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

UpdateAutomateRequestStatus

AdminOperationResponse UpdateAutomateRequestStatus(ctx, updateNodeRedRequestDetail, optional)

Put this automate request into update status mode. This automate request will be updated to new status.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
updateNodeRedRequestDetailUpdateNodeRedRequestDetailNode-RED container info
optional*UpdateAutomateRequestStatusOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdateAutomateRequestStatusOpts struct

NameTypeDescriptionNotes
xCorrelationIdoptional.StringCorrelation Id that can be passed, traced in the server and will be returned in the response if present in the request

Return type

AdminOperationResponse

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

UpdateAutomateStatus

HostAction UpdateAutomateStatus(ctx, hostID)

Get updated information to launch node-red container, terminate node-red container.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
hostIDstringID of Host

Return type

HostAction

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
Additional Technical Documentation Information
Properties
11/21/2024 9:58 PM
11/21/2024 9:59 PM
11/21/2024 9:59 PM
Documentation
Documentation
000004382
Translation Information
English

Powered by