Get the specified clinical job definition

get/repository/definitions/{itemId}

Returns the specified clinical job definition from the repository.

Authorization: Requires READ permission.

Request Samples

1

Response Samples

1{
2 "value": {
3 "version": 1,
4 "resource": {
5 "resourceLocation": "WORKSPACE",
6 "path": "/clinical/workspaces/testfad60fd1-9293-41ef-9a8e-4ae0118c078b.cjob",
7 "workspace": null
8 },
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": false
65 }
66 },
67 {
68 "name": "numeric_param",
69 "label": "numeric-parameter4",
70 "type": "NUMERIC",
71 "defaultValue": {
72 "value": 999
73 }
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}

Path Parameters

NameTypeRequiredDescription
itemId
string
true

The unique identifier for the repository clinical job.

Query Parameters

NameTypeRequiredDescription
fileVersion
string
false

The version of the file. This applies only to files in the repository. A dash (-) represents an unversioned file. If no version is specified, the latest is returned.

Responses

StatusMeaningDescription
200OK

OK

Schema
404Not Found

Not found - the specified clinical job could not be found.