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

Create task mock

POST
http://localhost:3000/workflow_engine/mocks/tasks
POST
/workflow_engine/mocks/tasks
$curl -X POST http://localhost:3000/workflow_engine/mocks/tasks \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{
>  "name": "string",
>  "serviceType": "Application",
>  "serviceName": "string",
>  "method": "string",
>  "finishState": "success"
>}'
1{
2  "_id": "string",
3  "name": "string",
4  "description": "string",
5  "serviceType": "Application",
6  "serviceName": "string",
7  "method": "string",
8  "finishState": "success",
9  "delay": 1,
10  "response": {},
11  "created": "2024-01-15T09:30:00Z",
12  "createdBy": "string",
13  "lastUpdated": "2024-01-15T09:30:00Z",
14  "lastUpdatedBy": "string"
15}
Creates a new task mock with the provided details.
Was this page helpful?
Previous

Deactivate task worker

Next
Built with

Authentication

AuthorizationBasic

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

Request

mock
namestringRequiredformat: "^[\w -]+$"
The name of the mock task
serviceTypeenumRequired
Whether or not the mock is for an adapter or application service
Allowed values:
serviceNamestringRequired
The adapter or application service name that contains the method to mock
methodstringRequired
The name of the method that is being mocked
finishStateenumRequired
The finish state of the mock
Allowed values:
descriptionstringOptionalDefaults to
A description of the mock task
delayintegerOptional>=0Defaults to 0
The number of seconds to delay the completion of the mock
responselist of any or boolean or integer or double or map from strings to any or string or nullOptional
The response for the mock that matches the return value for the task method

Response

The newly created task mock object
_idstringformat: "uuid"
The unique identifier for the mock task
namestringformat: "^[\w -]+$"
The name of the mock task
descriptionstring
A description of the mock task
serviceTypeenum
Whether or not the mock is for an adapter or application service
Allowed values:
serviceNamestring
The adapter or application service name that contains the method to mock
methodstring
The name of the method that is being mocked
finishStateenum
The finish state of the mock
Allowed values:
delayinteger
The number of seconds to delay the completion of the mock
responselist of any or boolean or integer or double or map from strings to any or string or null
The response for the mock that matches the return value for the task method
createdstringformat: "date-time"
The date and time when the mock was created
createdBystring
The id of user who created the mock task
lastUpdatedstringformat: "date-time"
The date and time when the mock was last updated
lastUpdatedBystring
The id of user who last updated the mock task

Errors

500
Internal Server Error