{ "basePath": "/rseapi/api/v1", "definitions": { "AdminLogLevel403EX": { "properties": { "message": { "description": "Response message", "example": "User is not authorized to perform the request", "type": "string" }, "status": { "description": "Response status", "example": "FORBIDEN", "type": "string" } }, "title": "Admin log level 403", "type": "object" }, "AdminServerLogLevelOKEX": { "properties": { "message": { "description": "Response message", "example": "Server log level (INFO) modification is successful", "type": "string" }, "status": { "description": "Response status", "example": "OK", "type": "string" } }, "title": "Admin Server log level OK", "type": "object" }, "AdminTokenMapContentEX": { "properties": { "entries": { "example": [ { "expiration": "2023.11.01 11:24:33:000 EST", "token": "*abcdefghij", "trackedUserID": "IBMUSER1", "userID": "IBMUSER", "validation": "OK" }, { "expiration": "2023.11.01 12:24:33:000 EST", "token": "*ABCDEEFGHIJ", "trackedUserID": "IBMUSER2", "userID": "IBMUSER", "validation": "OK" } ], "items": { "properties": { "expiration": { "type": "string" }, "token": { "type": "string" }, "trackedUserID": { "type": "string" }, "userID": { "type": "string" }, "validation": { "type": "string" } }, "type": "object" }, "type": "array" } }, "title": "Admin token map", "type": "object" }, "AdminUserLogLevelOKEX": { "properties": { "message": { "description": "Response message", "example": "User log level (2) modification is successful", "type": "string" }, "status": { "description": "Response status", "example": "OK", "type": "string" } }, "title": "Admin User log level OK", "type": "object" }, "ApiResultError": { "properties": { "errorCode": { "example": "00002", "type": "string" }, "errorMsg": { "example": "duplicated account already exist", "type": "string" }, "result": { "enum": [ false ], "type": "boolean" } }, "type": "object" }, "ApiResultOk": { "properties": { "result": { "enum": [ true ], "type": "boolean" }, "token": { "type": "string" } }, "required": [ "result", "token" ], "type": "object" }, "ServerLogsEX": { "example": { "access": "10.232.200.176 - - [21/Jan/2026:15:21:31 -0500] \"GET /rseapi/api-docs/favicon-32x32.png HTTP/1.1\" 200 628", "audit": "2026.01.21 15:21:39:470 EST PID:67372393 THREAD:12D3880000000046 TCB:006BACF0 ,FEKUNI9,BROWSE,JOB00678,0,188 Command GETSDSC CPU.cost=924", "jobId": "JOB00678", "jobName": "RSEA4997", "logDirectory": "/u/fekuni9/rseapi/logs/rseapi_4997.1/RSE/server", "rseapiServerStderr": "21-Jan-2026 15:08:10.970 INFO Ýmain¨ org.apache.catalina.startup.Catalina.start Server startup in Ý2936¨ milliseconds", "rseapiServerStdout": "2026.01.21 15:21:39:116 EST PID:67372393 DStoreDiagnosticLogCollector INFO : downloading the server log - cdcd9164-c952-423d-8b08-dd9f54649f0a" }, "properties": { "access": { "type": "string" }, "audit": { "type": "string" }, "jobId": { "type": "string" }, "jobName": { "type": "string" }, "logDirectory": { "type": "string" }, "rseapiServerStderr": { "type": "string" }, "rseapiServerStdout": { "type": "string" } }, "title": "Server Logs", "type": "object" }, "TSORunCommandEX": { "properties": { "output": { "description": "Output when running the TSO command.", "example": [ "CATALOG:CATALOG.V3S932\nUSER2.AAA.SEQ.BLK3120\nUSER2.ABC" ], "items": { "type": "string" }, "type": "array" } }, "title": "TSO Command Example", "type": "object" }, "UserLogsEX": { "example": [ { "ffs": "", "ffsget": "", "ffslock": "", "ffsput": "", "logDirectory": "/var/zexpl/logs/rseapi_4998.1/RSE/FEKUNI9", "rsecomm": "I2025.12.01 16:52:10:117 EST PID:00264028 THREAD:129EF0...\nI2025.12.01 16:52:11:134 EST PID:00264028 THREAD:129EF0..." } ], "items": { "properties": { "ffs": { "type": "string" }, "ffsget": { "type": "string" }, "ffslock": { "type": "string" }, "ffsput": { "type": "string" }, "logDirectory": { "type": "string" }, "rsecomm": { "type": "string" } }, "type": "object" }, "title": "User Logs", "type": "array" }, "allContent": { "properties": { "items": { "items": { "example": [ { "content": " J E S 2 J O B L O G -- S Y S T E M TEST -- N O D E TEST", "dsName": "IBMUSER.JOB12345.D0000002.JESMSGLG", "id": "2" }, { "content": "//TESTJES4 JOB (),MSGCLASS=H", "dsName": "IBMUSER.JOB12345.D0000003.JESJCL", "id": "3" }, { "content": "TESTING", "dsName": "IBMUSER.JOB12345.D0000004.JESYSMSG", "id": "4" } ], "properties": { "content": { "type": "string" }, "dsName": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "title": "Get all job content", "type": "object" }, "authContent": { "properties": { "password": { "description": "Password", "example": "PASSWORD", "type": "string" }, "userid": { "description": "Name of the user", "example": "USERID", "type": "string" } }, "required": [ "userid", "password" ], "title": "Authentication content", "type": "object" }, "authEx": { "properties": { "ticket": { "description": "Access ticket for the User", "example": "ZPSSGKA", "type": "string" }, "userid": { "description": "Name of the user accessing the service.", "example": "TESTUSER", "type": "string" } }, "title": "Authenticated", "type": "object" }, "authQueryEX": { "properties": { "creation": { "description": "Date and time of the created authorization token", "example": "Wed May 01 20:02:15 UTC 2024", "type": "string" }, "domain": { "description": "type of service", "example": "saf", "type": "string" }, "expiration": { "description": "Date and time of the token's expiry", "example": "Wed May 01 20:32:15 UTC 2024", "type": "string" }, "expired": { "description": "indicates whether token has expired", "example": false, "type": "boolean" }, "userid": { "description": "Name of the authorized user accessing the service.", "example": "TESTUSER", "type": "string" } }, "title": "Query Example", "type": "object" }, "commonPropertyNamespaceEX": { "properties": { "namespace": { "example": { "services": { "serviceX": 1234, "serviceY": 5677, "serviceZ": 8844 } }, "properties": { "commonProperties": { "type": "object" } }, "type": "object" } }, "title": "Common Property Namespace", "type": "object" }, "commonPropertyNamespacesEX": { "properties": { "namespaces": { "example": [ "ACMEServices1", "ACMEServices2", "ACMEServices3" ], "items": { "properties": { "namespace": { "type": "string" } } }, "type": "array" } }, "title": "Common Property Namespaces", "type": "object" }, "commonPropertySuccessResponseEX": { "example": { "result": "success" }, "properties": { "result": { "type": "string" } }, "title": "Common Property Success Response", "type": "object" }, "content": { "properties": { "content": { "description": "The content within a JES Job file", "example": "...05 MAR 2019 ----\n16.25.39 STC01800 $HASP373 BPXAS STARTED\n16.25.39 STC01800... ", "type": "string" } }, "title": "JES Content", "type": "object" }, "contentExportPartial": { "properties": { "message": { "description": "The content within a JES Job file", "example": "ALVINSO.TESTJE21.JOB11722.D0000002.JESMSGLG is exported to data set ALVINSO.SPOOL88. The contents are truncated due to the record length of the data set.", "type": "string" }, "status": { "description": "Response status", "example": "PARTIAL_CONTENT", "type": "string" } }, "title": "JES Content", "type": "object" }, "contentExportSuccess": { "properties": { "message": { "description": "The content within a JES Job file", "example": "ALVINSO.TESTJE21.JOB11722.D0000002.JESMSGLG is exported to data set ALVINSO.TEST24.", "type": "string" }, "status": { "description": "Response status", "example": "OK", "type": "string" } }, "title": "JES Content", "type": "object" }, "contentJson": { "properties": { "services": { "description": "JSON Key/Value Pairs", "example": { "serviceX": 1234 }, "type": "integer" } }, "title": "JSON Content", "type": "object" }, "contentMVS": { "properties": { "records": { "description": "The content of the data set, with \\n for new lines", "example": "//TESTJOBX JOB (),MSGCLASS=H\n// EXEC PGM=IEFBR14", "type": "string" } }, "title": "MVS Content", "type": "object" }, "contentScan": { "properties": { "content": { "description": "Content to scan", "example": "PASTE THE CONTENT HERE", "type": "string" } }, "title": "Scan from Content", "type": "object" }, "contentUnix": { "properties": { "content": { "description": "Content of the file", "example": "Hello world!", "type": "string" } }, "title": "UNIX Content", "type": "object" }, "copyFromDataSetPartialSuccResponse": { "properties": { "failed": { "items": { "properties": { "error": { "type": "string" }, "file": { "type": "string" } } }, "type": "array" }, "saved": { "items": { "properties": { "PDSmember": { "type": "string" } } }, "type": "array" } }, "title": "Copy Data Set to UNIX partial success response example", "type": "object" }, "copyFromDataSetResponse": { "properties": { "saved": { "items": { "properties": { "PDSmember": { "type": "string" } } }, "type": "array" } }, "title": "Copy Data Set to UNIX success response example", "type": "object" }, "copyToDataSetPartialSuccResponse": { "properties": { "failed": { "items": { "properties": { "error": { "type": "string" }, "file": { "type": "string" } } }, "type": "array" }, "saved": { "items": { "properties": { "PDSmember": { "type": "string" } } }, "type": "array" } }, "title": "Copy UNIX to Data Set partial success response example", "type": "object" }, "copyToDataSetResponse": { "properties": { "saved": { "items": { "properties": { "PDSmember": { "type": "string" } } }, "type": "array" } }, "title": "Copy UNIX to Data Set success response example", "type": "object" }, "datasetAttributes": { "properties": { "items": { "example": [ { "allocationUnit": "TRACKS", "blockSize": 27920, "creationDate": "Tue Nov 03 2020 UTC", "dataClass": "**None**", "dataSetOrganization": "PS", "dsnType": "SEQ", "extents": 1, "maxgens": "Unavailable", "mgmtClass": "**None**", "migrated": false, "name": "TST.ACCESS.READ.SEQ.SYMBOL.VM30094", "primary": 1, "recordFormat": "FB", "recordLength": 80, "referenceDate": "Tue Apr 23 2024 UTC", "secondary": 1, "storClass": "SCUSR", "type": "NONVSAM", "volumeSerial": "V3S93B" }, { "migrated": false, "name": "USER.ABC.READ.VSAM", "type": "CLUSTER", "volumeSerial": "*VSAM*" }, { "migrated": true, "name": "USER.ABC.TEST", "type": "NONVSAM", "volumeSerial": "MIGRAT" } ], "items": { "properties": { "allocationUnit": { "type": "string" }, "blockSize": { "type": "string" }, "creationDate": { "type": "string" }, "creationTime": { "type": "string" }, "dataClass": { "type": "string" }, "dataSetOrganization": { "type": "string" }, "dsName": { "type": "string" }, "dsnType": { "type": "string" }, "expirationDate": { "type": "string" }, "extents": { "type": "string" }, "maxgens": { "type": "string" }, "mgmtClass": { "type": "string" }, "migrated": { "type": "string" }, "name": { "type": "string" }, "primary": { "type": "string" }, "recordFormat": { "type": "string" }, "recordLength": { "type": "string" }, "referenceDate": { "type": "string" }, "secondary": { "type": "string" }, "storClass": { "type": "string" }, "type": { "type": "string" }, "volumeSerial": { "type": "string" } }, "type": "object" }, "type": "array" } }, "title": "MVS Dataset", "type": "object" }, "deleteDataset": { "title": "delete" }, "displayActiveAllResponse": { "properties": { "content": { "description": "Display Active (All) response", "example": { "all_cpu": "00:03:23.700", "all_cpu%": "0.06", "asid": "1", "asidx": "0x0001", "cpu_task": "00:03:23.700", "dp": "0xFF", "elapsed": "5,04:39:36.205", "hvcomhwm": "2.01G", "hvcomused": "6.00M", "io_rate": "0.00", "job_class": "", "job_id": "", "job_name": "*MASTER*", "job_proc": "", "job_step": "", "page_rate": "0.00", "position": "N/S", "position_description": "Non-swappable", "real_in_bytes": "50.34K", "real_in_frames": "3.15K", "sr": "", "sr_description": "", "step_io": "14.84K", "subtype": "SYS", "swapin": "TRUE", "system_name": "VM30095", "task_cpu%": "0.06", "type": "STC", "user_id": "+MASTER+" }, "type": "string" } }, "title": "Display Active (All) response", "type": "object" }, "displayActiveSysResponse": { "properties": { "content": { "description": "Display Active (Sys) response", "example": { "cpu%": "4.02", "number_of_100%_busy_cpus": "0", "number_of_cpus": "3", "page_rate": "0.00", "system_max": "2105", "system_name": "VM30095" }, "type": "string" } }, "title": "Display Active (Sys) response", "type": "object" }, "downloadResponse": { "title": "Download File", "type": "object" }, "emptyBody": { "example": [ {} ], "title": "Empty Body", "type": "object" }, "emptyResponse": { "title": "empty", "type": "object" }, "event": { "properties": { "data": { "description": "Data for the event", "example": "", "type": "string" }, "duration": { "description": "Event duration in milliseconds", "example": "3200", "type": "string" }, "endTime": { "description": "Event end time", "example": "Mon Jan 22 15:40:52 UTC 2026", "type": "string" }, "id": { "description": "Event ID", "example": "event-1769699291947", "type": "string" }, "name": { "description": "Event name", "example": "Unix command", "type": "string" }, "startTime": { "description": "Event start time", "example": "Mon Jan 22 15:38:50 UTC 2026", "type": "string" }, "status": { "description": "Event status", "example": "COMPLETED", "type": "string" } }, "title": "EVENT", "type": "object" }, "file": { "properties": { "link": { "description": "Relative address of the file or folder", "example": "/test/test2", "type": "string" }, "name": { "description": "Name of the file or folder", "example": "hello.txt", "type": "string" }, "type": { "description": "Type is either file or folder", "example": "file", "type": "string" } }, "title": "UNIX File/Folder", "type": "object" }, "holdJclContent": { "properties": { "request": { "description": "The JCL Content", "example": "hold", "type": "string" } }, "title": "Cancel JCL Content", "type": "object" }, "jclContent": { "properties": { "jcl": { "description": "The JCL Content", "example": "//TESTJES4 JOB (),MSGCLASS=H\n// EXEC PGM=IEFBR14", "type": "string" } }, "title": "JCL Content", "type": "object" }, "jclContentResponse": { "properties": { "content": { "description": "The JCL Content", "example": "//TESTJES4 JOB (),MSGCLASS=H\n// EXEC PGM=IEFBR14", "type": "string" } }, "title": "JCL Content", "type": "object" }, "jclDatasetContent": { "properties": { "file": { "description": "The JCL Dataset Content", "example": "TST.ACCESS.WRITE.PDS(ANAGRAM)", "type": "string" } }, "title": "JCL Dataset Content", "type": "object" }, "jclUnixContent": { "properties": { "file": { "description": "The JCL Unix File Content", "example": "/u/IBM/test/exec.jcl", "type": "string" } }, "title": "JCL Unix File Content", "type": "object" }, "job": { "properties": { "execMember": { "description": "Execution member name", "example": "M012", "type": "string" }, "execSystem": { "description": "Execution system name", "example": "VM12345", "type": "string" }, "executionClass": { "description": "Execution class", "example": "A", "type": "string" }, "jobId": { "description": "ID of the job", "example": "JOB123", "type": "string" }, "jobName": { "description": "Name of the job", "example": "TESTJOB", "type": "string" }, "owner": { "description": "Name of the owner", "example": "USER1", "type": "string" }, "phaseName": { "description": "Phase Name", "example": "20", "type": "string" }, "returnCode": { "description": "Return code", "example": "CC 0000", "type": "string" }, "status": { "description": "Status of the job", "example": "ACTIVE", "type": "string" }, "subsystem": { "description": "Name of the subsystem", "example": "JES2", "type": "string" }, "systemEntryDateTime": { "description": "System entry date and time", "example": "Mon Apr 22 15:38:50 UTC 2024", "type": "string" }, "type": { "description": "Type of the job", "example": "JOB", "type": "string" } }, "title": "JES Job", "type": "object" }, "jobsDelete": { "properties": { "message": { "example": "ss", "type": "string" } }, "title": "Delete Jobs", "type": "object" }, "listDatasets": { "properties": { "items": { "example": [ { "migrated": false, "name": "IBM.FILTER.MBR.PDS05K" }, { "migrated": false, "name": "IBM.FILTER.MBR.PDS06K" }, { "migrated": false, "name": "IBM.FILTER.MBR.PDS07K" }, { "migrated": false, "name": "IBM.FILTER.MBR.PDS08K" } ], "items": { "properties": { "migrated": { "type": "boolean" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" } }, "title": "List Datasets", "type": "object" }, "listGDSEntries": { "properties": { "items": { "example": [ { "migrated": false, "name": "USER1.GDG01.G0001V01" }, { "migrated": true, "name": "USER1.GDG01.G0002V00" }, { "migrated": false, "name": "USER1.GDG01.G0003V01" }, { "migrated": false, "name": "USER1.GDG01.G0004V00" } ], "items": { "properties": { "migrated": { "type": "boolean" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" } }, "title": "List GDS entries", "type": "object" }, "listJobs": { "properties": { "items": { "example": [ { "execMember": "M012", "execSystem": "VM12345", "executionClass": "A", "jobID": "JOB01195", "jobName": "TESTCR", "owner": "IBM", "phaseName": "Job is actively executing", "returnCode": "CC 0000", "status": "ACTIVE", "subsystem": "JES2", "systemEntryDateTime": "Mon Apr 22 15:38:50 UTC 2024", "type": "JOB" }, { "execMember": "", "execSystem": "", "executionClass": "A", "jobID": "JOB01145", "jobName": "TESTSR", "owner": "IBM", "phaseName": "Job is on the hard copy queue", "returnCode": "CC 0000", "status": "COMPLETION", "subsystem": "JES2", "systemEntryDateTime": "Mon Apr 22 15:38:50 UTC 2024", "type": "JOB" }, { "execMember": "", "execSystem": "", "executionClass": "A", "jobID": "JOB01123", "jobName": "TESTXR", "owner": "IBM", "phaseName": "Job is on the hard copy queue", "returnCode": "CC 0000", "status": "COMPLETION", "subsystem": "JES2", "systemEntryDateTime": "Mon Apr 22 15:38:50 UTC 2024", "type": "JOB" } ], "items": { "properties": { "execMember": { "type": "string" }, "execSystem": { "type": "string" }, "executionClass": { "type": "string" }, "jobId": { "type": "string" }, "jobName": { "type": "string" }, "owner": { "type": "string" }, "phaseName": { "type": "string" }, "returnCode": { "type": "string" }, "status": { "type": "string" }, "subsystem": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" } }, "title": "List Datasets", "type": "object" }, "listJobsFiles": { "properties": { "items": { "example": [ { "date": "Thu Apr 03 2025 EDT", "ddName": "JESMSGLG", "dsName": "TESTUSER.USERTEST.DD0000002.JSEMGI", "id": "2", "proc step": "", "recordCount": "65", "step name": "JES2", "timestamp": "21:35:39 EDT" }, { "date": "Thu Apr 03 2025 EDT", "ddName": "JESJCL", "dsName": "TESTUSER.USERTEST.DD0000003.JESJCL", "id": "3", "proc step": "", "recordCount": "75", "step name": "JES2", "timestamp": "21:35:39 EDT" }, { "date": "Thu Apr 03 2025 EDT", "ddName": "JESYSMSG", "dsName": "TESTUSER.USERTEST.DD0000002.JESYSMSG", "id": "4", "proc step": "", "recordCount": "12", "step name": "JES2", "timestamp": "21:35:39 EDT" } ], "items": { "properties": { "date": { "type": "string" }, "ddName": { "type": "string" }, "dsName": { "type": "string" }, "id": { "type": "string" }, "proc step": { "type": "string" }, "recordCount": { "type": "string" }, "step name": { "type": "string" }, "timestamp": { "type": "string" } }, "type": "object" }, "type": "array" } }, "title": "List Job Spool Files", "type": "object" }, "member": { "properties": { "items": { "example": [ "A0000005", "A0000006", "A0000020", "B0000033", "R0000005", "W0000045", "X0000005", "X0000009" ], "items": { "$ref": "#/definitions/memberItem" }, "type": "array" } }, "title": "MVS Member", "type": "object" }, "memberItem": { "properties": { "member": { "type": "string" } }, "type": "object" }, "mvsContentPUT": { "properties": { "records": { "description": "The content for a data set", "example": "RSED", "type": "string" } }, "title": "MVS Dataset Content", "type": "object" }, "mvsDatasetPOST": { "properties": { "allocationUnit": { "description": "Allocation/space unit", "example": "BLOCK", "type": "string" }, "blockSize": { "description": "Block Size", "example": 400, "type": "integer" }, "catalogId": { "description": "Id of the integrated catalog facility (ICF) catalog that contains this VSAM entry, The default is the system catalog search order", "example": "", "type": "string" }, "clusterBufferSpace": { "description": "The minimum buffer space to be allocated at open time", "example": 37888, "type": "integer" }, "clusterCISize": { "description": "The size of the control interval for the data component of the data set", "example": 18432, "type": "integer" }, "clusterErase": { "description": "To indicate whether the space occupied by the data set is to be overwritten with binary zeros when the data set is deleted", "example": "NO", "type": "string" }, "clusterKeyLen": { "description": "Record key length", "example": "60", "type": "integer" }, "clusterKeyOffset": { "description": "The position of the key within the record", "example": "0", "type": "integer" }, "clusterRecovery": { "description": "To indicate whether the storage allocated to your data component is to be formatted before records are inserted", "example": "YES", "type": "string" }, "clusterReuse": { "description": "To indicate whether the data set can be reset to empty status at open time", "example": "NO", "type": "string" }, "clusterShareCrossRegion": { "description": "How the cluster can be shared among users on one system", "example": 2, "type": "integer" }, "clusterShareCrossSystem": { "description": "How the cluster can be shared among users on different systems", "example": 3, "type": "integer" }, "clusterSpanned": { "description": "To indicate whether to allow a data record to span control intervals", "example": "NO", "type": "string" }, "clusterWritecheck": { "description": "to indicate whether the catalog is to be checked by a direct access device operation called write check when a record is written.", "example": "NO", "type": "string" }, "data": { "description": "Data component. The part of a VSAM data set, alternate index, or catalog that contains the data records.", "example": "", "type": "String" }, "dataAllocAverageRecSize": { "description": "The Length of all records (for RRDS data sets) or the average length of data set's records", "example": 60, "type": "integer" }, "dataAllocFreeSpacePercentCA": { "description": "The percentage of each control area that is to be set aside as free space when the VSAM data set is initially loaded, during a mass insert, and after a CI-splitn", "example": 0, "type": "integer" }, "dataAllocFreeSpacePercentCI": { "description": "The percentage of each control interval that is to be set aside as free space when the VSAM data set is initially loaded, during a mass insert, and after a CI-split", "example": 0, "type": "integer" }, "dataAllocMaxRecSize": { "description": "Data record maximum length", "example": 60, "type": "integer" }, "dataAllocPrimaryUnits": { "description": "Amount to be used for data primary space allocation", "example": 5, "type": "integer" }, "dataAllocSecondaryUnits": { "description": "Amount to be used for data secondary space allocation", "example": 5, "type": "integer" }, "dataAllocSpaceUnit": { "description": "Primary and secondary space unit for data allocation", "example": "TRK", "type": "string" }, "dataAllocVolumeSerials": { "description": "Data component volume serial(s)", "example": "", "type": "string" }, "dataClass": { "description": "Data Class", "example": "", "type": "string" }, "dataSetOrganization": { "description": "Dataset Organization", "example": "PO", "type": "string" }, "deviceType": { "description": "Device Type", "example": "3390", "type": "string" }, "directoryBlocks": { "description": "Directory Blocks", "example": 5, "type": "integer" }, "dsnType": { "description": "Dataset type", "example": "LIBRARYv2", "type": "string" }, "index": { "description": "Index component. Using the index, VSAM is able to randomly retrieve a record's data given a certain key", "example": "", "type": "string" }, "indexAllocCISize": { "description": "The size of the control interval for the index component of the cluster", "example": 1024, "type": "integer" }, "indexAllocSpaceUnit": { "description": "Primary and secondary space unit for index component allocation", "example": "TRK", "type": "string" }, "indexAllocVolumeSerials": { "description": "Index component volume serial(s)", "example": "", "type": "string" }, "indexPrimaryUnits": { "description": "Amount to be used for index primary space allocation", "example": 2, "type": "integer" }, "indexSecondaryUnits": { "description": "Amount to be used for index secondary space allocation", "example": 2, "type": "integer" }, "managementClass": { "description": "Management Class", "example": "", "type": "string" }, "name": { "description": "Dataset Name", "example": "USER.ABC", "type": "string" }, "primary": { "description": "Primary Space allocation", "example": 301, "type": "integer" }, "recordFormat": { "description": "Record Format", "example": "FB", "type": "string" }, "recordLength": { "description": "Record Length", "example": 80, "type": "integer" }, "secondary": { "description": "Secondary Space Allocation", "example": 100, "type": "integer" }, "storageClass": { "description": "Storage Class", "example": "SCUSR", "type": "string" }, "volumeSerial": { "description": "Volume Serial", "example": "", "type": "string" }, "vsamType": { "description": "VSAM data set type", "example": "KSDS", "type": "string" } }, "title": "MVS Dataset Properties", "type": "object" }, "mvsDatasetWithoutDSNamePOST": { "properties": { "allocationUnit": { "description": "Allocation/space unit", "example": "BLOCK", "type": "string" }, "blockSize": { "description": "Block Size", "example": 400, "type": "integer" }, "catalogId": { "description": "Id of the integrated catalog facility (ICF) catalog that contains this VSAM entry, The default is the system catalog search order", "example": "", "type": "string" }, "clusterBufferSpace": { "description": "The minimum buffer space to be allocated at open time", "example": 37888, "type": "integer" }, "clusterCISize": { "description": "The size of the control interval for the data component of the data set", "example": 18432, "type": "integer" }, "clusterErase": { "description": "To indicate whether the space occupied by the data set is to be overwritten with binary zeros when the data set is deleted", "example": "NO", "type": "string" }, "clusterKeyLen": { "description": "Record key length", "example": "60", "type": "integer" }, "clusterKeyOffset": { "description": "The position of the key within the record", "example": "0", "type": "integer" }, "clusterRecovery": { "description": "To indicate whether the storage allocated to your data component is to be formatted before records are inserted", "example": "YES", "type": "string" }, "clusterReuse": { "description": "To indicate whether the data set can be reset to empty status at open time", "example": "NO", "type": "string" }, "clusterShareCrossRegion": { "description": "How the cluster can be shared among users on one system", "example": 2, "type": "integer" }, "clusterShareCrossSystem": { "description": "How the cluster can be shared among users on different systems", "example": 3, "type": "integer" }, "clusterSpanned": { "description": "To indicate whether to allow a data record to span control intervals", "example": "NO", "type": "string" }, "clusterWritecheck": { "description": "to indicate whether the catalog is to be checked by a direct access device operation called write check when a record is written.", "example": "NO", "type": "string" }, "data": { "description": "Data component", "example": "", "type": "String" }, "dataAllocAverageRecSize": { "description": "The Length of all records (for RRDS data sets) or the average length of data set's records", "example": 60, "type": "integer" }, "dataAllocFreeSpacePercentCA": { "description": "The percentage of each control area that is to be set aside as free space when the VSAM data set is initially loaded, during a mass insert, and after a CI-splitn", "example": 0, "type": "integer" }, "dataAllocFreeSpacePercentCI": { "description": "The percentage of each control interval that is to be set aside as free space when the VSAM data set is initially loaded, during a mass insert, and after a CI-split", "example": 0, "type": "integer" }, "dataAllocMaxRecSize": { "description": "Data record maximum length", "example": 60, "type": "integer" }, "dataAllocPrimaryUnits": { "description": "Amount to be used for data primary space allocation", "example": 5, "type": "integer" }, "dataAllocSecondaryUnits": { "description": "Amount to be used for data secondary space allocation", "example": 5, "type": "string" }, "dataAllocSpaceUnit": { "description": "Primary and secondary space unit for data allocation", "example": "TRK", "type": "string" }, "dataAllocVolumeSerials": { "description": "Data component volume serial(s)", "example": "", "type": "string" }, "dataClass": { "description": "Data Class", "example": "", "type": "string" }, "dataSetOrganization": { "description": "Dataset Organization", "example": "PO", "type": "string" }, "deviceType": { "description": "Device Type", "example": "3390", "type": "string" }, "directoryBlocks": { "description": "Directory Block", "example": 5, "type": "string" }, "dsnType": { "description": "Dataset type", "example": "LIBRARYv2", "type": "string" }, "index": { "description": "Index component", "example": "", "type": "string" }, "indexAllocCISize": { "description": "The size of the control interval for the index component of the cluster", "example": 1024, "type": "integer" }, "indexAllocSpaceUnit": { "description": "Primary and secondary space unit for index component allocation", "example": "TRK", "type": "string" }, "indexAllocVolumeSerials": { "description": "Index component volume serial(s)", "example": "", "type": "string" }, "indexPrimaryUnits": { "description": "Amount to be used for index primary space allocation", "example": 2, "type": "integer" }, "indexSecondaryUnits": { "description": "Amount to be used for index secondary space allocation", "example": 2, "type": "integer" }, "managementClass": { "description": "Management Class", "example": "", "type": "string" }, "primary": { "description": "Primary Space allocation", "example": 301, "type": "integer" }, "recordFormat": { "description": "Record Format", "example": "FB", "type": "string" }, "recordLength": { "description": "Record Length", "example": 80, "type": "integer" }, "secondary": { "description": "Secondary Space Allocation", "example": 100, "type": "integer" }, "storageClass": { "description": "Storage Class", "example": "", "type": "string" }, "volumeSerial": { "description": "Volume Serial", "example": "", "type": "string" }, "vsamType": { "description": "VSAM data set type", "example": "KSDS", "type": "string" } }, "title": "MVS Dataset Properties", "type": "object" }, "mvsGetLockInfoAll": { "properties": { "dsn": { "example": "FEKUNI6.PDS.JCL", "type": "string" }, "lockInfo": { "example": [ { "ASID": "14d", "JobName": "RS135322", "Member": "MEMBER3", "System": "VM30096", "TCB": "6c6c68", "TrackingDate": 20210913152111, "UserID": "FEKUNI6" }, { "ASID": "1b0", "JobName": "B135363", "Member": "MEMBER5", "System": "VM30095", "TCB": "6c2e88", "TrackingDate": 20210913152113, "UserID": "FEKUNI0" } ], "items": { "properties": { "ASID": { "type": "string" }, "JobName": { "type": "string" }, "Member": { "type": "string" }, "System": { "type": "string" }, "TCB": { "type": "string" }, "TrackingDate": { "type": "string" }, "UserID": { "type": "string" }, "phaseName": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "type": "array" } }, "title": "LockInfo", "type": "object" }, "mvsGetLockOwner": { "properties": { "lockOwner": { "example": "FEKUNI1", "type": "string" }, "resource": { "example": "TST.SEQ1", "type": "string" } }, "title": "LockOwner", "type": "object" }, "mvsGetMappings": { "properties": { "default.encoding": { "example": "IBM-1047", "type": "string" }, "mappings": { "items": { "properties": { "encoding": { "example": "UTF-16BE", "type": "string" }, "extension": { "example": "err", "type": "string" }, "resource": { "example": "**ERRWDZ", "type": "string" }, "transfer": { "example": "binary", "type": "string" } }, "type": "object" }, "type": "array" } }, "title": "MVS Mappings", "type": "object" }, "mvsPutLock": { "properties": { "lockOwner": { "example": "FEKUNI1", "type": "string" }, "message": { "example": "TST.SEQ1 is locked by FEKUNI1", "type": "string" }, "resource": { "example": "TST.SEQ1", "type": "string" } }, "title": "Lock", "type": "object" }, "mvsPutUnlock": { "properties": { "lockOwner": { "example": "", "type": "string" }, "message": { "example": "TST.SEQ1 is unlocked", "type": "string" }, "resource": { "example": "TST.SEQ1", "type": "string" } }, "title": "Lock", "type": "object" }, "mvsQueryCountResult": { "properties": { "datasetsCount": { "example": 65, "type": "integer" }, "filter": { "example": "IBMUSER.*", "type": "string" } }, "title": "MVS Datasets count", "type": "object" }, "mvsSearchPDS": { "properties": { "found": { "example": [ { "dataset": "TSTDS.PDS.EXDS.ABC" }, { "dataset": "TSTDS.PDS.EXDS.BCD" }, { "dataset": "TSTDS.PDS.EXDS.CDZ" } ], "items": { "properties": { "dataset": { "type": "string" } }, "type": "object" }, "type": "array" } }, "title": "PDS search example", "type": "object" }, "mvsSearchPDSMember": { "properties": { "found": { "example": [ { "dataset": "TSTDS.ABC", "matches": [ { "line": "1", "string": "IBM Mainframe Z" }, { "line": "2", "string": "I work for IBM" } ], "member": "HUH" }, { "dataset": "TSTDS.XYZ", "matches": [ { "line": "3", "string": "IBM Systems" }, { "line": "4", "string": "IBM HYBRID CLOUD" } ], "member": "AHH" } ], "items": { "properties": { "dataset": { "type": "string" }, "matches": { "items": { "properties": { "line": { "type": "string" }, "string": { "type": "string" } }, "type": "object" }, "type": "array" }, "member": { "type": "string" } }, "type": "object" }, "type": "array" } }, "title": "PDSMember search example", "type": "object" }, "mvsSearchSEQ": { "properties": { "found": { "example": [ { "dataset": "TSTDS.SEQ.ABC", "matches": [ { "line": "1", "string": "AQQ" }, { "line": "4", "string": "AQQ HELLO" } ] }, { "dataset": "TSTDS.SEQ.XYZ", "matches": [ { "line": "5", "string": "AQQ" }, { "line": "7", "string": "MACHINE LEARNING AQQ" } ] } ], "items": { "properties": { "dataset": { "type": "string" }, "matches": { "items": { "properties": { "line": { "type": "string" }, "string": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "title": "SEQ search example", "type": "object" }, "mvsVSAMPropertiesDisplay": { "properties": { "alternateIndex": { "description": "Alternate index to provides a secondary way to access records", "example": "USER1.VSAM01.AIX1.INDEX", "type": "string" }, "alternateIndexPath": { "description": "Alternate index path, a logical link connects an alternate Index to its base VSAM cluster", "example": "USER1.VSAM01.AIX1PATH", "type": "string" }, "blockSize": { "description": "Block size", "example": "", "type": "integer" }, "clusterBufferSpace": { "description": "The minimum buffer space to be allocated at open time", "example": 9728, "type": "integer" }, "clusterCISize": { "description": "The size of the control interval for the data component of the data set", "example": 4096, "type": "integer" }, "clusterErase": { "description": "To indicate whether the space occupied by the data set is to be overwritten with binary zeros when the data set is deleted", "example": "N", "type": "string" }, "clusterKeyLen": { "description": "Record key length", "example": "4", "type": "integer" }, "clusterKeyOffset": { "description": "The position of the key within the record", "example": "0", "type": "integer" }, "clusterRecovery": { "description": "To indicate whether the storage allocated to your data component is to be formatted before records are inserted", "example": "N", "type": "string" }, "clusterReuse": { "description": "To indicate whether the data set can be reset to empty status at open time", "example": "N", "type": "string" }, "clusterShareCrossRegion": { "description": "How the cluster can be shared among users on one system", "example": 3, "type": "integer" }, "clusterShareCrossSystem": { "description": "How the cluster can be shared among users on different systems", "example": 3, "type": "integer" }, "clusterSpanned": { "description": "To indicate whether to allow a data record to span control intervals", "example": "N", "type": "string" }, "clusterWritecheck": { "description": "to indicate whether the catalog is to be checked by a direct access device operation called write check when a record is written.", "example": "N", "type": "string" }, "compressed": { "description": "Data compression mode", "example": "N", "type": "string" }, "createTime": { "description": "Data set creation time", "example": "10/28/2021 00:00", "type": "string" }, "dataAllocAverageRecSize": { "description": "The Length of all records (for RRDS data sets) or the average length of data set's records", "example": 1024, "type": "integer" }, "dataAllocFreeSpacePercentCA": { "description": "The percentage of each control area that is to be set aside as free space when the VSAM data set is initially loaded, during a mass insert, and after a CI-splitn", "example": 0, "type": "integer" }, "dataAllocFreeSpacePercentCI": { "description": "The percentage of each control interval that is to be set aside as free space when the VSAM data set is initially loaded, during a mass insert, and after a CI-split", "example": 0, "type": "integer" }, "dataAllocMaxRecSize": { "description": "Data record maximum length", "example": 32756, "type": "integer" }, "dataAllocPrimaryUnits": { "description": "Amount to be used for data primary space allocation", "example": 3, "type": "integer" }, "dataAllocSecondaryUnits": { "description": "Amount to be used for data secondary space allocation", "example": 1, "type": "integer" }, "dataAllocSpaceUnit": { "description": "Primary and secondary space allocation unit for the data component", "example": "CYL", "type": "string" }, "dataAllocVolumeSerials": { "description": "Data component volume serial(s)", "example": "V3S93O", "type": "string" }, "dataClass": { "description": "Data Class", "example": "", "type": "string" }, "dataComponent": { "description": "Data component. The part of a VSAM data set, alternate index, or catalog that contains the data records.", "example": "USER1.VSAM01.DATA", "type": "String" }, "extended": { "description": "Extended format structure", "example": "N", "type": "string" }, "extendedAddress": { "description": "Extended addressability capability", "example": "N", "type": "string" }, "indexAllocCISize": { "description": "The size of the control interval for the index component of the cluster", "example": 1536, "type": "integer" }, "indexAllocSpaceUnit": { "description": "Primary and secondary space allocation unit of the index component", "example": "TRK", "type": "string" }, "indexAllocVolumeSerials": { "description": "Index component volume serial(s)", "example": "V3S93O", "type": "string" }, "indexComponent": { "description": "Index component. Using the index, VSAM is able to use fast random access to retrieve a record by key", "example": "USER1.VSAM01.INDEX", "type": "string" }, "indexPrimaryUnits": { "description": "Amount to be used for index primary space allocation", "example": 1, "type": "integer" }, "indexSecondaryUnits": { "description": "Amount to be used for index secondary space allocation", "example": 1, "type": "integer" }, "managementClass": { "description": "Management Class", "example": "", "type": "string" }, "modifiedTime": { "description": "Data set last modified time", "example": "", "type": "string" }, "name": { "description": "Data set Name", "example": "USER1.VSAM01", "type": "string" }, "numExtends": { "description": "Number of data set extents per volume", "example": 0, "type": "integer" }, "recordFormat": { "description": "Record format. Varies by VSAM type", "example": "", "type": "string" }, "recordLength": { "description": "Record length", "example": "1024", "type": "integer" }, "storageClass": { "description": "Storage Class", "example": "", "type": "string" }, "vsamType": { "description": "VSAM data set type", "example": "KSDS", "type": "string" } }, "title": "MVS VSAM Cluster Properties", "type": "object" }, "mvsgetContent": { "properties": { "records": { "example": "//SYSCPRT DD SYSOUT=&SYSOUT1,DCB=(LRECL=137)", "type": "string" } }, "title": "MVS Content", "type": "object" }, "operationJclContent": { "properties": { "request": { "description": "The JCL Content", "example": "cancel|release|hold", "type": "string" } }, "title": "JCL Content Operation", "type": "object" }, "pdsMemberAttributes": { "properties": { "items": { "example": [ { "creationDate": "Fri Jan 17 2025 EST", "lastModifiedBy": "USER1", "lastModifiedDate": "Wed Jan 21 09:57:59 EST 2026", "lineCount": "10", "lockOwnerID": "", "memberName": "MEMBER1", "revision": "01.03" }, { "creationDate": "Mon Jan 19 2026 EST", "lastModifiedBy": "USER1", "lastModifiedDate": "Mon Jan 26 10:07:37 EST 2026", "lineCount": "20", "lockOwnerID": "USER9", "memberName": "MEMBER2", "revision": "01.02" } ], "items": { "properties": { "creationDate": { "type": "string" }, "lastModifiedBy": { "type": "string" }, "lastModifiedDate": { "type": "string" }, "lineCount": { "type": "integer" }, "lockOwnerID": { "type": "string" }, "memberName": { "type": "string" }, "revision": { "type": "string" } }, "type": "object" }, "type": "array" } }, "title": "MVS Dataset member", "type": "object" }, "scanContainerInfoEX": { "items": { "properties": { "extension": { "example": "asm", "type": "string" }, "fileTypeCd": { "example": "INCL", "type": "string" }, "languageCD": { "example": "ASM", "type": "string" }, "logicalName": { "example": "ABEND", "type": "string" }, "name": { "example": "ABEND", "type": "string" }, "references": { "items": { "properties": { "fileLineNo": { "example": 3, "type": "integer" }, "fileTypeCd": { "example": "MAC,", "type": "string" }, "name": { "example": "ABEND", "type": "string" }, "startColumnNo": { "example": 9, "type": "integer" }, "type": { "example": "MACRO_DEF", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "title": "Container Source Info", "type": "array" }, "scanSourceInfoContentEX": { "properties": { "extension": { "example": "asm", "type": "string" }, "fileTypeCd": { "example": "INCL", "type": "string" }, "languageCD": { "example": "ASM", "type": "string" }, "logicalName": { "example": "ABEND", "type": "string" }, "name": { "example": "ABEND", "type": "string" }, "references": { "items": { "properties": { "fileLineNo": { "example": 3, "type": "integer" }, "fileTypeCd": { "example": "MAC,", "type": "string" }, "name": { "example": "ABEND", "type": "string" }, "startColumnNo": { "example": 9, "type": "integer" }, "type": { "example": "MACRO_DEF", "type": "string" } }, "type": "object" }, "type": "array" } }, "title": "UNIX Scan Source Info", "type": "object" }, "scanSourceInfoEX": { "properties": { "extension": { "example": "asm", "type": "string" }, "fileTypeCd": { "example": "INCL", "type": "string" }, "languageCD": { "example": "ASM", "type": "string" }, "logicalName": { "example": "ABEND", "type": "string" }, "name": { "example": "ABEND", "type": "string" }, "references": { "items": { "properties": { "fileLineNo": { "example": 3, "type": "integer" }, "fileTypeCd": { "example": "MAC,", "type": "string" }, "name": { "example": "ABEND", "type": "string" }, "startColumnNo": { "example": 9, "type": "integer" }, "type": { "example": "MACRO_DEF", "type": "string" } }, "type": "object" }, "type": "array" } }, "title": "Source Info", "type": "object" }, "search": { "properties": { "file name": { "description": "name of the result file", "example": "hello.txt", "type": "string" }, "matches": { "description": "array of results", "properties": { "endOffset": { "type": "string" }, "line": { "type": "string" }, "startOffset": { "type": "string" }, "text": { "type": "string" } }, "type": "object" }, "path": { "description": "Path of the parent directory to the file", "example": "/test/test2", "type": "string" } }, "title": "UNIX Search", "type": "object" }, "serverDetailsEX": { "example": [ { "base_path": "rseapi", "cea_tso_set": false, "json_pretty_output": true, "rce_enabled": true, "rse_version": "3.4.3", "rseapi_auth_methods": "bearer, basic, certificate", "rseapi_hostname": "RSE.API.ibm.com", "rseapi_port": "41877", "rseapi_saf_jwt_mode": false, "rseapi_secure_transport": "secure", "rseapi_server_log_level": "INFO", "rseapi_version": "1.2.3", "zos_version": "03.01.00" } ], "properties": { "base_path": { "type": "string" }, "rse_version": { "type": "string" }, "rseapi_hostname": { "type": "string" }, "rseapi_port": { "type": "string" }, "rseapi_version": { "type": "string" }, "zos_version": { "type": "string" } }, "title": "Server Details", "type": "object" }, "status": { "properties": { "JES Name": { "description": "JES Name", "example": "JES2", "type": "string" }, "jmon version": { "description": "JMON Version", "example": "2.9.10", "type": "string" }, "protocol": { "description": "Protocol for status", "example": "01v10", "type": "string" } }, "title": "JES Status", "type": "object" }, "step": { "items": { "properties": { "line": { "description": "The line number.", "example": "3", "type": "string" }, "name": { "description": "The job name.", "example": "IEFPROC", "type": "string" }, "proc step": { "description": "The caller step.", "example": "BPXAS", "type": "string" }, "proc step index": { "description": "The procedure step index.", "example": "BPXAS", "type": "string" }, "program": { "description": "The program to run.", "example": "IEFIIC", "type": "string" }, "state": { "description": "The state of the job.", "example": "2", "type": "string" }, "step": { "description": "The procedure step name.", "example": "1", "type": "string" } } }, "title": "JES Steps", "type": "array" }, "unixClearEncodingResponseEx": { "properties": { "message": { "description": "Response message", "example": " encoding has been cleared", "type": "string" }, "status": { "description": "Response status", "example": "Ok", "type": "string" } }, "title": "Encoding Response example", "type": "object" }, "unixContentPUT": { "properties": { "content": { "description": "Content of the file", "example": "Hello world!", "type": "string" } }, "title": "UNIX Content", "type": "object" }, "unixConvEncodingResponseEx": { "properties": { "message": { "description": "Response message", "example": " converted to ", "type": "string" }, "status": { "description": "Response status", "example": "Ok", "type": "string" } }, "title": "Encoding Response example", "type": "object" }, "unixEncoding": { "properties": { "encoding": { "description": "Encoding of the UNIX file", "example": "IBM-1047", "type": "string" } }, "title": "UNIX Encoding", "type": "object" }, "unixEncodingConvert": { "properties": { "srcEncoding": { "description": "Source encoding of the UNIX file", "example": "IBM-1047", "type": "string" }, "tgtEncoding": { "description": "Target encoding of the UNIX file", "example": "UTF-8", "type": "string" } }, "title": "UNIX Encoding", "type": "object" }, "unixMarkEncodingResponseEx": { "properties": { "message": { "description": "Response message", "example": " encoding set to ", "type": "string" }, "status": { "description": "Response status", "example": "Ok", "type": "string" } }, "title": "Encoding Response example", "type": "object" }, "unixPermissions": { "properties": { "group": { "description": "Group of the UNIX file", "example": "group1", "type": "string" }, "owner": { "description": "Owner of the UNIX file", "example": "user1", "type": "string" }, "permissions": { "description": "Permission of the UNIX file", "example": "rwxrw-r--", "type": "string" } }, "title": "UNIX Permissions", "type": "object" }, "unixType": { "properties": { "permissions": { "description": "Permission of the UNIX file", "example": "rwxrw-r--", "type": "string" }, "type": { "description": "Parameter type of the UNIX file", "example": "file", "type": "string" } }, "title": "UNIX Parameters Type", "type": "object" }, "unixType2": { "properties": { "type": { "description": "Parameter type of the UNIX file", "example": "file", "type": "string" } }, "title": "UNIX Parameters Type", "type": "object" }, "unixcommand": { "properties": { "invocation": { "description": "Invocation of the UNIX Command", "example": "ls", "type": "string" }, "path": { "description": "Working directory", "example": "/usr/bin", "type": "string" } }, "title": "UNIX Command", "type": "object" }, "unixcommandResponseEX": { "properties": { "exit code": { "description": "Exit code", "example": 0, "type": "string" }, "invocation": { "description": "Invocation of the UNIX Command", "example": "ls", "type": "string" }, "output": { "description": "Sample output when running a UNIX command.", "items": { "properties": { "stderr": { "example": "", "type": "string" }, "stdout": { "example": "$SYSNAME\\n$VERSION\\n210\\n220\\n230\\n240", "type": "string" } }, "type": "object" }, "type": "array" }, "path": { "description": "Relative address of the file or folder", "example": "/", "type": "string" } }, "title": "UNIX Command", "type": "object" }, "unixfiles": { "properties": { "children": { "items": { "properties": { "fileOwner": { "example": "AUSER", "type": "string" }, "group": { "example": "USRGRP", "type": "string" }, "lastModified": { "example": "Tue Mar 14 11:38:32 EDT 2023", "type": "string" }, "name": { "example": "afile.c", "type": "string" }, "permissionsSymbolic": { "example": "-rw-r--r--", "type": "string" }, "size": { "example": 214, "type": "integer" }, "type": { "example": "FILE", "type": "string" } }, "type": "object" }, "type": "array" }, "fileOwner": { "example": "AUSER", "type": "string" }, "group": { "example": "USRGRP", "type": "string" }, "lastModified": { "example": "Thu Apr 10 13:06:45 EDT 2025", "type": "string" }, "permissionsSymbolic": { "example": "drwx------", "type": "string" }, "size": { "example": 8192, "type": "integer" }, "type": { "example": "DIRECTORY", "type": "string" } }, "title": "UNIX File/Folder gets a list of files and directories for a given path", "type": "object" }, "unixfiles_path": { "properties": {}, "title": "UNIX Content", "type": "object" }, "unixshellcommand": { "properties": { "environmentVariables": { "description": "Environment variables", "example": "ABC=123,VAR=avalue", "type": "string" }, "invocation": { "description": "Invocation of the UNIX Command", "example": "grep port *.xml", "type": "string" }, "path": { "description": "Working directory", "example": "/u/", "type": "string" } }, "title": "UNIX Shell Command", "type": "object" } }, "info": { "description": "IBM Remote System Explorer API (RSE API) is a collection of REST APIs that allow a client to work with various components on the z/OS host system, including MVS data sets, z/OS UNIX files and commands, JES jobs, TSO commands, and more.", "title": "RSE API Docs", "version": "v1.2.4" }, "paths": { "/admin/cancelActivity": { "post": { "description": "Stop all this user's longrunning activities in the specified service", "operationId": "cancelActivities", "parameters": [ { "description": "The service to cancel (default is 'all')", "enum": [ "all", "jes-jobs", "mvs-and-tso", "unix-files", "unix-commands", "scan-service", "common-properties" ], "in": "header", "name": "Service", "required": false, "type": "string" } ], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "412": { "description": "A pre-condition required for the execution of an operation was not met." }, "500": { "description": "Unable to process the request due to an internal server error." }, "503": { "description": "The operation is not available or not supported." } }, "summary": "Cancel activities for the specified service", "tags": [ "Administrator Commands" ] } }, "/admin/getServerLogs": { "get": { "description": "Retrieve the last n lines from the server logs. Administrative privileges are required.", "operationId": "getServerLogs", "parameters": [ { "default": 100, "description": "Specifies the last number of lines in the logs to retrieve. Defaults to last 100 lines.", "in": "header", "name": "Last-Number-Lines", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/ServerLogsEX" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Unauthorized user error", "schema": { "$ref": "#/definitions/AdminLogLevel403EX" } }, "500": { "description": "Unable to process the request due to an internal server error." }, "503": { "description": "The operation is not available or not supported." } }, "summary": "Retrieve the last n lines from the server logs", "tags": [ "Administrator Commands" ] } }, "/admin/getTokenMap": { "get": { "description": "List the token-client map.", "operationId": "getTokenMap", "parameters": [ { "description": "Specifies the comma-separator list of userIDs to query. Example: USER1,USER2", "in": "header", "name": "UserID-List", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/AdminTokenMapContentEX" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Unauthorized user error", "schema": { "$ref": "#/definitions/AdminLogLevel403EX" } }, "500": { "description": "Unable to process the request due to an internal server error." }, "503": { "description": "The operation is not available or not supported." } }, "summary": "List the token-client map. Require privilege to run..", "tags": [ "Administrator Commands" ] } }, "/admin/getUserLogs": { "get": { "description": "Retrieve the last n lines from the user logs. Administrative privileges are required when accessing log file content belonging to other users.", "operationId": "getUserLogs", "parameters": [ { "description": "Specifies a comma-separated list of user IDs. Defaults to the current user ID if not specified.", "in": "header", "name": "UserID-List", "type": "string" }, { "default": 100, "description": "Specifies the last number of lines in the logs to retrieve. Defaults to last 100 lines.", "in": "header", "name": "Last-Number-Lines", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/UserLogsEX" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Unauthorized user error", "schema": { "$ref": "#/definitions/AdminLogLevel403EX" } }, "500": { "description": "Unable to process the request due to an internal server error." }, "503": { "description": "The operation is not available or not supported." } }, "summary": "Retrieve the last n lines from the user logs", "tags": [ "Administrator Commands" ] } }, "/admin/serverLogLevel": { "put": { "description": "Modify server log level.", "operationId": "modifyServerLogLevel", "parameters": [ { "default": "WARN", "description": "Set the server log level.", "enum": [ "ERROR", "WARN", "INFO", "DEBUG" ], "in": "query", "name": "logLevel", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/AdminServerLogLevelOKEX" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Unauthorized user error", "schema": { "$ref": "#/definitions/AdminLogLevel403EX" } }, "500": { "description": "Unable to process the request due to an internal server error." }, "503": { "description": "The operation is not available or not supported." } }, "summary": "Modify server log level. Require privilege to run..", "tags": [ "Administrator Commands" ] } }, "/admin/userLogLevel": { "put": { "description": "Modify user log level.", "operationId": "modifyUserLogLevel", "parameters": [ { "description": "The user log level to set to. Valid value: 0 to 2. Example: 2", "in": "query", "name": "logLevel", "required": true, "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/AdminUserLogLevelOKEX" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Unauthorized user error", "schema": { "$ref": "#/definitions/AdminLogLevel403EX" } }, "500": { "description": "Unable to process the request due to an internal server error." }, "503": { "description": "The operation is not available or not supported." } }, "summary": "Modify user log level. Require privilege to run..", "tags": [ "Administrator Commands" ] } }, "/auth/login": { "post": { "consumes": [ "application/json", "text/plain" ], "description": "Authenticate with user credentials and return an embedded token providing access to the RESTful APIs. As part of a successfull response a bearer authorization token is returned in the response header. For a period of time that token can subsequently be used as the authorization token for APIs in request headers.\n\n For example, you can call curl -H \"Authorization: Bearer [token]\" https://[host]:[port]/rseapi/api/v1/auth/query to find out when the token expires. This authorization bearer token pattern applies to the other APIs as well.\n\n\n **The login request requires the user credentials in JSON format.**", "operationId": "auth", "parameters": [ { "description": "Return password/passphrase expiration information in the response header (false by default)", "enum": [ true, false ], "in": "header", "name": "Pass-Expiration", "required": false, "type": "boolean", "value": false }, { "description": "Specifies the user credentials to be authenticated.\n\n\n*To change password, add the following field after the password field: \"newpassword\": \"NEW PASSWORD\"*", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/authContent" } } ], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Authenticate with user credentials and return a embedded token", "tags": [ "Authentication" ] } }, "/auth/logout": { "post": { "description": "Close the session in an RSE API instance and clear the cache of the token.", "operationId": "logout", "parameters": [], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Close the user session", "tags": [ "Authentication" ] } }, "/auth/query": { "get": { "description": "Validate the authentication token that is used to access the RESTful APIs.\n\n\n**The response is a JSON object that contains information associated with the token.**", "operationId": "query", "parameters": [], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful request.", "schema": { "$ref": "#/definitions/authQueryEX" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Validate the authentication token for the service", "tags": [ "Authentication" ] } }, "/auth/refreshToken": { "post": { "description": "Renew the authentication token of a client connected with a bearer token. Return the new token and its expiration date time in the response's headers.", "operationId": "tokenRenew", "parameters": [], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "412": { "description": "A pre-condition required for the execution of an operation was not met." }, "500": { "description": "Unable to process the request due to an internal server error." }, "503": { "description": "The operation is not available or not supported." } }, "summary": "Generate a new authentication token of a connected client", "tags": [ "Authentication" ] } }, "/commonproperties": { "get": { "description": "Gets a list of namespaces.", "operationId": "getCommonPropertiesNamespaces", "parameters": [ { "description": "Specifies the access level of the namespace to query. *Example: public*", "enum": [ "public", "private" ], "in": "header", "name": "Access-Level", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/commonPropertyNamespacesEX" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Get a list of namespaces.", "tags": [ "Common Properties" ] } }, "/commonproperties/{namespace}": { "delete": { "description": "Deletes either a namespace or properties from a namespace.", "operationId": "deleteCommonProperty", "parameters": [ { "description": "The Namespace name. Ex. tstNamespace or TSTNAMESPACE. Alphanumerics, hyphens, and underscores only.", "in": "path", "name": "namespace", "required": true, "type": "string" }, { "description": "The path of the Common Property. Ex. services or services/serviceX.", "in": "query", "name": "jsonPath", "required": false, "type": "string" }, { "description": "Specifies the access level of the namespace to query. *Example: public*", "enum": [ "public", "private" ], "in": "header", "name": "Access-Level", "type": "string" } ], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Delete either a namespace or properties from namespace.", "tags": [ "Common Properties" ] }, "get": { "description": "Gets the Properties from within a Namespace.", "operationId": "getCommonProperty", "parameters": [ { "description": "The Namespace name. Ex. tstNamespace or TSTNAMESPACE. Alphanumerics, hyphens, and underscores only.", "in": "path", "name": "namespace", "required": true, "type": "string" }, { "description": "The path of the Common Property. Ex. services or services/serviceX.", "in": "query", "name": "jsonPath", "required": false, "type": "string" }, { "description": "Specifies the access level of the namespace to query. *Example: public*", "enum": [ "public", "private" ], "in": "header", "name": "Access-Level", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/commonPropertyNamespaceEX" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Get properties from within a namespace.", "tags": [ "Common Properties" ] }, "head": { "description": "Returns the namespace last modified time for the specified common properties namespace.", "operationId": "headCommonProperties", "parameters": [ { "description": "The Namespace name. Ex. tstNamespace or TSTNAMESPACE. Alphanumerics, hyphens, and underscores only.", "in": "path", "name": "namespace", "required": true, "type": "string" }, { "description": "Specifies the access level of the namespace to query. *Example: public*", "enum": [ "public", "private" ], "in": "header", "name": "Access-Level", "type": "string" } ], "responses": { "200": { "description": "Successful response", "headers": { "Namespace-ETag": { "description": "namespace last modified time (in milliseconds)", "type": "string" } } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Get the namespace last modified time for the specified common properties namespace.", "tags": [ "Common Properties" ] }, "post": { "description": "Creates a namespace.", "operationId": "postCommonProperties", "parameters": [ { "description": "The Namespace name. Ex. tstNamespace or TSTNAMESPACE. Alphanumerics, hyphens, and underscores only.", "in": "path", "name": "namespace", "required": true, "type": "string" }, { "description": "Specifies the access level of the namespace to query. *Example: public*", "enum": [ "public", "private" ], "in": "header", "name": "Access-Level", "type": "string" } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created", "schema": { "$ref": "#/definitions/commonPropertySuccessResponseEX" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Create a namespace.", "tags": [ "Common Properties" ] }, "put": { "consumes": [ "application/json", "text/plain" ], "description": "Adds properties to a namespace.", "operationId": "putCommonProperty", "parameters": [ { "description": "The Namespace name. Ex. tstNamespace or TSTNAMESPACE. Alphanumerics, hyphens, and underscores only.", "in": "path", "name": "namespace", "required": true, "type": "string" }, { "description": "The path of the Common Property. Ex. services or services/serviceX.", "in": "query", "name": "jsonPath", "required": false, "type": "string" }, { "description": "Specifies the access level of the namespace to query. *Example: public*", "enum": [ "public", "private" ], "in": "header", "name": "Access-Level", "type": "string" }, { "description": "Common Property Content. The valid content can be one of the following
  • a JSONObject string such as the example below
  • a single key-value properties string or a comma separated key-value properties string, e.g. \"key1\": \"value1\", \"key2\": \"value2\", \"key3\": \"value3\"
  • Any integer, decimal number, boolean, string, JSONObject or JSONArray wrapped in the first element of a JSONArray.
    e.g. [[\"Canada\", \"Frence\", \"Japan\", \"USA\"]]
", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/contentJson" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/commonPropertyNamespaceEX" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Add properties to a namespace.", "tags": [ "Common Properties" ] } }, "/commonproperties/{namespace}/copy": { "post": { "description": "Copies an existing namespace.", "operationId": "copyCommonProperties", "parameters": [ { "description": "The Namespace name. Ex. tstNamespace or TSTNAMESPACE. Alphanumerics, hyphens, and underscores only.", "in": "path", "name": "namespace", "required": true, "type": "string" }, { "description": "The NEW Namespace name. Ex. tstNamespace2 or TSTNAMESPACE2. Alphanumerics, hyphens, and underscores only.", "in": "query", "name": "newNamespace", "required": true, "type": "string" }, { "description": "Specifies the access level of the namespace to query. *Example: public*", "enum": [ "public", "private" ], "in": "header", "name": "Access-Level", "type": "string" } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created", "schema": { "$ref": "#/definitions/emptyResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Copy an existing namespace.", "tags": [ "Common Properties" ] } }, "/commonproperties/{namespace}/rename": { "post": { "description": "Renames an existing namespace.", "operationId": "renameCommonProperties", "parameters": [ { "description": "The Namespace name. Ex. tstNamespace or TSTNAMESPACE. Alphanumerics, hyphens, and underscores only.", "in": "path", "name": "namespace", "required": true, "type": "string" }, { "description": "The NEW Namespace name. Ex. tstNamespace2 or TSTNAMESPACE2. Alphanumerics, hyphens, and underscores only.", "in": "query", "name": "newNamespace", "required": true, "type": "string" }, { "description": "Specifies the access level of the namespace to query. *Example: public*", "enum": [ "public", "private" ], "in": "header", "name": "Access-Level", "type": "string" } ], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Rename an existing namespace.", "tags": [ "Common Properties" ] } }, "/datasets": { "post": { "consumes": [ "application/json" ], "description": "Creates a non-VSAM data set (partitioned or sequential) or a VSAM data set with provided properties.", "operationId": "createDataset", "parameters": [ { "default": "non-VSAM", "description": "Specifies the data set type. Ex. non-VSAM", "enum": [ "non-VSAM", "VSAM" ], "in": "header", "name": "Dataset-Type", "type": "string" }, { "description": "MVS Dataset Properties", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/mvsDatasetPOST" } } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful response", "schema": { "$ref": "#/definitions/emptyResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "409": { "description": "Target already exists." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Creates a non-VSAM data set (partitioned or sequential) or a VSAM data set with provided properties", "tags": [ "MVS Datasets" ] } }, "/datasets/mappings": { "get": { "description": "Gets the complete JSON representing MVS file system mappings.", "operationId": "getMVSMappings", "parameters": [ { "description": "Returns the checksum for the file", "enum": [ true, false ], "in": "header", "name": "E-Tag", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "headers": { "ETag": { "description": "ETag (checksum)", "type": "string" } }, "schema": { "$ref": "#/definitions/mvsGetMappings" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the complete JSON representing MVS file system mappings", "tags": [ "MVS Datasets" ] }, "head": { "description": "Gets the ETag (checksum) for the MVS file system mappings file", "operationId": "headMVSMappings", "parameters": [], "responses": { "200": { "description": "Successful response", "headers": { "ETag": { "description": "ETag (checksum)", "type": "string" } } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the ETag (checksum) for the MVS file system mappings file", "tags": [ "MVS Datasets" ] } }, "/datasets/search/PDS": { "get": { "description": "Search for partitioned data set(s) provided the filter with a data set name pattern filter.", "operationId": "searchPDS", "parameters": [ { "description": "A single data set filter string (e.g. HLQ.\\*, HLQ.\\*.BBB, or HLQ.AAA.BBB.) or a comma-separated filter list (e.g. HLQ1.\\*,HLQ2.\\*).", "in": "query", "name": "filter", "required": true, "type": "string" }, { "description": "Dataset name pattern. Ex. HLQ.PDS, or \\*.\\*", "in": "query", "name": "dsnPattern", "required": true, "type": "string" }, { "description": "Regex for data set name. If Regex pattern is not used, wildcard patterns are used.", "enum": [ true, false ], "in": "header", "name": "Regex-Dsn", "type": "boolean" }, { "description": "Search data sets including migrated data sets.", "enum": [ true, false ], "in": "header", "name": "Include-Migrated", "type": "boolean" }, { "description": "Searching data sets including data set in offline volumes.", "enum": [ true, false ], "in": "header", "name": "Include-Offline-Volume", "type": "boolean" }, { "description": "Number of results displayed for search If number-of-results is not used, default is 10000 results.", "in": "header", "name": "Number-Of-Results", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response

Example: .../datasets/search/PDS?filter=TST&dsn=TSTDS.PDS.EXDS.* with \"regex-dsn\" parameter set to true.", "schema": { "$ref": "#/definitions/mvsSearchPDSMember" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "406": { "description": "Server has been configured to restrict this function." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Search for partitioned data set(s) provided the filter with a data set name pattern", "tags": [ "MVS Datasets" ] } }, "/datasets/search/PDSMembers": { "get": { "description": "Search for PDS member(s) provided the filter with a member pattern and/or content string.", "operationId": "searchPDSMember", "parameters": [ { "description": "A single data set filter string (e.g. HLQ.\\*, HLQ.\\*.BBB, or HLQ.AAA.BBB.) or a comma-separated filter list (e.g. HLQ1.\\*,HLQ2.\\*).", "in": "query", "name": "filter", "required": true, "type": "string" }, { "description": "Member name pattern. Ex. MEM or *", "in": "query", "name": "memberPattern", "type": "string" }, { "description": "Content string to be searched. Ex. HelloWorld or *", "in": "query", "name": "content", "type": "string" }, { "description": "Regex for member name. If Regex pattern is not used, wildcard patterns are used.", "enum": [ true, false ], "in": "header", "name": "Regex-Member", "type": "boolean" }, { "description": "Regex for content. If Regex pattern is not used, wildcard patterns are used.", "enum": [ true, false ], "in": "header", "name": "Regex-Content", "type": "boolean" }, { "description": "Case-sensitive for content", "enum": [ true, false ], "in": "header", "name": "Case-Sensitive-Content", "type": "boolean" }, { "description": "Number of results displayed for search If number-of-results is not used, default is 10000 results.", "in": "header", "name": "Number-Of-Results", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response

Example: .../datasets/search/PDSMembers?filter=TSTDS&content=IBM", "schema": { "$ref": "#/definitions/mvsSearchPDSMember" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "406": { "description": "Server has been configured to restrict this function." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Search for PDS member(s) provided the filter with a member pattern and/or content string", "tags": [ "MVS Datasets" ] } }, "/datasets/search/SEQ": { "get": { "description": "Search for sequential data set(s) provided the filter with a data set name pattern and/or content string filter.", "operationId": "searchSEQ", "parameters": [ { "description": "A single data set filter string (e.g. HLQ.\\*, HLQ.\\*.BBB, or HLQ.AAA.BBB.) or a comma-separated filter list (e.g. HLQ1.\\*,HLQ2.\\*).", "in": "query", "name": "filter", "required": true, "type": "string" }, { "description": "Dataset name pattern. Ex. HLQ.PDS or \\*.\\*", "in": "query", "name": "dsnPattern", "type": "string" }, { "description": "Content string to be searched. Ex. HelloWorld or *", "in": "query", "name": "content", "type": "string" }, { "description": "Regex for data set name. If Regex pattern is not used, wildcard patterns are used.", "enum": [ true, false ], "in": "header", "name": "Regex-Dsn", "type": "boolean" }, { "description": "Regex for content. If Regex pattern is not used, wildcard patterns are used.", "enum": [ true, false ], "in": "header", "name": "Regex-Content", "type": "boolean" }, { "description": "Case-sensitive for content", "enum": [ true, false ], "in": "header", "name": "Case-Sensitive-Content", "type": "boolean" }, { "description": "Search data sets including migrated data sets. Searching migrated data set content is not allowed.", "enum": [ true, false ], "in": "header", "name": "Include-Migrated", "type": "boolean" }, { "description": "Searching data sets including data set in offline volumes. Searching offline data set content is not allowed.", "enum": [ true, false ], "in": "header", "name": "Include-Offline-Volume", "type": "boolean" }, { "description": "Number of results displayed for search If number-of-results is not used, default is 10000 results.", "in": "header", "name": "Number-Of-Results", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response

Example: .../datasets/search/SEQ?filter=TSTDS&content=AQQ", "schema": { "$ref": "#/definitions/mvsSearchSEQ" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "406": { "description": "Server has been configured to restrict this function." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Search for sequential data set(s) provided the filter with a data set name pattern and/or content string", "tags": [ "MVS Datasets" ] } }, "/datasets/{copydsn}/allocateLike": { "post": { "consumes": [ "application/json" ], "description": "Allocate a new data set (PDS, PDSE, SEQ or VSAM) with the attributes like those of an existing data set. Use corresponding non-VSAM or VSAM attributes-override template per data set type", "operationId": "postAllocateLike", "parameters": [ { "description": "Existing data set name. Ex. HLQ.PDS", "in": "path", "name": "copydsn", "required": true, "type": "string" }, { "description": "Newly created data set name. Ex. HLQ.TEST.PDS", "in": "query", "name": "dsn", "required": true, "type": "string" }, { "description": "MVS Dataset Property Overrides", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/mvsDatasetWithoutDSNamePOST" } } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created", "schema": { "$ref": "#/definitions/emptyResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Allocate a new data set (PDS, PDSE, SEQ or VSAM) with the attributes like those of an existing data set", "tags": [ "MVS Datasets" ] } }, "/datasets/{dsn}": { "delete": { "description": "Deletes a data set or a data set member provided the dataset/member name, or a VSAM data set.", "operationId": "deleteDataset", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "path", "name": "dsn", "required": true, "type": "string" } ], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Deletes a data set or a data set member provided the dataset/member name, or a VSAM data set", "tags": [ "MVS Datasets" ] } }, "/datasets/{dsn}/content": { "get": { "description": "Gets content of an existing data set member or sequential data set.", "operationId": "getDatasetContent", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "path", "name": "dsn", "required": true, "type": "string" }, { "description": "Return the results of a source scan in the resulting JSON", "enum": [ true, false ], "in": "header", "name": "Scan", "type": "boolean" }, { "description": "Returns the checksum for the file", "enum": [ true, false ], "in": "header", "name": "E-Tag", "type": "boolean" }, { "description": "The range of records to be retrieved from the data set file. Format SSS-EEE or SSS,NNN, example: 1000-1050 or 1000,51.
Cannot be specified with header 'Etag' or 'Scan'", "in": "header", "name": "Record-Range", "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" }, { "description": "Optional local encoding parameter", "in": "header", "name": "Local-Encoding", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/mvsgetContent" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "413": { "description": "Specified resource entity is larger than the defined limit by the server." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets content of an existing data set member or sequential data set", "tags": [ "MVS Datasets" ] }, "head": { "description": "Gets the ETag (checksum) and total bytes count (Bytes-On-Host) for the specified partitioned data set member, or sequential data set.", "operationId": "headDatasetContent", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "path", "name": "dsn", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response", "headers": { "Bytes-On-Host": { "description": "Total count of bytes on host", "type": "integer" }, "ETag": { "description": "ETag (checksum)", "type": "string" } } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the ETag (checksum) and total bytes count (Bytes-On-Host) for the specified partitioned data set member, or sequential data set.", "tags": [ "MVS Datasets" ] }, "put": { "consumes": [ "application/json", "text/plain" ], "description": "Updates content of an existing data set member or sequential data set.", "operationId": "updateDatasetContent", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "path", "name": "dsn", "required": true, "type": "string" }, { "description": "This header parameter will allow editing of the content if the checksum matches the Etag checksum in the response header", "in": "header", "name": "If-Match", "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" }, { "description": "Optional local encoding parameter", "in": "header", "name": "Local-Encoding", "type": "string" }, { "description": "MVS Dataset Content", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/mvsContentPUT" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/contentMVS" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "412": { "description": "A pre-condition required for the execution of an operation was not met." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Updates content of an existing data set member or sequential data set", "tags": [ "MVS Datasets" ] } }, "/datasets/{dsn}/copy": { "post": { "description": "Copy a data set or data set member from its current path to a destination path.", "operationId": "copyMVSDataset", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "path", "name": "dsn", "required": true, "type": "string" }, { "description": "Path of the destination. Ex. TST.ACCESS.COPY or TST.QE(MEMBER)", "in": "query", "name": "destination", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created", "schema": { "$ref": "#/definitions/emptyResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Copy a data set or data set member from its current path to a destination path", "tags": [ "MVS Datasets" ] } }, "/datasets/{dsn}/lock": { "put": { "description": "Acquires an exclusive lock on asequential data set or a member of a partitioned data set", "operationId": "putMVSLock", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "path", "name": "dsn", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/mvsPutLock" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Acquires an exclusive lock on asequential data set or a member of a partitioned data set", "tags": [ "MVS Datasets" ] } }, "/datasets/{dsn}/lockInfoAll": { "get": { "description": "Retrieve the lock info of all locks hold on members of a partition data set, including user ID, system name, ASID and TCB.", "operationId": "getLockInfoAll", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS", "in": "path", "name": "dsn", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/mvsGetLockInfoAll" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Retrieve the lock info of all locks hold on members of a partition data set, including user ID, system name, ASID and TCB.", "tags": [ "MVS Datasets" ] } }, "/datasets/{dsn}/lockOwner": { "get": { "description": "Gets the owner user id of the exclusive lock acquired on a sequential data set or a member of a partition data set", "operationId": "getMVSLockOwner", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "path", "name": "dsn", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/mvsGetLockOwner" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the owner user id of the exclusive lock acquired on a sequential data set or a member of a partition data set", "tags": [ "MVS Datasets" ] } }, "/datasets/{dsn}/migrate": { "post": { "description": "Migrates a data set provided with the data set name, if the system supports it.", "operationId": "migrateMVSDataset", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS", "in": "path", "name": "dsn", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created", "schema": { "$ref": "#/definitions/emptyResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Migrates a data set provided with the data set name", "tags": [ "MVS Datasets" ] } }, "/datasets/{dsn}/rawContent": { "get": { "description": "Download a data set member or sequential data set as raw streaming data.", "operationId": "getRawContentMVS", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "path", "name": "dsn", "required": true, "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" }, { "description": "Optional local encoding parameter", "in": "header", "name": "Local-Encoding", "type": "string" }, { "description": "Returns the checksum for the file", "enum": [ true, false ], "in": "header", "name": "E-Tag", "type": "boolean" }, { "description": "Specify optional binary header parameter (true by default)", "enum": [ true, false ], "in": "header", "name": "Binary", "type": "boolean" } ], "produces": [ "application/octet-stream" ], "responses": { "200": { "description": "Successful response, DOWNLOAD FILE", "headers": { "ETag": { "description": "ETag (checksum)", "type": "string" } }, "schema": { "$ref": "#/definitions/downloadResponse" } }, "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Download a data set member or sequential data set as raw streaming data", "tags": [ "MVS Datasets" ] }, "head": { "description": "Gets the ETag (checksum) and total bytes count (Bytes-On-Host) for the specified partitioned data set member, or sequential data set.", "operationId": "headDatasetRawContent", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "path", "name": "dsn", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response", "headers": { "Bytes-On-Host": { "description": "Total count of bytes on host", "type": "integer" }, "ETag": { "description": "ETag (checksum)", "type": "string" } } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the ETag (checksum) and total bytes count (Bytes-On-Host) for the specified partitioned data set member, or sequential data set.", "tags": [ "MVS Datasets" ] }, "put": { "consumes": [ "application/octet-stream" ], "description": "Upload raw streaming data for a data set member or sequential data set.
To choose a file to upload, try out the API and select \\\"application/octet-stream\\\".", "operationId": "putRawContentMVS", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "path", "name": "dsn", "required": true, "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" }, { "description": "Optional local encoding parameter", "in": "header", "name": "Local-Encoding", "type": "string" }, { "description": "This header parameter will allow editing of the content if the checksum matches the Etag checksum in the response header", "in": "header", "name": "If-Match", "type": "string" }, { "description": "Specify optional binary header parameter (true by default)", "enum": [ true, false ], "in": "header", "name": "Binary", "type": "boolean" }, { "in": "body", "name": "body", "required": true, "schema": { "format": "binary", "type": "string" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/emptyResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "412": { "description": "A pre-condition required for the execution of an operation was not met." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Upload raw streaming data for a data set member or sequential data set", "tags": [ "MVS Datasets" ] } }, "/datasets/{dsn}/recall": { "post": { "description": "Recalls a data set provided the data set name, if the system supports it.", "operationId": "recallMVSDataset", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS", "in": "path", "name": "dsn", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created", "schema": { "$ref": "#/definitions/emptyResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Recalls a data set provided the data set name", "tags": [ "MVS Datasets" ] } }, "/datasets/{dsn}/rename": { "post": { "description": "Rename a data set or data set member.", "operationId": "renameMVSDataset", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "path", "name": "dsn", "required": true, "type": "string" }, { "description": "New name of the Dataset or Dataset member. Ex. TST.ACCESS.WRITE.NEW or NEWMEMBER", "in": "query", "name": "newName", "required": true, "type": "string" } ], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Rename a data set or data set member", "tags": [ "MVS Datasets" ] } }, "/datasets/{dsn}/unlock": { "put": { "description": "Release the exclusive lock acquired on a sequential data set or a member of a partition data set.
The resource can only be unlocked at the same server and by the same user who acquired the lock on the resource.", "operationId": "putMVSUnlock", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "path", "name": "dsn", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/mvsPutUnlock" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Release the exclusive lock acquired on a sequential data set or a member of a partition data set", "tags": [ "MVS Datasets" ] } }, "/datasets/{filter}": { "get": { "description": "Gets the data sets' attributes, which match the provided filter.", "operationId": "getDatasetFilter", "parameters": [ { "description": "Dataset filter string. Ex. FILTERNAME.*", "in": "path", "name": "filter", "required": true, "type": "string" }, { "description": "Offset index (0-n) in the filtered data sets list to return. Ex. 5

(Either Range-Offset or Range-Name-Offset is used)", "in": "header", "name": "Range-Offset", "type": "integer" }, { "description": "Offset name in the filtered data sets list to return. The dataset must exist. Ex. FILTERNAME.PDS1

(Either Range-Offset or Range-Name-Offset is used)", "in": "header", "name": "Range-Name-Offset", "type": "string" }, { "description": "Maximum number of data sets to be returned.", "in": "header", "name": "Num-To-Show", "type": "integer" }, { "description": "Specifies the comma-separator list of data set attributes to query. Example: name,type,dsName,dsnType,recordFormat", "in": "header", "name": "Included-Attributes", "type": "string" }, { "default": "name", "description": "Metric to sort the returned list. Default to sort by name only", "enum": [ "name", "filetype" ], "in": "header", "name": "Sort-By", "type": "string" }, { "default": false, "description": "Include Generation Data Sets (GDS).", "enum": [ true, false ], "in": "header", "name": "Include-GDS", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "headers": { "Items-Count": { "description": "The count of returned items", "type": "integer" }, "Range-offset": { "description": "The range offset index (0-n)", "type": "integer" }, "Total-Count": { "description": "The total number of elements in the returned list", "type": "integer" } }, "schema": { "$ref": "#/definitions/datasetAttributes" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the data sets' attributes, which match the provided filter", "tags": [ "MVS Datasets" ] }, "head": { "description": "Gets the total count header of the data filter query for the specified filter", "operationId": "headGetDatasetFilter", "parameters": [ { "description": "Dataset filter string. Ex. FILTERNAME.*", "in": "path", "name": "filter", "required": true, "type": "string" }, { "default": false, "description": "Include Generation Data Sets (GDS).", "enum": [ true, false ], "in": "header", "name": "Include-GDS", "type": "boolean" } ], "responses": { "200": { "description": "Successful response", "headers": { "Total-Count": { "description": "THe total count of the dataset filter result", "type": "integer" } } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the total count header of the data filter query for the specified filter", "tags": [ "MVS Datasets" ] } }, "/datasets/{filter}/list": { "get": { "description": "Gets all data sets names that match the provided filter.", "operationId": "getDatasetOldFilter", "parameters": [ { "description": "Dataset filter string. Ex. FILTERNAME.*", "in": "path", "name": "filter", "required": true, "type": "string" }, { "description": "Offset index (0-n) in the filtered data sets list to return. Ex. 5

(Either Range-Offset or Range-Name-Offset is used)", "in": "header", "name": "Range-Offset", "type": "integer" }, { "description": "Offset name in the filtered data sets list to return. The dataset must exist. Ex. FILTERNAME.PDS1

(Either Range-Offset or Range-Name-Offset is used)", "in": "header", "name": "Range-Name-Offset", "type": "string" }, { "description": "Maximum number of data sets to be returned.", "in": "header", "name": "Num-To-Show", "type": "integer" }, { "default": "name", "description": "Metric to sort the returned list. Default to sort by name only", "enum": [ "name", "filetype" ], "in": "header", "name": "Sort-By", "type": "string" }, { "default": false, "description": "Include Generation Data Sets (GDS).", "enum": [ true, false ], "in": "header", "name": "Include-GDS", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "headers": { "Items-Count": { "description": "The count of returned items", "type": "integer" }, "Range-offset": { "description": "The range offset index (0-n)", "type": "integer" }, "Total-Count": { "description": "The total number of elements in the returned list", "type": "integer" } }, "schema": { "$ref": "#/definitions/listDatasets" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets all data sets names that match the provided filter", "tags": [ "MVS Datasets" ] } }, "/datasets/{gdgName}/GDSList": { "get": { "description": "Gets the Generation Data sets of a Generation Data Group", "operationId": "getGDSList", "parameters": [ { "description": "Genration Data Group name. Ex. USER1.GDG01", "in": "path", "name": "gdgName", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/listGDSEntries" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the Generation Data sets of a Generation Data Group", "tags": [ "MVS Datasets" ] } }, "/datasets/{pdsName}/memberAttrs": { "get": { "description": "Gets the PDS members' attributes.", "operationId": "getPDSMemberAttributes", "parameters": [ { "description": "PDS name. Ex. USER1.PDS1", "in": "path", "name": "pdsName", "required": true, "type": "string" }, { "description": "Specifies the comma-separator list of PDS members or member wildcard patterns to query. Ex. MEMBER*,LOGFILE

(Range-Offset, Range-Name-Offset and Num-To-Show are not used with a non-wildcard Members filter)", "in": "header", "name": "Members", "type": "string" }, { "description": "Offset index (0-n) in the filtered members list to return. Ex. 5

(Either Range-Offset or Range-Name-Offset is used)", "in": "header", "name": "Range-Offset", "type": "integer" }, { "description": "Offset name in the filtered members list to return. Ex. MEMBER1

(Either Range-Offset or Range-Name-Offset is used)", "in": "header", "name": "Range-Name-Offset", "type": "string" }, { "description": "Maximum number of filtered members to be returned.", "in": "header", "name": "Num-To-Show", "type": "integer" }, { "description": "Specifies the comma-separator list of partition data set member attributes to query. Ex: creationDate,lastModifiedDate,lastModifiedBy,linecount,revision,lockOwner", "in": "header", "name": "Included-Attributes", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "headers": { "Items-Count": { "description": "The count of returned items", "type": "integer" }, "Range-Total-Count": { "description": "The range total number of elements in the returned list", "type": "integer" }, "Range-offset": { "description": "The range offset index (0-n)", "type": "integer" }, "Total-Count": { "description": "The total number of members in the partition data set", "type": "integer" } }, "schema": { "$ref": "#/definitions/pdsMemberAttributes" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the PDS members' attributes", "tags": [ "MVS Datasets" ] } }, "/datasets/{pdsName}/members": { "get": { "description": "Gets a list of members provided with a data set name.", "operationId": "getDatasetMembers", "parameters": [ { "description": "PDS name. Ex. USER1.PDS1", "in": "path", "name": "pdsName", "required": true, "type": "string" }, { "description": "Show the member mapping", "enum": [ true, false ], "in": "header", "name": "Mapping", "type": "boolean" }, { "description": "Offset index (0-n) in the members list to return. Ex. 5

(Either Range-Offset or Range-Name-Offset is used)", "in": "header", "name": "Range-Offset", "type": "integer" }, { "description": "Offset name in the members list to return. Ex. MEMBER1

(Either Range-Offset or Range-Name-Offset is used)", "in": "header", "name": "Range-Name-Offset", "type": "string" }, { "description": "Maximum number of members to be returned.", "in": "header", "name": "Num-To-Show", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "headers": { "Items-Count": { "description": "The count of returned items", "type": "integer" }, "Range-Total-Count": { "description": "The range total number of elements in the returned list", "type": "integer" }, "Range-offset": { "description": "The range offset index (0-n)", "type": "integer" }, "Total-Count": { "description": "The total number of members in the partitioned data set", "type": "integer" } }, "schema": { "$ref": "#/definitions/member" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets a list of members provided with a data set name", "tags": [ "MVS Datasets" ] } }, "/datasets/{vsamCluster}/VSAMAttributes": { "get": { "description": "Get the VSAM cluster data set attributes", "operationId": "VSAMAttributesDisplay", "parameters": [ { "description": "VSAM Cluster name. Ex. USER1.VSAM01", "in": "path", "name": "vsamCluster", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/mvsVSAMPropertiesDisplay" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Get the VSAM cluster data set attributes", "tags": [ "MVS Datasets" ] } }, "/info/serverdetails": { "get": { "description": "Get information about this RSE API server.", "operationId": "getServerDetails", "parameters": [], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/serverDetailsEX" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Get information about this RSE API server", "tags": [ "Server Information" ] } }, "/jobs": { "get": { "description": "List the job(s) provided the job prefix, owner, and/or status.", "operationId": "getJesJobs", "parameters": [ { "description": "Prefix of the job. *Example: BPXAS, R**", "in": "query", "name": "prefix", "type": "string" }, { "description": "Owner of the job. Default to requester user id", "in": "query", "name": "owner", "type": "string" }, { "description": "Status of the job. *Example: ACTIVE*", "enum": [ "ACTIVE", "OUTPUT", "INPUT", "HELD", "ALL" ], "in": "query", "name": "status", "type": "string" }, { "description": "Specifies the comma-separator list of the following JES job attributes to query.\n\nExample:\n\njobName,owner,systemEntryDateTime,jobId,returnCode,subsystem,type,executionClass,execSystem,phaseName,execMember,status\n\nWhen Show-Additional-Attributes header is set to true, the following additional JES job attributes can be specified in the comma-separator list to query.\n\nExample:\n\nsysoutClass,outputNode,execNode,deviceName,holdStatus,priority,returnInfo,systemReturnCode,jobKey,dataToken,spoolTracks,secLabel,flagByte,programmer,jobPosition,isActive,maxRC,asID,phase", "in": "header", "name": "Included-Attributes", "type": "string" }, { "description": "This indicates whether to retrieve the following additional JES job attributes (false by default).\n\nExample:\n\nsysoutClass,outputNode,execNode,deviceName,holdStatus,priority,returnInfo,systemReturnCode,jobKey,dataToken,spoolTracks,secLabel,flagByte,programmer,jobPosition,isActive,maxRC,asID,phase", "enum": [ true, false ], "in": "header", "name": "Show-Additional-Attributes", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful request.", "schema": { "$ref": "#/definitions/listJobs" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "List the job(s) provided the job prefix, owner, and/or status", "tags": [ "JES Jobs" ] } }, "/jobs/dataset": { "post": { "consumes": [ "application/json", "text/plain" ], "description": "Submits a JES Job provided the data set information in JSON or plain text format.", "operationId": "submitJobDataset", "parameters": [ { "description": "Specifies the name and value for a JCL symbol. The symbol name and value are separated by ':'. Multiple symbol names and values can be specified and separated by ','.\n\nA symbol name is 1 to 8 characters, where the first character must be uppercase alphabetic (A-Z) or special ($, #, @).\n\nA symbol value is limited to 255 characters.\n\n\n**For example:**\n\n'MBR1:ABC,MBR2:XYZ' specifies symbol name MBR1 with value ABC and symbol name MBR2 with value XYZ.\n\nSpecifying this custom header and submitting a job that uses //MYDD DSN=MY.DATASET(&MBR1.),DISP=SHR in the JCL will cause ABC to be substituted as the member name.", "in": "header", "name": "JCL-Symbols", "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" }, { "description": "Enable subscription to event notifications upon event completion (default: false). When enabled, an event notification ID will be included in the response header event-notification-id. This ID can be used with the Event Notification API to receive a notification once the subscribed event is completed. The output from the original response will be included in the event notification.", "enum": [ true, false ], "in": "header", "name": "Event-Notification", "type": "boolean" }, { "description": "Dataset Content Information", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/jclDatasetContent" } } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created.", "schema": { "$ref": "#/definitions/job" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Submits a JES Job provided the data set information in JSON", "tags": [ "JES Jobs" ] } }, "/jobs/displayactive/all": { "get": { "description": "Display all active job address space information.", "operationId": "GetDisplayActiveAll", "parameters": [ { "description": "Specifies the comma-separator list of JES job address space attributes to query. Ex. asid,swapin,all_cpu,asidx,page_rate,user_id,io_rate,type,dp,all_cpu%,job_name,real_in_bytes,elapsed,hvcomused,task_cpu%,hvcomhwm,cpu_task,real_in_frames,subtype,system_name,step_io,position_description,sr,sr_description,job_proc,job_class,job_step,job_id,position", "in": "header", "name": "Included-Attributes", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/displayActiveAllResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Display all active job address space information", "tags": [ "JES Jobs" ] } }, "/jobs/displayactive/sys": { "get": { "description": "Display active system address space information.", "operationId": "GetDisplayActiveSys", "parameters": [], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/displayActiveSysResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Display active system address space information", "tags": [ "JES Jobs" ] } }, "/jobs/notification": { "get": { "description": "Gets the notification when the job completed.

Notes: Notification is sent only if the header Event-Notification is set to true when submitting the job.", "operationId": "getJobNotification", "parameters": [ { "description": "An ID used to subscribe to notifications for the event. Example: 'event-1755233980619'", "in": "query", "name": "eventNotificationId", "required": true, "type": "string" }, { "default": 600, "description": "Event notification listener timeout. The default timeout is 600 seconds (10 minutes). When the timeout is reached, the event notification will be returned with a status of COMPLETED or ACTIVE. If the event remains ACTIVE, it means the event is still running, and you must subscribe to the event notification again.", "in": "header", "name": "Event-Notification-Listener-Timeout", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/event" } }, "400": { "description": "Bad request." } }, "summary": "Subscribes to the notification of the job", "tags": [ "JES Jobs" ] } }, "/jobs/string": { "post": { "consumes": [ "application/json", "text/plain" ], "description": "Submits a JES Job provided the JCL content in JSON or plain text format.", "operationId": "submitJobString", "parameters": [ { "description": "Specifies the name and value for a JCL symbol. The symbol name and value are separated by ':'. Multiple symbol names and values can be specified and separated by ','.\n\nA symbol name is 1 to 8 characters, where the first character must be uppercase alphabetic (A-Z) or special ($, #, @).\n\nA symbol value is limited to 255 characters.\n\n\n**For example:**\n\n'MBR1:ABC,MBR2:XYZ' specifies symbol name MBR1 with value ABC and symbol name MBR2 with value XYZ.\n\nSpecifying this custom header and submitting a job that uses //MYDD DSN=MY.DATASET(&MBR1.),DISP=SHR in the JCL will cause ABC to be substituted as the member name.", "in": "header", "name": "JCL-Symbols", "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" }, { "description": "Enable subscription to event notifications upon event completion (default: false). When enabled, an event notification ID will be included in the response header event-notification-id. This ID can be used with the Event Notification API to receive a notification once the subscribed event is completed. The output from the original response will be included in the event notification.", "enum": [ true, false ], "in": "header", "name": "Event-Notification", "type": "boolean" }, { "description": "JCL Content", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/jclContent" } } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created.", "schema": { "$ref": "#/definitions/job" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Submits a JES Job provided the JCL content in JSON or plain text format", "tags": [ "JES Jobs" ] } }, "/jobs/unix": { "post": { "consumes": [ "application/json", "text/plain" ], "description": "Submits a JES Job provided the Unix file information in JSON or plain text format.", "operationId": "submitJobUnix", "parameters": [ { "description": "Specifies the name and value for a JCL symbol. The symbol name and value are separated by ':'. Multiple symbol names and values can be specified and separated by ','.\n\nA symbol name is 1 to 8 characters, where the first character must be uppercase alphabetic (A-Z) or special ($, #, @).\n\nA symbol value is limited to 255 characters.\n\n\n**For example:**\n\n'MBR1:ABC,MBR2:XYZ' specifies symbol name MBR1 with value ABC and symbol name MBR2 with value XYZ.\n\nSpecifying this custom header and submitting a job that uses //MYDD DSN=MY.DATASET(&MBR1.),DISP=SHR in the JCL will cause ABC to be substituted as the member name.", "in": "header", "name": "JCL-Symbols", "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" }, { "description": "Enable subscription to event notifications upon event completion (default: false). When enabled, an event notification ID will be included in the response header event-notification-id. This ID can be used with the Event Notification API to receive a notification once the subscribed event is completed. The output from the original response will be included in the event notification.", "enum": [ true, false ], "in": "header", "name": "Event-Notification", "type": "boolean" }, { "description": "Unix File Content Information", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/jclUnixContent" } } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created.", "schema": { "$ref": "#/definitions/job" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Submits a JES Job provided the Unix file information in JSON", "tags": [ "JES Jobs" ] } }, "/jobs/{jobId}": { "delete": { "description": "Purges the JES job given the job ID.", "operationId": "deleteJobWithJobID", "parameters": [ { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" } ], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Purges a job.", "tags": [ "JES Jobs" ] }, "get": { "description": "Gets information about the job given the job ID.", "operationId": "getJobInfoWithJobId", "parameters": [ { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" }, { "description": "This indicates whether to retrieve the following additional JES job attributes (false by default).\n\nExample:\n\nsysoutClass,outputNode,execNode,deviceName,holdStatus,priority,returnInfo,systemReturnCode,jobKey,dataToken,spoolTracks,secLabel,flagByte,programmer,jobPosition,isActive,maxRC,asID,phase", "enum": [ true, false ], "in": "header", "name": "Show-Additional-Attributes", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/job" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets information about the job.", "tags": [ "JES Jobs" ] }, "put": { "consumes": [ "application/json" ], "description": "Perform an operation on a job [Cancel, Release, Hold, Requeue] given the job ID.", "operationId": "operationJesJobsWithJobID", "parameters": [ { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" }, { "description": "The new class for JES requeue", "in": "header", "name": "New-Class", "type": "string" }, { "description": "JES Job Operation Content Body", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/operationJclContent" } } ], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Perform an operation on a job [Cancel, Release, Hold, Requeue]", "tags": [ "JES Jobs" ] } }, "/jobs/{jobId}/allRawContent": { "get": { "description": "Download all combined job spool files and job steps as raw streaming data for the given job ID.", "operationId": "getAllJobFileRawContent", "parameters": [ { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" }, { "description": "The range of records to be retrieved from the job spool file. Format SSS-EEE or SSS,NNN, example: 1000-1050 or 1000,51.", "in": "header", "name": "Record-Range", "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" } ], "produces": [ "application/octet-stream" ], "responses": { "200": { "description": "Successful response, DOWNLOAD FILE", "schema": { "$ref": "#/definitions/downloadResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Download all job spool files and job steps combined.", "tags": [ "JES Jobs" ] } }, "/jobs/{jobId}/allcontent": { "get": { "description": "Gets the content of job spools and job steps for the specified job ID.", "operationId": "getJobFileContent", "parameters": [ { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" }, { "description": "Merge the content from all job spools and job steps into one consolidated output. Default is false.", "enum": [ true, false ], "in": "header", "name": "Merged-Content", "type": "boolean" }, { "description": "The range of records to be retrieved from the job spool file. Format SSS-EEE or SSS,NNN, example: 1000-1050 or 1000,51.", "in": "header", "name": "Record-Range", "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/allContent" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "413": { "description": "Specified resource entity is larger than the defined limit by the server." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets all content of a job by its job ID", "tags": [ "JES Jobs" ] } }, "/jobs/{jobId}/files": { "get": { "description": "Gets list of spool and job file information given a job ID.", "operationId": "getJobIdFilesWithJobID", "parameters": [ { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/listJobsFiles" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets list of spool and job file information", "tags": [ "JES Jobs" ] } }, "/jobs/{jobId}/files/{fileId}/content": { "get": { "description": "Gets the content of a job given job ID, and file ID.", "operationId": "getJobFileContentWithJobIDAndFileID", "parameters": [ { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" }, { "description": "The file ID. *Example: 2341*", "in": "path", "name": "fileId", "required": true, "type": "string" }, { "description": "The range of records to be retrieved from the job spool file. Format SSS-EEE or SSS,NNN, example: 1000-1050 or 1000,51.", "in": "header", "name": "Record-Range", "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/content" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "413": { "description": "Specified resource entity is larger than the defined limit by the server." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the content of a job", "tags": [ "JES Jobs" ] } }, "/jobs/{jobId}/files/{fileId}/export/{dsn}": { "post": { "description": "Export job spool contents to MVS data set given job ID, fileID, and MVS data set.", "operationId": "postExportJobWithJobID", "parameters": [ { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" }, { "description": "The file ID. *Example: 2341*", "in": "path", "name": "fileId", "required": true, "type": "string" }, { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "path", "name": "dsn", "required": true, "type": "string" }, { "description": "Default is false. Specify true to skip the job spool file exporting when detetcing file content truncation during export.", "in": "header", "name": "Skip-Exporting-When-Cutoff", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/contentExportSuccess" } }, "206": { "description": "Successful request, partial contents created", "schema": { "$ref": "#/definitions/contentExportPartial" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "413": { "description": "Specified resource entity is larger than the defined limit by the server." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Export job spool contents to MVS data set", "tags": [ "JES Jobs" ] } }, "/jobs/{jobId}/files/{fileId}/rawContent": { "get": { "description": "Download a job spool file as raw streaming data for the given job ID, and file ID.", "operationId": "getJobFileRawContentWithJobIDAndFileID", "parameters": [ { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" }, { "description": "The file ID. *Example: 2341*", "in": "path", "name": "fileId", "required": true, "type": "string" }, { "description": "The range of records to be retrieved from the job spool file. Format SSS-EEE or SSS,NNN, example: 1000-1050 or 1000,51.", "in": "header", "name": "Record-Range", "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" } ], "produces": [ "application/octet-stream" ], "responses": { "200": { "description": "Successful response, DOWNLOAD FILE", "schema": { "$ref": "#/definitions/downloadResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Download a job spool file as raw streaming data", "tags": [ "JES Jobs" ] } }, "/jobs/{jobId}/jcl": { "get": { "description": "Gets the JCL for a job given job ID.", "operationId": "getJCLJobWithJobID", "parameters": [ { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/jclContentResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the JCL for a job", "tags": [ "JES Jobs" ] } }, "/jobs/{jobId}/steps": { "get": { "description": "Gets the step information for a job given the job ID.", "operationId": "getJobStepsWithJobID", "parameters": [ { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/step" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the step information for a job", "tags": [ "JES Jobs" ] } }, "/jobs/{jobName}/{jobId}": { "delete": { "description": "Purges JES Job provided the job name and ID.", "operationId": "deleteJobFiles", "parameters": [ { "description": "The job name. Example: BPXAS, CICS*, *", "in": "path", "name": "jobName", "required": true, "type": "string" }, { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" } ], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Purges a job provided the job name and ID", "tags": [ "JES Jobs" ] }, "get": { "description": "Gets information about the job provided the job name and ID.", "operationId": "getJobInfo", "parameters": [ { "description": "The job name. Example: BPXAS, CICS*, *", "in": "path", "name": "jobName", "required": true, "type": "string" }, { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" }, { "description": "This indicates whether to retrieve the following additional JES job attributes (false by default).\n\nExample:\n\nsysoutClass,outputNode,execNode,deviceName,holdStatus,priority,returnInfo,systemReturnCode,jobKey,dataToken,spoolTracks,secLabel,flagByte,programmer,jobPosition,isActive,maxRC,asID,phase", "enum": [ true, false ], "in": "header", "name": "Show-Additional-Attributes", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/job" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets information about the job provided the job name and ID", "tags": [ "JES Jobs" ] }, "put": { "consumes": [ "application/json" ], "description": "Perform an operation on a job [Cancel, Release, Hold, Requeue].", "operationId": "operationJesJobs", "parameters": [ { "description": "The job name. Example: BPXAS, CICS*, *", "in": "path", "name": "jobName", "required": true, "type": "string" }, { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" }, { "description": "The new class for JES requeue", "in": "header", "name": "New-Class", "type": "string" }, { "description": "JES Job Operation Content Body", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/operationJclContent" } } ], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Perform an operation on a job [Cancel, Release, Hold, Requeue]", "tags": [ "JES Jobs" ] } }, "/jobs/{jobName}/{jobId}/files": { "get": { "description": "Gets list of spool and job file information provided a job name and ID.", "operationId": "getJobIdFiles", "parameters": [ { "description": "The job name. Example: BPXAS, CICS*, *", "in": "path", "name": "jobName", "required": true, "type": "string" }, { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/listJobsFiles" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets list of spool and job file information provided a job name and ID", "tags": [ "JES Jobs" ] } }, "/jobs/{jobName}/{jobId}/files/{fileId}/content": { "get": { "description": "Gets the content of a job provided job name, ID, and fileID.", "operationId": "getJobFileContent", "parameters": [ { "description": "The job name. Example: BPXAS, CICS*, *", "in": "path", "name": "jobName", "required": true, "type": "string" }, { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" }, { "description": "The file ID. *Example: 2341*", "in": "path", "name": "fileId", "required": true, "type": "string" }, { "description": "The range of records to be retrieved from the job spool file. Format SSS-EEE or SSS,NNN, example: 1000-1050 or 1000,51.", "in": "header", "name": "Record-Range", "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/content" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "413": { "description": "Specified resource entity is larger than the defined limit by the server." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the content of a job provided job name, ID, and fileID", "tags": [ "JES Jobs" ] } }, "/jobs/{jobName}/{jobId}/files/{fileId}/export/{dsn}": { "post": { "description": "Export a JES job provided job name, ID, fileID, and MVS data set.", "operationId": "postExportJob", "parameters": [ { "description": "The job name. Example: BPXAS, CICS*, *", "in": "path", "name": "jobName", "required": true, "type": "string" }, { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" }, { "description": "The file ID. *Example: 2341*", "in": "path", "name": "fileId", "required": true, "type": "string" }, { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "path", "name": "dsn", "required": true, "type": "string" }, { "description": "Default is false. Specify true to skip the job spool file exporting when detetcing file content truncation during export.", "in": "header", "name": "Skip-Exporting-When-Cutoff", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/contentExportSuccess" } }, "206": { "description": "Successful request, partial contents created", "schema": { "$ref": "#/definitions/contentExportPartial" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "413": { "description": "Specified resource entity is larger than the defined limit by the server." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Export a JES job provided job name, ID, fileID, and MVS data set", "tags": [ "JES Jobs" ] } }, "/jobs/{jobName}/{jobId}/files/{fileId}/rawContent": { "get": { "description": "Download a job spool file as raw streaming data for the given job name, ID, and fileID.", "operationId": "getJobFileRawContent", "parameters": [ { "description": "The job name. Example: BPXAS, CICS*, *", "in": "path", "name": "jobName", "required": true, "type": "string" }, { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" }, { "description": "The file ID. *Example: 2341*", "in": "path", "name": "fileId", "required": true, "type": "string" }, { "description": "The range of records to be retrieved from the job spool file. Format SSS-EEE or SSS,NNN, example: 1000-1050 or 1000,51.", "in": "header", "name": "Record-Range", "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" } ], "produces": [ "application/octet-stream" ], "responses": { "200": { "description": "Successful response, DOWNLOAD FILE", "schema": { "$ref": "#/definitions/downloadResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Download a job spool file as raw streaming data for the given job name, ID, and fileID.", "tags": [ "JES Jobs" ] } }, "/jobs/{jobName}/{jobId}/jcl": { "get": { "description": "Gets the JCL for a job provided job name and ID.", "operationId": "getJCLJob", "parameters": [ { "description": "The job name. Example: BPXAS, CICS*, *", "in": "path", "name": "jobName", "required": true, "type": "string" }, { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/jclContentResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the JCL for a job provided job name and ID", "tags": [ "JES Jobs" ] } }, "/jobs/{jobName}/{jobId}/steps": { "get": { "description": "Gets the step information for a job provided the job name and id.", "operationId": "getJobSteps", "parameters": [ { "description": "The job name. Example: BPXAS, CICS*, *", "in": "path", "name": "jobName", "required": true, "type": "string" }, { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/step" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the step information for a job provided the job name and id", "tags": [ "JES Jobs" ] } }, "/scan/notification": { "get": { "description": "Gets the notification when the classification scan completed.

Notes: The notification is subscribed to and sent only when the 'Event-Notification' header is set to true when running classification scan operation. The event notification ID is provided in the rseponse header event-notification-id only under this condition.", "operationId": "getUnixFileNotification", "parameters": [ { "description": "An ID used to subscribe to notifications for the event. Example: 'event-1755233980619'", "in": "query", "name": "eventNotificationId", "required": true, "type": "string" }, { "default": 600, "description": "Event notification listener timeout. The default timeout is 600 seconds (10 minutes). When the timeout is reached, the event notification will be returned with a status of COMPLETED or ACTIVE. If the event remains ACTIVE, it means the event is still running, and you must subscribe to the event notification again.", "in": "header", "name": "Event-Notification-Listener-Timeout", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/event" } }, "400": { "description": "Bad request." } }, "summary": "Subscribes to the notification of the classification scan", "tags": [ "Classification Scan" ] } }, "/scan/sourcecontainerinfo": { "get": { "description": "Provides source information for each file or member in this container", "operationId": "getScanSourceInfoStreamFromContainer", "parameters": [ { "description": "The directory or PDS containing source files or members for scanning.

Example: /u/IBM/Test for a UNIX folder or TST.DEV.RSE for a PDS ", "in": "query", "name": "path", "required": true, "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" }, { "description": "Indicates the file or member names to scan (default is *)", "in": "header", "name": "Filename-Filter", "required": false, "type": "string" }, { "description": "An optional hint suggesting the likely language for the source code.", "enum": [ "ASM", "C", "COB", "CPP", "EASY", "ISPF", "JAVA", "JCL", "PLI", "PLX", "REXX", "SORT", "TEXT", "UKN", "XML", "ZBND" ], "in": "header", "name": "Language-Hint", "required": false, "type": "string" }, { "description": "Enable subscription to event notifications upon event completion (default: false). When enabled, an event notification ID will be included in the response header event-notification-id. This ID can be used with the Event Notification API to receive a notification once the subscribed event is completed. The output from the original response will be included in the event notification.", "enum": [ true, false ], "in": "header", "name": "Event-Notification", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/scanContainerInfoEX" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Detect source information from the content of the files or members in this container", "tags": [ "Classification Scan" ] } }, "/scan/sourceinfo": { "get": { "description": "Detect source information from the content of the file provided in the path.", "operationId": "getScanSourceInfoFromFile", "parameters": [ { "description": "The path to the source file or member for scanning.

Example: /u/IBM/Test/xyz.c for a UNIX file or TST.DEV.COBOL(TSTMBR) for a member ", "in": "query", "name": "path", "required": true, "type": "string" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" }, { "description": "An optional hint suggesting the likely language for the source code.", "enum": [ "ASM", "C", "COB", "CPP", "EASY", "ISPF", "JAVA", "JCL", "PLI", "PLX", "REXX", "SORT", "TEXT", "UKN", "XML", "ZBND" ], "in": "header", "name": "Language-Hint", "required": false, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/scanSourceInfoEX" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Detect source information from the content of the file provided in the path", "tags": [ "Classification Scan" ] } }, "/scan/sourceinfofromcontent": { "post": { "consumes": [ "application/json", "text/plain" ], "description": "Detect source information from the content of the request body.", "operationId": "getScanSourceInfoFromContent", "parameters": [ { "description": "An optional hint suggesting the likely language for the source code.", "enum": [ "ASM", "C", "COB", "CPP", "EASY", "ISPF", "JAVA", "JCL", "PLI", "PLX", "REXX", "SORT", "TEXT", "UKN", "XML", "ZBND" ], "in": "header", "name": "Language-Hint", "required": false, "type": "string" }, { "description": "Scan from Content. **Put the Content to scan in the value of content key**", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/contentScan" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/scanSourceInfoContentEX" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Detect source information from the content of the request body", "tags": [ "Classification Scan" ] } }, "/tso": { "put": { "description": "Run a TSO command to interact with the z/OS system.", "operationId": "runTSOCommand", "parameters": [ { "description": "The TSO command to be executed.

Example: LISTDS 'TSTFILE.JCL'", "in": "query", "name": "command", "required": true, "type": "string" }, { "description": "Makes the output easier to read", "enum": [ true, false ], "in": "header", "name": "Pretty-Output", "required": false, "type": "boolean" }, { "description": "Specify this if you wish to reuse a shell", "in": "header", "name": "Shell-Id", "required": false, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/TSORunCommandEX" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." }, "503": { "description": "The operation is not available or not supported." } }, "summary": "Run a TSO command to interact with the z/OS system.", "tags": [ "TSO Commands" ] } }, "/tso/shellcommand": { "put": { "description": "Run a TSO command with streaming output", "operationId": "putTSOShellCommand", "parameters": [ { "description": "The TSO command to be executed.

Example: LISTDS 'TSTFILE.JCL'", "in": "query", "name": "command", "required": true, "type": "string" }, { "description": "Specify this if you wish to reuse a shell", "in": "header", "name": "Shell-Id", "required": false, "type": "string" } ], "produces": [ "text/plain" ], "responses": { "200": { "description": "Successful response", "schema": { "type": "string" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." }, "503": { "description": "The operation is not available or not supported." } }, "summary": "Execute a long running TSO command", "tags": [ "TSO Commands" ] } }, "/unixcommands": { "post": { "consumes": [ "application/json", "text/plain" ], "description": "Run a UNIX command, specifying the working directory and invocation in the request body.", "operationId": "postUnixCommand", "parameters": [ { "description": "Formats output to be easier to read", "enum": [ true, false ], "in": "header", "name": "Pretty-Output", "type": "boolean" }, { "description": "Enable subscription to event notifications upon event completion (default: false). When enabled, an event notification ID will be included in the response header event-notification-id. This ID can be used with the Event Notification API to receive a notification once the subscribed event is completed. The output from the original response will be included in the event notification.", "enum": [ true, false ], "in": "header", "name": "Event-Notification", "type": "boolean" }, { "description": "Invocation and path of UNIX Command", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/unixcommand" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/unixcommandResponseEX" } }, "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Run a UNIX command", "tags": [ "UNIX Commands" ] }, "put": { "description": "Run a UNIX command, specifying the working directory and the invocation fields.", "operationId": "putUnixCommand", "parameters": [ { "description": "The working directory specified for the file/folder. Example: /u/IBM/*test*", "in": "query", "name": "path", "required": true, "type": "string" }, { "description": "The command/program to be executed. Example: ls -lrt", "in": "query", "name": "invocation", "required": true, "type": "string" }, { "description": "Formats output to be easier to read", "enum": [ true, false ], "in": "header", "name": "Pretty-Output", "type": "boolean" }, { "description": "Enable subscription to event notifications upon event completion (default: false). When enabled, an event notification ID will be included in the response header event-notification-id. This ID can be used with the Event Notification API to receive a notification once the subscribed event is completed. The output from the original response will be included in the event notification.", "enum": [ true, false ], "in": "header", "name": "Event-Notification", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/unixcommandResponseEX" } }, "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Run a UNIX command", "tags": [ "UNIX Commands" ] } }, "/unixcommands/notification": { "get": { "description": "Gets the notification when the Unix command completed.

Notes: The notification is subscribed to and sent only when the 'Event-Notification' header is set to true during the execution of Unix commands. The event notification ID is provided in the rseponse header event-notification-id only under this condition.", "operationId": "getUnixCommandNotification", "parameters": [ { "description": "An ID used to subscribe to notifications for the event. Example: 'event-1755233980619'", "in": "query", "name": "eventNotificationId", "required": true, "type": "string" }, { "default": 600, "description": "Event notification listener timeout. The default timeout is 600 seconds (10 minutes). When the timeout is reached, the event notification will be returned with a status of COMPLETED or ACTIVE. If the event remains ACTIVE, it means the event is still running, and you must subscribe to the event notification again.", "in": "header", "name": "Event-Notification-Listener-Timeout", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/event" } }, "400": { "description": "Bad request." } }, "summary": "Subscribes to the notification of the Unix command execution", "tags": [ "UNIX Commands" ] } }, "/unixcommands/shellcommand": { "post": { "consumes": [ "application/json", "text/plain" ], "description": "Run a UNIX command, specifying the working directory, invocation and environment variables in the request body.", "operationId": "postUnixShellCommand", "parameters": [ { "description": "Enable subscription to event notifications upon event completion (default: false). When enabled, an event notification ID will be included in the response header event-notification-id. This ID can be used with the Event Notification API to receive a notification once the subscribed event is completed. The output from the original response will be included in the event notification.", "enum": [ true, false ], "in": "header", "name": "Event-Notification", "type": "boolean" }, { "description": "Invocation, path and environment variables of UNIX shell command", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/unixshellcommand" } } ], "produces": [ "text/plain" ], "responses": { "200": { "description": "Successful response", "schema": { "type": "string" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Execute a long running UNIX command in a shell", "tags": [ "UNIX Commands" ] }, "put": { "description": "Run a UNIX command, specifying the working directory, invocation and envrionment variables.", "operationId": "putUnixShellCommand", "parameters": [ { "description": "The working directory specified for the file/folder. Example: /u/IBM/*test*", "in": "query", "name": "path", "required": true, "type": "string" }, { "description": "The command/program to be executed. Example: ls -lrt", "in": "query", "name": "invocation", "required": true, "type": "string" }, { "description": "A comma separated list of defined environment variables. Example: MYVAR=1,XPATH=/u/test", "in": "query", "name": "environmentVariables", "type": "string" }, { "description": "Enable subscription to event notifications upon event completion (default: false). When enabled, an event notification ID will be included in the response header event-notification-id. This ID can be used with the Event Notification API to receive a notification once the subscribed event is completed. The output from the original response will be included in the event notification.", "enum": [ true, false ], "in": "header", "name": "Event-Notification", "type": "boolean" } ], "produces": [ "text/plain" ], "responses": { "200": { "description": "Successful response", "schema": { "type": "string" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Execute a long running UNIX command in a shell", "tags": [ "UNIX Commands" ] } }, "/unixfiles": { "get": { "description": "Gets a list of UNIX files and folders corresponding to a path.", "operationId": "getUNIXFiles", "parameters": [ { "description": "The working directory. Example: /u/IBM/test", "in": "query", "name": "path", "type": "string" }, { "description": "Specifies the comma-separator list of data set attributes to query. Example: name,type,size,link,lastModified,permissionsSymbolic,fileOwner,group", "in": "header", "name": "Included-Attributes", "type": "string" }, { "description": "If the path is a directory, this indicates whether to retrieve permission, ownership and encoding information for the files under the directory (false by default)", "enum": [ true, false ], "in": "header", "name": "Show-Additional-Attributes", "type": "boolean" }, { "description": "Indicates whether to show hidden files (true by default)", "enum": [ true, false ], "in": "header", "name": "Show-Hidden", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/unixfiles" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets a list of UNIX files and folders corresponding to a path", "tags": [ "UNIX Files" ] } }, "/unixfiles/archives": { "get": { "description": "Gets a list of UNIX files and folders corresponding to a given archive path and a path within that archive.", "operationId": "getUNIXArchiveFiles", "parameters": [ { "description": "The archive file path. Example: /u/IBM/archive.zip, /u/IBM/archive.tar or /u/IBM/archive.pax", "in": "query", "name": "archivePath", "type": "string" }, { "description": "The relative path of the file or directory within the archive. Example: /test/test.sh or /test. When not specified, the default is /", "in": "query", "name": "relativePath", "required": false, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/unixfiles" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets a list of UNIX files and folders corresponding to a given archive path and a path within that archive", "tags": [ "UNIX Files" ] } }, "/unixfiles/archives/{archivePath}": { "delete": { "description": "Deletes a UNIX File/Folder within an archive path.", "operationId": "deleteUNIXArchiveFiles", "parameters": [ { "description": "The archive file path. Example: /u/IBM/archive.zip, /u/IBM/archive.tar or /u/IBM/archive.pax", "in": "path", "name": "archivePath", "required": true, "type": "string" }, { "description": "The relative path of the file or directory within the archive. Example: /test/test.sh or /test", "in": "query", "name": "relativePath", "required": true, "type": "string" } ], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Deletes a UNIX File/Folder within an archive path", "tags": [ "UNIX Files" ] }, "get": { "description": "Gets the content of UNIX files within an archive.", "operationId": "getUNIXArchiveFilesWithPath", "parameters": [ { "description": "The archive file path. Example: /u/IBM/archive.zip, /u/IBM/archive.tar or /u/IBM/archive.pax", "in": "path", "name": "archivePath", "required": true, "type": "string" }, { "description": "The relative path of the file or directory within the archive. Example: /test/test.sh or /test", "in": "query", "name": "relativePath", "required": true, "type": "string" }, { "description": "Convert the host code page to the local encoding (default is UTF-8)", "enum": [ true, false ], "in": "header", "name": "Convert", "type": "boolean" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" }, { "description": "Optional local encoding parameter", "in": "header", "name": "Local-Encoding", "type": "string" }, { "description": "Return the results of a source scan in the resulting JSON", "enum": [ true, false ], "in": "header", "name": "Scan", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/contentUnix" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the content of UNIX files within an archive", "tags": [ "UNIX Files" ] }, "post": { "consumes": [ "application/json", "text/plain" ], "description": "Creates a UNIX file/folder within an archive path.", "operationId": "postUNIXFilesWithArchivePath", "parameters": [ { "description": "The archive file path. Example: /u/IBM/archive.zip, /u/IBM/archive.tar or /u/IBM/archive.pax", "in": "path", "name": "archivePath", "required": true, "type": "string" }, { "description": "The relative path of the file or directory within the archive. Example: /test/test.sh or /test", "in": "query", "name": "relativePath", "required": true, "type": "string" }, { "description": "UNIX File Parameters", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/unixType2" } } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created", "schema": { "$ref": "#/definitions/unixfiles_path" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Creates a UNIX file/folder within an archive path", "tags": [ "UNIX Files" ] }, "put": { "consumes": [ "application/json", "text/plain" ], "description": "Changes content from UNIX Files within an archive.", "operationId": "putUNIXFilesWithArchivePath", "parameters": [ { "description": "The archive file path. Example: /u/IBM/archive.zip, /u/IBM/archive.tar or /u/IBM/archive.pax", "in": "path", "name": "archivePath", "required": true, "type": "string" }, { "description": "The relative path of the file or directory within the archive. Example: /test/test.sh or /test", "in": "query", "name": "relativePath", "required": true, "type": "string" }, { "description": "Convert to the host encoding", "enum": [ true, false ], "in": "header", "name": "Convert", "type": "boolean" }, { "description": "If not specified when convert is specified then it will fall back to the the chtagged encoding. If the file is not chtagged with an encoding, then it will fall back to the default host encoding. If \"binary\" is specified then the upload will be in binary mode.", "in": "header", "name": "Host-Encoding", "type": "string" }, { "description": "Optional local encoding parameter", "in": "header", "name": "Local-Encoding", "type": "string" }, { "description": "This header parameter will allow editing of the content if the checksum matches the Etag checksum in the response header", "in": "header", "name": "If-Match", "type": "string" }, { "description": "UNIX File Content", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/contentUnix" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/unixfiles_path" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "412": { "description": "A pre-condition required for the execution of an operation was not met." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Changes content from UNIX Files within an archive", "tags": [ "UNIX Files" ] } }, "/unixfiles/archives/{archivePath}/export": { "post": { "description": "Export a UNIX File/Folder from an archive, to a destination path.", "operationId": "exportUNIXFilesFromArchive", "parameters": [ { "description": "The archive file path. Example: /u/IBM/archive.zip, /u/IBM/archive.tar or /u/IBM/archive.pax", "in": "path", "name": "archivePath", "required": true, "type": "string" }, { "description": "The relative path of the file or directory within the archive. Example: /test/test.sh or /test", "in": "query", "name": "relativePath", "required": true, "type": "string" }, { "description": "The destination path of the exported file or directory. Example: /u/IBM/test.sh", "in": "query", "name": "destination", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created", "schema": { "$ref": "#/definitions/emptyResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Export a UNIX File/Folder from an archive, to a destination path", "tags": [ "UNIX Files" ] } }, "/unixfiles/archives/{archivePath}/import": { "post": { "description": "Import a UNIX File/Folder from a specified path to a destination relative path within an archive.", "operationId": "importUNIXFilesToArchive", "parameters": [ { "description": "The archive file path. Example: /u/IBM/archive.zip, /u/IBM/archive.tar or /u/IBM/archive.pax", "in": "path", "name": "archivePath", "required": true, "type": "string" }, { "description": "The destination path of the new file within the archive to be appended to the parent path. Example: /dir/NewFolder/*test*, where test would be the name of the new file", "in": "query", "name": "relativePath", "required": true, "type": "string" }, { "description": "The source path of the file to be imported to the destination. Example: /u/IBM/test", "in": "query", "name": "sourcePath", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created", "schema": { "$ref": "#/definitions/emptyResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Import a UNIX File/Folder from a specified path to a destination relative path within an archive", "tags": [ "UNIX Files" ] } }, "/unixfiles/search/files": { "get": { "description": "Search for UNIX Files by specifying the path, file name, and text pattern.

If Regex pattern is not used, wildcard patterns are used.", "operationId": "searchUNIXFileNew", "parameters": [ { "description": "The working directory. Example: /u/IBM/test", "in": "query", "name": "path", "required": true, "type": "string" }, { "description": "The name of the file to perform the action on. Example: test.txt or ***.txt", "in": "query", "name": "filename", "required": true, "type": "string" }, { "description": "The text pattern to be searched for in the provided file. Example: *hello*", "in": "query", "name": "text", "type": "string" }, { "description": "Regex for filename. If Regex pattern is not used, wildcard patterns are used.", "enum": [ true, false ], "in": "header", "name": "Regex-Filename", "type": "boolean" }, { "description": "Regex for content. If Regex pattern is not used, wildcard patterns are used.", "enum": [ true, false ], "in": "header", "name": "Regex-Content", "type": "boolean" }, { "description": "Case-sensitive for filename", "enum": [ true, false ], "in": "header", "name": "Case-Sensitive-Filename", "type": "boolean" }, { "description": "Case-sensitive for content", "enum": [ true, false ], "in": "header", "name": "Case-Sensitive-Content", "type": "boolean" }, { "description": "Resolve Symbolic Links. Default to true", "enum": [ true, false ], "in": "header", "name": "Resolve-Symbolic-Links", "type": "boolean" }, { "description": "Number of results displayed for search If number-of-results is not used, default is 10000 results.", "in": "header", "name": "Number-Of-Results", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/search" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Search for UNIX files that match file name and/or content patterns", "tags": [ "UNIX Files" ] } }, "/unixfiles/{path}": { "delete": { "description": "Deletes the specified UNIX file.", "operationId": "deleteUNIXFiles", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Deletes a UNIX file", "tags": [ "UNIX Files" ] }, "get": { "description": "Gets content from UNIX Files within a path.", "operationId": "getUNIXFilesWithPath", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" }, { "description": "Convert the host code page to the local encoding (default is UTF-8)", "enum": [ true, false ], "in": "header", "name": "Convert", "type": "boolean" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" }, { "description": "Optional local encoding parameter", "in": "header", "name": "Local-Encoding", "type": "string" }, { "description": "Return the results of a source scan in the resulting JSON", "enum": [ true, false ], "in": "header", "name": "Scan", "type": "boolean" }, { "description": "Returns the checksum for the file", "enum": [ true, false ], "in": "header", "name": "E-Tag", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "headers": { "ETag": { "description": "ETag (checksum)", "type": "string" } }, "schema": { "$ref": "#/definitions/contentUnix" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "413": { "description": "Specified resource entity is larger than the defined limit by the server." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets content from UNIX Files within a path", "tags": [ "UNIX Files" ] }, "head": { "description": "Gets the checksum (Etag) and total byte count (Bytes-On-Host) for the specified UNIX file", "operationId": "headUNIXFilesWithPath", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response", "headers": { "Bytes-On-Host": { "description": "Bytes-On-Host (number of bytes on the host file system)", "type": "integer" }, "ETag": { "description": "ETag (checksum)", "type": "string" } } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the checksum (Etag) and total byte count (Bytes-On-Host) for the specified UNIX file", "tags": [ "UNIX Files" ] }, "post": { "consumes": [ "application/json", "text/plain" ], "description": "Creates the specified UNIX file or folder", "operationId": "postUNIXFilesWithPath", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" }, { "description": "UNIX File Parameters", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/unixType" } } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created", "schema": { "$ref": "#/definitions/unixfiles_path" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Creates a UNIX file or folder", "tags": [ "UNIX Files" ] }, "put": { "consumes": [ "application/json", "text/plain" ], "description": "Sets the content for the specified UNIX file.", "operationId": "putUNIXFilesWithPath", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" }, { "description": "Convert to the host encoding", "enum": [ true, false ], "in": "header", "name": "Convert", "type": "boolean" }, { "description": "If not specified when convert is specified then it will fall back to the the chtagged encoding. If the file is not chtagged with an encoding, then it will fall back to the default host encoding. If \"binary\" is specified then the upload will be in binary mode.", "in": "header", "name": "Host-Encoding", "type": "string" }, { "description": "Optional local encoding parameter", "in": "header", "name": "Local-Encoding", "type": "string" }, { "description": "This header parameter will allow editing of the content if the checksum matches the Etag checksum in the response header", "in": "header", "name": "If-Match", "type": "string" }, { "description": "UNIX File Content", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/contentUnix" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/unixfiles_path" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "412": { "description": "A pre-condition required for the execution of an operation was not met." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Sets the content of a UNIX file", "tags": [ "UNIX Files" ] } }, "/unixfiles/{path}/changePermissions": { "put": { "consumes": [ "application/json", "text/plain" ], "description": "Change permissions of the specified UNIX file or folder.", "operationId": "changePermissionsUNIXFiles", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" }, { "description": "UNIX File Permissions", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/unixPermissions" } } ], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Change permissions of a UNIX file or folder", "tags": [ "UNIX Files" ] } }, "/unixfiles/{path}/clearEncoding": { "put": { "description": "Clear the encoding chtag for a file provided the path.", "operationId": "clearUNIXEncoding", "parameters": [ { "description": "The working directory. Example: /u/IBM/test", "in": "path", "name": "path", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/unixClearEncodingResponseEx" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Clear the encoding chtag for a file provided the path", "tags": [ "UNIX Files" ] } }, "/unixfiles/{path}/convertEncoding": { "post": { "consumes": [ "application/json", "text/plain" ], "description": "Changes a UNIX file to a target encoding.", "operationId": "postUNIXConverEncoding", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" }, { "description": "UNIX File Encoding", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/unixEncodingConvert" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/unixConvEncodingResponseEx" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Converts a UNIX file to another encoding", "tags": [ "UNIX Files" ] } }, "/unixfiles/{path}/copy": { "post": { "description": "Copy the specified UNIX file or folder to the specified destination", "operationId": "copyUNIXFiles", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" }, { "description": "The destination path of the exported file or directory. Example: /u/IBM/test.sh", "in": "query", "name": "destination", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created", "schema": { "$ref": "#/definitions/emptyResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Copy a UNIX file or folder from a path to another location", "tags": [ "UNIX Files" ] } }, "/unixfiles/{path}/copyFromDataSet": { "post": { "description": "Copy the specified PDS, PDS member or SEQ to the UNIX file or folder location.", "operationId": "copyFromDataSet", "parameters": [ { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "query", "name": "dsn", "required": true, "type": "string" }, { "description": "The destination file or directory. Example: /u/IBM/*test* or /u/sandbox/start.jcl", "in": "path", "name": "path", "required": true, "type": "string" }, { "description": "Specifies the file extension for copied files (only applicable when copying a PDS). Example: jcl", "in": "header", "name": "File-Extension", "type": "string" } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created", "schema": {} }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Copy a PDS, PDS member or SEQ to a UNIX location", "tags": [ "UNIX Files" ] } }, "/unixfiles/{path}/copyToDataSet": { "post": { "description": "Copy the specified UNIX file or folder to the specified PDS, PDS member or SEQ.", "operationId": "copyToDataSet", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" }, { "description": "Path of the destination. Ex. TST.ACCESS.COPY or TST.QE(MEMBER)", "in": "query", "name": "destination", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created", "schema": {} }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Copy a UNIX file or folder to a PDS, PDS member or SEQ", "tags": [ "UNIX Files" ] } }, "/unixfiles/{path}/getEncoding": { "get": { "description": "Get the encoding for a file provided the path. If the file is binary, then \"binary\" will be returned", "operationId": "getUNIXEncoding", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/unixEncoding" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Get the encoding for a file provided the path", "tags": [ "UNIX Files" ] } }, "/unixfiles/{path}/link": { "post": { "description": "Creates a symbolic link to the specified file or folder and a hard link to files.", "operationId": "symlinkUNIXFILES", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" }, { "description": "Target path of the link. Example: /u/IBM/test.txt", "in": "query", "name": "destination", "required": true, "type": "string" }, { "description": "Indicates the link type as a soft link or a hard link.", "enum": [ "soft", "hard" ], "in": "query", "name": "type", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created", "schema": { "$ref": "#/definitions/emptyResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Creates Symbol link or hard link based on type", "tags": [ "UNIX Files" ] } }, "/unixfiles/{path}/markEncoding": { "put": { "consumes": [ "application/json", "text/plain" ], "description": "Set the encoding chtag for a file provided the path. To mark a file as binary, specify \"binary\" as the encoding", "operationId": "putUNIXEncoding", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" }, { "description": "UNIX File Encoding", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/unixEncoding" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/unixMarkEncodingResponseEx" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Set the encoding chtag for a file provided the path", "tags": [ "UNIX Files" ] } }, "/unixfiles/{path}/move": { "post": { "description": "Move the specified UNIX file or folder to a new location.", "operationId": "moveUNIXFiles", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" }, { "description": "Path to move the file over to. Example: /NewFolder/test", "in": "query", "name": "newPath", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Successful request, new resource created", "schema": { "$ref": "#/definitions/emptyResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Move a UNIX file or folder", "tags": [ "UNIX Files" ] } }, "/unixfiles/{path}/rawContent": { "get": { "description": "Download the specified UNIX file as raw streaming data.", "operationId": "getRawContentUNIX", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" }, { "description": "Convert the host code page to the local encoding (default is UTF-8)", "enum": [ true, false ], "in": "header", "name": "Convert", "type": "boolean" }, { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" }, { "description": "Optional local encoding parameter", "in": "header", "name": "Local-Encoding", "type": "string" }, { "description": "Returns the checksum for the file", "enum": [ true, false ], "in": "header", "name": "E-Tag", "type": "boolean" } ], "produces": [ "application/octet-stream" ], "responses": { "200": { "description": "Successful response, DOWNLOAD FILE", "headers": { "ETag": { "description": "ETag (checksum)", "type": "string" } }, "schema": { "$ref": "#/definitions/downloadResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Download a UNIX file as raw streaming data", "tags": [ "UNIX Files" ] }, "head": { "description": "Gets the checksum (Etag) and total byte count (Bytes-On-Host) for the specified UNIX file", "operationId": "headRawContentUNIX", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful response", "headers": { "Bytes-On-Host": { "description": "Bytes-On-Host (number of bytes on the host file system)", "type": "integer" }, "ETag": { "description": "ETag (checksum)", "type": "string" } } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Gets the checksum (Etag) and total byte count (Bytes-On-Host) for the specified UNIX file", "tags": [ "UNIX Files" ] }, "put": { "consumes": [ "application/octet-stream" ], "description": "Upload raw streaming data to the specified UNIX file.
To choose a file to upload, try out the API and select \\\"application/octet-stream\\\".", "operationId": "putRawContentUNIX", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" }, { "description": "Convert to the host encoding", "enum": [ true, false ], "in": "header", "name": "Convert", "type": "boolean" }, { "description": "If not specified when convert is specified then it will fall back to the the chtagged encoding. If the file is not chtagged with an encoding, then it will fall back to the default host encoding. If \"binary\" is specified then the upload will be in binary mode.", "in": "header", "name": "Host-Encoding", "type": "string" }, { "description": "Optional local encoding parameter", "in": "header", "name": "Local-Encoding", "type": "string" }, { "description": "This header parameter will allow editing of the content if the checksum matches the Etag checksum in the response header", "in": "header", "name": "If-Match", "type": "string" }, { "default": false, "description": "Tag file with the specified host encoding as part of the upload", "enum": [ true, false ], "in": "header", "name": "Tag-File", "type": "boolean" }, { "in": "body", "name": "body", "schema": { "format": "binary", "type": "string" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful response", "schema": { "$ref": "#/definitions/emptyResponse" } }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "412": { "description": "A pre-condition required for the execution of an operation was not met." }, "413": { "description": "Specified resource entity is larger than the defined limit by the server." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Upload raw streaming data to a UNIX file", "tags": [ "UNIX Files" ] } }, "/unixfiles/{path}/rename": { "post": { "description": "Rename a UNIX file or folder.", "operationId": "renameUNIXFiles", "parameters": [ { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" }, { "description": "The new name of the UNIX File or Folder", "in": "query", "name": "newName", "required": true, "type": "string" } ], "responses": { "204": { "description": "Successful response, no content to display." }, "400": { "description": "Bad request." }, "401": { "description": "Unauthorized request was made." }, "403": { "description": "Server refuses to authorize request." }, "404": { "description": "The specified resource was not found." }, "500": { "description": "Unable to process the request due to an internal server error." } }, "summary": "Rename a UNIX file or folder", "tags": [ "UNIX Files" ] } } }, "swagger": "2.0", "x-components": { "parameters": { "Dataset-Type": { "default": "non-VSAM", "description": "Specifies the data set type. Ex. non-VSAM", "enum": [ "non-VSAM", "VSAM" ], "in": "header", "name": "Dataset-Type", "type": "string" }, "Etag": { "description": "Returns the checksum for the file", "enum": [ true, false ], "in": "header", "name": "E-Tag", "type": "boolean" }, "If-Match": { "description": "This header parameter will allow editing of the content if the checksum matches the Etag checksum in the response header", "in": "header", "name": "If-Match", "type": "string" }, "Include-GDS": { "default": false, "description": "Include Generation Data Sets (GDS).", "enum": [ true, false ], "in": "header", "name": "Include-GDS", "type": "boolean" }, "Included-Attributes": { "description": "Specifies the comma-separator list of data set attributes to query. Example: name,type,dsName,dsnType,recordFormat", "in": "header", "name": "Included-Attributes", "type": "string" }, "Included-AttributesJES": { "description": "Specifies the comma-separator list of the following JES job attributes to query.\n\nExample:\n\njobName,owner,systemEntryDateTime,jobId,returnCode,subsystem,type,executionClass,execSystem,phaseName,execMember,status\n\nWhen Show-Additional-Attributes header is set to true, the following additional JES job attributes can be specified in the comma-separator list to query.\n\nExample:\n\nsysoutClass,outputNode,execNode,deviceName,holdStatus,priority,returnInfo,systemReturnCode,jobKey,dataToken,spoolTracks,secLabel,flagByte,programmer,jobPosition,isActive,maxRC,asID,phase", "in": "header", "name": "Included-Attributes", "type": "string" }, "Included-AttributesJESDisplayAll": { "description": "Specifies the comma-separator list of JES job address space attributes to query. Ex. asid,swapin,all_cpu,asidx,page_rate,user_id,io_rate,type,dp,all_cpu%,job_name,real_in_bytes,elapsed,hvcomused,task_cpu%,hvcomhwm,cpu_task,real_in_frames,subtype,system_name,step_io,position_description,sr,sr_description,job_proc,job_class,job_step,job_id,position", "in": "header", "name": "Included-Attributes", "type": "string" }, "Included-AttributesPDSMembers": { "description": "Specifies the comma-separator list of partition data set member attributes to query. Ex: creationDate,lastModifiedDate,lastModifiedBy,linecount,revision,lockOwner", "in": "header", "name": "Included-Attributes", "type": "string" }, "Included-AttributesUSS": { "description": "Specifies the comma-separator list of data set attributes to query. Example: name,type,size,link,lastModified,permissionsSymbolic,fileOwner,group", "in": "header", "name": "Included-Attributes", "type": "string" }, "MVSDestination": { "description": "Path of the destination. Ex. TST.ACCESS.COPY or TST.QE(MEMBER)", "in": "query", "name": "destination", "required": true, "type": "string" }, "MVSNewName": { "description": "New name of the Dataset or Dataset member. Ex. TST.ACCESS.WRITE.NEW or NEWMEMBER", "in": "query", "name": "newName", "required": true, "type": "string" }, "Mapping": { "description": "Show the member mapping", "enum": [ true, false ], "in": "header", "name": "Mapping", "type": "boolean" }, "Members": { "description": "Specifies the comma-separator list of PDS members or member wildcard patterns to query. Ex. MEMBER*,LOGFILE

(Range-Offset, Range-Name-Offset and Num-To-Show are not used with a non-wildcard Members filter)", "in": "header", "name": "Members", "type": "string" }, "Overwrite-Target": { "description": "Indicates whether to overwrite the target if it already exists (true by default)", "in": "header", "name": "Overwrite-Target", "schema": { "enum": [ "true", "false" ], "type": "boolean" } }, "ServiceName": { "description": "The service to cancel (default is 'all')", "enum": [ "all", "jes-jobs", "mvs-and-tso", "unix-files", "unix-commands", "scan-service", "common-properties" ], "in": "header", "name": "Service", "required": false, "type": "string" }, "Show-Additional-Attributes": { "description": "If the path is a directory, this indicates whether to retrieve permission, ownership and encoding information for the files under the directory (false by default)", "enum": [ true, false ], "in": "header", "name": "Show-Additional-Attributes", "type": "boolean" }, "Show-Additional-Attributes-JES": { "description": "This indicates whether to retrieve the following additional JES job attributes (false by default).\n\nExample:\n\nsysoutClass,outputNode,execNode,deviceName,holdStatus,priority,returnInfo,systemReturnCode,jobKey,dataToken,spoolTracks,secLabel,flagByte,programmer,jobPosition,isActive,maxRC,asID,phase", "enum": [ true, false ], "in": "header", "name": "Show-Additional-Attributes", "type": "boolean" }, "Skip-Exporting-When-CutoffJESExport": { "description": "Default is false. Specify true to skip the job spool file exporting when detetcing file content truncation during export.", "in": "header", "name": "Skip-Exporting-When-Cutoff", "type": "string" }, "Sort-By": { "default": "name", "description": "Metric to sort the returned list. Default to sort by name only", "enum": [ "name", "filetype" ], "in": "header", "name": "Sort-By", "type": "string" }, "TSOCommandQuery": { "description": "The TSO command to be executed.

Example: LISTDS 'TSTFILE.JCL'", "in": "query", "name": "command", "required": true, "type": "string" }, "Tag-File": { "default": false, "description": "Tag file with the specified host encoding as part of the upload", "enum": [ true, false ], "in": "header", "name": "Tag-File", "type": "boolean" }, "UserID-List": { "description": "Specifies the comma-separator list of userIDs to query. Example: USER1,USER2", "in": "header", "name": "UserID-List", "type": "string" }, "access-level": { "description": "Specifies the access level of the namespace to query. *Example: public*", "enum": [ "public", "private" ], "in": "header", "name": "Access-Level", "type": "string" }, "archivePath": { "description": "The archive file path. Example: /u/IBM/archive.zip, /u/IBM/archive.tar or /u/IBM/archive.pax", "in": "query", "name": "archivePath", "type": "string" }, "archivePath2": { "description": "The archive file path. Example: /u/IBM/archive.zip, /u/IBM/archive.tar or /u/IBM/archive.pax", "in": "path", "name": "archivePath", "required": true, "type": "string" }, "binaryDefaultTrue": { "description": "Specify optional binary header parameter (true by default)", "enum": [ true, false ], "in": "header", "name": "Binary", "type": "boolean" }, "body": { "description": "body content for put", "in": "query", "name": "body", "required": true, "schema": { "type": "string" } }, "case-sensitive-content": { "description": "Case-sensitive for content", "enum": [ true, false ], "in": "header", "name": "Case-Sensitive-Content", "type": "boolean" }, "case-sensitive-filename": { "description": "Case-sensitive for filename", "enum": [ true, false ], "in": "header", "name": "Case-Sensitive-Filename", "type": "boolean" }, "checkCertExpiration": { "description": "Return user authenticate certificate expiration information in the response header. Default to false", "in": "header", "name": "Cert-Expiration", "required": false, "schema": { "enum": [ true, false ], "type": "boolean" }, "value": false }, "checkExpiration": { "description": "Return password/passphrase expiration information in the response header (false by default)", "enum": [ true, false ], "in": "header", "name": "Pass-Expiration", "required": false, "type": "boolean", "value": false }, "commonPropertyNamespace": { "description": "The Namespace name. Ex. tstNamespace or TSTNAMESPACE. Alphanumerics, hyphens, and underscores only.", "in": "path", "name": "namespace", "required": true, "type": "string" }, "commonPropertyNamespaceQuery": { "description": "The Namespace name. Ex. tstNamespace or TSTNAMESPACE. Alphanumerics, hyphens, and underscores only.", "in": "query", "name": "namespace", "required": true, "schema": { "type": "string" } }, "commonPropertyjsonPath": { "description": "The path of the Common Property. Ex. services or services/serviceX.", "in": "query", "name": "jsonPath", "required": false, "type": "string" }, "containerScanQuery": { "description": "The directory or PDS containing source files or members for scanning.

Example: /u/IBM/Test for a UNIX folder or TST.DEV.RSE for a PDS ", "in": "query", "name": "path", "required": true, "type": "string" }, "content-search": { "description": "Content string to be searched. Ex. HelloWorld or *", "in": "query", "name": "content", "type": "string" }, "contentUnix": { "description": "The content string to be appended into a file. Example: *hello this is a test string*", "in": "query", "name": "content", "schema": { "type": "string" } }, "convert": { "description": "Convert the host code page to the local encoding (default is UTF-8)", "enum": [ true, false ], "in": "header", "name": "Convert", "type": "boolean" }, "convertForPUT": { "description": "Convert to the host encoding", "enum": [ true, false ], "in": "header", "name": "Convert", "type": "boolean" }, "convertTrueOnly": { "description": "Convert to the host encoding", "enum": [ true, false ], "in": "header", "name": "Convert", "type": "boolean" }, "copydsn": { "description": "Existing data set name. Ex. HLQ.PDS", "in": "path", "name": "copydsn", "required": true, "type": "string" }, "destination": { "description": "The destination path of the exported file or directory. Example: /u/IBM/test.sh", "in": "query", "name": "destination", "required": true, "type": "string" }, "destination1": { "description": "Target path of the link. Example: /u/IBM/test.txt", "in": "query", "name": "destination", "required": true, "type": "string" }, "destinationRelativePath": { "description": "The destination path of the new file within the archive to be appended to the parent path. Example: /dir/NewFolder/*test*, where test would be the name of the new file", "in": "query", "name": "relativePath", "required": true, "type": "string" }, "dsn": { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "path", "name": "dsn", "required": true, "type": "string" }, "dsn-searchNotRequired": { "description": "Dataset name pattern. Ex. HLQ.PDS or \\*.\\*", "in": "query", "name": "dsnPattern", "type": "string" }, "dsn-searchRequired": { "description": "Dataset name pattern. Ex. HLQ.PDS, or \\*.\\*", "in": "query", "name": "dsnPattern", "required": true, "type": "string" }, "dsnMigrate": { "description": "Dataset name. Ex. TST.QUALI.PDS", "in": "path", "name": "dsn", "required": true, "type": "string" }, "dsnNotRequired": { "description": "Dataset name. Ex. HLQ.PS or HLQ.PO(MEMBER)", "in": "query", "name": "dsn", "schema": { "type": "string" } }, "dsnSource": { "description": "Dataset name. Ex. TST.QUALI.PDS, TST.QUALI.SEQ or TST.PO(MEMBER)", "in": "query", "name": "dsn", "required": true, "type": "string" }, "encoding": { "description": "The encoding for the Unix File.", "in": "query", "name": "encoding", "schema": { "type": "string" } }, "encodingconversion": { "description": "The encoding conversion for the Unix File.", "in": "query", "name": "encodingConversion", "schema": { "type": "string" } }, "environmentVariables": { "description": "A comma separated list of defined environment variables. Example: MYVAR=1,XPATH=/u/test", "in": "query", "name": "environmentVariables", "type": "string" }, "eventNotification": { "description": "Enable subscription to event notifications upon event completion (default: false). When enabled, an event notification ID will be included in the response header event-notification-id. This ID can be used with the Event Notification API to receive a notification once the subscribed event is completed. The output from the original response will be included in the event notification.", "enum": [ true, false ], "in": "header", "name": "Event-Notification", "type": "boolean" }, "eventNotificationId": { "description": "An ID used to subscribe to notifications for the event. Example: 'event-1755233980619'", "in": "query", "name": "eventNotificationId", "required": true, "type": "string" }, "eventNotificationListenerTimeout": { "default": 600, "description": "Event notification listener timeout. The default timeout is 600 seconds (10 minutes). When the timeout is reached, the event notification will be returned with a status of COMPLETED or ACTIVE. If the event remains ACTIVE, it means the event is still running, and you must subscribe to the event notification again.", "in": "header", "name": "Event-Notification-Listener-Timeout", "type": "integer" }, "fileExtension": { "description": "Specifies the file extension for copied files (only applicable when copying a PDS). Example: jcl", "in": "header", "name": "File-Extension", "type": "string" }, "fileId": { "description": "The file ID. *Example: 2341*", "in": "path", "name": "fileId", "required": true, "type": "string" }, "filename": { "description": "The name of the file to perform the action on. Example: test.txt or ***.txt", "in": "query", "name": "filename", "required": true, "type": "string" }, "filenameFilter": { "description": "Indicates the file or member names to scan (default is *)", "in": "header", "name": "Filename-Filter", "required": false, "type": "string" }, "filenameRegex": { "description": "The name of the file to perform the action on. Example: test.txt or ***.txt. With regex headers as true. Ex. [A-Za-z0-9_-]*\\.*[A-Za-z0-9]{3,4}", "in": "query", "name": "filename", "schema": { "type": "string" } }, "filepath": { "description": "The path of the file or folder. Example: /u/IBM/test/file.txt", "in": "path", "name": "path", "required": true, "type": "string" }, "filter": { "description": "Dataset filter string. Ex. FILTERNAME.*", "in": "path", "name": "filter", "required": true, "type": "string" }, "filterQuery": { "description": "A single data set filter string (e.g. HLQ.\\*, HLQ.\\*.BBB, or HLQ.AAA.BBB.) or a comma-separated filter list (e.g. HLQ1.\\*,HLQ2.\\*).", "in": "query", "name": "filter", "required": true, "type": "string" }, "gdgName": { "description": "Genration Data Group name. Ex. USER1.GDG01", "in": "path", "name": "gdgName", "required": true, "type": "string" }, "hostEncoding": { "description": "Optional host encoding parameter", "in": "header", "name": "Host-Encoding", "type": "string" }, "hostEncoding_PUT": { "description": "If not specified when convert is specified then it will fall back to the the chtagged encoding. If the file is not chtagged with an encoding, then it will fall back to the default host encoding. If \"binary\" is specified then the upload will be in binary mode.", "in": "header", "name": "Host-Encoding", "type": "string" }, "include-migrated-pds": { "description": "Search data sets including migrated data sets.", "enum": [ true, false ], "in": "header", "name": "Include-Migrated", "type": "boolean" }, "include-migrated-seq": { "description": "Search data sets including migrated data sets. Searching migrated data set content is not allowed.", "enum": [ true, false ], "in": "header", "name": "Include-Migrated", "type": "boolean" }, "include-offline-volume-pds": { "description": "Searching data sets including data set in offline volumes.", "enum": [ true, false ], "in": "header", "name": "Include-Offline-Volume", "type": "boolean" }, "include-offline-volume-seq": { "description": "Searching data sets including data set in offline volumes. Searching offline data set content is not allowed.", "enum": [ true, false ], "in": "header", "name": "Include-Offline-Volume", "type": "boolean" }, "invocation": { "description": "The command/program to be executed. Example: ls -lrt", "in": "query", "name": "invocation", "required": true, "type": "string" }, "isPrettyOutputTSO": { "description": "Makes the output easier to read", "enum": [ true, false ], "in": "header", "name": "Pretty-Output", "required": false, "type": "boolean" }, "isPrettyOutputUnix": { "description": "Formats output to be easier to read", "enum": [ true, false ], "in": "header", "name": "Pretty-Output", "type": "boolean" }, "jclContent": { "description": "The JCL Content for the POST", "in": "path", "name": "JCL Content", "required": true, "schema": { "type": "string" } }, "jclDatasetContent": { "description": "The JCL Dataset Content for the POST", "in": "path", "name": "JCL Dataset Content", "required": true, "schema": { "type": "string" } }, "jclUnixContent": { "description": "The JCL Unix File Content for the POST", "in": "path", "name": "JCL Unix File Content", "required": true, "schema": { "type": "string" } }, "jesJclSymbol": { "description": "Specifies the name and value for a JCL symbol. The symbol name and value are separated by ':'. Multiple symbol names and values can be specified and separated by ','.\n\nA symbol name is 1 to 8 characters, where the first character must be uppercase alphabetic (A-Z) or special ($, #, @).\n\nA symbol value is limited to 255 characters.\n\n\n**For example:**\n\n'MBR1:ABC,MBR2:XYZ' specifies symbol name MBR1 with value ABC and symbol name MBR2 with value XYZ.\n\nSpecifying this custom header and submitting a job that uses //MYDD DSN=MY.DATASET(&MBR1.),DISP=SHR in the JCL will cause ABC to be substituted as the member name.", "in": "header", "name": "JCL-Symbols", "type": "string" }, "jesRecordRange": { "description": "The range of records to be retrieved from the job spool file. Format SSS-EEE or SSS,NNN, example: 1000-1050 or 1000,51.", "in": "header", "name": "Record-Range", "type": "string" }, "jesRequeueClass": { "description": "The new class for JES requeue", "in": "header", "name": "New-Class", "type": "string" }, "jobId": { "description": "The job id. Example: STC29784", "in": "path", "name": "jobId", "required": true, "type": "string" }, "jobName": { "description": "The job name. Example: BPXAS, CICS*, *", "in": "path", "name": "jobName", "required": true, "type": "string" }, "jobNotification": { "description": "Send notification when the job completed (Default is false).", "in": "header", "name": "Job-Notification", "schema": { "enum": [ true, false ], "type": "boolean" } }, "languageHint": { "description": "An optional hint suggesting the likely language for the source code.", "enum": [ "ASM", "C", "COB", "CPP", "EASY", "ISPF", "JAVA", "JCL", "PLI", "PLX", "REXX", "SORT", "TEXT", "UKN", "XML", "ZBND" ], "in": "header", "name": "Language-Hint", "required": false, "type": "string" }, "localEncoding": { "description": "Optional local encoding parameter", "in": "header", "name": "Local-Encoding", "type": "string" }, "member-search": { "description": "Member name pattern. Ex. MEM or *", "in": "query", "name": "memberPattern", "type": "string" }, "mergedContent": { "description": "Merge the content from all job spools and job steps into one consolidated output. Default is false.", "enum": [ true, false ], "in": "header", "name": "Merged-Content", "type": "boolean" }, "namespace": { "description": "The Namespace name. Ex. tstNamespace or TSTNAMESPACE. Alphanumerics, hyphens, and underscores only.", "in": "path", "name": "namespace", "required": true, "type": "string" }, "namespaceName": { "description": "The Namespace name. Ex. tstNamespace or TSTNAMESPACE. Alphanumerics, hyphens, and underscores only.", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, "newCommonPropertyNamespaceQuery": { "description": "The NEW Namespace name. Ex. tstNamespace2 or TSTNAMESPACE2. Alphanumerics, hyphens, and underscores only.", "in": "query", "name": "newNamespace", "required": true, "type": "string" }, "newDsn": { "description": "Newly created data set name. Ex. HLQ.TEST.PDS", "in": "query", "name": "dsn", "required": true, "type": "string" }, "newName": { "description": "The new name of the UNIX File or Folder", "in": "query", "name": "newName", "required": true, "type": "string" }, "newPath": { "description": "Path to move the file over to. Example: /NewFolder/test", "in": "query", "name": "newPath", "required": true, "type": "string" }, "newpassword": { "description": "Type the new password that you would like to change to.", "in": "query", "name": "newpassword", "required": false, "schema": { "type": "string" } }, "numToShow": { "description": "Maximum number of members to be returned.", "in": "header", "name": "Num-To-Show", "type": "integer" }, "numToShowDatasetsList": { "description": "Maximum number of data sets to be returned.", "in": "header", "name": "Num-To-Show", "type": "integer" }, "numToShowMemberAttrs": { "description": "Maximum number of filtered members to be returned.", "in": "header", "name": "Num-To-Show", "type": "integer" }, "number-of-results": { "description": "Number of results displayed for search If number-of-results is not used, default is 10000 results.", "in": "header", "name": "Number-Of-Results", "type": "integer" }, "owner": { "description": "Owner of the job. Default to requester user id", "in": "query", "name": "owner", "type": "string" }, "password": { "description": "**Type the current password.**", "in": "query", "name": "password", "required": true, "schema": { "type": "string" } }, "path": { "description": "The working directory. Example: /u/IBM/test", "in": "path", "name": "path", "required": true, "type": "string" }, "path1": { "description": "The working directory. Example: /u/IBM/test", "in": "query", "name": "path", "required": true, "type": "string" }, "path2": { "description": "The working directory. Example: /u/IBM/test", "in": "query", "name": "path", "type": "string" }, "pathDestination": { "description": "The destination file or directory. Example: /u/IBM/*test* or /u/sandbox/start.jcl", "in": "path", "name": "path", "required": true, "type": "string" }, "pathQuery": { "description": "The working directory specified for the file/folder. Example: /u/IBM/*test*", "in": "query", "name": "path", "required": true, "type": "string" }, "pathScanQuery": { "description": "The path to the source file or member for scanning.

Example: /u/IBM/Test/xyz.c for a UNIX file or TST.DEV.COBOL(TSTMBR) for a member ", "in": "query", "name": "path", "required": true, "type": "string" }, "pdsName": { "description": "PDS name. Ex. USER1.PDS1", "in": "path", "name": "pdsName", "required": true, "type": "string" }, "prefix": { "description": "Prefix of the job. *Example: BPXAS, R**", "in": "query", "name": "prefix", "type": "string" }, "recordRange": { "description": "The range of records to be retrieved from the data set file. Format SSS-EEE or SSS,NNN, example: 1000-1050 or 1000,51.
Cannot be specified with header 'Etag' or 'Scan'", "in": "header", "name": "Record-Range", "type": "string" }, "regex-content": { "description": "Regex for content. If Regex pattern is not used, wildcard patterns are used.", "enum": [ true, false ], "in": "header", "name": "Regex-Content", "type": "boolean" }, "regex-dsn": { "description": "Regex for data set name. If Regex pattern is not used, wildcard patterns are used.", "enum": [ true, false ], "in": "header", "name": "Regex-Dsn", "type": "boolean" }, "regex-filename": { "description": "Regex for filename. If Regex pattern is not used, wildcard patterns are used.", "enum": [ true, false ], "in": "header", "name": "Regex-Filename", "type": "boolean" }, "regex-member": { "description": "Regex for member name. If Regex pattern is not used, wildcard patterns are used.", "enum": [ true, false ], "in": "header", "name": "Regex-Member", "type": "boolean" }, "relativePath": { "description": "The relative path of the file or directory within the archive. Example: /test/test.sh or /test", "in": "query", "name": "relativePath", "required": true, "type": "string" }, "relativePathForListing": { "description": "The relative path of the file or directory within the archive. Example: /test/test.sh or /test. When not specified, the default is /", "in": "query", "name": "relativePath", "required": false, "type": "string" }, "resolve-symbolic-links": { "description": "Resolve Symbolic Links. Default to true", "enum": [ true, false ], "in": "header", "name": "Resolve-Symbolic-Links", "type": "boolean" }, "scan": { "description": "Return the results of a source scan in the resulting JSON", "enum": [ true, false ], "in": "header", "name": "Scan", "type": "boolean" }, "serverLogLevel": { "default": "WARN", "description": "Set the server log level.", "enum": [ "ERROR", "WARN", "INFO", "DEBUG" ], "in": "query", "name": "logLevel", "required": true, "type": "string" }, "shellID": { "description": "Specify this if you wish to reuse a shell", "in": "header", "name": "Shell-Id", "required": false, "type": "string" }, "showHidden": { "description": "Indicates whether to show hidden files (true by default)", "enum": [ true, false ], "in": "header", "name": "Show-Hidden", "type": "boolean" }, "sourcePath": { "description": "The source path of the file to be imported to the destination. Example: /u/IBM/test", "in": "query", "name": "sourcePath", "required": true, "type": "string" }, "startIndex": { "description": "Offset index (0-n) in the members list to return. Ex. 5

(Either Range-Offset or Range-Name-Offset is used)", "in": "header", "name": "Range-Offset", "type": "integer" }, "startName": { "description": "Offset name in the members list to return. Ex. MEMBER1

(Either Range-Offset or Range-Name-Offset is used)", "in": "header", "name": "Range-Name-Offset", "type": "string" }, "startRangeIndex": { "description": "Offset index (0-n) in the filtered members list to return. Ex. 5

(Either Range-Offset or Range-Name-Offset is used)", "in": "header", "name": "Range-Offset", "type": "integer" }, "startRangeIndexDatasetsList": { "description": "Offset index (0-n) in the filtered data sets list to return. Ex. 5

(Either Range-Offset or Range-Name-Offset is used)", "in": "header", "name": "Range-Offset", "type": "integer" }, "startRangeName": { "description": "Offset name in the filtered members list to return. Ex. MEMBER1

(Either Range-Offset or Range-Name-Offset is used)", "in": "header", "name": "Range-Name-Offset", "type": "string" }, "startRangeNameDatasetsList": { "description": "Offset name in the filtered data sets list to return. The dataset must exist. Ex. FILTERNAME.PDS1

(Either Range-Offset or Range-Name-Offset is used)", "in": "header", "name": "Range-Name-Offset", "type": "string" }, "status": { "description": "Status of the job. *Example: ACTIVE*", "enum": [ "ACTIVE", "OUTPUT", "INPUT", "HELD", "ALL" ], "in": "query", "name": "status", "type": "string" }, "text": { "description": "The text pattern to be searched for in the provided file. Example: *hello*", "in": "query", "name": "text", "type": "string" }, "type": { "description": "type of file", "in": "query", "name": "type", "schema": { "type": "string" } }, "type1": { "description": "Indicates the link type as a soft link or a hard link.", "enum": [ "soft", "hard" ], "in": "query", "name": "type", "required": true, "type": "string" }, "typeUnix": { "description": "The type is either a file or a folder to be created/deleted.", "in": "query", "name": "type", "schema": { "type": "string" } }, "userLogLevel": { "description": "The user log level to set to. Valid value: 0 to 2. Example: 2", "in": "query", "name": "logLevel", "required": true, "type": "integer" }, "userid": { "description": "**Type the user ID.**", "in": "query", "name": "userid", "required": true, "schema": { "type": "string" } }, "vsamCluster": { "description": "VSAM Cluster name. Ex. USER1.VSAM01", "in": "path", "name": "vsamCluster", "required": true, "type": "string" } }, "responses": { "BadRequest": { "description": "Bad request." }, "Conflict": { "description": "Target already exists." }, "Forbidden": { "description": "Server refuses to authorize request." }, "InternalServerError": { "description": "Unable to process the request due to an internal server error." }, "LargeEntity": { "description": "Specified resource entity is larger than the defined limit by the server." }, "NewResourceCreated": { "description": "Successful response, new resource created." }, "NoContent": { "description": "Successful response, no content to display." }, "NotAllowed": { "description": "Server has been configured to restrict this function." }, "NotFound": { "description": "The specified resource was not found." }, "PreconditionFailed": { "description": "A pre-condition required for the execution of an operation was not met." }, "ServiceUnvailable": { "description": "The operation is not available or not supported." }, "Unauthorized": { "description": "Unauthorized request was made." } } } }