Create Task - MindBridge Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

Create Task

Endpoint: POST /v1/tasks

cURL Example:

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "engagementId": "<string>",
  "analysisResultId": "<string>",
  "rowId": 123,
  "transactionId": 123,
  "assignedId": "<string>",
  "description": "<string>",
  "sample": "<string>",
  "auditAreas": [
    "<string>"
  ],
  "assertions": [
    "<string>"
  ],
  "dueDate": "2023-12-25",
  "tags": [
    "<string>"
  ]
}
'

Python Example:

import requests

url = "https://{tenant}.mindbridge.ai/api/v1/tasks"

payload = {
    "engagementId": "<string>",
    "analysisResultId": "<string>",
    "rowId": 123,
    "transactionId": 123,
    "assignedId": "<string>",
    "description": "<string>",
    "sample": "<string>",
    "auditAreas": ["<string>"],
    "assertions": ["<string>"],
    "dueDate": "2023-12-25",
    "tags": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

JavaScript Example:

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    engagementId: '<string>',
    analysisResultId: '<string>',
    rowId: 123,
    transactionId: 123,
    assignedId: '<string>',
    description: '<string>',
    sample: '<string>',
    auditAreas: ['<string>'],
    assertions: ['<string>'],
    dueDate: '2023-12-25',
    tags: ['<string>']
  })
};

fetch('https://{tenant}.mindbridge.ai/api/v1/tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Request Body

{
  "engagementId": "<string>",
  "analysisResultId": "<string>",
  "rowId": 123,
  "transactionId": 123,
  "assignedId": "<string>",
  "description": "<string>",
  "sample": "<string>",
  "auditAreas": [
    "<string>"
  ],
  "assertions": [
    "<string>"
  ],
  "dueDate": "2023-12-25",
  "tags": [
    "<string>"
  ]
}

Response Example

{
  "id": "<string>",
  "version": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "engagementId": "<string>",
  "analysisResultId": "<string>",
  "rowId": 123,
  "transactionId": 123,
  "assignedId": "<string>",
  "description": "<string>",
  "sample": "<string>",
  "auditAreas": ["<string>"],
  "assertions": ["<string>"],
  "dueDate": "2023-12-25",
  "tags": ["<string>"]
}

Authorizations

Authorization: Bearer <token>

Body Parameters

Available Options for Task Status

Available Options for Task Type