Salesforce

Bash API endpoint: getEngines

Printable View
« Go Back
Information
Bash API endpoint: getEngines
000007418
Public
Product Selection
aiWare - API
Article Details

Get the list of engines deployed and available on aiWARE

Example

aiware getEngines X-Correlation-Id:value  internalApplicationID=value  internalOrganizationID=value  engineName=value  engineState=value  engineType=value  engineOutputType=value  engineCategoryID=value  engineIDs=value  offset=value  limit=value  direction=value  startTime=value  endTime=value  preload=value  orderBy=value

Parameters

NameTypeDescriptionNotes
xCorrelationIdstringCorrelation Id that can be passed, traced in the server and will be returned in the response if present in the request[optional] [default to null]
internalApplicationIDstringInternal ID of Application[optional] [default to null]
internalOrganizationIDstringID of Organization. UUID. This ID is unique to this aiWARE installation.[optional] [default to null]
engineNamestringField to string match against the engine names[optional] [default to null]
engineStateEngineStateEnumField to match the current state[optional] [default to null]
engineTypeEngineTypeEnumField to match the current type[optional] [default to null]
engineOutputTypeEngineTypeEnumField to match the current type[optional] [default to null]
engineCategoryIDstringFilter to the particular engine category ID[optional] [default to null]
engineIDsstringField to provide the input to get engines by Engine ID list. Separated by commas[optional] [default to null]
offsetintegerthe number of data to skip before getting the result set[optional] [default to null]
limitintegerthe number of items to return.[optional] [default to 10]
directionstringthe sort order. ASC or DESC.[optional] [default to DESC]
startTimeintegerThe unix timestamp, describing the start time for the stats[optional] [default to null]
endTimeintegerThe unix timestamp, describing the end time for the stats[optional] [default to null]
preloadbooleanFilter engines by preload[optional] [default to null]
orderBystringThe value should be in [name, state, type, organizationID, createdTime][optional] [default to null]

Return type

GetEnginesResponse

Authorization

api_key

HTTP request headers

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

 
Additional Technical Documentation Information
Properties
2/3/2025 7:56 PM
2/3/2025 8:03 PM
2/3/2025 8:03 PM
Documentation
Documentation
000007418
Translation Information
English
Powered by