Process Builder API Schemas

Defines the data structure for process configuration.
More information: https://openapi-generator.tech
Contact Info: team@openapitools.org
Version: 1.0.0
BasePath:
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Models

[ Jump to Methods ]

Table of Contents

  1. ActionSchema - Action Schema
  2. ActionSchema_content -
  3. Category - Category Schema
  4. CategorySpecificProperties - Category Details
  5. Inputs - Inputs Schema
  6. ObjectInputBaseSchema - Base Persistence Schema
  7. Parameter - Parameter Schema
  8. ParameterSpecificProperties - Parameter Details
  9. Status - Status Schema
  10. StepSchema - Step Schema
  11. Steps - Steps Schema
  12. StepsSpecificProperties - Process Steps List
  13. Users - Users Schema

ActionSchema - Action Schema Up

Defines a single action (form, notification, redirection) within a step.
actionType
added
content

ActionSchema_content - Up

Category - Category Schema Up

Final schema structure for a category.
persistenceId_string
String Unique database ID of the object record.
fullName
fullDescription
enabled

CategorySpecificProperties - Category Details Up

fullName
fullDescription
enabled

Inputs - Inputs Schema Up

Final schema structure for the process inputs.
persistenceId_string
String Unique database ID of the object record.

ObjectInputBaseSchema - Base Persistence Schema Up

Base properties for persistent objects.
persistenceId_string
String Unique database ID of the object record.

Parameter - Parameter Schema Up

Final schema structure for parameters.
persistenceId_string
String Unique database ID of the object record.
fullName
fullDescription
version
criticality
token
displayName
documentsFolder (optional)
cancellationDelay
category
refStorage

ParameterSpecificProperties - Parameter Details Up

fullName
fullDescription
version
criticality
token
displayName
documentsFolder (optional)
cancellationDelay
category
refStorage

Status - Status Schema Up

Final schema structure for statuses.
persistenceId_string
String Unique database ID of the object record.

StepSchema - Step Schema Up

Defines the structure for a single process step.
name
ref
description
String Detailed description of the process step.
index
actions

Steps - Steps Schema Up

Final schema structure for the steps collection.
persistenceId_string
String Unique database ID of the object record.
steps
array[StepSchema] Array containing all process steps.

StepsSpecificProperties - Process Steps List Up

steps
array[StepSchema] Array containing all process steps.

Users - Users Schema Up

Final schema structure for users.
persistenceId_string
String Unique database ID of the object record.