Get the collection of clinical job schedules
get/schedules
Returns a collection of clinical job schedules for the current user. The default sort is name:ascending:primary
Authorization: Requires administrative privileges to get clinical job schedules for all or other users.
1{2 "value": {3 "name": "schedules",4 "accept": "application/vnd.sas.clinical.job.schedule+json",5 "start": 0,6 "count": 3,7 "items": [8 {9 "version": 1,10 "createdBy": "test1",11 "creationTimeStamp": "2025-08-18T22:05:28.887Z",12 "modifiedBy": "test1",13 "modifiedTimeStamp": "2025-08-19T20:09:31.845Z",14 "id": "a90545d8-9023-4c9b-b293-9998c44cb25d",15 "createdByDisplayName": "Test User (test1)",16 "modifiedByDisplayName": "Test User (test1)",17 "name": "hourlyNever",18 "runAs": "test1",19 "runAsDisplayName": "Test User (test1)",20 "trigger": {21 "version": 1,22 "type": "HOURLY",23 "timeZone": "America/New_York",24 "interval": 1,25 "numOccurrences": -1,26 "start": "2025-08-18",27 "minutes": "00",28 "hours": "00"29 },30 "jobInfo": {31 "job": {32 "name": "putAll.cjob",33 "path": "/test/putAll.cjob",34 "location": "/test",35 "resourceLocation": "REPOSITORY",36 "fileVersion": ""37 }38 },39 "status": "DISABLED",40 "jobAvailable": true41 },42 {43 "version": 1,44 "createdBy": "test1",45 "creationTimeStamp": "2025-08-18T14:41:18.910Z",46 "modifiedBy": "test1",47 "modifiedTimeStamp": "2025-08-18T22:05:02.112Z",48 "id": "4651307d-42f7-4437-8221-3c8657f76b0d",49 "createdByDisplayName": "Test User (test1)",50 "modifiedByDisplayName": "Test User (test1)",51 "name": "schedForDisable",52 "runAs": "test1",53 "runAsDisplayName": "Test User (test1)",54 "trigger": {55 "version": 1,56 "type": "DAILY",57 "timeZone": "America/New_York",58 "interval": 1,59 "numOccurrences": -1,60 "start": "2025-10-31",61 "end": "2025-12-31",62 "minutes": "40",63 "hours": "10"64 },65 "jobInfo": {66 "job": {67 "name": "putAll.cjob",68 "path": "/test/putAll.cjob",69 "location": "/test",70 "resourceLocation": "REPOSITORY",71 "fileVersion": ""72 }73 },74 "status": "DISABLED",75 "jobAvailable": true76 },77 {78 "version": 1,79 "createdBy": "test1",80 "creationTimeStamp": "2025-08-19T20:11:16.002Z",81 "modifiedBy": "test1",82 "modifiedTimeStamp": "2025-08-19T20:12:53.318Z",83 "id": "f2b3144e-44bd-4bc0-8ade-e060c635ef07",84 "createdByDisplayName": "Test User (test1)",85 "modifiedByDisplayName": "Test User (test1)",86 "name": "sjhOverrides",87 "runAs": "test1",88 "runAsDisplayName": "Test User (test1)",89 "trigger": {90 "version": 1,91 "type": "DAILY",92 "timeZone": "America/New_York",93 "interval": 1,94 "numOccurrences": -1,95 "start": "2025-08-19",96 "end": "2025-09-25",97 "minutes": "15",98 "hours": "16"99 },100 "jobInfo": {101 "job": {102 "name": "multiple_param_no_default.cjob",103 "path": "/test/Schedule_Edit_Parameters_DefaultValues/multiple_param_no_default.cjob",104 "location": "/test/Schedule_Edit_Parameters_DefaultValues",105 "resourceLocation": "REPOSITORY"106 },107 "parameterValues": [108 {109 "version": 1,110 "name": "masked_param",111 "value": {112 "value": "*****"113 },114 "label": "Masked param",115 "type": "CHARACTER_MASKED"116 },117 {118 "version": 1,119 "name": "char_param",120 "value": {121 "value": "sampleParmValue"122 },123 "label": "Char param",124 "type": "CHARACTER"125 },126 {127 "version": 1,128 "name": "num_param",129 "value": {130 "value": 22131 },132 "label": "Num param",133 "type": "NUMERIC"134 },135 {136 "version": 1,137 "name": "date_param",138 "value": {139 "value": "2025-08-30T21:55:06Z"140 },141 "label": "Date param",142 "type": "DATE"143 },144 {145 "version": 1,146 "name": "file_param",147 "value": {148 "path": "/test/putAll.sas"149 },150 "label": "File param",151 "type": "FILE"152 },153 {154 "version": 1,155 "name": "folder_param",156 "value": {157 "path": "/test/mnfTest/inputsOutputs",158 "includeSubfolders": false159 },160 "label": "Folder param",161 "type": "FOLDER"162 }163 ]164 },165 "status": "ENABLED",166 "jobAvailable": true167 }168 ],169 "limit": 1000,170 "version": 2171 }172}
| Name | Type | Required | Description |
|---|---|---|---|
filter | string<filter-criteria> | false | Filter criteria for items. See Filtering in REST APIs for more information. |
limit | integer | false | The maximum number of items to return. The default is 1000 which is the maximum. Paging is not supported but filter and sort are available to customize the schedules that are returned. |
sortBy | string<sort-criteria> | false | Sorts the returned items. See Sorting in REST APIs for more information. |
| Status | Meaning | Description | ||
|---|---|---|---|---|
| 200 | OK | OK | Schema |