Initialises a Coding tool (Coding tool)
Initialises a Coding tool
Path Parameters
projectId string required
Project ID
workflowId string required
Workflow ID
toolId string required
Tool ID
Responses
- 200
- 400
- 401
- 403
- 404
Initialised coding tool
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
_etag string nullable
codeMaps object[] nullable
id string nullable
text string nullable
createdById string nullable
createdByName string nullable
createdUtc date-time nullable
customerId string nullable
description string nullable
id string nullable
input object nullable
datasetId string nullable
datasetName string nullable
fromPreviousTool boolean nullable
fromPreviousToolId string nullable
inputIsSurveyDataset boolean nullable
metadata object nullable
preFilter string nullable
projectId string nullable
projectName string nullable
usePreFilter boolean nullable
isDeleted boolean nullable
isDisabled boolean nullable
isaEtag string nullable
lastModifiedById string nullable
lastModifiedByName string nullable
lastModifiedUtc date-time nullable
name string nullable
output object nullable
description string nullable
name string nullable
overwrite boolean nullable
projectId string nullable
projectName string nullable
save boolean nullable
tags object[] nullable
id string nullable
name string nullable
projectId string nullable
qifEtag string nullable
readReceipts object[] nullable
timeStamp date-time nullable
userId string nullable
userName string nullable
tags object[] nullable
id string nullable
name string nullable
toolType int32
Possible values: [0
, 1
, 2
, 3
, 4
]
Default value: 0
type string nullable
workflowId string nullable
{
"_etag": "string",
"codeMaps": [
{
"id": "string",
"text": "string"
}
],
"createdById": "string",
"createdByName": "string",
"createdUtc": "2025-01-13T15:06:27.021Z",
"customerId": "string",
"description": "string",
"id": "string",
"input": {
"datasetId": "string",
"datasetName": "string",
"fromPreviousTool": true,
"fromPreviousToolId": "string",
"inputIsSurveyDataset": true,
"metadata": {},
"preFilter": "string",
"projectId": "string",
"projectName": "string",
"usePreFilter": true
},
"isDeleted": true,
"isDisabled": true,
"isaEtag": "string",
"lastModifiedById": "string",
"lastModifiedByName": "string",
"lastModifiedUtc": "2025-01-13T15:06:27.021Z",
"name": "string",
"output": {
"description": "string",
"name": "string",
"overwrite": true,
"projectId": "string",
"projectName": "string",
"save": true,
"tags": [
{
"id": "string",
"name": "string"
}
]
},
"projectId": "string",
"qifEtag": "string",
"readReceipts": [
{
"timeStamp": "2025-01-13T15:06:27.021Z",
"userId": "string",
"userName": "string"
}
],
"tags": [
{
"id": "string",
"name": "string"
}
],
"toolType": 0,
"type": "string",
"workflowId": "string"
}
Invalid request. The message will vary depending on the cause
Unauthorized
Access denied
Not found
Loading...