Update clinical job attributes
Updates the editable attributes of the specified clinical job definition in the user's workspace.
1{2 "value": {3 "version": 1,4 "resource": {5 "resourceLocation": "WORKSPACE",6 "path": "/clinical/workspaces/testfad60fd1-9293-41ef-9a8e-4ae0118c078b.cjob",7 "workspace": null8 },9 "description": "Updated clinical job with programs and parameters.",10 "logsLocation": "./",11 "resultsLocation": "./",12 "manifestLocation": "./",13 "owner": "test1",14 "runAsOwner": false,15 "programs": [16 {17 "path": "../programs/Test_0.sas",18 "version": "1.1"19 },20 {21 "path": "../programs/Test_1.sas",22 "version": "-"23 },24 {25 "path": "../programs/Test_2.sas",26 "version": "-"27 },28 {29 "path": "../programs/Test_3.sas",30 "version": "-"31 }32 ],33 "parameters": [34 {35 "name": "char_param",36 "label": "character-parameter",37 "type": "CHARACTER",38 "defaultValue": {39 "value": "This is a test"40 }41 },42 {43 "name": "char_param_masked",44 "label": "character-parameter-mask",45 "type": "CHARACTER_MASKED",46 "defaultValue": {47 "value": "*****"48 }49 },50 {51 "name": "file_param",52 "label": "file-parameter2",53 "type": "FILE",54 "defaultValue": {55 "path": "/test/Demo/inputs/input.sas7bdat"56 }57 },58 {59 "name": "folder_param",60 "label": "folder-parameter3",61 "type": "FOLDER",62 "defaultValue": {63 "path": "../Demo",64 "includeSubfolders": false65 }66 },67 {68 "name": "numeric_param",69 "label": "numeric-parameter4",70 "type": "NUMERIC",71 "defaultValue": {72 "value": 99973 }74 },75 {76 "name": "date_param",77 "label": "date-parameter5",78 "type": "DATE",79 "defaultValue": {80 "value": "2023-12-15T05:00:00Z"81 }82 }83 ],84 "publishSetup": {85 "files": [],86 "folders": []87 },88 "publishCheckin": {89 "enableVersioningOnNewFiles": false,90 "fileVersion": "MINOR",91 "locations": []92 }93 }94}
| Name | Type | Required | Description |
|---|---|---|---|
useRelativePaths | boolean | false | Specifies whether the paths referenced within the clinical job should be saved as relative paths. Relative paths are relative to the clinical job's location. The default is true. |
The attributes on the clinical job to update.
A batch of executable programs and the parameters and inputs required to execute the programs. For repository jobs, the method for handling the check-in of generated outputs can also be specified in the clinical job definition.
| Name | Type | Required | Description |
|---|---|---|---|
version | number | false | The version of the representation. This is version 1. |
resource | oneOfRepository ResourceWorkspace Resource | false | Clinical resource represents a file or container item in the user's workspace or in the clinical repository. |
description | string | false | Description of the job. |
logsLocation | string | false | Location of the log file from the clinical job execution. |
manifestLocation | string | false | Location of the manifest file from the clinical job execution. |
resultsLocation | string | false | Location of the results file from the clinical job execution. |
owner | string | false | User who owns the clinical job file in the repository. |
ownerDisplayName | string | false | Display name of clinical job owner in the repository. |
runAsOwner | boolean | false | Indicates whether the clinical job in the repository has been marked to be run as owner. |
programs | array [Clinical Job Program] | false | The programs to be run when the clinical job is executed. |
parameters | array [Clinical Job Parameter] | false | Definition of parameters that can be specified for the clinical job. |
publishSetup | Clinical Job Publish Setup | false | The file and folders to be used in the submission of a clinical repository job. This information does not apply to workspace job submissions. |
publishCheckin | Clinical Job Publish Checkin | false | Check-in specification for output files from the clinical repository job submission. This information does not apply to workspace job submissions. |
| Status | Meaning | Description | ||
|---|---|---|---|---|
| 200 | OK | OK - the clinical job was updated. | Schema | |
| 400 | Bad Request | Bad Request | ||
| 404 | Not Found | Not found - the clinical job could not be found. |