Get one RecordCreationWorkflow

GET

api

sys

recordcreationworkflows

{id}

Get one RecordCreationWorkflow

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/recordcreationworkflows/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/recordcreationworkflows/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

{
  "BusinessId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "EntityDomain": "<string>",
  "EntityType": "<string>",
  "Status": 123,
  "SourceType": 123,
  "SourceKey": "<string>",
  "SourceRevision": "<string>",
  "IsDefault": true,
  "DraftVersionId": 123,
  "PublishedVersionId": 123,
  "CreatedByUserId": 123,
  "CreatedByUserFullName": "<string>",
  "CreatedByUserEmail": "<string>",
  "UpdatedByUserId": 123,
  "UpdatedByUserFullName": "<string>",
  "UpdatedByUserEmail": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A business-scoped record creation workflow with draft and published versions.

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 RecordCreationWorkflow-Read role.

Path Parameters

integer

required

The Id of the RecordCreationWorkflow record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/recordcreationworkflows/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/recordcreationworkflows/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/recordcreationworkflows/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business that owns this workflow.

string

Display name of the workflow.

string

Optional description of the workflow.

string

Domain of the entity created by this workflow.

string

Type of entity created by this workflow.

integer

Current lifecycle status of the workflow. See eRecordCreationWorkflowStatus enum values: 1 = Draft, 2 = Published, 3 = Archived.

integer

How this workflow was originally created. See eRecordCreationWorkflowSourceType enum values: 1 = Blank, 2 = BuiltIn, 3 = Generated, 4 = Duplicated.

string

Stable key of the source template.

string

Revision of the source template when copied.

boolean

Whether this is the default published workflow for its entity.

integer

Current mutable draft version.

integer

Current immutable published version.

integer

User who created the workflow.

string

Display value for CreatedByUser.FullName..

string

Display value for CreatedByUser.Email..

integer

User who last updated the workflow.

string

Display value for UpdatedByUser.FullName..

string

Display value for UpdatedByUser.Email..

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "Name": "",
  "Description": null,
  "EntityDomain": "",
  "EntityType": "",
  "Status": 0,
  "SourceType": 0,
  "SourceKey": null,
  "SourceRevision": null,
  "IsDefault": false,
  "DraftVersionId": null,
  "PublishedVersionId": null,
  "CreatedByUserId": 0,
  "CreatedByUserFullName": null,
  "CreatedByUserEmail": null,
  "UpdatedByUserId": 0,
  "UpdatedByUserFullName": null,
  "UpdatedByUserEmail": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "[email protected]",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "RecordCreationWorkflow Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one RecordCreationWorkflow

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/recordcreationworkflows/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/recordcreationworkflows/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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

{
  "BusinessId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "EntityDomain": "<string>",
  "EntityType": "<string>",
  "Status": 123,
  "SourceType": 123,
  "SourceKey": "<string>",
  "SourceRevision": "<string>",
  "IsDefault": true,
  "DraftVersionId": 123,
  "PublishedVersionId": 123,
  "CreatedByUserId": 123,
  "CreatedByUserFullName": "<string>",
  "CreatedByUserEmail": "<string>",
  "UpdatedByUserId": 123,
  "UpdatedByUserFullName": "<string>",
  "UpdatedByUserEmail": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Get one RecordCreationWorkflow

Authentication

Path Parameters

Code Examples

Response

200