For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI ReferenceRelease notes
DocumentationAPI ReferenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Integration API routes
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTActivate task worker
        • POSTActivate the job worker
        • GETCheck staterator state
        • POSTCreate task mock
        • POSTDeactivate task worker
        • POSTDeactivate the job worker
        • DELDelete a task mock
        • POSTdiff to HTML
        • POSTEvaluation
        • POSTEvaluation group
        • GETGet aggregate job metrics
        • GETGet aggregate task metrics
        • GETGet task mock
        • GETGet the current task rate limit settings
        • GETGet worker status
        • POSTQuery data using 'json-query' format
        • PUTReplace a task mock
        • GETReturn a list of all IANA defined timezones
        • GETSearch task mocks
        • PUTUpdate the task rate limit settings at runtime
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceWorkflow Engine

Search task mocks

GET
http://localhost:3000/workflow_engine/mocks/tasks
GET
/workflow_engine/mocks/tasks
$curl http://localhost:3000/workflow_engine/mocks/tasks \
>     -u "<username>:<password>"
1{
2  "results": [
3    {
4      "_id": "string",
5      "name": "string",
6      "description": "string",
7      "serviceType": "Application",
8      "serviceName": "string",
9      "method": "string",
10      "finishState": "success",
11      "delay": 1,
12      "response": {},
13      "created": "2024-01-15T09:30:00Z",
14      "createdBy": "string",
15      "lastUpdated": "2024-01-15T09:30:00Z",
16      "lastUpdatedBy": "string"
17    }
18  ],
19  "skip": 0,
20  "limit": 50,
21  "total": 100
22}
Searches for mocks based on query parameters.
Was this page helpful?
Previous

Update the task rate limit settings at runtime

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Query parameters

namestringOptionalformat: "^[\w -]*$"
Filter mocks by name
idsstringOptional
Filter mocks by id
serviceTypeenumOptional
Filter mocks by service type
Allowed values:
serviceNamestringOptional
Filter mocks by service name
methodstringOptional
Filter mocks by method name
finishStateenumOptional
Filter mocks by finish state
Allowed values:
createdBystringOptional
Filter mocks by the user id that created the mock
skipintegerOptionalDefaults to 0
Number of mocks to skip for pagination
limitintegerOptionalDefaults to 25

Maximum number of mocks to return (default is 25)

includeResponsebooleanOptionalDefaults to false
Whether to include the response in the mock results

Response

Search results containing an array of task mocks
resultslist of objects
skipinteger>=0
The number of documents skipped before returning data. When 0, no data is skipped.
limitinteger0-100
Specifies a limit to the maximum number of data results returned.
totalinteger>=0
The total number of documents returned from a search.

Errors

500
Internal Server Error