Create a clinical workflow

post/workflows

Creates a clinical workflow.

Request Samples

Response Samples

1{
2  "value": {
3    "version": 1,
4    "createdBy": "sastest1",
5    "creationTimeStamp": "2025-09-30T18:12:50.026Z",
6    "modifiedBy": "sastest1",
7    "modifiedTimeStamp": "2025-09-30T18:12:50.026Z",
8    "id": "4e91d7f7-b926-4c87-bd60-cf380a2e9d99",
9    "typeId": "clinicalWorkflow",
10    "createdByDisplayName": "SAS Test User 1 (sastest1)",
11    "modifiedByDisplayName": "SAS Test User 1 (sastest1)",
12    "name": "jobWorkflow",
13    "contextId": "9848b115-388f-43d7-a714-47771b401d10",
14    "contextTypeId": "organization",
15    "contextPath": "/Org",
16    "definitionId": "WF9344F872-E3B7-4D7A-A7F1-9EF925A4DB76",
17    "definitionVersion": 1,
18    "definitionName": "Run Clinical Job and Wait for Completion",
19    "owner": "sastest1",
20    "ownerDisplayName": "SAS Test User 1 (sastest1)",
21    "status": "NOT_STARTED"
22  }
23}

Request Body

Specifies information for creating a clinical workflow

Information to provide in the request body to create a clinical workflow.

NameTypeRequiredDescription
version
number
false

The version of the representation. This is version 1.

name
string
false

The name of the group.

contextId
string
false

The unique identifier for the context in which to create the clinical workflow.

definitionId
string
false

The identifier for the clinical workflow definition from which to create the clinical workflow.

description
string
false

The description of the clinical workflow.

Responses

StatusMeaningDescription
201Created

Created - the clinical workflow was created successfully.

HeadersSchema
400Bad Request

Bad Request

409Conflict

A clinical workflow with the same name already exists