#Bizproc templates

Entity: bizprocTemplate | Scope: bizproc | Base path: /v1/bizproc-templates

Legacy entity (UPPER_CASE field names) — field names are automatically converted to camelCase.

#Operations

Method Path Description Bitrix24 Method
GET /v1/bizproc-templates List all (with filter, sort, pagination) bizproc.workflow.template.list
POST /v1/bizproc-templates Create new bizproc.workflow.template.add
PATCH /v1/bizproc-templates/:id Update by ID bizproc.workflow.template.update
DELETE /v1/bizproc-templates/:id Delete by ID bizproc.workflow.template.delete

Disabled operations: get

#Fields

API Name Bitrix24 Name Type Readonly Description
id ID number yes Идентификатор записи
moduleId MODULE_ID string
entity ENTITY string
documentType DOCUMENT_TYPE array
autoExecute AUTO_EXECUTE number
name NAME string
description DESCRIPTION string
modified MODIFIED datetime yes
isModified IS_MODIFIED boolean yes
userId USER_ID number

#Examples

#List

Terminal 
curl -X GET '/v1/bizproc-templates?limit=10' \
  -H 'X-Api-Key: YOUR_KEY'

#Create

Terminal 
curl -X POST '/v1/bizproc-templates' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"moduleId":"value","entity":"value","documentType":"value"}'

#Update

Terminal 
curl -X PATCH '/v1/bizproc-templates/123' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title":"updated"}'

#Delete

Terminal 
curl -X DELETE '/v1/bizproc-templates/123' \
  -H 'X-Api-Key: YOUR_KEY'

#Batch

Terminal 
curl -X POST '/v1/batch' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"calls":[{"entity":"bizproc-templates","action":"list","params":{"limit":5}}]}'