Create RecordCreationWorkflowVersion

POST

api

sys

recordcreationworkflowversions

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/recordcreationworkflowversions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "WorkflowId": 123,
  "VersionNumber": 123,
  "SchemaVersion": 123,
  "DefinitionJson": "<string>",
  "DefinitionHash": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/recordcreationworkflowversions"

payload = {
    "WorkflowId": 123,
    "VersionNumber": 123,
    "SchemaVersion": 123,
    "DefinitionJson": "<string>",
    "DefinitionHash": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    WorkflowId: 123,
    VersionNumber: 123,
    SchemaVersion: 123,
    DefinitionJson: '<string>',
    DefinitionHash: '<string>'
  })
};

fetch('https://spaces.nexudus.com/api/sys/recordcreationworkflowversions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A mutable draft or immutable published version of a record creation workflow.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the RecordCreationWorkflowVersion-Create role.

Request Body

Required Fields

integer

required

Workflow that owns this version.

integer

required

Monotonic version number within the workflow.

integer

required

Version of the persisted workflow document contract.

string

required

Full JSON workflow document.

string

required

Deterministic hash of the workflow document.

Optional Fields

boolean

Whether this version remains mutable.

string

Last validation result for diagnostics.

string

Date and time this immutable version was published.

integer

User who published this version.

string

Optimistic concurrency token changed on every draft save.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/recordcreationworkflowversions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "WorkflowId": 0,
    "VersionNumber": 0,
    "SchemaVersion": 0,
    "DefinitionJson": "",
    "DefinitionHash": ""
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/recordcreationworkflowversions',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      WorkflowId: 0,
      VersionNumber: 0,
      SchemaVersion: 0,
      DefinitionJson: '',
      DefinitionHash: ''
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/recordcreationworkflowversions',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'WorkflowId': 0,
        'VersionNumber': 0,
        'SchemaVersion': 0,
        'DefinitionJson': '',
        'DefinitionHash': ''
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the recordcreationworkflowversion was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "RecordCreationWorkflowVersion was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[email protected]",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "DefinitionJson: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "DefinitionJson"
    }
  ],
  "WasSuccessful": false
}

Create RecordCreationWorkflowVersion

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/recordcreationworkflowversions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "WorkflowId": 123,
  "VersionNumber": 123,
  "SchemaVersion": 123,
  "DefinitionJson": "<string>",
  "DefinitionHash": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/recordcreationworkflowversions"

payload = {
    "WorkflowId": 123,
    "VersionNumber": 123,
    "SchemaVersion": 123,
    "DefinitionJson": "<string>",
    "DefinitionHash": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    WorkflowId: 123,
    VersionNumber: 123,
    SchemaVersion: 123,
    DefinitionJson: '<string>',
    DefinitionHash: '<string>'
  })
};

fetch('https://spaces.nexudus.com/api/sys/recordcreationworkflowversions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Create RecordCreationWorkflowVersion

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400