Skip to main content
POST
/
v1
/
process
Create process
curl --request POST \
  --url https://api.example.com/v1/process \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "label": "<string>",
  "steps": [
    {
      "policyNames": [
        "<string>"
      ],
      "id": "<string>",
      "name": "<string>",
      "label": "<string>",
      "description": "<string>",
      "rawDescription": "<string>",
      "processId": "<string>",
      "tokenIds": [
        "<string>"
      ],
      "roles": [
        {
          "p": "<string>",
          "r": [
            "<string>"
          ]
        }
      ],
      "orderedPolicies": [
        "<string>"
      ],
      "viewPolicyNames": [
        "<string>"
      ],
      "status": "IN_CONSENSUS",
      "webhookUrls": "<string>",
      "legalContractId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>",
      "stepIdsDependencies": [
        {
          "id": "<string>"
        }
      ],
      "stepIdsReprovalDependencies": [
        {
          "id": "<string>"
        }
      ],
      "parameters": [
        {
          "name": "<string>",
          "label": "<string>",
          "id": "<string>",
          "type": "ATTACHMENT",
          "isCalc": true,
          "isUnique": true,
          "isPermanent": true,
          "isRequired": true,
          "columns": 123,
          "decimals": 123,
          "stepId": "<string>",
          "parameterId": "<string>",
          "entityId": "<string>",
          "contractTemplateId": "<string>",
          "contractTemplate": {
            "templateEntityId": "<string>",
            "templateEntityName": "<string>"
          },
          "hideColumns": [
            "<string>"
          ],
          "computedFormula": [
            "<string>"
          ],
          "readFromOtherMeasurementData": {
            "processId": "<string>",
            "stepId": "<string>",
            "id": "<string>",
            "parameterId": "<string>",
            "readParameterId": "<string>",
            "searchFieldId": "<string>",
            "selectedFields": [
              {
                "readParameterId": "<string>",
                "writeParameterId": "<string>"
              }
            ]
          },
          "readFromEntity": {
            "stepId": "<string>",
            "id": "<string>",
            "processId": "<string>",
            "entityId": "<string>",
            "readParameterId": "<string>",
            "originParameterId": "<string>",
            "targetParameterIds": [
              "<string>"
            ],
            "createdAt": "<string>",
            "updatedAt": "<string>"
          },
          "optionItems": [
            {
              "value": "<string>",
              "id": "<string>",
              "label": "<string>",
              "color": "<string>",
              "meta": {},
              "parameterId": "<string>",
              "persisted": true,
              "entityParameterId": "<string>",
              "createdAt": "<string>",
              "updatedAt": "<string>",
              "deletedAt": "<string>"
            }
          ],
          "apiCalls": [
            {
              "id": "<string>",
              "type": "<string>",
              "description": "<string>",
              "sort": [
                "<string>"
              ],
              "parameters": [
                "<unknown>"
              ],
              "createdAt": "<string>",
              "updatedAt": "<string>"
            }
          ],
          "sheetData": {
            "id": "<string>",
            "cell": "<string>",
            "inputType": "<string>",
            "page": "<string>",
            "sheet": "<string>",
            "formula": "<string>"
          },
          "advancedOptions": {
            "id": "<string>",
            "tooltip": "<string>",
            "description": "<string>",
            "placeholder": "<string>",
            "max": 123,
            "maxLength": 123,
            "min": 123,
            "minLength": 123,
            "decimals": 123,
            "sort": 123,
            "currency": "USD",
            "locale": "pt-BR",
            "isHidden": true,
            "rightFreeze": true,
            "leftFreeze": true,
            "hasCustomColor": true,
            "hasMetadata": true,
            "hiddenFrom": [
              "<string>"
            ],
            "isMultiple": true,
            "insertOnEntity": "<string>",
            "insertOnEntityMetadata": [
              "<string>"
            ],
            "dateFormat": "dd/MM/yyyy",
            "entityOperation": [
              "WRITE"
            ],
            "parameterId": "<string>",
            "entityParameterId": "<string>",
            "createdAt": "<string>",
            "updatedAt": "<string>",
            "deletedAt": "<string>"
          },
          "parameters": [
            {
              "id": "<string>",
              "name": "<string>",
              "label": "<string>",
              "type": "ATTACHMENT",
              "isCalc": true,
              "isUnique": true,
              "isPermanent": true,
              "columns": 123,
              "stepId": "<string>",
              "isRequired": true,
              "decimals": 123,
              "parameterId": "<string>",
              "computedFormula": [
                "<string>"
              ],
              "createdAt": "<string>",
              "updatedAt": "<string>",
              "optionItems": [
                {
                  "value": "<string>",
                  "id": "<string>",
                  "label": "<string>",
                  "color": "<string>",
                  "meta": {},
                  "parameterId": "<string>",
                  "persisted": true,
                  "entityParameterId": "<string>",
                  "createdAt": "<string>",
                  "updatedAt": "<string>",
                  "deletedAt": "<string>"
                }
              ],
              "sheetData": {
                "id": "<string>",
                "cell": "<string>",
                "inputType": "<string>",
                "page": "<string>",
                "sheet": "<string>",
                "formula": "<string>"
              },
              "advancedOptions": {
                "id": "<string>",
                "tooltip": "<string>",
                "description": "<string>",
                "placeholder": "<string>",
                "max": 123,
                "maxLength": 123,
                "min": 123,
                "minLength": 123,
                "decimals": 123,
                "sort": 123,
                "currency": "USD",
                "locale": "pt-BR",
                "isHidden": true,
                "rightFreeze": true,
                "leftFreeze": true,
                "hasCustomColor": true,
                "hasMetadata": true,
                "hiddenFrom": [
                  "<string>"
                ],
                "isMultiple": true,
                "insertOnEntity": "<string>",
                "insertOnEntityMetadata": [
                  "<string>"
                ],
                "dateFormat": "dd/MM/yyyy",
                "entityOperation": [
                  "WRITE"
                ],
                "parameterId": "<string>",
                "entityParameterId": "<string>",
                "createdAt": "<string>",
                "updatedAt": "<string>",
                "deletedAt": "<string>"
              },
              "readFromOtherMeasurementData": {
                "processId": "<string>",
                "stepId": "<string>",
                "id": "<string>",
                "parameterId": "<string>",
                "readParameterId": "<string>",
                "searchFieldId": "<string>",
                "selectedFields": [
                  {
                    "readParameterId": "<string>",
                    "writeParameterId": "<string>"
                  }
                ]
              }
            }
          ],
          "entity": {
            "label": "<string>",
            "params": [
              {}
            ],
            "hasGSheetKey": true
          },
          "hasGSheetKey": true,
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "deletedAt": "<string>"
        }
      ]
    }
  ],
  "id": "<string>",
  "iconName": "<string>"
}
'
{
  "orgId": "<string>",
  "name": "<string>",
  "label": "<string>",
  "steps": [
    {
      "policyNames": [
        "<string>"
      ],
      "id": "<string>",
      "name": "<string>",
      "label": "<string>",
      "description": "<string>",
      "rawDescription": "<string>",
      "processId": "<string>",
      "tokenIds": [
        "<string>"
      ],
      "roles": [
        {
          "p": "<string>",
          "r": [
            "<string>"
          ]
        }
      ],
      "orderedPolicies": [
        "<string>"
      ],
      "viewPolicyNames": [
        "<string>"
      ],
      "status": "IN_CONSENSUS",
      "webhookUrls": "<string>",
      "legalContractId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>",
      "stepIdsDependencies": [
        {
          "id": "<string>"
        }
      ],
      "stepIdsReprovalDependencies": [
        {
          "id": "<string>"
        }
      ]
    }
  ],
  "id": "<string>",
  "iconName": "<string>"
}

Authorizations

Authorization
string
header
required

Body

application/json
name
string
required
label
string
required
steps
object[]
required
id
string
iconName
string

Response

201 - application/json

ok

orgId
string
required
name
string
required
label
string
required
steps
object[]
required
id
string
iconName
string