Update the specified clinical workflow

patch/workflows/{workflowId}

Updates the editable attributes of this 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}

Path Parameters

NameTypeRequiredDescription
workflowId
string
true

The unique identifier for the clinical workflow.

Header Parameters

NameTypeRequiredDescription
If-Match
string
true

The ETag that was returned from a GET, POST or PUT of a resource.

Request Body

The attributes on the clinical workflow to update.

Specifies the attributes and values to update the clinical workflow.

NameTypeRequiredDescription
attributes
object
false

Specifies the attributes and values to update. See the example for details.

Responses

StatusMeaningDescription
200OK

OK - the clinical workflow was updated.

HeadersSchema
400Bad Request

Bad Request

404Not Found

Not found - the clinical workflow could not be found.

412Precondition Failed

The ETag provided does not match the current resource.

Schema
428Precondition Required

The request headers did not include a If-Match precondition.

Schema