{"openapi":"3.0.1","info":{"title":"CA 7 Workload Automation RESTful Web Services","description":"CA 7 Workload Automation RESTful Web Services
Product Version: 12.1.06, CA 7 Supported Version: 12.1.01, Build Number: 617, Build Time: 2024-12-12 20:20
For more information, see [CA 7 Documentation](https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/automation/ca-workload-automation-ca-7-edition/12-1/using/commands/command-descriptions.html)\n\n[Swagger/OpenAPI JSON Document](https://localhost:8080/mock/apicatalog/api/v1/apidoc/ca7services/null%20null)","version":"v12.1.06"},"servers":[{"url":"https://localhost:8080/mock/ca7services/","description":"Generated server url"}],"tags":[{"name":"REST API Transaction","description":"Transaction operations"},{"name":"Job History","description":"CA 7 historical job information"},{"name":"Datasets","description":"CA 7 dataset management"},{"name":"Job Definitions","description":"CA 7 job definitions"},{"name":"Agent Credentials Management","description":"CA 7 agent credentials management"},{"name":"Resources","description":"CA 7 resource management"},{"name":"Agent Management","description":"CA 7 agent management"},{"name":"Batch","description":"Multiple API calls in the same CA 7 session"},{"name":"REST API Version","description":"Version information"},{"name":"REST API CA 7 Instances","description":"Retrieve, add, update, or delete a CA 7 instance configuration, including the DEFAULT_INSTANCE"},{"name":"Commands","description":"CA 7 commands"},{"name":"Job Instances","description":"CA 7 job instances (jobs in the active workload)"}],"paths":{"/api/v1/commands/jclovrd":{"post":{"tags":["Commands"],"summary":"Issue JCLOVRD command for DEFAULT_INSTANCE","description":"The JCLOVRD command establishes or satisfies JCL override requirements.
This command is primarily used when the CPU job does not have a permanent JCL override requirement assigned.
The CPU job for which the JCL override is being established (or satisfied) must be in the request queue.
If you are using CA Workload Automation CA 7 Edition to insert IBM WLM scheduling environment keywords on JOB statements,
you can use the JCLOVRD command to suppress or allow SCHENV= keyword insertion.
This function is available as the J value for FILL FUNCTION on the QM.1 panel.
The function can also be accomplished with the QM.2 and QM.3 panels.
[CA 7 Documentation](https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/automation/ca-workload-automation-ca-7-edition/12-1/using/commands/command-descriptions/jclovrd-command.html)","operationId":"jclovrd_1","parameters":[{"name":"key","in":"query","description":"The command transaction key","required":false,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJCLOVRD","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"CA 7 was able to process the JCLOVRD command","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJCLOVRDResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorJCLOVRDResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"401":{"description":"You are not authorized to issue the command"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]}},"/api/v1/transaction/key":{"get":{"tags":["REST API Transaction"],"summary":"Retrieves a unique transaction key to be used as command identifier","description":"Retrieves a unique transaction key to be passed to any CA7Onl command.
The key will be used to ensure the same command is not sent twice.
After it is used in the payload of the initial request, the transaction key can only be used when reissuing the POST on the same endpoint, with the same payload.
Also note that the key will expire.
So it should not be used if more than 60 minutes have elapsed since the initial invocation.","operationId":"getKey","responses":{"200":{"description":"Generates a unique key to be used as identifier for a CA7Onl command","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UniqueKeyResponse","exampleSetFlag":false},"exampleSetFlag":false}}}},"security":[{"basicScheme":[]}]}},"/api/v1/job/definition/resource/shared-resource":{"put":{"tags":["Job Definitions"],"summary":"Modify Shared resource for a job definition for DEFAULT_INSTANCE","description":"Modify a Shared resource for the definition of a job","operationId":"updateSharedResource_1","parameters":[{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSharedResourceModify","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"CA 7 was able to process the change","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSharedResourceModifyResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSharedResourceModifyError","exampleSetFlag":false},"exampleSetFlag":false}}},"403":{"description":"You are not authorized to use this function"},"401":{"description":"You are not authorized to issue the command"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]},"post":{"tags":["Job Definitions"],"summary":"Add Shared resource to a job definition for DEFAULT_INSTANCE","description":"Add a Shared resource to the definition of a job","operationId":"addSharedResource_1","parameters":[{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSharedResourceAdd","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"CA 7 was able to process the change","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSharedResourceAddResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"403":{"description":"You are not authorized to use this function"},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSharedResourceAddError","exampleSetFlag":false},"exampleSetFlag":false}}},"401":{"description":"You are not authorized to issue the command"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]},"delete":{"tags":["Job Definitions"],"summary":"Delete Shared resource from a job definition for DEFAULT_INSTANCE","description":"Delete a Shared resource from the definition of a job","operationId":"deleteSharedResource_1","parameters":[{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSharedResourceDelete","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"CA 7 was able to process the change","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSharedResourceDeleteResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSharedResourceDeleteError","exampleSetFlag":false},"exampleSetFlag":false}}},"403":{"description":"You are not authorized to use this function"},"401":{"description":"You are not authorized to issue the command"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]}},"/api/v1/ca7-instance/list":{"post":{"tags":["REST API CA 7 Instances"],"summary":"Find Instances","description":"Find all configured instances that have all the properties in the request","operationId":"listInstance","parameters":[{"name":"Authorization","in":"header","description":"The CA 7 user and password
Basic Authentication","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ca7InstanceEntityFilter","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"The instances with the given properties were listed"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"basicScheme":[]}]}},"/api/v1/{ca7Id}/job/definition/resource":{"get":{"tags":["Job Definitions"],"summary":"Get job resources for one or more jobs for CA 7 instance specified in path","description":"Get a list of the job resources for one or more jobs","operationId":"getJobResources","parameters":[{"name":"ca7Id","in":"path","description":"CA7ONL Instance","required":true,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"jobname","in":"query","description":"The CA 7 job name","required":true,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"databasename","in":"query","description":"The CA 7 database name","required":false,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Authorization","in":"header","description":"The CA 7 user and password
Basic Authentication","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"responses":{"200":{"description":"CA 7 was able to process the command","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CA7JobResourceListResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure"},"401":{"description":"The userid or password is invalid"},"403":{"description":"You are not authorized to use this function"},"404":{"description":"No information found for the specified criteria"},"503":{"description":"Unable to connect to Datacom database; the credentials may be incorrect or the Datacom Server may not be available"}},"security":[{"basicScheme":[]}]}},"/api/v1/agent/{agent-name}/stop-start":{"put":{"tags":["Agent Management"],"summary":"Stop-start Agent for DEFAULT_INSTANCE","description":"Stop-start an Agent. This operation will stop and start the specified Agent.","operationId":"stopStartAgent_1","parameters":[{"name":"agent-name","in":"path","description":"Specifies the name of the Agent to stop-start.

Limits: 1 to 16 alphanumeric characters","required":true,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"os","in":"query","description":"Specifies the operating system of the Agent as known by the Scheduler.

Windows
Linux
Unix
etc.

Services invoked with GET
Services invoked with a transaction key

Including services such as these in the payload of a BATCH invocation may lead to unintended results.
Descriptor Format

Name	Value
path Required	The path as shown in Swagger for the endpoint associated with this API request
method Required	The API method Valid values are POST, PUT or DELETE.
body Required if the method is POST, PUT, or DELETE Invalid if the method is GET	The request body required for the API specified by path Note that double quotes (\") in the original API request body should be replaced with single quotes (') in the body value.
parameters Optional depending upon the path and method	Name/value pairs specified using standard JSON format enclosed in curly brackets { }

","content":{"application/json":{"schema":{"type":"array","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/batchMultipeRequestSchema","exampleSetFlag":false},"types":["array"]},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"The list of api was processed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"401":{"description":"You are not authorized to issue the command"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]}},"/api/v1/{ca7Id}/commands/verify":{"post":{"tags":["Commands"],"summary":"Issue VERIFY command for CA 7 instance specified in path","description":"The VERIFY command establishes or satisfies a manual verification requirement for a currently scheduled run of the job in the request queue before its execution.
A verification requirement is established for the currently scheduled run to ensure completion of some unusual activity before job submission.
For more information on VERIFY command, see [CA 7 Documentation](https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/automation/ca-workload-automation-ca-7-edition/12-1/using/commands/command-descriptions/verify-command.html)","operationId":"verify","parameters":[{"name":"ca7Id","in":"path","description":"CA7ONL Instance","required":true,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"key","in":"query","description":"The command transaction key","required":false,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandVERIFY","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"CA 7 was able to process the VERIFY command","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandVERIFYResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorVERIFYResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"403":{"description":"You are not authorized to use this function"},"401":{"description":"You are not authorized to issue the command"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]}},"/api/v1/{ca7Id}/job/history/prior-run":{"get":{"tags":["Job History"],"summary":"Retrieves job information from the prior-run queue for CA 7 instance specified in path","operationId":"priorRunQueueResponse","parameters":[{"name":"ca7Id","in":"path","description":"CA7ONL Instance","required":true,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"jobname","in":"query","description":"The CA 7 job name","required":false,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"databasename","in":"query","description":"The CA 7 database name","required":false,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Authorization","in":"header","description":"The CA 7 user and password
Basic Authentication","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"responses":{"200":{"description":"Succesfully retrieved job information from prior-run queue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ca7PriorRunQueueJobListResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure"},"401":{"description":"The userid or password is invalid"},"403":{"description":"You are not authorized to use this function"},"404":{"description":"No information found for the specified criteria"},"503":{"description":"Unable to connect to Datacom database; the credentials may be incorrect or the Datacom Server may not be available"}},"security":[{"basicScheme":[]}]}},"/api/v1/{ca7Id}/job/definition/trigger-successor":{"get":{"tags":["Job Definitions"],"summary":"Get triggered jobs for one or more jobs for CA 7 instance specified in path","description":"Get a list of the triggered jobs for one or more jobs","operationId":"getTriggerSuccessor","parameters":[{"name":"ca7Id","in":"path","description":"CA7ONL Instance","required":true,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"jobname","in":"query","description":"The CA 7 job name","required":true,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"databasename","in":"query","description":"The CA 7 database name","required":false,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Authorization","in":"header","description":"The CA 7 user and password
Basic Authentication","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"responses":{"200":{"description":"CA 7 was able to process the command","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CA7TriggeredJobsListResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure"},"401":{"description":"The userid or password is invalid"},"403":{"description":"You are not authorized to use this function"},"404":{"description":"No information found for the specified criteria"},"503":{"description":"Unable to connect to Datacom database; the credentials may be incorrect or the Datacom Server may not be available"}},"security":[{"basicScheme":[]}]},"put":{"tags":["Job Definitions"],"summary":"Modify Job Trigger for a job definition for CA 7 instance specified in path","description":"Modify a Job Trigger for the definition of a job","operationId":"modifyJobTrigger","parameters":[{"name":"ca7Id","in":"path","description":"CA7ONL Instance","required":true,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobTriggerModify","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"CA 7 was able to process the change","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobTriggerModifyResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobTriggerModifyError","exampleSetFlag":false},"exampleSetFlag":false}}},"401":{"description":"You are not authorized to issue the command"},"403":{"description":"You are not authorized to use this function"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]},"post":{"tags":["Job Definitions"],"summary":"Add Job Trigger to a job definition for CA 7 instance specified in path","description":"Add a Job Trigger to the definition of a job","operationId":"addJobTrigger","parameters":[{"name":"ca7Id","in":"path","description":"CA7ONL Instance","required":true,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobTriggerAdd","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"CA 7 was able to process the change","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobTriggerAddResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobTriggerAddError","exampleSetFlag":false},"exampleSetFlag":false}}},"401":{"description":"You are not authorized to issue the command"},"403":{"description":"You are not authorized to use this function"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]},"delete":{"tags":["Job Definitions"],"summary":"Delete Job Trigger from a job definition for CA 7 instance specified in path","description":"Delete a Job Trigger from the definition of a job","operationId":"deleteJobTrigger","parameters":[{"name":"ca7Id","in":"path","description":"CA7ONL Instance","required":true,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobTriggerDelete","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"CA 7 was able to process the change","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobTriggerDeleteResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobTriggerDeleteError","exampleSetFlag":false},"exampleSetFlag":false}}},"401":{"description":"You are not authorized to issue the command"},"403":{"description":"You are not authorized to use this function"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]}},"/api/v1/agent/{agent-name}/stop":{"put":{"tags":["Agent Management"],"summary":"Stop Agent for DEFAULT_INSTANCE","description":"Stop an Agent. This operation will stop the specified Agent.

Note: WARNING: If successful, the Agent will be stopped and no longer available to accept work. The Agent must be manually started.","operationId":"stopAgent_1","parameters":[{"name":"agent-name","in":"path","description":"Specifies the name of the Agent to stop.

Limits: 1 to 16 alphanumeric characters","required":true,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"os","in":"query","description":"Specifies the operating system of the Agent as known by the Scheduler.

Windows
Linux
Unix
etc.

Windows
Linux
Unix
etc.

Default: Linux","required":false,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"responses":{"204":{"description":"The Agent was successfully stopped and started"},"400":{"description":"The command cannot be processed due to a bad request"},"401":{"description":"The userid or password is invalid"},"403":{"description":"Access to the endpoint forbidden by CA 7. Contact your CA 7 security administrator"}},"security":[{"basicScheme":[]}]}},"/api/v1/agent/{agent-name}/details":{"get":{"tags":["Agent Management"],"summary":"Get Agent details for DEFAULT_INSTANCE","description":"Return additional details about an Agent.","operationId":"getAgentDetails_1","parameters":[{"name":"agent-name","in":"path","description":"Specifies the name of the Agent for which to retrieve additional details.

Limits: 1 to 16 alphanumeric characters","required":true,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"os","in":"query","description":"Specifies the operating system of the Agent as known by the Scheduler.

Default: Linux","required":false,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"responses":{"200":{"description":"The additional Agent information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CA7AgentDetails","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a bad request"},"401":{"description":"The userid or password is invalid"},"403":{"description":"Access to the endpoint forbidden by CA 7. Contact your CA 7 security administrator"}},"security":[{"basicScheme":[]}]}},"/api/v1/{ca7Id}/commands/resolv":{"post":{"tags":["Commands"],"summary":"Issue RESOLV command for CA 7 instance specified in path","description":"The RESOLV top line command creates or modifies processing schedules for jobs that are to be scheduled on a date/time basis.
Work that is scheduled by a trigger or on-request work that is DEMANDed or RUN has no direct relationship to a base calendar and
therefore does not require the use of this function., see
[CA 7 Documentation](https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/automation/ca-workload-automation-ca-7-edition/12-1/using/commands/command-descriptions/resolv-command.html)","operationId":"resolve","parameters":[{"name":"ca7Id","in":"path","description":"CA7ONL Instance","required":true,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandRESOLV","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"CA 7 was able to process the RESOLV command","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandRESOLVResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorRESOLVResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"403":{"description":"You are not authorized to use this function"},"401":{"description":"You are not authorized to issue the command"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]}},"/api/v1/job/definition/resource/resource-count-resource":{"put":{"tags":["Job Definitions"],"summary":"Modify Resource Count resource for a job definition for DEFAULT_INSTANCE","description":"Modify a Resource Count resource for the definition of a job","operationId":"modifyJobResourceCountResource_1","parameters":[{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobCountResourceModify","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"CA 7 was able to process the change","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobCountResourceModifyResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobCountResourceModifyError","exampleSetFlag":false},"exampleSetFlag":false}}},"403":{"description":"You are not authorized to use this function"},"401":{"description":"You are not authorized to issue the command"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]},"post":{"tags":["Job Definitions"],"summary":"Add Resource Count resource to a job definition for DEFAULT_INSTANCE","description":"Add a Resource Count resource to the definition of a job","operationId":"addJobResourceCountResource_1","parameters":[{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobCountResourceAdd","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"CA 7 was able to process the change","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobCountResourceAddResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobCountResourceAddError","exampleSetFlag":false},"exampleSetFlag":false}}},"403":{"description":"You are not authorized to use this function"},"401":{"description":"You are not authorized to issue the command"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]},"delete":{"tags":["Job Definitions"],"summary":"Delete Resource Count resource from a job definition for DEFAULT_INSTANCE","description":"Delete a Resource Count resource from the definition of a job","operationId":"deleteJobResourceCountResource_1","parameters":[{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobCountResourceDelete","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"CA 7 was able to process the change","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobCountResourceDeleteResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandJobCountResourceDeleteError","exampleSetFlag":false},"exampleSetFlag":false}}},"403":{"description":"You are not authorized to use this function"},"401":{"description":"You are not authorized to issue the command"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]}},"/api/v1/job/definition/resource":{"get":{"tags":["Job Definitions"],"summary":"Get job resources for one or more jobs for DEFAULT_INSTANCE","description":"Get a list of the job resources for one or more jobs","operationId":"getJobResources_1","parameters":[{"name":"jobname","in":"query","description":"The CA 7 job name","required":true,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"databasename","in":"query","description":"The CA 7 database name","required":false,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Authorization","in":"header","description":"The CA 7 user and password
Basic Authentication","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"responses":{"200":{"description":"CA 7 was able to process the command","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CA7JobResourceListResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure"},"401":{"description":"The userid or password is invalid"},"403":{"description":"You are not authorized to use this function"},"404":{"description":"No information found for the specified criteria"},"503":{"description":"Unable to connect to Datacom database; the credentials may be incorrect or the Datacom Server may not be available"}},"security":[{"basicScheme":[]}]}},"/api/v1/dataset/definition/dataset":{"put":{"tags":["Datasets"],"summary":"Modify a dataset definition for DEFAULT_INSTANCE","description":"Modify the definition of a dataset","operationId":"modifyDataset_1","parameters":[{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandDatasetModify","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"CA 7 was able to process the change","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandDatasetModifyResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandDatasetModifyError","exampleSetFlag":false},"exampleSetFlag":false}}},"403":{"description":"You are not authorized to use this function"},"401":{"description":"You are not authorized to issue the command"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]},"post":{"tags":["Datasets"],"summary":"Create a new dataset definition for DEFAULT_INSTANCE","description":"Create a new definition of a dataset","operationId":"addDataset_1","parameters":[{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandDatasetAdd","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"CA 7 was able to process the change","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandDatasetAddResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandDatasetAddError","exampleSetFlag":false},"exampleSetFlag":false}}},"403":{"description":"You are not authorized to use this function"},"401":{"description":"You are not authorized to issue the command"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]},"delete":{"tags":["Datasets"],"summary":"Delete a dataset definition for DEFAULT_INSTANCE","description":"Delete the definition of a dataset","operationId":"deleteDataset_1","parameters":[{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandDatasetDelete","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"200":{"description":"CA 7 was able to process the change","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandDatasetDeleteResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"403":{"description":"You are not authorized to use this function"},"400":{"description":"The command cannot be processed due to a failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandDatasetDeleteError","exampleSetFlag":false},"exampleSetFlag":false}}},"401":{"description":"You are not authorized to issue the command"},"404":{"description":"The command cannot be processed due to a failure"}},"security":[{"basicScheme":[]}]}},"/api/v1/{ca7Id}/agent-credentials":{"post":{"tags":["Agent Credentials Management"],"summary":"Add Agent credentials for CA 7 instance specified in path","description":"Add Agent credentials to be associated with a user ID, Agent name, job type and source.","operationId":"addAgentPassword","parameters":[{"name":"ca7Id","in":"path","description":"CA7ONL Instance","required":true,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentCredentialsAddRequest","exampleSetFlag":false},"exampleSetFlag":false}},"required":true},"responses":{"204":{"description":"Agent credentials associated with the specified userid, agent, jobType and source parameters were successfully added"},"400":{"description":"The command cannot be processed due to a bad request"},"401":{"description":"The userid or password is invalid"},"403":{"description":"Access to the endpoint forbidden by CA 7. Contact your CA 7 security administrator"},"409":{"description":"Agent credentials already exists for the specified userid, agent, jobType and source parameters"}},"security":[{"basicScheme":[]}]}},"/api/v1/agent-credentials/{userid}/status":{"get":{"tags":["Agent Credentials Management"],"summary":"Get Agent credentials status for DEFAULT_INSTANCE","description":"Check for the presence of Agent credentials associated with the specified user ID, Agent name, job type and source.","operationId":"getAgentPasswordStatus_1","parameters":[{"name":"userid","in":"path","description":"Specifies a user ID that is passed with a password to an agent for authorization.

Limits: 1 to 128 characters. The wildcard characters * and ? are not permitted

Example: wlaagent","required":true,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"agent","in":"query","description":"Specifies the agent that is the target of a job submission and where the user ID and password authorization takes place.

Limits: 1 to 16 characters. The wildcard characters * and ? are not permitted

Example: WINAGENT001","required":false,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"jobType","in":"query","description":"Specifies the job type of the job that requires a user ID and password authorization.

Limits: 1 to 16 characters. The wildcard characters * and ? are not permitted

Example: NT_JOB","required":false,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"source","in":"query","description":"Specifies the source field for a job that requires a user ID and password authorization. This property applies to agent job types which allow CONNECTIONUSER or PROXYUSER C-LANG statements.

Limits: 1 to 64 characters. The wildcard characters * and ? are not permitted

Example: example.domain.com","required":false,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"responses":{"204":{"description":"Agent credentials exist for the specified userid, agent, jobType and source parameters"},"400":{"description":"The command cannot be processed due to a bad request"},"401":{"description":"The userid or password is invalid"},"403":{"description":"Access to the endpoint forbidden by CA 7. Contact your CA 7 security administrator"},"404":{"description":"Agent credentials do not exist for the specified userid, agent, jobType and source parameters"}},"security":[{"basicScheme":[]}]}},"/api/v1/job/instance/list":{"get":{"tags":["Job Instances"],"summary":"Retrieves information about active jobs for DEFAULT_INSTANCE","operationId":"jobQueuestatus_1","parameters":[{"name":"ca7no","in":"query","description":"The CA 7 job number","required":false,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"jobname","in":"query","description":"The CA 7 job name","required":false,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"databasename","in":"query","description":"The CA 7 database name","required":false,"style":"form","explode":true,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"all","in":"query","description":"Fetch all the available properties
If the job number is provided, all the properties will be returned
","required":true,"style":"form","explode":true,"schema":{"type":"boolean","exampleSetFlag":false,"types":["boolean"],"default":false}},{"name":"Authorization","in":"header","description":"The CA 7 user and password
Basic Authentication","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}},{"name":"Content-Type","in":"header","description":"One of application/json or application/xml","required":false,"style":"simple","explode":false,"schema":{"type":"string","exampleSetFlag":false,"types":["string"]}}],"responses":{"200":{"description":"Successfully retrieved information about jobs in the active workload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ca7QueueJobListResponse","exampleSetFlag":false},"exampleSetFlag":false}}},"400":{"description":"The command cannot be processed due to a failure"},"401":{"description":"The userid or password is invalid"},"403":{"description":"You are not authorized to use this function"},"404":{"description":"No information found for the specified criteria"},"503":{"description":"Unable to connect to Datacom database; the credentials may be incorrect or the Datacom Server may not be available"}},"security":[{"basicScheme":[]}]}},"/api/v1/{ca7Id}/commands/submit":{"post":{"tags":["Commands"],"summary":"Issue SUBMIT command for CA 7 instance specified in path","description":"The SUBMIT top line command modifies and expedites the process of job submission for jobs already residing in the queues.
This processing can be accomplished in two ways:

All outstanding input requirements for the specified jobs can be posted as satisfied.
Optionally, by specifying EXPRESS=YES, a priority can be set for a specific job.
This priority ensures that the job is submitted ahead of other jobs also ready for submission.
Note:
EXPRESS=YES has no effect when workload balancing is being used.

Add a specific submit time requirement where none was previously defined.
Remove a defined submit time requirement.
Change an existing submit time requirement to either earlier or later than defined.

Is executing
Is in ABEND status in the request queue
Has already executed and purged from the request queue

If VRM corequisite propagation is enabled and the resource name matches the propagation prefix,
the command is forwarded to the CA 7 instances that are specified in the initialization file options unless INTERNAL=YES is specified.
Command propagation is honored even if the resource is already active.

If VRM corequisite propagation is enabled and the resource name matches the propagation prefix, the command is forwarded to the CA 7 instances that are specified in the initialization file options unless INTERNAL=YES is specified.
Command propagation is honored even if the resource is already active.

Limits:

Example:

Limits:

Example:

Limits:

Example:

Limits:

Example:

Is executing
Is in ABEND status in the request queue
Has already executed and purged from the request queue

Limits:

Example:

Limits:

Example:

Limits:

Example:

Limits:

Example:

Limits:

Example:

Limits:

Default:

Limits:

Windows
Linux
Unix
etc.

Default:

Note:

Limits:

Default:

Add a specific submit time requirement where none was previously defined.
Remove a defined submit time requirement.
Change an existing submit time requirement to either earlier or later than defined.

For CPU jobs, the CANCEL command only removes the job from the queues.
Cancelation of a job in the active queue or ready queue (if it has been submitted)
does not cause termination of the job's execution.
CPU jobs that can be executing have to be canceled from the operating system separately.
Execution must be terminated from an OS system console.
For XPJOB jobs, the CANCEL command removes the job from the queues.
If the XPDEF initialization option XPKILL is set to YES,
and the XPJOB job has been submitted to the target node but is still in the ready queue or the active queue,
a cancel request is created and sent to the target node.
Some remote CA Scheduling Agents support the cancel request, and the request cancels or 'kills' the process execution.
It is not the responsibility of CA WA CA 7 Edition to verify that the target platform supports the kill facility.
If the cancel request was not transmitted, an error message appears in the browse and log data.
For agent definition jobs (AGJOBs), the CANCEL command sends a request to the agent and removes the job from the queues.
If the agent is not active at the time of the CANCEL request, the message is queued and sent when the agent becomes active.

All outstanding input requirements for the specified jobs can be posted as satisfied.
Optionally, by specifying EXPRESS=YES, a priority can be set for a specific job.
This priority ensures that the job is submitted ahead of other jobs also ready for submission.
Note:
EXPRESS=YES has no effect when workload balancing is being used.

If VRM corequisite propagation is enabled and the resource name matches the propagation prefix, the command is forwarded to the CA 7 instances that are specified in the initialization file options unless INTERNAL=YES is specified.
Command propagation is honored even if the resource is already active.

If VRM corequisite propagation is enabled and the resource name matches the propagation prefix,
the command is forwarded to the CA 7 instances that are specified in the initialization file options unless INTERNAL=YES is specified.
Command propagation is honored even if the resource is already active.

Note:

Limits:

Windows
Linux
Unix
etc.

Default:

Limits:

Default:

Limits:

Default:

Limits:

Default:

Limits:

Default:

Note:

Limits:

Windows
Linux
Unix
etc.

Default:

Limits:

Default:

Limits:

Default:

For CPU jobs, the CANCEL command only removes the job from the queues.
Cancelation of a job in the active queue or ready queue (if it has been submitted)
does not cause termination of the job's execution.
CPU jobs that can be executing have to be canceled from the operating system separately.
Execution must be terminated from an OS system console.
For XPJOB jobs, the CANCEL command removes the job from the queues.
If the XPDEF initialization option XPKILL is set to YES,
and the XPJOB job has been submitted to the target node but is still in the ready queue or the active queue,
a cancel request is created and sent to the target node.
Some remote CA Scheduling Agents support the cancel request, and the request cancels or 'kills' the process execution.
It is not the responsibility of CA WA CA 7 Edition to verify that the target platform supports the kill facility.
If the cancel request was not transmitted, an error message appears in the browse and log data.
For agent definition jobs (AGJOBs), the CANCEL command sends a request to the agent and removes the job from the queues.
If the agent is not active at the time of the CANCEL request, the message is queued and sent when the agent becomes active.

Limits:

Example:

Limits:

Example:

Limits:

Example:

Limits:

Example:

Limits:

Example:

Note:

Limits:

Windows
Linux
Unix
etc.

Default:

Limits:

Windows
Linux
Unix
etc.

Default:

Note:

Limits:

Default:

Limits:

Product Version
The CA 7 Rest API version
CA 7 Supported Version
The CA 7 supported version
Build Number
The build number
Build Time
The date and time when the build was done, GMT

Limits:

(Optional)

Default:

Limits:

(Optional)

Default:

Limits:

Note:

(Required if triggered-job-queue-time is omitted)

Limits:

Note:

(Required if triggered-job-due-out-time is omitted)

Limits:

(Optional)

Default:

Limits:

(Optional)

Default:

Limits:

Note:

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Note:

Limits:

(Optional)

Limits:

(Optional)

If used, the value must be one of the following values:

B
Roll the schedule back to the previous available processing day in the Base Calendar.
F
Roll forward the schedule to the next available processing day.
N
Do not roll. Schedule day must stand.
D
Do not roll and do not schedule.

Default:

(Optional)

Limits:

Usage:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Default:

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

Note:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

Limits:

(Optional)

Default:

Limits:

(Optional)

Limits:

Notes:

The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROC
The only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROC
If a job is restarted in a step after this step-name, the resource does not go through free processing until the job completes
A step flush condition does not post the step-name process

Valid values are

A = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)
F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfully
N = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resource
Y = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)

Limits:

(Optional)

Default:

Limits:

(Optional)

Limits:

Notes:

The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROC
The only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROC
If a job is restarted in a step after this step-name, the resource does not go through free processing until the job completes
A step flush condition does not post the step-name process

Valid values are

A = Specifies the resource count is only decremented when the job abends
F = Specifies the resource count is decremented when the job completes, either successfully or unsuccessfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes, either successfully or unsuccessfully
N = Specifies the resource count is not decremented when the job completes. The PRSCF command can be used to decrement the resource count. A cancel of the job also decrements the resource count
Y = Specifies the resource count is decremented when the job or step ends successfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes successfully (does not abend)

Limits:

(Optional)

Default:

Limits:

(Optional)

Limits:

Notes:

The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROC
The only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROC
If a job is restarted in a step after this step-name, the resource does not go through free processing until the job completes
A step flush condition does not post the step-name process

Valid values are

A = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)
F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfully
N = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resource
Y = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)

Limits:

Exception:

Default:

Limits:

Default:

A
Specifies the job is submitted only if the resource is active (as established by the PRSQA command).
I
Specifies the job is submitted only if the resource is not active.

Limits:

(Optional)

Default:

Limits:

(Optional)

Default:

Valid values are

A = Specifies the job is submitted only if the resource is active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the system
I = Specifies the job is submitted only if the resource is not active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the system

CPU = A CPU job
XPJOB = A cross-platform job
AGENT = An Agent job

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Default:

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Valid when:

Default:

Limits:

(Optional)

Valid when:

Default:

Limits:

(Optional)

Valid when:

Limits:

(Optional)

Valid when:

Default:

Y = The job is flagged for load processing. The reload flag is automatically reset to N once the load completes successfully
N = The job is not flagged for load processing unless it is the first time it has run in CA 7
X = The job is only flagged for load processing when the LOAD command is used and is never automatically changed even if the LOAD command is used

(Optional)

Default:

Y = The job will be executed
N = The job does not run but shows a normal completion as if it did run. JCL is not required for non-executable jobs

(Optional)

Valid when:

Default:

Y = Retain the JCL in the trailer queue after a successful run.
N = Do not retain the JCL in the trailer queue after a successful run

(Optional)

Default:

Y = The job will be held
N = The job will not be held

(Optional)

Valid when:

Default:

Y = The job needs manual JCL overrides before it can be submitted
N = The job does not need manual JCL overrides before it can be submitted

(Optional)

Default:

Y = The JCL is retrieved from the JCL Override library for the next run
N = The JCL is not retrieved from the JCL Override library for the next run

(Optional)

Default:

Y = The job requires any pre-submission manual verification
N = The job does not require any pre-submission manual verification

(Optional)

Valid when:

Default:

Y = The job is a maintenance job
N = The job is not a maintenance job

(Optional)

Default:

0 = No lead time is considered when satisfying this job's requirements
99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each predecessor job must complete typically while this job is in the request queue
nn = Since the last run of this job, specifies that each predecessor job must have run within the last nn hours. Values for nn can be from 1 to 98

(Optional)

Valid when:

Default:

0 = No lead time is considered when satisfying this job's requirements
99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each data set requirement must be satisfied typically while this job is in the request queue
nn = Since the last run of this job, specifies that each data set requirement must be satisfied within the last nn hours. Values for nn can be from 1 to 98

(Optional)

Limits:

(Optional)

Valid when:

Default:

Limits:

(Optional)

Valid when:

Default:

Y = Inserts the step with the WA Restart Option processing code of P
N = Does not insert the RMS step

(Optional)

Valid when:

Note:

Default:

Limits:

(Optional)

Valid when:

Default:

EQ = Equal to
LT = Less than
GT = Greater than
GE = Greater than or equal to
LE = Less than or equal to
NE = Not equal to
#S = Make step condition code tests based on #SCC statements in the JCL
IG = Make no evaluation of the job. CA 7 always assumes the job completes successfully, regardless of condition codes, abend codes, or runtime JCL errors. When this is used, the insert-ca11-rms property should be N
0 = No condition test will be made

NOTE:

(Optional)

Default:

Limits:

(Optional)

Default:

Y = The pre-execution requirements will be listed
N = The pre-execution requirements will not be listed

(Optional)

Default:

Y = Prompt messages will be issued when the job is late
N = Prompt messages will not be issued when the job is late

(Optional)

Default:

Y = Messages will be issued if requirements are not used
N = Messages will not be issued if requirements are not used

(Optional)

Valid when:

Default:

Y = Messages will be issued if data sets used are not found in the CA 7 database
N = Messages will not be issued if data sets used are not found in the CA 7 database

(Optional)

Valid when:

Default:

Limits:

(Optional)

Default:

Limits:

(Optional)

Valid when:

Default:

Limits:

(Optional)

Default:

Limits:

(Optional)

Default:

Limits:

(Optional)

Valid when:

Default:

Limits:

(Optional)

Limits:

(Optional)

Valid when:

Default:

Limits:

(Optional)

Valid when:

Default:

Limits:

(Required when job-type is XPJOB)

Valid when:

Limits:

(Required when job-type is XPJOB)

Valid when:

Limits:

(Optional)

Valid when:

Limits:

(Optional)

Valid when:

Limits:

Note:

(Optional)

Valid when:

Default:

Limits:

(Optional)

Valid when:

Default:

Y = Executes an \"SU -\" causing the environment setup to include execution of the \".PROFILE\" for the target user
N = Executes an \"SU\" command without the profile option

(Optional)

Valid when:

Default:

Y = Issue WTOs as the job enters into the submission process. Retain up to 256 characters of the data that is sent for inclusion in a log record
N = Do not activate tracing for this job

(Required when job-type is AGENT)

Valid when:

Default:

UNIX_JOB - Generic UNIX
NT_JOB - Microsoft Windows
FILE_TRIGGER - File Trigger
FTP_JOB - FTP
SCP_JOB - Secure Copy
SFTP_JOB - Secure File Transfer
BDC_JOB - SAP Batch Input Session
BWIP_JOB - SAP Business Warehouse InfoPackage
BWPC_JOB - SAP Business Warehouse Process Chain
SAP_JOB - SAP Generic
SAPA_JOB - SAP Archive
SAPE_JOB - SAP Event Monitor
SAPM_JOB - SAP Process Monitor
PS_JOB - PeopleSoft
OA_JOB - Oracle Request
OAC_JOB - Oracle Copy
CPU_MON - CPU Monitor
DISK_MON - Disk Monitor
IP_MON - IP Monitor
PROCESS_MON - Process Monitor
TEXT_MON - Text File Monitor
EVENTLOG_MON - Event Log Monitor
SERVICE_MON - Service Monitor
SQL_JOB - Database SQL
DBSP_JOB - Database Stored Procedure
DB_MON - Database Monitor
DB_TRIG - Database Trigger
AS400_JOB - AS400/OS400
JMSP_JOB - J2EE JMS Publish
JMSS_JOB - J2EE JMS Subscribe
EJBE_JOB - J2EE Entity Bean
HTTP_JOB - J2EE HTTP/Servlet
POJO_JOB - J2EE POJO
RMI_JOB - J2EE RMI
EJB_JOB - J2EE Session Bean
JMXB_JOB - JMX-Mbean Attribute Get
JMXA_JOB - JMX-Mbean Attribute Set
JMXO_JOB - JMX-Mbean Operation
JMXS_JOB - JMX-Mbean Subscribe
JMXN_JOB - JMX-Mbean Create Instance
JMXR_JOB - JMX-Mbean Remove Instance
SNPG_JOB - SNMP Get Attribute
SNPS_JOB - SNMP Set Attribute
SNPC_JOB - SNMP Subscribe
SNPE_JOB - SNMP TrapSend
WEB_SERV - Web Services
WOL_JOB - Wake-On-LAN
PROXY_JOB - Remote Execution
NONSTOP_JOB - HP Integrity NonStop

(Required when job-type is AGENT)

Valid when:

Limits:

(Optional)

Valid when:

Limits:

(Required if dataset-number is omitted)

Note:

Limits:

(Required if dataset-name is omitted)

Limits:

(Optional)

Note:

Default:

Limits:

(Optional)

Default:

Limits:

Note:

(Required if triggered-job-queue-time is omitted)

Limits:

Note:

(Required if triggered-job-due-out-time is omitted)

Limits:

(Optional)

Default:

Limits:

(Optional)

Default:

Limits:

Note:

(Required if dataset-number is omitted)

Limits:

Note:

(Required if dataset-name is omitted)

Limits:

(Optional)

NORM = Internal means both the creating-job and using-jobs for this data set are known to CA 7.
External means the creating-job, using-jobs, or both for this data set are not known to CA 7.
PERM = Specifies this data set is always available for input

Default:

Note:

(Optional)

Y = The data set is a generation data group
N = The data set is not a generation data group

Default:

Note:

(Optional)

Y = SMF inserts the values when the data set is next used
N = SMF does not insert the values when the data set is next used

Default:

Note:

(Optional)

Y = The action takes place when the SMF data set creation record is received (when the data set is closed)
N = Causes triggering or posting action to take place at the job termination

Default:

(Optional)

TAPE
DASD

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Required if dataset-number is omitted)

Limits:

Note:

(Required if dataset-name is omitted)

Limits:

Note:

Limits:

*
Specifies all jobs.
job
Specifies a fully qualified job name
Limits:: 1 to 8 alphanumeric characters
job*
Specifies multiple jobs that a generic job name specifies.
Limits:: 1 to 7 alphanumeric characters that are terminated with an asterisk.

Default:

Limits:

Note:

This service determines values of status in much the same way as values are determined
for the JOB STATUS column of the LQ command.
The ‘LATE’ value is an exception.
Unlike the LQ command, this service will only evaluate and report late conditions when
none of the other conditions are detected.
For example, the LQ command output may report a status value of ‘LATE’
even if the job is actually waiting for virtual resources.
In such a case, this service will report ‘W-RSRC’.

ARFJ
Indicates an ARF recovery job.
AUTO
Indicates a triggered job.
DEMD
Indicates a demanded job.
EXTL
Indicates a job that is submitted external to CA WA CA 7 Edition
LOAD
Indicates a job to be loaded (brought in by the LOAD command).
PS
Indicates a job that the Personal Scheduling System submitted.
RPET
Indicates a repeated job.
RUN/br> Indicates a job that is brought in by the RUN command.
SSCN
Indicates a job that is brought in by schedule scan.
XDEM
Indicates a job brought in by the DEMAND command from an XPS client.
XPS
Indicates a job brought in from an XPS client using the RUN command with the REF option.
XRUN
Indicates a job brought in from an XPS client using the RUN command.

Note:

ARFJ
Indicates an ARF recovery job.
AUTO
Indicates a triggered job.
DEMD
Indicates a demanded job.
EXTL
Indicates a job that is submitted external to CA WA CA 7 Edition
LOAD
Indicates a job to be loaded (brought in by the LOAD command).
PS
Indicates a job that the Personal Scheduling System submitted.
RPET
Indicates a repeated job.
RUN/br> Indicates a job that is brought in by the RUN command.
SSCN
Indicates a job that is brought in by schedule scan.
XDEM
Indicates a job brought in by the DEMAND command from an XPS client.
XPS
Indicates a job brought in from an XPS client using the RUN command with the REF option.
XRUN
Indicates a job brought in from an XPS client using the RUN command.

*
Specifies all jobs.
job
Specifies a fully qualified job name
Limits:: 1 to 8 alphanumeric characters
job*
Specifies multiple jobs that a generic job name specifies.
Limits:: 1 to 7 alphanumeric characters that are terminated with an asterisk.

*
Specifies all resources.
resource
Specifies a fully qualified resource name.
Limits::1 to 44 alphanumeric characters
resource*
Specifies multiple resources that a generic resource name specifies.
Limits:: 1 to 43 alphanumeric characters that are terminated with an asterisk

Limits:

(Optional)

Default:

Limits:

(Optional)

Default:

Limits:

Note:

(Required if triggered-job-queue-time is omitted)

Limits:

Note:

(Required if triggered-job-due-out-time is omitted)

Limits:

(Optional)

Default:

Limits:

(Optional)

Default:

Limits:

Note:

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Note:

Limits:

(Optional)

Limits:

(Optional)

If used, the value must be one of the following values:

B
Roll the schedule back to the previous available processing day in the Base Calendar.
F
Roll forward the schedule to the next available processing day.
N
Do not roll. Schedule day must stand.
D
Do not roll and do not schedule.

Default:

(Optional)

Limits:

Usage:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Default:

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

Note:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

Limits:

(Optional)

Default:

Limits:

(Optional)

Default:

Limits:

(Optional)

Limits:

Notes:

The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROC
The only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROC
If a job is restarted in a step after this step-name, the resource does not go through free processing until the job completes
A step flush condition does not post the step-name process

Valid values are

A = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)
F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfully
N = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resource
Y = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)

Limits:

(Optional)

Default:

Limits:

(Optional)

Limits:

Notes:

The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROC
The only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROC
If a job is restarted in a step after this step-name, the resource does not go through free processing until the job completes
A step flush condition does not post the step-name process

Valid values are

A = Specifies the resource count is only decremented when the job abends
F = Specifies the resource count is decremented when the job completes, either successfully or unsuccessfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes, either successfully or unsuccessfully
N = Specifies the resource count is not decremented when the job completes. The PRSCF command can be used to decrement the resource count. A cancel of the job also decrements the resource count
Y = Specifies the resource count is decremented when the job or step ends successfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes successfully (does not abend)

Limits:

(Optional)

Default:

Limits:

(Optional)

Limits:

Notes:

The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROC
The only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROC
If a job is restarted in a step after this step-name, the resource does not go through free processing until the job completes
A step flush condition does not post the step-name process

Valid values are

A = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)
F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfully
N = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resource
Y = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)

Limits:

Exception:

Default:

Limits:

Default:

A
Specifies the job is submitted only if the resource is active (as established by the PRSQA command).
I
Specifies the job is submitted only if the resource is not active.

Limits:

(Optional)

Default:

Limits:

(Optional)

Default:

Valid values are

A = Specifies the job is submitted only if the resource is active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the system
I = Specifies the job is submitted only if the resource is not active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the system

CPU = A CPU job
XPJOB = A cross-platform job
AGENT = An Agent job

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Default:

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Valid when:

Default:

Limits:

(Optional)

Valid when:

Default:

Limits:

(Optional)

Valid when:

Limits:

(Optional)

Valid when:

Default:

Y = The job is flagged for load processing. The reload flag is automatically reset to N once the load completes successfully
N = The job is not flagged for load processing unless it is the first time it has run in CA 7
X = The job is only flagged for load processing when the LOAD command is used and is never automatically changed even if the LOAD command is used

(Optional)

Default:

Y = The job will be executed
N = The job does not run but shows a normal completion as if it did run. JCL is not required for non-executable jobs

(Optional)

Valid when:

Default:

Y = Retain the JCL in the trailer queue after a successful run.
N = Do not retain the JCL in the trailer queue after a successful run

(Optional)

Default:

Y = The job will be held
N = The job will not be held

(Optional)

Valid when:

Default:

Y = The job needs manual JCL overrides before it can be submitted
N = The job does not need manual JCL overrides before it can be submitted

(Optional)

Default:

Y = The JCL is retrieved from the JCL Override library for the next run
N = The JCL is not retrieved from the JCL Override library for the next run

(Optional)

Default:

Y = The job requires any pre-submission manual verification
N = The job does not require any pre-submission manual verification

(Optional)

Valid when:

Default:

Y = The job is a maintenance job
N = The job is not a maintenance job

(Optional)

Default:

0 = No lead time is considered when satisfying this job's requirements
99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each predecessor job must complete typically while this job is in the request queue
nn = Since the last run of this job, specifies that each predecessor job must have run within the last nn hours. Values for nn can be from 1 to 98

(Optional)

Valid when:

Default:

0 = No lead time is considered when satisfying this job's requirements
99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each data set requirement must be satisfied typically while this job is in the request queue
nn = Since the last run of this job, specifies that each data set requirement must be satisfied within the last nn hours. Values for nn can be from 1 to 98

(Optional)

Limits:

(Optional)

Valid when:

Default:

Limits:

(Optional)

Valid when:

Default:

Y = Inserts the step with the WA Restart Option processing code of P
N = Does not insert the RMS step

(Optional)

Valid when:

Note:

Default:

Limits:

(Optional)

Valid when:

Default:

EQ = Equal to
LT = Less than
GT = Greater than
GE = Greater than or equal to
LE = Less than or equal to
NE = Not equal to
#S = Make step condition code tests based on #SCC statements in the JCL
IG = Make no evaluation of the job. CA 7 always assumes the job completes successfully, regardless of condition codes, abend codes, or runtime JCL errors. When this is used, the insert-ca11-rms property should be N
0 = No condition test will be made

NOTE:

(Optional)

Default:

Limits:

(Optional)

Default:

Y = The pre-execution requirements will be listed
N = The pre-execution requirements will not be listed

(Optional)

Default:

Y = Prompt messages will be issued when the job is late
N = Prompt messages will not be issued when the job is late

(Optional)

Default:

Y = Messages will be issued if requirements are not used
N = Messages will not be issued if requirements are not used

(Optional)

Valid when:

Default:

Y = Messages will be issued if data sets used are not found in the CA 7 database
N = Messages will not be issued if data sets used are not found in the CA 7 database

(Optional)

Valid when:

Default:

Limits:

(Optional)

Default:

Limits:

(Optional)

Valid when:

Default:

Limits:

(Optional)

Default:

Limits:

(Optional)

Default:

Limits:

(Optional)

Valid when:

Default:

Limits:

(Optional)

Limits:

(Optional)

Valid when:

Default:

Limits:

(Optional)

Valid when:

Default:

Limits:

(Required when job-type is XPJOB)

Valid when:

Limits:

(Required when job-type is XPJOB)

Valid when:

Limits:

(Optional)

Valid when:

Limits:

(Optional)

Valid when:

Limits:

Note:

(Optional)

Valid when:

Default:

Limits:

(Optional)

Valid when:

Default:

Y = Executes an \"SU -\" causing the environment setup to include execution of the \".PROFILE\" for the target user
N = Executes an \"SU\" command without the profile option

(Optional)

Valid when:

Default:

Y = Issue WTOs as the job enters into the submission process. Retain up to 256 characters of the data that is sent for inclusion in a log record
N = Do not activate tracing for this job

(Required when job-type is AGENT)

Valid when:

Default:

UNIX_JOB - Generic UNIX
NT_JOB - Microsoft Windows
FILE_TRIGGER - File Trigger
FTP_JOB - FTP
SCP_JOB - Secure Copy
SFTP_JOB - Secure File Transfer
BDC_JOB - SAP Batch Input Session
BWIP_JOB - SAP Business Warehouse InfoPackage
BWPC_JOB - SAP Business Warehouse Process Chain
SAP_JOB - SAP Generic
SAPA_JOB - SAP Archive
SAPE_JOB - SAP Event Monitor
SAPM_JOB - SAP Process Monitor
PS_JOB - PeopleSoft
OA_JOB - Oracle Request
OAC_JOB - Oracle Copy
CPU_MON - CPU Monitor
DISK_MON - Disk Monitor
IP_MON - IP Monitor
PROCESS_MON - Process Monitor
TEXT_MON - Text File Monitor
EVENTLOG_MON - Event Log Monitor
SERVICE_MON - Service Monitor
SQL_JOB - Database SQL
DBSP_JOB - Database Stored Procedure
DB_MON - Database Monitor
DB_TRIG - Database Trigger
AS400_JOB - AS400/OS400
JMSP_JOB - J2EE JMS Publish
JMSS_JOB - J2EE JMS Subscribe
EJBE_JOB - J2EE Entity Bean
HTTP_JOB - J2EE HTTP/Servlet
POJO_JOB - J2EE POJO
RMI_JOB - J2EE RMI
EJB_JOB - J2EE Session Bean
JMXB_JOB - JMX-Mbean Attribute Get
JMXA_JOB - JMX-Mbean Attribute Set
JMXO_JOB - JMX-Mbean Operation
JMXS_JOB - JMX-Mbean Subscribe
JMXN_JOB - JMX-Mbean Create Instance
JMXR_JOB - JMX-Mbean Remove Instance
SNPG_JOB - SNMP Get Attribute
SNPS_JOB - SNMP Set Attribute
SNPC_JOB - SNMP Subscribe
SNPE_JOB - SNMP TrapSend
WEB_SERV - Web Services
WOL_JOB - Wake-On-LAN
PROXY_JOB - Remote Execution
NONSTOP_JOB - HP Integrity NonStop

(Required when job-type is AGENT)

Valid when:

Limits:

(Optional)

Valid when:

Limits:

(Required if dataset-number is omitted)

Note:

Limits:

(Required if dataset-name is omitted)

Limits:

(Optional)

Note:

Default:

Limits:

(Optional)

Default:

Limits:

Note:

(Required if triggered-job-queue-time is omitted)

Limits:

Note:

(Required if triggered-job-due-out-time is omitted)

Limits:

(Optional)

Default:

Limits:

(Optional)

Default:

Limits:

Note:

Limits:

Note:

(Optional)

NORM = Internal means both the creating-job and using-jobs for this data set are known to CA 7.
External means the creating-job, using-jobs, or both for this data set are not known to CA 7.
PERM = Specifies this data set is always available for input

Default:

Note:

(Optional)

Y = The data set is a generation data group
N = The data set is not a generation data group

Default:

Note:

(Optional)

Y = SMF inserts the values when the data set is next used
N = SMF does not insert the values when the data set is next used

Default:

Note:

(Optional)

Y = The action takes place when the SMF data set creation record is received (when the data set is closed)
N = Causes triggering or posting action to take place at the job termination

Default:

(Optional)

TAPE
DASD

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

(Optional)

Limits:

ON
Establishes a manual verification requirement that did not previously exist.

OFF
Indicates that a previously established manual verification requirement is satisfied and can be
removed. A verification requirement no longer appears on the requirements list in the request queue.

Limits:

Format:hhmm

(Optional)

Limits:

yyddd Defines the Julian date to submit the job.

","example":"23285","exampleSetFlag":true,"types":["string"]}},"description":"SUBTM command parameters","exampleSetFlag":false,"types":["object"]},"CommandSUBMITResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the SUBMIT command","example":"SPOA-00 REQUEST COMPLETE.; JOB CA75RSRC HAS BEEN POSTED FOR SUBMISSION (EXPRESS); 000 EXTERNAL INPUTS FORCED; INTERNAL INPUTS FORCED","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 SUBMIT command","example":"SUBMIT,JOB=48,EXPRESS=YES","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api SUBMIT Request Response","exampleSetFlag":false,"types":["object"]},"ErrorSUBMITResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: SUBMIT,JOB=98; SPOA-05 JOB NOT FOUND IN REQ OR RDY QUEUE","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandSUBMIT":{"type":"object","properties":{"ca7#":{"type":"string","description":"Specifies the CA 7 job number of the job whose requirements you want to post as satisfied.Limits:
1 to 4 alphanumeric characters","example":"0123","exampleSetFlag":true,"types":["string"]},"express":{"type":"string","description":"(Optional) Indicates to place the job ahead of all other jobs (those jobs without EXPRESS=YES) for submission.
The value must be coded as shown. Not valid if workload balancing is being used.
Use of EXPRESS=YES does not establish an increased execution priority for a job.
Rather, it ensures that nonexpress jobs are not submitted ahead of a job that is flagged as an express job.","example":"YES","exampleSetFlag":true,"types":["string"]}},"description":"SUBMIT command parameters","exampleSetFlag":false,"types":["object"]},"RunHCommandResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the RUNH command","example":"SPO7-00 JOB CA75SCHD(19MH) ADDED TO THE REQ/Q BY RUNH","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 RUNH command","example":"RUNH,JOB=CA75SCHD","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api RUNH Request Response","exampleSetFlag":false,"types":["object"]},"ErrorRunHResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: SPO7-21 JOB NOT DEFINED AND JCLID/JCLLIB NOT SPECIFIED - NONJOB","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandRunh":{"type":"object","properties":{"job":{"type":"string","description":"Identifies the job to submit.
The value must be a job name.
If the job has not been defined in the database,
this name must also match the member name for the JCL unless the job is defined in the database.
See also JCLID. JOB and JOBL are mutually exclusive.
Limits:
1 to 8 alphanumeric characters","example":"PAYROLL","exampleSetFlag":true,"types":["string"]},"jobl":{"type":"string","description":"Identifies the job to submit.
The value must be a long job name.
If the job has not been defined in the database, use JOB instead.
See also JCLID. JOB and JOBL are mutually exclusive.
Limits:
1 to 64 alphanumeric characters","example":"payrollSW123","exampleSetFlag":true,"types":["string"]},"arfset":{"type":"string","description":"(Optional) Identifies the ARF set name that is used for this run of the job.
If **NONE** is specified, no ARF processing is performed for this run of the job.
Limits:
1 to 8 alphanumeric characters or **NONE**","example":"PAYSYS","exampleSetFlag":true,"types":["string"]},"class":{"type":"string","description":"(Optional) Specifies the workload balancing class for resource checking.
Limits:
1 alphanumeric character","exampleSetFlag":false,"types":["string"]},"dotm":{"type":"string","description":"(Optional) Specifies a due-out time-of-day for the job. If omitted, the current time (when command is processed) plus the lead time is used.
Format: hhmm
Defines the time-of-day where hh is the hours (0 through 24) and mm is minutes (00 through 59).
You can omit leading zeros.
","example":"1450","exampleSetFlag":true,"types":["string"]},"exec":{"type":"string","description":"(Optional) Specifies whether to execute the job (YES/NO).
If NO (N) is used, the job does not run but shows a normal completion as if it did run.
The value that is specified here overrides the value that is coded on the job definition EXEC field.
Default:
The job definition panel EXEC value if job defined to CA WA CA 7 Edition; otherwise YES.","example":"YES|NO","exampleSetFlag":true,"types":["string"]},"jclid":{"type":"string","description":"(Optional) Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a numeric INDEX associated with the wanted JCL data set
(on the JCL statement in the initialization file). If the job is defined in the database,
the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.
This field or the JCLLIB field is required if the job is not defined in the database.
JCLID and JCLLIB are mutually exclusive.
Note:
Attempts to run cross-platform jobs that are not defined to the database fail because they are treated as regular CPU jobs when processed.
Limits:
1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.
Required:
No, unless job is not defined in database","example":"10","exampleSetFlag":true,"types":["string"]},"jcllib":{"type":"string","description":"(Optional) Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a symbolic INDEX associated with the wanted JCL data set
(on the JCL statement in the initialization file).
If the job is defined in the database, the value must be the same as the value on the DB.1 panel
or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.
This field or the JCLID field is required if the job is not defined in the database.
JCLID and JCLLIB are mutually exclusive.
Note:
Attempts to run cross-platform jobs that are not defined to the database fail because they are treated as regular CPU jobs when processed.
Limits:
2 to 16 alphanumeric characters beginning with ampersand (&)
Required:
No, unless job is not defined in database
Note:
A dynamic allocation failure on a JCL data set specified by JCLLIB causes the job to enter the request queue in SKELETON status. ","example":"&SPECIAL","exampleSetFlag":true,"types":["string"]},"late":{"type":"string","description":"(Optional) Specifies whether notification occurs when the job becomes late.
Specify YES (Y) to make the job eligible to be marked LATE.
If NO (N) is used, the job is never marked LATE.
The value that is specified here overrides the value that is coded on the job definition PROMPTS field.","example":"NO|YES","exampleSetFlag":true,"types":["string"]},"leadtm":{"type":"string","description":"(Optional) Specifies the lead (processing) time that is required for the job to run. If omitted, 1 hour is used.
Format: hhmm
Defines the time where hh is hours (0 through 23) and mm is minutes (00 through 59).
You can omit leading zeros.","example":"0100","exampleSetFlag":true,"types":["string"]},"mainid":{"type":"string","description":"(Optional) Specifies the MAINID, as defined in the initialization file CPU statement, to which the job is redirected. The value that is specified here overrides the value that is coded on the job definition MAINID field.\nThe name must be one of the following values:

ALL
Specifies all CPUs are acceptable for executing the job.

SYn
n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.

/SYn
n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

-SYn
n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.
Limits:
Invalid with cross-platform jobs","example":"ALL|SY2|/SY3|-SY2","exampleSetFlag":true,"types":["string"]},"rms":{"type":"string","description":"(Optional) Specifies whether CA WA CA 7 Edition inserts the CA WA Restart Option RMS step.
Specify YES (Y) to insert the step with the CA WA Restart Option processing code of P.
Enter NO (N) to indicate that the RMS step is not inserted.
The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
Limits:
Invalid for cross-platform jobs.
Note: For more information, see [Interface with CA WA Restart Option for z/OS Schedulers](https://docops.ca.com/ca-workload-automation-ca-7-edition/12-0/en/configuring/interfaces/interfaces-with-other-products/interface-with-ca-wa-restart-option-for-z-os-schedulers/) ","example":"NO|YES","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"(Optional) Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.
If used, the value must be a schedule ID number.
Default: 1
Limits:
1 to 3 numeric characters from 1 through 999
Required:
No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)","example":"9","exampleSetFlag":true,"types":["string"]},"time":{"type":"string","description":"(Optional) Establishes a submit time-of-day requirement for the job.
Format: hhmm
Defines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59).
Leading zeros are not required.","example":"1240|+0130","exampleSetFlag":true,"types":["string"]},"type":{"type":"string","description":"(Optional) Indicates that the job is being scheduled for rerun.
The value must be specified as shown.
TYPE=RES is optional.
If used, a restart requirement is placed on the job, and the job has to be manually restarted.","example":"CLOCK|END|RES|START","exampleSetFlag":true,"types":["string"]}},"description":"RUNH command parameters","exampleSetFlag":false,"types":["object"]},"RunCommandResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the RUN command","example":"SPO7-00 JOB CA75SCHD(19MF) ADDED TO THE REQ/Q BY RUN","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 RUN command","example":"RUN,JOB=CA75SCHD","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api RUN Request Response","exampleSetFlag":false,"types":["object"]},"ErrorRunResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: SPO7-21 JOB NOT DEFINED AND JCLID/JCLLIB NOT SPECIFIED - NONJOB","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandRun":{"type":"object","properties":{"job":{"type":"string","description":"Identifies the job to submit.
The value must be a job name.
If the job has not been defined in the database,
this name must also match the member name for the JCL unless the job is defined in the database.
See also JCLID. JOB and JOBL are mutually exclusive.
Limits:
1 to 8 alphanumeric characters","example":"PAYROLL","exampleSetFlag":true,"types":["string"]},"jobl":{"type":"string","description":"Identifies the job to submit.
The value must be a long job name.
If the job has not been defined in the database, use JOB instead.
See also JCLID. JOB and JOBL are mutually exclusive.
Limits:
1 to 64 alphanumeric characters","example":"payrollSW123","exampleSetFlag":true,"types":["string"]},"arfset":{"type":"string","description":"(Optional) Identifies the ARF set name that is used for this run of the job.
If **NONE** is specified, no ARF processing is performed for this run of the job.
Limits:
1 to 8 alphanumeric characters or **NONE**","example":"PAYSYS","exampleSetFlag":true,"types":["string"]},"class":{"type":"string","description":"(Optional) Specifies the workload balancing class for resource checking.
Limits:
1 alphanumeric character","example":"A","exampleSetFlag":true,"types":["string"]},"dotm":{"type":"string","description":"(Optional) Specifies a due-out time-of-day for the job. If omitted, the current time (when command is processed) plus the lead time is used.
Format: hhmm
Defines the time-of-day where hh is the hours (0 through 24) and mm is minutes (00 through 59).
You can omit leading zeros.
","example":"1450","exampleSetFlag":true,"types":["string"]},"exec":{"type":"string","description":"(Optional) Specifies whether to execute the job (YES/NO).
If NO (N) is used, the job does not run but shows a normal completion as if it did run.
The value that is specified here overrides the value that is coded on the job definition EXEC field.
Default:
The job definition panel EXEC value if job defined to CA WA CA 7 Edition; otherwise YES.","example":"YES|NO","exampleSetFlag":true,"types":["string"]},"jclid":{"type":"string","description":"(Optional) Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a numeric INDEX associated with the wanted JCL data set
(on the JCL statement in the initialization file). If the job is defined in the database,
the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.
This field or the JCLLIB field is required if the job is not defined in the database.
JCLID and JCLLIB are mutually exclusive.
Note:
Attempts to run cross-platform jobs that are not defined to the database fail because they are treated as regular CPU jobs when processed.
Limits:
1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.
Required:
No, unless job is not defined in database","example":"10","exampleSetFlag":true,"types":["string"]},"jcllib":{"type":"string","description":"(Optional) Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a symbolic INDEX associated with the wanted JCL data set
(on the JCL statement in the initialization file).
If the job is defined in the database, the value must be the same as the value on the DB.1 panel
or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.
This field or the JCLID field is required if the job is not defined in the database.
JCLID and JCLLIB are mutually exclusive.
Note:
Attempts to run cross-platform jobs that are not defined to the database fail because they are treated as regular CPU jobs when processed.Limits:
2 to 16 alphanumeric characters beginning with ampersand (&)
Required:
No, unless job is not defined in database
Note:
A dynamic allocation failure on a JCL data set specified by JCLLIB causes the job to enter the request queue in SKELETON status. ","example":"&SPECIAL","exampleSetFlag":true,"types":["string"]},"late":{"type":"string","description":"(Optional) Specifies whether notification occurs when the job becomes late.
Specify YES (Y) to make the job eligible to be marked LATE.
If NO (N) is used, the job is never marked LATE.
The value that is specified here overrides the value that is coded on the job definition PROMPTS field.","example":"NO|YES","exampleSetFlag":true,"types":["string"]},"leadtm":{"type":"string","description":"(Optional) Specifies the lead (processing) time that is required for the job to run. If omitted, 1 hour is used.
Format: hhmm
Defines the time where hh is hours (0 through 23) and mm is minutes (00 through 59).
You can omit leading zeros.","example":"0100","exampleSetFlag":true,"types":["string"]},"mainid":{"type":"string","description":"(Optional) Specifies the MAINID, as defined in the initialization file CPU statement, to which the job is redirected. The value that is specified here overrides the value that is coded on the job definition MAINID field.\nThe name must be one of the following values:

ALL
Specifies all CPUs are acceptable for executing the job.

SYn
n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.

/SYn
n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.

-SYn
n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.
Limits:
Invalid with cross-platform jobs","example":"ALL|SY2|/SY3|-SY2","exampleSetFlag":true,"types":["string"]},"rms":{"type":"string","description":"(Optional) Specifies whether CA WA CA 7 Edition inserts the CA WA Restart Option RMS step.
Specify YES (Y) to insert the step with the CA WA Restart Option processing code of P.
Enter NO (N) to indicate that the RMS step is not inserted.
The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
Limits:
Invalid for cross-platform jobs.
Note: For more information, see [Interface with CA WA Restart Option for z/OS Schedulers](https://docops.ca.com/ca-workload-automation-ca-7-edition/12-0/en/configuring/interfaces/interfaces-with-other-products/interface-with-ca-wa-restart-option-for-z-os-schedulers/) ","example":"NO|YES","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"(Optional) Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.
If used, the value must be a schedule ID number.
Default: 1
Limits:
1 to 3 numeric characters from 1 through 999
Required:
No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)","example":"9","exampleSetFlag":true,"types":["string"]},"time":{"type":"string","description":"(Optional) Establishes a submit time-of-day requirement for the job.
Format: hhmm
Defines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59).
Leading zeros are not required.","example":"1240|+0130","exampleSetFlag":true,"types":["string"]},"type":{"type":"string","description":"(Optional) Indicates that the job is being scheduled for rerun.
The value must be specified as shown.
TYPE=RES is optional.
If used, a restart requirement is placed on the job, and the job has to be manually restarted.","example":"CLOCK|END|RES|START","exampleSetFlag":true,"types":["string"]}},"description":"RUN command parameters","exampleSetFlag":false,"types":["object"]},"RestartCommandResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the RESTART command","example":"SJR2-10 RESTART STEP LIST FOR JOB...JOB1 (19LC) 00000000 SYS 0806 38749; SJR2-00 RESTART FOR JOB JOB1 (19) COMPLETED AT 12:16:59 ON 20.176; SJR0-00 REQUEST COMPLETED AT 12:16:59 ON 20.176","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 RESTART command","example":"RESTART,JOB=19LC,REASON=PER PROD SUPPORT","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api RESTART Request Response","exampleSetFlag":false,"types":["object"]},"ErrorRestartResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: JR0-10 RESTART STEP LIST FOR JOB...; SJR0-12 JOB NOT FOUND ON REQUEST QUEUE; SJR0-36 REASON REQUIRED BUT MISSING; SJR0-00 REQUEST COMPLETED AT 14:09:42 ON 20.177","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandRestart":{"type":"object","properties":{"ca7#":{"type":"string","description":"Indicates the individual job to restart, and the value must be a CA 7 job number.
","example":"0016","exampleSetFlag":true,"types":["string"]},"bypgdg":{"type":"string","description":"(Optional) Indicates whether CA Workload Automation Restart Option for z/OS Schedulers bypasses GDG logic on a restart/rerun.
Value can be NO, YES, VER, or CAT.
Default: CA Workload Automation Restart Option for z/OS Schedulers default value","example":"NO|YES|VER|CAT","exampleSetFlag":true,"types":["string"]},"condcd":{"type":"string","description":"(Optional) Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers condition code
that the CA Workload Automation Restart Option for z/OS Schedulers step sets when the rerun is executed.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use
and CA Workload Automation CA 7® Edition is inserting the RMS step.
See the INSERT-RMS field on the DB.1 panel.
Limits:
1 to 4 numeric characters from 0 to 4095","example":"8","exampleSetFlag":true,"types":["string"]},"forcecomp":{"type":"string","description":"(Optional) Indicates whether to flag the job as a normal completion.
If FORCECOMP=YES, the previous abnormal status of the job is ignored.
Normal job completion processing is performed instead of a restart.
Value can be NO or YES. NO is the default.","example":"NO|YES","exampleSetFlag":true,"types":["string"]},"lcc":{"type":"string","description":"(Optional) Indicates an optional condition code value that replaces the last condition code value for the step that the LSTP references and,
optionally, LPSTP keywords.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
Default: 0
Limits:
1 to 4 numeric characters from 0 to 4095","example":"12","exampleSetFlag":true,"types":["string"]},"lstp":{"type":"string","description":"(Optional) Indicates an optional step name that has its last condition code value reset in the
CA Workload Automation Restart Option for z/OS Schedulers CMT.
Code LSTP and LCC when LPSTP is specified.
LSTP requires that an STPSTRT value is specified and that the LSTP step name occurs in the JCL of the job before the STPSTRT step name.
This option is honored only when CA Workload Automation Restart Option for z/OS Schedulers is in use.
Limits:
1 to 8 alphanumeric characters","example":"JS050","exampleSetFlag":true,"types":["string"]},"lpstp":{"type":"string","description":"(Optional) Indicates an optional step name referencing a procedure that has its last condition code value reset
in the CA Workload Automation Restart Option for z/OS Schedulers CMT.
If LPSTP is used, also code LSTP and LCC.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
Limits:
1 to 8 alphanumeric characters","example":"COPY010","exampleSetFlag":true,"types":["string"]},"procstrt":{"type":"string","description":"(Optional) Indicates an optional step name referencing a procedure where processing is to start.
If PROCESS=R and PROCSTRT are used, also code STPSTRT.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
Limits:
1 to 8 alphanumeric characters","example":"UPDTZ1","exampleSetFlag":true,"types":["string"]},"procend":{"type":"string","description":"(Optional) Indicates an optional step name referencing a procedure where processing is to end.
If PROCESS=R and PROCEND are used, code STPEND.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
Limits:
1 to 8 alphanumeric characters","example":"UPDTZ5","exampleSetFlag":true,"types":["string"]},"process":{"type":"string","description":"(Optional) Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers processing function code character to use in the restart/rerun.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use
and CA WA CA 7 Edition is inserting the RMS step.
See the INSERT-RMS field on the DB.1 panel. Value can be F, P, S, N, O, or R.
Default: P
Limits:
1 alphabetic character","example":"R","exampleSetFlag":true,"types":["string"]},"reason":{"type":"string","description":"(Optional) Specifies a reason for the restart.
If the CA Workload Automation Restart Option for z/OS Schedulers Reason-for-Rerun module is available,
a code of up to four characters can be input and it is expanded.
Any reason input or expanded is copied to the run log.
This field is optional unless CA Workload Automation Restart Option for z/OS Schedulers requires a reason or
REASON=YES was specified in the RESTART statement in the initialization file.
Limits:
1 to 40 alphanumeric characters","example":"PER PROD SUPPORT","exampleSetFlag":true,"types":["string"]},"stpend":{"type":"string","description":"(Optional) Indicates an optional step name or number at which processing is to end.
f not specified, the last step of the job is assumed to be the ending step.
Code STPEND when PROCEND is specified.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
Limits:
1 to 8 alphanumeric characters","example":"STEPA3","exampleSetFlag":true,"types":["string"]},"stpstrt":{"type":"string","description":"(Optional) Indicates an optional step name or number at which processing is to start.
If STPSTRT is not coded, the first step of the job is assigned to be the starting step.
Code STPSTRT when PROCSTRT is specified. This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
It can be one of

stepname
Specifies the step name or number at which processing is to start.

*CMT*
Indicates that the job is to restart with the step values currently on the CMT record.

*RERUN*
Indicates to rerun t the total job. If there are no restartable steps, specify *RERUN*.

*RESUBP*
Indicates that the CMT record of the job is set to production, and then the job is submitted.
","example":"JS0002|*CMT*|*RERUN*|*RESUBP*","exampleSetFlag":true,"types":["string"]},"sup11stp":{"type":"string","description":"(Optional) Indicates whether to suppress the insertion of the CA Workload Automation Restart Option for z/OS Schedulers RMS step.
If the job is resubmitted with SUP11STP=YES, the CA Workload Automation Restart Option for z/OS Schedulers step is not inserted.
Only valid if CA WA CA 7 Edition is inserting the CA Workload Automation Restart Option for z/OS Schedulers step.
See the INSERT-RMS field on the DB.1 panel.
Value can be NO or YES. NO is the default.","example":"NO|YES","exampleSetFlag":true,"types":["string"]},"usage":{"type":"string","description":"(Optional) Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers usage code of the character to use in the restart/rerun.
For the values, see the CA Workload Automation Restart Option for z/OS Schedulers documentation.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use and
CA WA CA 7 Edition is inserting the RMS step.
See the INSERT-RMS field on the DB.1 panel.
Limits:
1 alphanumeric character","example":"R","exampleSetFlag":true,"types":["string"]},"ca11rstp":{"type":"string","description":"(Optional) Indicates that the RESTART command should return the job jobstep.procstep information from the CA Workload Automation Restart Option for z/OS Schedulers (CA-11) database (if available) in a SRJ2-55 message.
YES or Y are the only valid values. If YES or Y is specified, no other keywords are allowed, and no attempt is made to restart the job.","example":"Y","exampleSetFlag":true,"types":["string"]}},"description":"RESTART command parameters","exampleSetFlag":false,"types":["object"]},"CommandRESOLVResponse":{"type":"object","properties":{"ca7messages":{"type":"string","description":"CA 7 Response to the RESOLV command","example":"RESOLV,YEAR=15,SCAL=01,TEST=NO,PRINT=YES; SRC1-00 REQUEST COMPLETED AT 16:14:21 ON 22.033);","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 RESOLV command","example":"RESOLV,YEAR=15,SCAL=01,TEST=NO,PRINT=YES","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api RESOLV Request Response","exampleSetFlag":false,"types":["object"]},"ErrorRESOLVResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: SRC1-134 JOB jobname NOT RESOLVED - CALENDAR SCALyyss NOT AVAILABLE","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandRESOLV":{"type":"object","properties":{"job":{"type":"string","description":"(Optional) Limits selection for resolution to the jobs specified.
If omitted, all job schedules are candidates for resolution.
Value can be a specific job name or a generic name that identifies multiple jobs beginning with the specified characters.
An asterisk (\\*) must be used to delimit the generic job name.
The asterisk can appear in any of the eight positions but must immediately follow the last significant character of the job name requested.
For example:

AB\\* causes all jobs beginning with AB to be selected for resolution.

* causes all job schedules to be selected for resolution.
","example":"AJOB*","exampleSetFlag":true,"types":["string"]},"duplicate-date":{"type":"string","description":"(Optional) Indicates whether to produce specific duplicate day messages (SRC1-137) each time that two or more schedule IDs for the same job schedule a given day.
The default is NO unless the extended resolve message option is set in the user profile by the /PROF command.","example":"NO","exampleSetFlag":true,"types":["string"]},"old-year":{"type":"string","description":"(Optional) Specifies the year that is defined in the schedule member data
(the value that is supplied by YEAR in the previous resolution that updated the schedule member).
Only those candidate schedule members whose year data matches the OLDYR value are selected for resolution.
If used, use one of the following values:
empty
Default:If omitted, only those schedule members that have not previously been resolved or whose schedules have expired are selected.

yy
Indicates a specific year.

\\*
Indicates all years and all schedules.
","example":"22","exampleSetFlag":true,"types":["string"]},"print":{"type":"string","description":"(Optional) Specifies whether to display a month-by-month schedule day calendar after resolution of the defined member is complete.
If used, value must be YES or NO (default).","example":"YES","exampleSetFlag":true,"types":["string"]},"scal":{"type":"string","description":"(Optional) Value is the xx portion of the base calendar name, SCALyyxx.
The SCAL value must also match the base calendar identifier (SCAL)
specified in any SCHID of the schedule definition for the individual jobs.
This value is used during the selection process of resolution to determine which schedule members to resolve.
Required: No (unless JOB is omitted)

\\*
Indicates all SCALs.

xx
Indicates a specific SCAL.
","example":"22","exampleSetFlag":true,"types":["string"]},"test":{"type":"string","description":"(Optional) Indicates whether schedule members are updated because of the resolution process.
YES and NO are the only allowable values.

YES
Normal resolution occurs and all messages are printed, but no updating of the database occurs.
This option can be used at a year-end or whenever a base calendar is changed to see the results of the resolution activity,
without actually changing the schedule mask or affecting the current schedule process.
YES is the default.

NO
Normal resolution occurs and all messages are printed, and updating of the database occurs.
","example":"NO","exampleSetFlag":true,"types":["string"]},"year":{"type":"string","description":"(Optional) Identifies the year of the base calendars against which the schedule is resolved.
The value is the number that is the yy portion of the base calendar name, SCALyyxx./br>When a schedule is successfully updated, the YEAR value becomes part of the schedule data (see OLDYR).
If the YEAR parameter is not specified, the current year is assumed to be the year from the system internal date and time.
Also, if YEAR is not coded on the RESOLV, a determination is made to see whether the RESOLV is made
within the period January 1 through June 30 as determined from system date and time.
If so, the schedule is resolved against January through December of the current year.
If a RESOLV is done within the period July 1 through December 31, the schedule is resolved against
July 1 through December 31 of the current year and January 1 through June 30 of the next year.
This behavior requires the existence of base calendars for calendar years involved.
If a required base calendar is not available, an error message is issued.
The schedule member is unresolved, unless a perpetual calendar is defined for this SCALyyXX.
In that case, the calendar is generated from the PCALYYXX member in the perpetual calendar data set.
nYEAR is optional.
If YEAR is specified, the resolution is made against January through December of the year specified.
Default: Current year
Limits: 2 numeric characters","example":"20","exampleSetFlag":true,"types":["string"]}},"description":"RESOLV command parameters","exampleSetFlag":false,"types":["object"]},"CommandREQUEUEResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the REQUEUE command","example":"REQUEUE,JOB=48; SPOB-00 JOB=CA75RSRC(0048) SET FOR RESTART.; REQUEST COMPLETED AT 12:51:16 ON 20.259.","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 REQUEUE command","example":"REQUEUE,JOB=48","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api REQUEUE Request Response","exampleSetFlag":false,"types":["object"]},"ErrorREQUEUEResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: REQUEUE,JOB=50; SPOB-05 JOB MEETING SELECTION CRITERIA NOT FOUND.","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandREQUEUE":{"type":"object","properties":{"agent":{"type":"string","description":"(Optional) Indicates the agent name or mask that an agent name must match for an agent job
before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.
AGENT cannot be used with CPU, MAINID, or NODE.
For any agent job that is requeued, a cancel request is sent to the agent running the job.
The status of the agent or the computer on which the agent is running determines whether the request is honored.
Limits:
1 to 16 alphanumeric charactersDefault:
* (all agent names)","example":"UXAGENT","exampleSetFlag":true,"types":["string"]},"cpu":{"type":"string","description":"(Optional) Used with JOB to specify the CPU ID of active queue jobs that are to be requeued.
The value identifies the CPU and corresponds to the CPU field displayed on the LQ command (the SMF identifier).
CPU cannot be used with MAINID, NODE, or AGENT.
The CPU parameter is ignored if used with a JOB parameter that references a specific job name or job number, but not if a job mask is specified.
Limits:
1 to 4 numeric characters","example":"34","exampleSetFlag":true,"types":["string"]},"force":{"type":"string","description":"(Optional) Resumes job completion for stranded jobs.
When a job finishes executing, it must move to the request queue so that CA WA CA 7 Edition
can process the database and queue updates that are required for job completion.
But, if a job cannot be moved because of an I/O error or an out-of-space condition on the request queue,
the job may be stranded in the ready or active queue, unable to complete
Once the request queue error is corrected, you can use REQUEUE with FORCE=CMP to resume job completion for these jobs.
Limits:
CMP is the only value","example":"CMP","exampleSetFlag":true,"types":["string"]},"ca7#":{"type":"string","description":"(Optional) Indicates the job number
must match before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.
If JOB is used alone, both the active and ready queues are searched for the specified job number.
If JOB is used with Q, the search is restricted to the indicated queue. jobname,jobnumber and longjobname are mutually exclusive
Default:
* (all jobs)Limits:
1 to 8 alphanumeric characters","example":"29","exampleSetFlag":true,"types":["string"]},"jobname":{"type":"string","description":"(Optional) Indicates the job name, or mask that a job name
must match before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.
If JOB is used alone, both the active and ready queues are searched for the specified job.
If JOB is used with Q, the search is restricted to the indicated queue. jobname,jobnumber and longjobname are mutually exclusive.
Default:
* (all jobs)Limits:
1 to 8 alphanumeric characters","example":"PAYROLL","exampleSetFlag":true,"types":["string"]},"longjobname":{"type":"string","description":"(Optional) Indicates the long job name or mask that a long job name must match before
it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.
If JOBL is used alone, both the active and ready queues are searched for the specified long job name.
If JOBL is used with Q, the search is restricted to the indicated queue.jobname,jobnumber and longjobname are mutually exclusive
Limits:
1 to 64 alphanumeric characters","example":"ALONGJOBNAME","exampleSetFlag":true,"types":["string"]},"mainid":{"type":"string","description":"(Optional) Used with JOB to indicate that only those jobs in the ready queue with this MAINID are to be requeued.
Value must be specified as a single MAINID name.
MAINID cannot be used with CPU, NODE, or AGENT.
The MAINID parameter is ignored if used with a JOB parameter that references a specific job name or job number, but not if a job mask is specifie..
The name must be one of the following values:

ALL Indicates that all MAINIDs are considered.

SYn Where n indicates a CPU assigned number as defined in the initialization file CPU statement.
The value of n can range from 1 to 7.
/SYn
Where n indicates a CPU assigned number. The / indicates \"not this MAINID.\"
The value of n can range from 1 to 7.
Limits:
1 to 4 alphanumeric characters","example":"ALL|SY2|/SY3","exampleSetFlag":true,"types":["string"]},"node":{"type":"string","description":"(Optional) Indicates the node name or mask that a node name must match for an XPJOB job,
before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.
NODE cannot be used with CPU, MAINID, or AGENT.
For any XPJOB that is requeued, a cancel request is sent to the node where the job is running
(assuming the initialization file XPDEF statement parameter XPKILL=NO is not set).
The status of the node or the computer that the node points to, determines whether the request is honored.
Limits:
1 to 8 alphanumeric characters","example":"NODEXP","exampleSetFlag":true,"types":["string"]},"q":{"type":"string","description":"(Optional) Used with JOB to indicate in which queue the job search is to occur.
ACT
The active queue.RDY
The ready queue
","example":"RDY","exampleSetFlag":true,"types":["string"]},"type":{"type":"string","description":"(Optional) Flags the job after it returns to the request queue with a status of JCLERR instead of REQUE.
If not coded, the status reflects REQUE.
","example":".....","exampleSetFlag":true,"types":["string"]}},"description":"REQUEUE command parameters","exampleSetFlag":false,"types":["object"]},"ReleaseCommandResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the RELEASE command","example":"SPO1-00 REQUEST COMPLETE; CA75LG11 19LU REQ RELEASED","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 RELEASE command","example":"RELEASE,JOB=19LU","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api RELEASE Request Response","exampleSetFlag":false,"types":["object"]},"ErrorReleaseResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: SPO1-06 JOB/STATION NOT FOUND","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandRelease":{"type":"object","properties":{"ca7#":{"type":"string","description":"Indicates the individual job to release, and the value must be a CA 7 job number.
Omit jobnumber when Q is specified.
","example":"0016","exampleSetFlag":true,"types":["string"]},"q":{"type":"string","description":"Indicates to release the contents of an entire queue. Omit Q when JOB or JOBL is specified.Required:
Yes, unless JOB or JOBL is used.
REQ
Release the contents of the request queue.RDY
Release the contents of the ready queue..
","example":"RDQ","exampleSetFlag":true,"types":["string"]}},"description":"RELEASE command parameters","exampleSetFlag":false,"types":["object"]},"CommandPRSQDResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the PRSQD command","example":"SPOR-37 PRSQD SUCCESSFUL;PRSQD - CO-REQ RES : CICSREG8 FREED","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 PRSQD command","example":"PRSQD,RSRC=CICSREG8","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api PRSQD Request Response","exampleSetFlag":false,"types":["object"]},"ErrorPRSQDResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"PRSQD,RSRC=A234567890B234567890C234567890D234567890E234567890; SPO4-01 PRSQD UNSUCCESSFUL; RSRC -- INVALID OR MISSING","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandPRSQD":{"type":"object","properties":{"rsrc":{"type":"string","description":"Specifies a fully qualified corequisite resource name.
Limits:
1 to 44 alphanumeric characters","example":"CICSREG8","exampleSetFlag":true,"types":["string"]},"internal":{"type":"string","description":"(Optional) If YES or Y is specified, the command is not forwarded to other CA 7 instances
even if VRM Corequisite Propagation is enabled and the resource name matches the selection criteria.
Default: NO","example":"YES","exampleSetFlag":true,"types":["string"]}},"description":"PRSQD command parameters","exampleSetFlag":false,"types":["object"]},"CommandPRSQAResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the PRSQA command","example":"SPOR-39 PRSQA SUCCESSFUL;CO-REQUISITE RESOURCE: DOGGER; ACTIVATED.","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 PRSQA command","example":"PRSQA,RSRC=DOGGER","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api PRSQA Request Response","exampleSetFlag":false,"types":["object"]},"ErrorPRSQAResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"PRSQA,RSRC=A234567890B234567890C234567890D234567890E234567890; SPO4-01 PRSQA UNSUCCESSFUL; RSRC -- INVALID OR MISSING","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandPRSQA":{"type":"object","properties":{"rsrc":{"type":"string","description":"Specifies a fully qualified corequisite resource name.
Limits:
1 to 44 alphanumeric characters","example":"CICSREG8","exampleSetFlag":true,"types":["string"]},"internal":{"type":"string","description":"(Optional) If YES or Y is specified, the command is not forwarded to other CA 7 instances
even if VRM Corequisite Propagation is enabled and the resource name matches the selection criteria.
Default: NO","example":"YES","exampleSetFlag":true,"types":["string"]}},"description":"PRSQA command parameters","exampleSetFlag":false,"types":["object"]},"CommandPRSCFResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the PRSCF command","example":"SPOR-35 PRSCF SUCCESSFUL; RESOURCE : CA75RSRC; FREED FOR JOB - CA75RSRC","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 PRSCF command","example":"PRSCF,JOB=CA75RSRC,RSRC=CA75RSRC","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api PRSCF Request Response","exampleSetFlag":false,"types":["object"]},"ErrorPRSCFResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: PRSCF,JOB=44,RSRC=RE3SOURCE; SPOR-32 PRSCF UNSUCCESSFUL; RESOURCE : RE3SOURCE; NOT USED BY JOB 0044","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandPRSCF":{"type":"object","properties":{"job":{"type":"string","description":" Specifies the CA Workload Automation CA 7 Edition job name or number to which the resource is attached.

jobnumber
Indicates a specific CA 7 job number.
Limits:
1 to 4 numeric characters
","example":"PAYROLL","exampleSetFlag":true,"types":["string"]},"rsrc":{"type":"string","description":"Specifies the fully qualified resource name to free.
You can optionally specify * to indicate to free all resources that are connected to the job.
Limits:
1 to 44 alphanumeric characters","example":"RESOURCE.TYPE2.EXEC","exampleSetFlag":true,"types":["string"]},"force":{"type":"string","description":"(Optional) FORCE=YES indicates that CA WA CA 7 Edition is not to evaluate
the availability of the named resources for this run of the job only.
This run of the job does not use the named resources.
This keyword can be used on an exception basis to let a job in a W-RSRC status bypass VRM checking for one or more resources defined for it on the RM.1 panel.","example":"YES","exampleSetFlag":true,"types":["string"]}},"description":"PRSCF command parameters","exampleSetFlag":false,"types":["object"]},"CommandPOSTResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the POST command","example":" SPO4-00 POST SUCCESSFUL FOR JOB=CA7JOB1(0206)","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 POST command","example":"POST,JOB=44,USR=ABC","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api POST Request Response","exampleSetFlag":false,"types":["object"]},"ErrorPOSTResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: POST,JOB=44,USR=ABC; SPO4-05 POST UNSUCCESSFUL FOR JOB=CA75LG31(0044); USR=ABC; REQUIREMENT NOT FOUND or POST,JOB=88,USR=ABC; SPO4-04 POST UNSUCCESSFUL; JOB 0088 NOT FOUND IN REQ/Q","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandPOST":{"type":"object","properties":{"ca7#":{"type":"string","description":"Indicates the job number in up to four digits, for which requirements are posted.","example":"29","exampleSetFlag":true,"types":["string"]},"usr":{"type":"string","description":"(Optional) Identifies a user-defined description of a requirement to post as satisfied.
Mutually exclusive with DEPJOB and DSN.
When used, must match the text that is used to define the requirement on the DB.6 panel or with the ADDRQ command.
Limits:
1 to 36 alphanumeric characters","example":"USER WILL CALL TO RELEASE","exampleSetFlag":true,"types":["string"]},"depjob":{"type":"string","description":"(Optional) Identifies a predecessor job dependency requirement to post as satisfied.
Value must be a specific job name.
Mutually exclusive with DSN and USR.
In normal situations, CA WA CA 7 Edition automatically posts this type of requirement when the predecessor job completes its execution successfully.
A manual posting is only necessary if a job defined as a requirement was not to be run,
or ran unsuccessfully and a successor job is to be run.The DEPJOB must be posted if it is not currently defined to CA WA CA 7 Edition
(an external job).
Limits:
1 to 8 alphanumeric characters","example":"PAYJOB","exampleSetFlag":true,"types":["string"]},"dsn":{"type":"string","description":"(Optional) Identifies a data set requirement to post as satisfied.
Value can be a specific data set name or a CA WA CA 7 Edition data set number.
If you are using a number, only the number can be specified without the DS prefix.
Mutually exclusive with DEPJOB and USR.

dsname
Indicates a specific data set name.
Limits:
1 to 44 alphanumeric characters

dsnumber
Indicates a specific data set number. Limits:
1 to 8 numeric characters
","example":"CA7.DSN1","exampleSetFlag":true,"types":["string"]},"internal":{"type":"string","description":" (Optional) Valid only with DSN to indicate that the data set being posted is internal to the CA WA CA 7 Edition workload.
YES is the only acceptable value.
Mutually exclusive with USR, DEPJOB, and PREQ.
In normal situations, CA WA CA 7 Edition automatically posts requirements for internal data sets.
Limits:
YES is the only acceptable value.","example":"YES","exampleSetFlag":true,"types":["string"]},"preq":{"type":"string","description":"(Optional) Valid only with DSN to identify up to 11 numeric values to include
with other CA WA CA 7 Edition log data logged as a result of the POST command being issued.
Mutually exclusive with USR, DEPJOB, and INTERNAL.
Code values in sublist form, within parentheses.
You can code up to 11 values that are separated by commas between the parentheses.
Each value cannot exceed 4 numeric digits.
This optional field can be useful for logging any meaningful numbers, such as batch numbers, which can later be reviewed in the log data set.
","example":"(17,19,20,32)","exampleSetFlag":true,"types":["string"]}},"description":"POST command parameters","exampleSetFlag":false,"types":["object"]},"CommandJCLOVRDResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the JCLOVRD command","example":"SPO0-00 JCLOVRD FUNCTION SUCCESSFUL","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 JCLOVRD command","example":"JCLOVRD,JOB=88,SET=ON","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api JCLOVRD Request Response","exampleSetFlag":false,"types":["object"]},"ErrorJCLOVRDResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: JCLOVRD,JOB=88,SET=ON; SPO0-06 JOB NOT FOUND IN REQ/Q;orJCLOVRD,JOB=35,SET=XX; SPO0-04 SET -- INVALID","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandJCLOVRD":{"type":"object","properties":{"ca7#":{"type":"string","description":"Defines the CA 7 job number of the job in the request queue for which to establish or remove the override requirement.
Limits:
1 to 4 numeric characters","example":"0143","exampleSetFlag":true,"types":["string"]},"set":{"type":"string","description":"Specifies to establish or satisfy JCL override requirements.
When a job fails with a JCL error, the JCL override requirement is automatically set to ON when the job returns to the request queue.
The JCL override must be set to OFF before the job can be submitted again.

ON
Establishes a JCL override requirement for the specified job.
The SET=ON option is used for jobs in the request queue to indicate that an override is needed before execution is to occur.

OFF
Satisfies a JCL override requirement for the specified job. The SET=OFF option indicates that a previously defined need (requirement) for overrides has been satisfied and execution can be safely attempted.
When a JCL override requirement is set to OFF,
that requirement no longer appears on a requirements list for the job
When a REPL is done from the QM.5 panel, the JCL override requirement is automatically set to OFF.

WLM
Sets job to allow the insertion of SCHENV= keyword on the JOB statement at submission time when these conditions are true:
The scheduling environment insertion feature is activated.
A scheduling Environment VRM definition is attached to the job (or SCHENV global default).

NOWLM
Sets job to suppress the insertion of a SCHENV= keyword on the JOB statement at submission time even when one is typically associated with the job.
This option can be used when the validation of an associated IBM WLM scheduling environment has failed causing the job to be requeued (see Browse message SSM0-42).
FSetting the NOWLM option lets you submit the job without SCHENV= keyword insertion.
","example":"ON","exampleSetFlag":true,"types":["string"]}},"description":"JCLOVRD command parameters","exampleSetFlag":false,"types":["object"]},"CommandHOLDResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the HOLD command","example":"HOLD,JOB=44; JOBNAME NUM. QUE ACTION;CA75LG31 0044 REQ HELD BY JOB","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 HOLD command","example":"HOLD,JOB=44","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api HOLD Request Response","exampleSetFlag":false,"types":["object"]},"ErrorHOLDResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: HOLD,JOB=77; SPO1-06 JOB/STATION NOT FOUND","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandHOLD":{"type":"object","properties":{"ca7#":{"type":"string","description":"Defines the individual job number to hold. Omit if Q is specified.

jobnumber
Defines the job number of the job to hold.
Limits:
1 to 4 numeric characters
Required: Yes, unless the Q parameter is used.
","example":"29","exampleSetFlag":true,"types":["string"]},"q":{"type":"string","description":"Specifies to hold the contents of an entire queue.
Possible values:

REQ
Specifies to hold all jobs currently in the request queue.

RDY
Specifies to hold all jobs currently in the ready queue.
Required: Yes, unless job number is used.
","example":"RDY","exampleSetFlag":true,"types":["string"]}},"description":"HOLD command parameters","exampleSetFlag":false,"types":["object"]},"DemandHCommandResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the DEMANDH command","example":"SPO7-00 JOB JOB1 (0002) ADDED TO THE REQ/Q BY DEMANDH","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 DEMANDH command","example":"DEMANDH,JOB=CA75SCHD","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api DEMANDH Request Response","exampleSetFlag":false,"types":["object"]},"ErrorDemandHResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: SPO7-21 JOB NOT DEFINED AND JCLID/JCLLIB NOT SPECIFIED - NONJOB","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandDemandh":{"type":"object","properties":{"job":{"type":"string","description":"Defines the name of the job being demanded.
The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.
JOB and JOBL are mutually exclusive
Limits:
1 to 8 alphanumeric characters","example":"PAYROLL","exampleSetFlag":true,"types":["string"]},"jobl":{"type":"string","description":"(Optional) Defines the long name of the job being demanded. The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.
JOB and JOBL are mutually exclusive
Limits:
1 to 64 alphanumeric characters","example":"payrollSW123","exampleSetFlag":true,"types":["string"]},"arfset":{"type":"string","description":"(Optional)Defines the ARF set name that is used for this run of the job.
you specify **NONE**, no ARF processing is performed for this run of the job
Limits:
1 to 4 alphanumeric characters","example":"PAYSYS","exampleSetFlag":true,"types":["string"]},"cc":{"type":"string","description":"(Optional)Defines, with RO (relational operator), the job-level condition codes that are used to determine whether a job executes successfully.
If specified, this value overrides the RO defined for the job in the CA WA CA 7 Edition database.
RO is required when CC is specified
Limits:
1 to 4 numeric characters(0-4095)","example":"8","exampleSetFlag":true,"types":["string"]},"class":{"type":"string","description":"(Optional)Defines the workload balancing class for resource checking,
Limits:
1 alphanumeric character","example":"A","exampleSetFlag":true,"types":["string"]},"count":{"type":"string","description":"Defines the maximum number of times to repeat the job. COUNT is ignored if INTERVAL is not specified.
If both COUNT and STOP are specified, the job stops repeating when the COUNT reaches zero or the STOP time is reached, whichever comes first.
Default: None. The job continues repeating until the STOP time is reached
Limits:
1 to 4 numeric characters(0-1439)","example":"10","exampleSetFlag":true,"types":["string"]},"date":{"type":"string","description":"(Optional)Defines due-out and submit dates.
Limits:
If used, specify DOTM or TIME.

+nn
Defines the number of days after the current date.
Limits:
1 to 2 numeric characters from 1 to 99

yyddd Defines the Julian date to run the job.
","example":"+5|20242","exampleSetFlag":true,"types":["string"]},"depjob":{"type":"string","description":"(Optional)Defines a single predecessor job that must complete while the demanded job is waiting.
Limits:
1 to 8 alphanumeric characters","example":"PREJB10","exampleSetFlag":true,"types":["string"]},"dotm":{"type":"string","description":"(Optional)Defines the due-out time-of-day for the job in hours (hh) and minutes (mm).
If omitted, the current time (when the DEMAND was processed) plus the lead time is assumed.
If DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.
If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.
Default: Current time, hhmm","example":"1450","exampleSetFlag":true,"types":["string"]},"exec":{"type":"string","description":"(Optional)Specifies whether to execute the job (YES/NO).
If NO (N) is used, the job does not run but shows a normal completion as if it did run.
The value that is specified here overrides the value that is coded on the job definition EXEC field.
Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES,
Values:YES|Y, NO|N","example":"YES|NO","exampleSetFlag":true,"types":["string"]},"interval":{"type":"string","description":"(Optional)Identifies that the job is repeated (executed more than once) and defines the amount of time between each iteration.
If INTERVAL is specified, the TIME and TYPE keywords are required.
If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.
For information about how the deadline, due-out, and submit times are calculated for repeating jobs, see the Usage Notes.
Default: None. The job is not repeated.
Limits:
hh=1 through 2 numeric charact, hhmm","example":"0030","exampleSetFlag":true,"types":["string"]},"jclid":{"type":"string","description":"(Optional)Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).
If the job is defined in the database, the value must be the same as the value on the DB.1 panel
or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.
This field or the JCLLIB field is required if the job is not defined in the database.
JCLID and JCLLIB are mutually exclusive.
Note:
Attempts to run cross-platform jobs that are not defined to the database fail because they are treated as regular CPU jobs when processed,

Limits:
1 to 3 numeric characters(1-999)","example":"10","exampleSetFlag":true,"types":["string"]},"jcllib":{"type":"string","description":"(Optional)Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).
If the job is defined in the database, the value must be the same as the value on the DB.1 panel
or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.
This field or the JCLID field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.
Note:
Attempts to run cross-platform jobs that are not defined to the database fail because they are treated as regular CPU jobs when processed
1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.","example":"&SPECIAL","exampleSetFlag":true,"types":["string"]},"late":{"type":"string","description":"(Optional)Specifies whether a notification occurs when the job becomes late.
Specify YES (Y) to make the job eligible to be marked LATE.
If NO (N) is used, the job is never marked LATE.
The value that is specified here overrides the value that is coded on the job definition PROMPTS field,
Values:YES|Y, NO|N","example":"NO|YES","exampleSetFlag":true,"types":["string"]},"leadtm":{"type":"string","description":"(Optional)Defines the amount of elapsed time that is required to process the job.
Indicates in hours (hh) and minutes (mm) the elapsed time.
The maximum value that you can specify is 2400.
Default: 1 hour
Limits:
hh= 1 through 2 numeric characters from 0 to 24
mm= 2 numeric characters from 00 to 59","example":"0100","exampleSetFlag":true,"types":["string"]},"mainid":{"type":"string","description":"(Optional)Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.
The value that is specified here overrides the value that is coded on the job definition MAINID field.
Also, the SASSXX05 user exit does not override this value.
The name must be one of the following values:

ALL\n Specifies all CPUs are acceptable for executing the job.

SYn\n n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.
/SYn\n n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.
-SYn\n n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.
Limits:
Invalid for internal cross-platform jobs.","example":"ALL|SY2|/SY3|-SY2","exampleSetFlag":true,"types":["string"]},"prty":{"type":"string","description":"(Optional)Defines the initial workload balancing priority,
1-3 numeric (1-255)","example":"255","exampleSetFlag":true,"types":["string"]},"rms":{"type":"string","description":"(Optional)Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.
Specify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P.Enter NO (N) to indicate do not insert of the RMS step.
The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
Limits:
Invalid for internal cross-platform jobs
, Values: YES|Y, NO|N","example":"NO|YES","exampleSetFlag":true,"types":["string"]},"ro":{"type":"string","description":"(Optional)Specifies the relational operator of the condition code (CC) or
if the step level #SCC statements are being used in the JCL of the job.
If specified, this RO overrides the RO defined for the job in the CA WA CA 7 Edition database.
The following values are valid:

EQ
Equal to

LT
Less than

GT
Greater than

GE
Greater than or equal to

LE
Less than or equal to

NE
Not equal to

#S
Step condition code tests to be made based on a #SCC statement.

IG
No evaluation of the job is done.
CA WA CA 7 Edition always assumes that the job completes successfully,
regardless of condition codes, abend codes, or run-time JCL errors.

0
No condition code test is made.
Default:
The job definition panel RO value if the job is defined to CA WA CA 7 Edition; otherwise 0.
Limits:

Invalid with agent jobs.","example":"EQ|LT|GT|GE|LE|NE|#S|IG|0","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"Defines the schedule ID within the job's total schedule definition to use for this run.
If omitted, SCHID=1 is assumed unless the job exists in the CA WA CA 7 Edition database and has an associated schedule.
In this case, the first SCHID defined in the schedule member is assumed.
Default: 1,
Limits:
1 to 3 numeric characters from 1 to 999 (See Note)
Note: If the SCHEDULE statement in the initialization file specifies SCHID=YES, this parameter is required. ","example":"9","exampleSetFlag":true,"types":["string"]},"set":{"type":"string","description":"(Optional)Specifies skip the next scheduled cycle for the job (SKP),
disable triggering (NTR), or bypass the database updating at the job completion.

SKP
Specifies this run of the job takes the place of the next scheduled run.
This value has the same effect as entering NXTCYC,SET=SKP.
It is reflected on output from LJOB and LLOCK commands as if NXTCYC,SET=SKP was used.
This parameter is invalid if the job has no schedule.
SET=SKP has no impact on repeating jobs that are already in the queues.

NTR
Specifies normal triggering is disabled only for this run of the job.

NDB
Allows a job to bypass all load processing at the job completion,
but allows other processing to proceed typically.
Note: Data set triggering is still in effect.
, SKP|NTR|NDB","example":"NDB|NTR|SKP","exampleSetFlag":true,"types":["string"]},"stop":{"type":"string","description":"(Optional)Defines the clock time after which the job is not repeated.
STOP is ignored if INTERVAL is not specified.
If both COUNT and STOP are specified, the job stops repeating when either the COUNT reaches zero or the STOP time is reached, whichever comes first.
If the STOP time is less than the submit time, the stop date is assumed to be the following day.
Default:
1439 minutes (24 hours minus 1 minute) after the submit time
Limits:

hh=1 through 2 numeric characters from 0 to 23
mm=2 numeric characters from 00 to 59","example":"1300","exampleSetFlag":true,"types":["string"]},"time":{"type":"string","description":"(Optional)Defines a submit time-of-day requirement for the job.
If the format is used with a +, the submit time is calculated from the current time, adding the specified number of hours and minutes.
If the + is used, the DATE keyword must be omitted.
Limits:

+ is optional
hh= 1 through 2 numeric characters from 0 to 23
mm= 2 numeric characters from 00 to 59
Required:

No (unless DATE is used, if so, specify DOTM or TIME (hhmm format). Also required if TYPE=CLOCK is specified.","example":"1240|+0130","exampleSetFlag":true,"types":["string"]},"type":{"type":"string","description":"(Optional)TYPE=RES specifies the job is being scheduled in restart/rerun status.
TYPE=CLOCK, START, or END controls how the submit time requirement is calculated for repeating jobs.

When TYPE=RES the job is put into the request queue with a restart requirement.
The job is not submitted before the CA WA CA 7 Edition restart is done.
The output networks are scheduled, but input requirements checking is bypassed.
TYPE=CLOCK, START, or END is ignored if INTERVAL is not specified.
With TYPE=CLOCK, the interval is added to the previous iteration's submit time requirement to determine the new submit time requirement.
With TYPE=START and END the interval is added to the previous iteration's last (most recent) start and end time,
respectively, to determine the new submit time requirement. TYPE is required when INTERVAL is specified.
Limits:

RES, CLOCK, START, or END","example":"CLOCK|END|RES|START","exampleSetFlag":true,"types":["string"]}},"description":"DEMANDH command parameters","exampleSetFlag":false,"types":["object"]},"DemandCommandResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the DEMAND command","example":"SPO7-00 JOB JOB1 (0001) ADDED TO THE REQ/Q BY DEMAND","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 DEMAND command","example":"DEMAND,JOB=CA75SCHD","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api DEMAND Request Response","exampleSetFlag":false,"types":["object"]},"ErrorDemandResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: SPO7-21 JOB NOT DEFINED AND JCLID/JCLLIB NOT SPECIFIED - NONJOB","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandDemand":{"type":"object","properties":{"job":{"type":"string","description":"Defines the name xxx of the job being demanded.
The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.
JOB and JOBL are mutually exclusive
Limits:
1 to 8 alphanumeric characters","example":"PAYROLL","exampleSetFlag":true,"types":["string"]},"jobl":{"type":"string","description":"(Optional) Defines the long name of the job being demanded. The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.
JOB and JOBL are mutually exclusive
Limits:
1 to 64 alphanumeric characters","example":"payrollSW123","exampleSetFlag":true,"types":["string"]},"arfset":{"type":"string","description":"(Optional)Defines the ARF set name that is used for this run of the job.
you specify **NONE**, no ARF processing is performed for this run of the job
Limits:
1 to 4 alphanumeric characters","example":"PAYSYS","exampleSetFlag":true,"types":["string"]},"cc":{"type":"string","description":"(Optional)Defines, with RO (relational operator), the job-level condition codes that are used to determine whether a job executes successfully.
If specified, this value overrides the RO defined for the job in the CA WA CA 7 Edition database.
RO is required when CC is specified
Limits:
1 to 4 numeric characters(0-4095)","example":"8","exampleSetFlag":true,"types":["string"]},"class":{"type":"string","description":"(Optional)Defines the workload balancing class for resource checking.
Limits:
1 alphanumeric character","example":"A","exampleSetFlag":true,"types":["string"]},"count":{"type":"string","description":"Defines the maximum number of times to repeat the job. COUNT is ignored if INTERVAL is not specified.
If both COUNT and STOP are specified, the job stops repeating when the COUNT reaches zero or the STOP time is reached, whichever comes first.
Default: None. The job continues repeating until the STOP time is reached
Limits:
1 to 4 numeric characters(0-1439)","example":"10","exampleSetFlag":true,"types":["string"]},"date":{"type":"string","description":"(Optional)Defines due-out and submit dates.
Limits:
If used, specify DOTM or TIME.

+nn
Defines the number of days after the current date.
Limits:
1 to 2 numeric characters from 1 to 99

yyddd Defines the Julian date to run the job.
","example":"+5|20242","exampleSetFlag":true,"types":["string"]},"depjob":{"type":"string","description":"(Optional)Defines a single predecessor job that must complete while the demanded job is waiting.
Limits:
1 to 8 alphanumeric characters","example":"PREJB10","exampleSetFlag":true,"types":["string"]},"dotm":{"type":"string","description":"(Optional)Defines the due-out time-of-day for the job in hours (hh) and minutes (mm).
If omitted, the current time (when the DEMAND was processed) plus the lead time is assumed.
If DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.
If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.
Default: Current time, hhmm","example":"1450","exampleSetFlag":true,"types":["string"]},"exec":{"type":"string","description":"(Optional)Specifies whether to execute the job (YES/NO).
If NO (N) is used, the job does not run but shows a normal completion as if it did run.
The value that is specified here overrides the value that is coded on the job definition EXEC field.
Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES,
Values:YES|Y, NO|N","example":"YES|NO","exampleSetFlag":true,"types":["string"]},"interval":{"type":"string","description":"(Optional)Identifies that the job is repeated (executed more than once) and defines the amount of time between each iteration.
If INTERVAL is specified, the TIME and TYPE keywords are required.
If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.
For information about how the deadline, due-out, and submit times are calculated for repeating jobs, see the Usage Notes.
Default: None. The job is not repeated.
Limits:
hh=1 through 2 numeric charact, hhmm","example":"0030","exampleSetFlag":true,"types":["string"]},"jclid":{"type":"string","description":"(Optional)Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).
If the job is defined in the database, the value must be the same as the value on the DB.1 panel
or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.
This field or the JCLLIB field is required if the job is not defined in the database.
JCLID and JCLLIB are mutually exclusive.
Note:
Attempts to run cross-platform jobs that are not defined to the database fail because they are treated as regular CPU jobs when processed,

Limits:
1 to 3 numeric characters(1-999)","example":"10","exampleSetFlag":true,"types":["string"]},"jcllib":{"type":"string","description":"(Optional)Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).
If the job is defined in the database, the value must be the same as the value on the DB.1 panel
or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.
This field or the JCLID field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.
Note:
Attempts to run cross-platform jobs that are not defined to the database fail because they are treated as regular CPU jobs when processed
1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.","example":"&SPECIAL","exampleSetFlag":true,"types":["string"]},"late":{"type":"string","description":"(Optional)Specifies whether a notification occurs when the job becomes late.
Specify YES (Y) to make the job eligible to be marked LATE.
If NO (N) is used, the job is never marked LATE.
The value that is specified here overrides the value that is coded on the job definition PROMPTS field,
Values:YES|Y, NO|N","example":"NO|YES","exampleSetFlag":true,"types":["string"]},"leadtm":{"type":"string","description":"(Optional)Defines the amount of elapsed time that is required to process the job.
Indicates in hours (hh) and minutes (mm) the elapsed time.
The maximum value that you can specify is 2400.
Default: 1 hour
Limits:
hh= 1 through 2 numeric characters from 0 to 24
mm= 2 numeric characters from 00 to 59","example":"0100","exampleSetFlag":true,"types":["string"]},"mainid":{"type":"string","description":"(Optional)Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.
The value that is specified here overrides the value that is coded on the job definition MAINID field.
Also, the SASSXX05 user exit does not override this value.
The name must be one of the following values:

ALL\n Specifies all CPUs are acceptable for executing the job.

SYn\n n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.
/SYn\n n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.
-SYn\n n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.
Limits:
Invalid for internal cross-platform jobs.","example":"ALL|SY2|/SY3|-SY2","exampleSetFlag":true,"types":["string"]},"prty":{"type":"string","description":"(Optional)Defines the initial workload balancing priority,
1-3 numeric (1-255)","example":"255","exampleSetFlag":true,"types":["string"]},"rms":{"type":"string","description":"(Optional)Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.
Specify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P.Enter NO (N) to indicate do not insert of the RMS step.
The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
Limits:
Invalid for internal cross-platform jobs
, Values: YES|Y, NO|N","example":"NO|YES","exampleSetFlag":true,"types":["string"]},"ro":{"type":"string","description":"(Optional)Specifies the relational operator of the condition code (CC) or
if the step level #SCC statements are being used in the JCL of the job.
If specified, this RO overrides the RO defined for the job in the CA WA CA 7 Edition database.
The following values are valid:

EQ
Equal to

LT
Less than

GT
Greater than

GE
Greater than or equal to

LE
Less than or equal to

NE
Not equal to

#S
Step condition code tests to be made based on a #SCC statement.

IG
No evaluation of the job is done.
CA WA CA 7 Edition always assumes that the job completes successfully,
regardless of condition codes, abend codes, or run-time JCL errors.

0
No condition code test is made.
Default:
The job definition panel RO value if the job is defined to CA WA CA 7 Edition; otherwise 0.
Limits:

Invalid with agent jobs.","example":"EQ|LT|GT|GE|LE|NE|#S|IG|0","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"Defines the schedule ID within the job's total schedule definition to use for this run.
If omitted, SCHID=1 is assumed unless the job exists in the CA WA CA 7 Edition database and has an associated schedule.
In this case, the first SCHID defined in the schedule member is assumed.
Default: 1,
Limits:
1 to 3 numeric characters from 1 to 999 (See Note)
Note: If the SCHEDULE statement in the initialization file specifies SCHID=YES, this parameter is required. ","example":"9","exampleSetFlag":true,"types":["string"]},"set":{"type":"string","description":"(Optional)Specifies skip the next scheduled cycle for the job (SKP),
disable triggering (NTR), or bypass the database updating at the job completion.

SKP
Specifies this run of the job takes the place of the next scheduled run.
This value has the same effect as entering NXTCYC,SET=SKP.
It is reflected on output from LJOB and LLOCK commands as if NXTCYC,SET=SKP was used.
This parameter is invalid if the job has no schedule.
SET=SKP has no impact on repeating jobs that are already in the queues.

NTR
Specifies normal triggering is disabled only for this run of the job.

NDB
Allows a job to bypass all load processing at the job completion,
but allows other processing to proceed typically.
Note: Data set triggering is still in effect.
, SKP|NTR|NDB","example":"NDB|NTR|SKP","exampleSetFlag":true,"types":["string"]},"stop":{"type":"string","description":"(Optional)Defines the clock time after which the job is not repeated.
STOP is ignored if INTERVAL is not specified.
If both COUNT and STOP are specified, the job stops repeating when either the COUNT reaches zero or the STOP time is reached, whichever comes first.
If the STOP time is less than the submit time, the stop date is assumed to be the following day.
Default:
1439 minutes (24 hours minus 1 minute) after the submit time
Limits:

hh=1 through 2 numeric characters from 0 to 23
mm=2 numeric characters from 00 to 59","example":"1300","exampleSetFlag":true,"types":["string"]},"time":{"type":"string","description":"(Optional)Defines a submit time-of-day requirement for the job.
If the format is used with a +, the submit time is calculated from the current time, adding the specified number of hours and minutes.
If the + is used, the DATE keyword must be omitted.
Limits:

+ is optional
hh= 1 through 2 numeric characters from 0 to 23
mm= 2 numeric characters from 00 to 59
Required:

No (unless DATE is used, if so, specify DOTM or TIME (hhmm format). Also required if TYPE=CLOCK is specified.","example":"1240|+0130","exampleSetFlag":true,"types":["string"]},"type":{"type":"string","description":"(Optional)TYPE=RES specifies the job is being scheduled in restart/rerun status.
TYPE=CLOCK, START, or END controls how the submit time requirement is calculated for repeating jobs.

When TYPE=RES the job is put into the request queue with a restart requirement.
The job is not submitted before the CA WA CA 7 Edition restart is done.
The output networks are scheduled, but input requirements checking is bypassed.
TYPE=CLOCK, START, or END is ignored if INTERVAL is not specified.
With TYPE=CLOCK, the interval is added to the previous iteration's submit time requirement to determine the new submit time requirement.
With TYPE=START and END the interval is added to the previous iteration's last (most recent) start and end time,
respectively, to determine the new submit time requirement. TYPE is required when INTERVAL is specified.
Limits:

RES, CLOCK, START, or END","example":"CLOCK|END|RES|START","exampleSetFlag":true,"types":["string"]}},"description":"DEMAND command parameters","exampleSetFlag":false,"types":["object"]},"CancelCommandResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the CANCEL command","example":"SPO6-00 JOB JOB1 (0002) HAS BEEN CANCELED.","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 CANCEL command","example":"CANCEL,JOB=19LT","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api CANCEL Request Response","exampleSetFlag":false,"types":["object"]},"ErrorCancelResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: SPO6-03 NO QUEUE RECORDS FOUND","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandCancel":{"type":"object","properties":{"ca7#":{"type":"string","description":"Indicates the individual job to cancel, and the value must be a CA 7 job number.
","example":"0016","exampleSetFlag":true,"types":["string"]},"force":{"type":"string","description":"(Optional) Specifies to force the cancellation of the job.
If you want to cancel the job to dump the log data set, specify FORCE=YES to prevent the job from being resubmitted.
Use FORCE=YES when a job to be canceled shows a status of SKELETON or RETRY.
Use FORCE=YES to cancel a job with connected resources.
Warning! Use of this option can potentially cause CA WA CA 7 Edition to abend; therefore, only use it as a last resort. ","exampleSetFlag":false,"types":["string"]},"reason":{"type":"string","description":"(Optional) Defines the reason for the job cancellation.
Depending on the initialization file CANCEL statement value, this reason can be required or optional.
If it is required but not given, a message prompts the user to provide it.
The text is entered into the run log entry for this occurrence of this job and is displayed on any subsequent LRLOG inquiries.
Limits:
1 to 40 alphanumeric characters
Required:
No (depending on initialization options)","example":"PER PROD SUPPORT","exampleSetFlag":true,"types":["string"]}},"description":"CANCEL command parameters","exampleSetFlag":false,"types":["object"]},"CommandARFPResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the ARFP command","example":"SPO6-00 JOB JOB1 (0002) HAS BEEN ARFP.","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 ARFP command","example":"ARFP,JOB=19","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api ARFP Request Response","exampleSetFlag":false,"types":["object"]},"ErrorARFPResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: SPO6-03 NO QUEUE RECORDS FOUND","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandARFP":{"type":"object","properties":{"ca7#":{"type":"string","description":"Defines the unique CA 7 job number for the job whose ARF requirements you want to purge.
","example":"16","exampleSetFlag":true,"types":["string"]},"force":{"type":"string","description":"(Optional)If set to YES,forces the purging of the ARF requirement for a job
even if it does not exist in the request, ready, or active queue.
","example":"YES","exampleSetFlag":true,"types":["string"]}},"description":"ARFP command parameters","exampleSetFlag":false,"types":["object"]},"CommandADDRQResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the ADDRQ command","example":"ADDRQ,JOB=43,DEPJOB=CA75ANA1; SPO4-00 ADDRQ SUCCESSFUL FOR JOB=CA75LG31(0043);DEPJOB=CA75ANA1","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 ADDRQ command","example":"ADDRQ,JOB=43,DEPJOB=CA75ANA1","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api ADDRQ Request Response","exampleSetFlag":false,"types":["object"]},"ErrorADDRQResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: ADDRQ,JOB=45,DEPJOB=CA75ANA1; SPO4-04 ADDRQ UNSUCCESSFUL; JOB 0045 NOT FOUND IN REQ/Q","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The request identifier used in the request if any.","example":"4729de2d-03a4-4cf8-84d9-66d7e3452954","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandADDRQ":{"type":"object","properties":{"ca7#":{"type":"string","description":" Defines the job to which you want to add the job requirement.
The job must be in the request queue.

jobnumber
Defines the CA 7 job number to which you want to add the requirement for this run of the job.
Limits:
1 to 4 numeric characters
","example":"029","exampleSetFlag":true,"types":["string"]},"depjob":{"type":"string","description":"Defines a temporary one-time job dependency requirement.
The DEPJOB value specifies the job name that must complete execution or must be manually posted complete before the job identified by JOB is eligible for submission.
DEPJOB is required unless USR is used, in which case, omit DEPJOB.
This requirement is satisfied automatically when the predecessor job completes.
Only in unusual situations would this requirement must be satisfied manually. That is, any time that a normal completion did not occur.
Required: Yes, unless USR is used.
Limits:
1 to 8 alphanumeric characters","example":"PAYJOB","exampleSetFlag":true,"types":["string"]},"usr":{"type":"string","description":"Defines the description of a temporary, one-time user requirement..
This requirement must be manually satisfied before the job identified by JOB is eligible for submission.
If any commas are included as part of the text, enclose the entire requirements text in parentheses.
This requirement is satisfied automatically when the predecessor job completes.
Only in unusual situations would this requirement must be satisfied manually. That is, any time that a normal completion did not occur.
Required: USR is required unless DEPJOB is used, in which case, omit USR.
Limits:
1 to 36 alphanumeric characters","example":"USER WILL CALL TO RELEASE","exampleSetFlag":true,"types":["string"]}},"description":"ADDRQ command parameters","exampleSetFlag":false,"types":["object"]},"GetLogFilesRequest":{"type":"object","properties":{"filenames":{"maxItems":50,"type":"array","description":"Log file names. Wildcards are not allowed.","example":["receiver.log","transmitter.log"],"exampleSetFlag":true,"items":{"type":"string","exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"Specifies an optional list of file names to retrieve","exampleSetFlag":false,"types":["object"]},"AgentCredentialsAddRequest":{"type":"object","properties":{"userid":{"type":"string","description":"Specifies a user ID that is passed with a password to an agent for authorization.
Limits:
1 to 128 characters. The wildcard characters * and ? are not permitted","example":"wlaagent","exampleSetFlag":true,"types":["string"]},"agent":{"type":"string","description":"Specifies the agent that is the target of a job submission and where the user ID and password authorization takes place.
Limits:
1 to 16 characters. The wildcard characters * and ? are not permitted","example":"WINAGENT001","exampleSetFlag":true,"types":["string"]},"jobType":{"type":"string","description":"Specifies the job type of the job that requires a user ID and password authorization.
Limits:
1 to 16 characters. The wildcard characters * and ? are not permitted","example":"NT_JOB","exampleSetFlag":true,"types":["string"]},"source":{"type":"string","description":"Specifies the source field for a job that requires a user ID and password authorization. This field applies to agent job types which allow CONNECTIONUSER or PROXYUSER C-LANG statements. If omitted, it indicates that these credentials are eligible for selection for all source values. If specified, it is used as the domain name when selecting the credentials for the user.
Limits:
1 to 64 characters. The wildcard characters * and ? are not permitted","example":"example.domain.com","exampleSetFlag":true,"types":["string"]},"password":{"type":"string","description":"Specifies the password to associate with the four key fields (userid, agent, jobType, and source)
Limits:
1 to 32 characters.","example":"thisIsSecret","exampleSetFlag":true,"types":["string"]}},"exampleSetFlag":false,"types":["object"]},"Ca7InstanceEntityFilter":{"required":["ca7_host","ca7_port","name"],"type":"object","properties":{"name":{"type":"string","description":"The unique name of this instance.
This is the name to be used in all API requests
.","example":"C11","exampleSetFlag":true,"types":["string"]},"ca7_host":{"type":"string","description":"The CA7ONL host IP/DNS
.","example":"myhost.domain.com","exampleSetFlag":true,"types":["string"]},"ca7_port":{"type":"integer","description":"The CA7ONL port
.","format":"int32","example":11423,"exampleSetFlag":true,"types":["integer"]},"ca7_secure":{"type":"boolean","description":"True, if the communication with CA 7 should use secure sockets.","example":false,"exampleSetFlag":true,"types":["boolean"]},"ca7_keystore":{"type":"string","description":"The full path to the keystore/truststore file used for SSL communication to CA7ONL","example":"/Users/auser/mydir/KeyStore.jks","exampleSetFlag":true,"types":["string"]},"ca7_protocol":{"type":"string","description":" The SSL protocol to be used for secure socket communication with CA7ONL.
The default is TLSv1.2.
If it is not specified the default will be used.","example":"TLSv1.2","exampleSetFlag":true,"types":["string"]},"ca7_communicatorPoolSize":{"type":"integer","description":"The maximum number of connections to be opened to a CA7ONL instance.
This must be a positive value that does not exceed the maximum number of terminals.
","format":"int32","example":5,"exampleSetFlag":true,"types":["integer"]},"ca7_communicatorEvictableIdleTimeSeconds":{"type":"integer","description":"The time, in seconds, to keep an existing connection open.
If the connection is not used and the idle time passes, the connection will be closed.
","format":"int32","example":30,"exampleSetFlag":true,"types":["integer"]},"ca7_authorizationRetryCount":{"type":"integer","description":"The number of retries to be used for access to endpoint authorization.
If HttpStatus.SERVICE_UNAVAILABLE is returned, the authorization will be retried up to ca7_authorizationRetryCount.
The default is 5.","format":"int32","example":5,"exampleSetFlag":true,"types":["integer"]},"ca7_timeout":{"type":"integer","description":"The timeout, in seconds, used when connecting to and reading from CA 7 via the TCP/IP terminal interface.
The default is 60.","format":"int32","example":60,"exampleSetFlag":true,"types":["integer"]},"ca7_use_uid_filter":{"type":"boolean","description":"Flag to turn on/off the UID/COIDs usage
Default: false","example":false,"exampleSetFlag":true,"types":["boolean"]},"ca7_pool_retry":{"type":"integer","description":"How many times to try to get the communicator from the pool
Default: 10","format":"int32","example":10,"exampleSetFlag":true,"types":["integer"]},"ca7_pool_retry_timeout":{"type":"integer","description":"The time interval between 2 attempts to get the communicator from the pool, in milliseconds
Default: 500","format":"int32","example":500,"exampleSetFlag":true,"types":["integer"]},"db_logical_name":{"type":"string","description":"The logical database name
If not specified in the instance configuration, the name will need to be passed as a parameter to the request.","example":"CA7DB1","exampleSetFlag":true,"types":["string"]},"db_host":{"type":"string","description":"The Datacom server host IP/DNS
If not specified in the instance configuration, all the requests that requires Datacom connection will fail","example":"DBCA7","exampleSetFlag":true,"types":["string"]},"db_port":{"type":"integer","description":"The Datacom server port
If not specified in the instance configuration, all the requests that requires Datacom connection will fail","format":"int32","example":11221,"exampleSetFlag":true,"types":["integer"]},"db_user":{"type":"string","description":"The Datacom user ID
If not specified in the instance configuration, all the requests that requires Datacom connection will fail","example":"JOEDOE","exampleSetFlag":true,"types":["string"]},"db_server_name":{"type":"string","description":"The Datacom server name
If not specified in the instance configuration, all the requests that requires Datacom connection will fail","example":"DNSVNAME","exampleSetFlag":true,"types":["string"]},"db_secure":{"type":"boolean","description":"Flag to be set to true if the connection to db will be done using SSL
The default is false","example":true,"exampleSetFlag":true,"types":["boolean"]},"db_trustStore":{"type":"string","description":"The full path to the keystore/truststore file used for SSL communication to Datacom","example":"/Users/auser/mydir/KeyStore.jks","exampleSetFlag":true,"types":["string"]},"db_protocol":{"type":"string","description":" The SSL protocol to be used for secure socket communication with Datacom.
The default is TLSv1.2.
If it is not specified, the default will be used.","example":"TLSv1.2","exampleSetFlag":true,"types":["string"]},"db_max_pool":{"type":"integer","description":"The maximum number of Datacom connections to be available in the same time.
Default: 10","format":"int32","example":10,"exampleSetFlag":true,"types":["integer"]},"db_min_pool":{"type":"integer","description":"The minimum number of Datacom connections to be kept idle when they are not used
Default: 0","format":"int32","example":0,"exampleSetFlag":true,"types":["integer"]},"db_timeout":{"type":"integer","description":"The connection to Datacom timeout in seconds
Default: 60","format":"int32","example":60,"exampleSetFlag":true,"types":["integer"]},"db_trace":{"type":"boolean","description":"Flag to turn on/off the jdbc trace on the RestApi side for Datacom queries
Default: false","example":false,"exampleSetFlag":true,"types":["boolean"]}},"description":"CA 7 Instance Configuration","exampleSetFlag":false,"types":["object"]},"BatchResponse":{"type":"object","properties":{"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"success-count":{"type":"integer","description":"The number of successful API from he batch execution","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"failure-count":{"type":"integer","description":"The number of failed API from he batch execution","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"total-count":{"type":"integer","description":"The total number of executed APIs","format":"int32","example":2,"exampleSetFlag":true,"types":["integer"]},"responses":{"$ref":"#/components/schemas/batchMultipeResponseSchema","exampleSetFlag":false}},"description":"The response to the batch request","exampleSetFlag":false,"types":["object"]},"ErrorResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"The error message","example":"The transaction key 9e1613a9+562c-11ed-8496-8394a522f469 is invalid. Please use a key generated by the API.","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]}},"exampleSetFlag":false,"types":["object"]},"ResourceCountResource":{"type":"object","properties":{"resource-name":{"type":"string","description":"Identifies the names of the active resources.","example":"PAYROLL.RCT","exampleSetFlag":true,"types":["string"]},"total-count":{"type":"string","description":"The total number of resource count resource","example":"12","exampleSetFlag":true,"types":["string"]},"used-count":{"type":"string","description":"The number of resource count resource currently in use","example":"12","exampleSetFlag":true,"types":["string"]}},"description":"The Resource Count Resource properties","exampleSetFlag":false,"types":["object"]},"ResourceCountResourceStatusResponse":{"type":"object","properties":{"count":{"type":"integer","description":"The number of Resource Count resources that match the selection criteria","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"resource-count-resources":{"type":"array","description":"The list of resource count resources usage","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ResourceCountResource","exampleSetFlag":false},"types":["array"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]}},"exampleSetFlag":false,"types":["object"]},"Ca7ActRqmts":{"type":"object","properties":{"rqmtType":{"type":"string","description":"The type of the requirement. Valid values are JOB, DSN, NW, and USER, 4 CHAR","example":"USER","exampleSetFlag":true,"types":["string"]},"predObject":{"type":"string","description":"The name of the requirement, 44 CHAR","example":"PAYROLL1","exampleSetFlag":true,"types":["string"]},"satisfied":{"type":"string","description":"Flag set to Y when the requirement has been satisfied, 1 CHAR","example":"N","exampleSetFlag":true,"types":["string"]},"nextRunOnly":{"type":"string","description":"Flag set to Y if the requirement is only for the next execution, 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]},"addrq":{"type":"string","description":"Flag set to Y if the requirement was created with the ADDRQ command, 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]},"weak":{"type":"string","description":"Flag set to Y if the requirement is set as weak., 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]},"external":{"type":"string","description":" Flag set to Y if the requirement is for an external dataset, 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]},"negative":{"type":"string","description":"Flag set to Y is the requirement is a negative requirement, 1 CHAR","example":"N","exampleSetFlag":true,"types":["string"]},"hardLeadTime":{"type":"string","description":"Y if the lead time is a real time (not a special value like 99), 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]},"dsIsGdg":{"type":"string","description":" Flag set to Y if the dataset requirement is for a GDG, 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]},"triggers":{"type":"string","description":"Y if dataset triggers a job, 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]},"satisfiedBySubmit":{"type":"string","description":"Flag set to Y if the requirement was satisfied by the SUBMIT command, 1 CHAR","example":"N","exampleSetFlag":true,"types":["string"]},"satisfiedByPost":{"type":"string","description":" Flag set to Y if the requirement was manually satisfied, 1 CHAR","example":"N","exampleSetFlag":true,"types":["string"]},"inputDSNUsed":{"type":"string","description":"Flag set to Y if the dataset was opened during job execution, 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]},"satisfiedByDRMode":{"type":"string","description":"Flag set to Y if the requirement was satisfied by the current disaster recovery mode options, 1 CHAR","example":"N","exampleSetFlag":true,"types":["string"]},"gdgRef":{"type":"integer","description":"The GDG reference number, INTEGER","format":"int64","example":3,"exampleSetFlag":true,"types":["integer"]},"gdgBias":{"type":"integer","description":"The GDG bias number, INTEGER","format":"int64","example":2,"exampleSetFlag":true,"types":["integer"]},"timeSatisfied":{"type":"string","description":"The date and time the requirement was satisfied , DATE/TIME","example":"2020-10-29-09.32.49.0580","exampleSetFlag":true,"types":["string"]},"lastRunTime":{"type":"string","description":"The predecessor's last run date/time, DATE/TIME","example":"2020-10-29-09.32.49.0580","exampleSetFlag":true,"types":["string"]},"prose#":{"type":"integer","description":"Prose number for this dataset predecessor, INTEGER","format":"int64","example":123,"exampleSetFlag":true,"types":["integer"]},"creatingJob":{"type":"string","description":" Name of job that creates this dataset, 8 CHAR","example":"FINANCE","exampleSetFlag":true,"types":["string"]},"rqdsnbr":{"type":"integer","description":"Dataset number of required dataset, INTEGER","format":"int64","example":11,"exampleSetFlag":true,"types":["integer"]}},"description":"CA7_ACT_RQMTS active requirements record","exampleSetFlag":false,"types":["object"]},"Ca7ActRqmtsListResponse":{"type":"object","properties":{"job-count":{"type":"integer","description":"The number of jobs","format":"int32","example":3,"exampleSetFlag":true,"types":["integer"]},"job-requirements":{"type":"array","description":"The list of jobs in active CA 7 workload and their requirements","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Ca7JobActiveRequirements","exampleSetFlag":false},"types":["array"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"database-name":{"type":"string","description":"The CA7 Logical Database Name","example":"CA7DB","exampleSetFlag":true,"types":["string"]},"database-url":{"type":"string","description":"The Database URL","example":"jdbc:datacom://domain:port/ServerName=DCName","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2020-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api request response to get an active job requirements","exampleSetFlag":false,"types":["object"]},"Ca7JobActiveRequirements":{"type":"object","properties":{"predecessor-count":{"type":"integer","description":"The number of predecessors","format":"int32","example":3,"exampleSetFlag":true,"types":["integer"]},"job":{"$ref":"#/components/schemas/Ca7QueueForReq","exampleSetFlag":false},"predecessors":{"type":"array","description":"The requirements status information about a job in the active CA 7 workload ","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Ca7ActRqmts","exampleSetFlag":false},"types":["array"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"database-name":{"type":"string","description":"The CA 7 logical database name","example":"DB1","exampleSetFlag":true,"types":["string"]},"database-url":{"type":"string","description":"The Database URL","example":"jdbc:datacom://domain:port/ServerName=DCName","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 active job requirements","exampleSetFlag":false,"types":["object"]},"Ca7QueueForReq":{"type":"object","properties":{"job":{"type":"string","description":"The job name for this job in the active workload, 8 CHAR","example":"PAYROLL","exampleSetFlag":true,"types":["string"]},"queueName":{"type":"string","description":"The name of the queue in which this job is currently located. Values are: 1=pre-processing; 2=request;3=ready; 4=active; 5=post-processing; 6=prior-run, CHAR 16","example":"active","exampleSetFlag":true,"types":["string"]},"ca7#":{"type":"string","description":"The CA 7 job number for this job in the active workload","example":"0033","exampleSetFlag":true,"types":["string"]},"override":{"type":"string","description":"Y if JCL/PARM DATA override is required, N if not, 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]},"verify":{"type":"string","description":"Y if job has a manual verification requirement, N if not, 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]},"waitSubmitTime":{"type":"string","description":"Y if this job has a submit time requirement, N if not, 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]},"abended":{"type":"string","description":"Y if job abended, N if not, 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]},"held":{"type":"string","description":"Y if job is held, N if not, 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]},"heldByJob":{"type":"string","description":"Y if job was held on entry to the queues, N if not, 1 CHAR","example":"N","exampleSetFlag":true,"types":["string"]},"jclError":{"type":"string","description":"Y if job marked with JCL error, N if not, 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]},"noUserId":{"type":"string","description":"Y if there is not a valid security id for this job, N if there is, 1 CHAR","example":"N","exampleSetFlag":true,"types":["string"]},"nosecurity":{"type":"string","description":"Y if there was an error retrieving security data,N if no, 1 CHAR","example":"N","exampleSetFlag":true,"types":["string"]},"nodeFailed":{"type":"string","description":"Y if this is an XPJOB job and at the time of it last submit its node was down, N if not, 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]},"nodeOffline":{"type":"string","description":"Y if this is an XPJOB job and at the time of its last submit its node was offline, N if not, 1 CHAR","example":"N","exampleSetFlag":true,"types":["string"]},"nodeStopped":{"type":"string","description":"Y if this is an XPJOB job and at the time of it last submit its node was stopped, N if not, 1 CHAR","example":"N","exampleSetFlag":true,"types":["string"]},"xtrackerInact":{"type":"string","description":"Y if at time of submission, the XTRACKER task is not active for an XPJOB job or IAS is not active for an agent job, N if not, 1 CHAR","example":"Y","exampleSetFlag":true,"types":["string"]}},"description":"The properties of a job in the active CA 7 workload","exampleSetFlag":false,"types":["object"]},"Ca7ActJCLResponse":{"type":"object","properties":{"job":{"$ref":"#/components/schemas/Ca7QueueForJCL","exampleSetFlag":false},"statement-count":{"type":"integer","format":"int32","exampleSetFlag":false,"types":["integer"]},"JCL":{"type":"array","description":"The JCL of the job in active queue","example":"//CA75LG31 JOB (113300000,IGN),'L G 3 1'","exampleSetFlag":true,"items":{"type":"object","description":"The JCL of the job in active queue","example":"//CA75LG31 JOB (113300000,IGN),'L G 3 1'","exampleSetFlag":true,"types":["object"]},"types":["array"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"database-name":{"type":"string","description":"The CA 7 logical database name","example":"DB1","exampleSetFlag":true,"types":["string"]},"database-url":{"type":"string","description":"The Database URL","example":"jdbc:datacom://domain:port/ServerName=DCName","exampleSetFlag":true,"types":["string"]},"path":{"type":"string","description":"The REST API path to the command","example":"/ca7services/api/v1/job/instance/JCL","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2020-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api request response to get an active job JCL","exampleSetFlag":false,"types":["object"]},"Ca7QueueForJCL":{"type":"object","properties":{"job":{"type":"string","description":"The job name for this job in the active workload, 8 CHAR","example":"PAYROLL","exampleSetFlag":true,"types":["string"]},"queueName":{"type":"string","description":"The name of the queue in which this job is currently located. Values are: 1=pre-processing; 2=request;3=ready; 4=active; 5=post-processing; 6=prior-run, CHAR 16","example":"active","exampleSetFlag":true,"types":["string"]},"ca7#":{"type":"string","description":"The CA 7 job number for this job in the active workload","example":"0033","exampleSetFlag":true,"types":["string"]}},"description":"The properties of a job in the active CA 7 workload","exampleSetFlag":false,"types":["object"]},"Ca7PriorRunQueue":{"type":"object","properties":{"job":{"type":"string","description":"Identifies the name of the job as defined in the database.","example":"CA7JOB01","exampleSetFlag":true,"types":["string"]},"ca7#":{"type":"string","description":"Identifies the CA 7 job number that was assigned on initial queue entry.","example":"33","exampleSetFlag":true,"types":["string"]},"deadlineTime":{"type":"string","description":"Date/time job began execution in order to finish by due-out time.","example":"2020-01-27T17:06:00.000000-05:00","exampleSetFlag":true,"types":["string"]},"startTime":{"type":"string","description":"Date/time job started.","example":"2020-01-27T16:06:00.000000-05:00","exampleSetFlag":true,"types":["string"]},"dueOutTime":{"type":"string","description":"Date/time job scheduled to complete.","example":"2020-01-27T17:06:00.000000-05:00","exampleSetFlag":true,"types":["string"]},"endTime":{"type":"string","description":"Date/time job completed.
","example":"2020-01-27T16:06:50.700000-05:00","exampleSetFlag":true,"types":["string"]},"hostName":{"type":"string","description":"The SMF Id of the system where this is executing, 8 CHAR.","example":"SMFCA","exampleSetFlag":true,"types":["string"]},"scheduleId":{"type":"integer","description":"The schedule id for this execution, INTEGER.","format":"int32","example":18,"exampleSetFlag":true,"types":["integer"]},"jobStatus":{"type":"string","description":"Identifies the highest condition code passed by any step within this job.","example":"C0000","exampleSetFlag":true,"types":["string"]},"entryMode":{"type":"string","description":"Identifies how the job was brought into the queue.
The possible values are:
AUTO
Indicates a triggered job.
DEMD
Indicates a demanded job.
EXTL
Indicates a job that is submitted external to CA WA CA 7 Edition
PS
Indicates a job that the Personal Scheduling System submitted.
RPET
Indicates a repeated job.
RUN/br> Indicates a job that is brought in by the RUN command.
SSCN
Indicates a job that is brought in by schedule scan.
XDEM
Indicates a job brought in by the DEMAND command from an XPS client.

Note: If ARF detects an exception condition for the job,
the last character of this field has an asterisk as in the following example: DEM*","example":"LOAD","exampleSetFlag":true,"types":["string"]}},"description":"CA7_PRIOR_RUN job record","exampleSetFlag":false,"types":["object"]},"Ca7PriorRunQueueJobListResponse":{"type":"object","properties":{"jobs":{"type":"array","description":"The list of filtered jobs in prior run queue","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Ca7PriorRunQueue","exampleSetFlag":false},"types":["array"]},"count":{"type":"integer","description":"The number of jobs","format":"int32","example":5,"exampleSetFlag":true,"types":["integer"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"database-name":{"type":"string","description":"The CA 7 logical database name","example":"DB1","exampleSetFlag":true,"types":["string"]},"database-url":{"type":"string","description":"The Database URL","example":"jdbc:datacom://domain:port/ServerName=DCName","exampleSetFlag":true,"types":["string"]}},"exampleSetFlag":false,"types":["object"]},"CA7TriggeredByJobEntry":{"type":"object","properties":{"job":{"type":"string","description":"The triggering job name","example":"JOBA","exampleSetFlag":true,"types":["string"]},"triggered-job-count":{"type":"integer","description":"The number of jobs triggered by the triggering job","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"triggered-jobs":{"type":"array","description":"The list of jobs that are triggered by this job","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7TriggeredJob","exampleSetFlag":false},"types":["array"]}},"description":"The list of triggering jobs","exampleSetFlag":false,"types":["object"]},"CA7TriggeredJob":{"type":"object","properties":{"triggered-by-job-schid":{"type":"string","description":"The schedule ID of the triggering job","example":"10","exampleSetFlag":true,"types":["string"]},"job":{"type":"string","description":"The name of the triggered job","example":"JOBZ","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"The schedule ID of the triggered job","example":"20","exampleSetFlag":true,"types":["string"]},"due-out-time":{"type":"string","description":"The due-out time of the triggered job","example":"00:30:00","exampleSetFlag":true,"types":["string"]},"due-out-time-exists":{"type":"string","description":"An indication of whether a due-out time exists for the triggered job (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"queue-time":{"type":"string","description":"The queue time of the triggered job (in DDDHHMMSSNNNNNN format)","example":"000000000000000","exampleSetFlag":true,"types":["string"]},"lead-time":{"type":"string","description":"The lead time of the triggered job (in DDDHHMMSSNNNNNN format)","example":"000001500000000","exampleSetFlag":true,"types":["string"]},"submit-time":{"type":"string","description":"The submit time of the triggered job","example":"01:00:00","exampleSetFlag":true,"types":["string"]},"submit-time-exists":{"type":"string","description":"An indication of whether a submit time exists for the triggered job (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]}},"description":"The list of jobs that are triggered by this job","exampleSetFlag":false,"types":["object"]},"CA7TriggeredJobsListResponse":{"type":"object","properties":{"triggered-by-job-count":{"type":"integer","description":"The number of triggering jobs that match the selection criteria","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"triggered-by-jobs":{"type":"array","description":"The list of triggering jobs","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7TriggeredByJobEntry","exampleSetFlag":false},"types":["array"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"database-name":{"type":"string","description":"The CA 7 logical database name","example":"DB1","exampleSetFlag":true,"types":["string"]},"database-url":{"type":"string","description":"The Database URL","example":"jdbc:datacom://domain:port/ServerName=DCName","exampleSetFlag":true,"types":["string"]}},"exampleSetFlag":false,"types":["object"]},"CA7TriggeredByObject":{"type":"object","properties":{"type":{"type":"string","description":"The type of the triggering object (JOB/DSN/USER)","example":"DSN","exampleSetFlag":true,"types":["string"]},"name":{"type":"string","description":"The name of the triggering object","example":"DATASET.JOBZ","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"The schedule ID of the triggering object","example":"20","exampleSetFlag":true,"types":["string"]},"triggered-job-schid":{"type":"string","description":"The schedule ID of the triggered job","example":"20","exampleSetFlag":true,"types":["string"]},"triggered-job-due-out-time":{"type":"string","description":"The due-out time of the triggered job","example":"00:30:00","exampleSetFlag":true,"types":["string"]},"triggered-job-due-out-time-exists":{"type":"string","description":"An indication of whether a due-out time exists for the triggered job (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"triggered-job-queue-time":{"type":"string","description":"The queue time of the triggered job (in DDDHHMMSSNNNNNN format)","example":"000000000000000","exampleSetFlag":true,"types":["string"]},"triggered-job-lead-time":{"type":"string","description":"The lead time of the triggered job (in DDDHHMMSSNNNNNN format)","example":"000001500000000","exampleSetFlag":true,"types":["string"]},"triggered-job-submit-time":{"type":"string","description":"The submit time of the triggered job","example":"01:00:00","exampleSetFlag":true,"types":["string"]},"triggered-job-submit-time-exists":{"type":"string","description":"An indication of whether a submit time exists for the triggered job (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]}},"description":"The list of objects (triggers) that trigger this job","exampleSetFlag":false,"types":["object"]},"CA7TriggeredByObjectsListResponse":{"type":"object","properties":{"triggered-job-count":{"type":"integer","description":"The number of triggered jobs that match the selection criteria","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"triggered-jobs":{"type":"array","description":"The list of triggered jobs","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7TriggeredJobEntry","exampleSetFlag":false},"types":["array"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"database-name":{"type":"string","description":"The CA 7 logical database name","example":"DB1","exampleSetFlag":true,"types":["string"]},"database-url":{"type":"string","description":"The Database URL","example":"jdbc:datacom://domain:port/ServerName=DCName","exampleSetFlag":true,"types":["string"]}},"exampleSetFlag":false,"types":["object"]},"CA7TriggeredJobEntry":{"type":"object","properties":{"job":{"type":"string","description":"The triggered job name","example":"JOBA","exampleSetFlag":true,"types":["string"]},"triggered-by-count":{"type":"integer","description":"The number of objects (triggers) that trigger this job","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"triggered-bys":{"type":"array","description":"The list of objects (triggers) that trigger this job","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7TriggeredByObject","exampleSetFlag":false},"types":["array"]}},"description":"The list of triggered jobs","exampleSetFlag":false,"types":["object"]},"CA7JobStep":{"type":"object","properties":{"number":{"type":"string","description":"The number of the step within the job","example":"1","exampleSetFlag":true,"types":["string"]},"name":{"type":"string","description":"The name of the step","example":"DOBACKUP","exampleSetFlag":true,"types":["string"]},"program-name":{"type":"string","description":"The name of the program executed in the step","example":"BKUPUTIL","exampleSetFlag":true,"types":["string"]},"procedure-step-name":{"type":"string","description":"The name of the procedure step","example":"BACKUP","exampleSetFlag":true,"types":["string"]},"region-size":{"type":"string","description":"The size of the region specified for the step in kilobytes (K)","example":"4096","exampleSetFlag":true,"types":["string"]},"requested-time":{"type":"string","description":"The amount of time specified for the step","example":"1440","exampleSetFlag":true,"types":["string"]},"ca11-can-restart":{"type":"string","description":"An indication of whether the job can be restarted by CA 11 in this step (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"dd-statement-count":{"type":"integer","description":"The number of DD statements for the step","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"dd-statements":{"type":"array","description":"The list of DD statements for the step","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7JobStepDD","exampleSetFlag":false},"types":["array"]}},"description":"The list of steps in the job","exampleSetFlag":false,"types":["object"]},"CA7JobStepDD":{"type":"object","properties":{"number":{"type":"string","description":"The number of the DD within the step","example":"1","exampleSetFlag":true,"types":["string"]},"name":{"type":"string","description":"The name of the DD statement","example":"SYSUT1","exampleSetFlag":true,"types":["string"]},"gdg-bias":{"type":"string","description":"The generation data group (GDG) bias value (the +/- number)","example":"0","exampleSetFlag":true,"types":["string"]},"dataset-name":{"type":"string","description":"The name of the data set on the DD statement","example":"DAILY.ACCOUNTS.PAYABLE.BACKUP","exampleSetFlag":true,"types":["string"]},"input-output-count":{"type":"string","description":"The number of input/output operations to the data set","example":"147720","exampleSetFlag":true,"types":["string"]},"wlb-tape-count":{"type":"string","description":"The number of TAPE1/TAPE2 units for workload balancing","example":"4","exampleSetFlag":true,"types":["string"]},"dataset-type":{"type":"string","description":"The type of the dataset. The value is D for a normal dataset. Other values are used internally during processing and should not be expected on a consistent basis","example":"D","exampleSetFlag":true,"types":["string"]},"disposition-initial":{"type":"string","description":"The initial disposition specified on the DD statement.
Valid values are:
N = NEW
M = MOD
O = OLD
S = SHR
","example":"NEW","exampleSetFlag":true,"types":["string"]},"disposition-normal":{"type":"string","description":"The normal disposition specified on the DD statement.
Valid values are:
P = PASS
K = KEEP
D = DELETE
C = CATLG
U = UNCATLG
","example":"CATLG","exampleSetFlag":true,"types":["string"]},"disposition-abnormal":{"type":"string","description":"The abnormal disposition specified on the DD statement.
Valid values are:
K = KEEP
D = DELETE
C = CATLG
U = UNCATLG
","example":"DELETE","exampleSetFlag":true,"types":["string"]},"gdg":{"type":"string","description":"An indication of whether the dataset is a generation data group (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"member":{"type":"string","description":"An indication of whether the dataset specifies a PDS (or PDSE) member name (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"media":{"type":"string","description":"The media type of the dataset.
Valid values are:
T = tape
D = disk
","example":"D","exampleSetFlag":true,"types":["string"]},"wlb-tape1-device":{"type":"string","description":"An indication of whether the unit is a workload balancing TAPE1 device (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"wlb-tape2-device":{"type":"string","description":"An indication of whether the unit is a workload balancing TAPE2 device (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"type":{"type":"string","description":"The type of DD statement.
Valid values are:
N = normal
I = SYSIN
O = SYSOUT
S = SUBSYS
T = temporary
D = DUMMY
","example":"N","exampleSetFlag":true,"types":["string"]},"permanent":{"type":"string","description":"An indication of whether the dataset is marked permanent (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"unit-affinity":{"type":"string","description":"An indication of whether the DD has a unit affinity and thus is not counted in the device usage counts (device already allocated) (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"multiple-tape-drives":{"type":"string","description":"An indication of whether the data set uses more than 1 tape device (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"not-first-reference":{"type":"string","description":"An indication of whether this is not the first reference to this dataset in the job (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"created-and-used":{"type":"string","description":"An indication of whether the dataset is both created and used in the job (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"dataset-number":{"type":"string","description":"The internal number CA 7 has assigned to this data set","example":"42","exampleSetFlag":true,"types":["string"]}},"description":"The list of DD statements for the step","exampleSetFlag":false,"types":["object"]},"CA7JobStepDDListResponse":{"type":"object","properties":{"job-count":{"type":"integer","description":"The number of jobs that match the selection criteria","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"jobs":{"type":"array","description":"The list of jobs that match the selection criteria","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7JobStepJob","exampleSetFlag":false},"types":["array"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"database-name":{"type":"string","description":"The CA 7 logical database name","example":"DB1","exampleSetFlag":true,"types":["string"]},"database-url":{"type":"string","description":"The Database URL","example":"jdbc:datacom://domain:port/ServerName=DCName","exampleSetFlag":true,"types":["string"]}},"exampleSetFlag":false,"types":["object"]},"CA7JobStepJob":{"type":"object","properties":{"job":{"type":"string","description":"The name of the job","example":"JOBA","exampleSetFlag":true,"types":["string"]},"step-count":{"type":"integer","description":"The number of steps in the job","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"steps":{"type":"array","description":"The list of steps in the job","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7JobStep","exampleSetFlag":false},"types":["array"]}},"description":"The list of jobs that match the selection criteria","exampleSetFlag":false,"types":["object"]},"CA7JobSchedule":{"type":"object","properties":{"schid":{"type":"string","description":"The schedule ID of the scheduled job","example":"20","exampleSetFlag":true,"types":["string"]},"sequence-number":{"type":"string","description":"A sequence number, starting at 1, of this scheduling element within the schedule id","example":"1","exampleSetFlag":true,"types":["string"]},"start-time-minus-one":{"type":"string","description":"An indication of whether the start time is on the day before the due-out time (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"submit-time-minus-one":{"type":"string","description":"An indication of whether the submit time is on the day before the due-out time (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"july-to-june-schedule":{"type":"string","description":"An indication of whether the schedule is July-June (instead of January-December) (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"due-out-time":{"type":"string","description":"The due-out time of the scheduled job (in 0HHMMSS format)","example":"0010000","exampleSetFlag":true,"types":["string"]},"lead-time":{"type":"string","description":"The lead time of the scheduled job (in 0HHMMSS format)","example":"0001000","exampleSetFlag":true,"types":["string"]},"submit-time":{"type":"string","description":"The submit time of the scheduled job (in 0HHMMSS format)","example":"0003000","exampleSetFlag":true,"types":["string"]},"roll-option":{"type":"string","description":"The roll option for the schedule id.
Valid values are:
B = Roll the schedule back to the previous available processing day in the Base Calendar.
F = Roll forward the schedule to the next available processing day.
N = Do not roll. Schedule day must stand.
D = Do not roll and do not schedule.
","example":"D","exampleSetFlag":true,"types":["string"]},"calendar-build-date":{"type":"string","description":"Date on which the calendar was built","example":"2021-01-31","exampleSetFlag":true,"types":["string"]},"index":{"type":"string","description":"The index value for the schedule id","example":"0","exampleSetFlag":true,"types":["string"]},"schedule-modification-overlaid":{"type":"string","description":"An indication of whether a schedule modification (SCHDMOD) has been overlaid by a subsequent RESOLV command (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"schedule-modification-current":{"type":"string","description":"An indication of whether a schedule modification (SCHDMOD) has been made to this schedule (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"calendar-id":{"type":"string","description":"Contains the override of the default SCAL for this SCHID. The CC portion of the SCALyycc calendar","example":"P1","exampleSetFlag":true,"types":["string"]},"repeat-type":{"type":"string","description":"For repeat scheduling, the type of repeat job. This field determines how the submit time requirement is calculated for repeating jobs.
Valid values are:
C = CLOCK
S = START
E = END
","example":"C","exampleSetFlag":true,"types":["string"]},"repeat-interval":{"type":"string","description":"For repeat scheduling, the interval between repetitions of the job (in DDDHHMMSSNNNNNN format)","example":"000023000000000","exampleSetFlag":true,"types":["string"]},"repeat-count":{"type":"string","description":"For repeat scheduling, the number of times the job should be repeated","example":"5","exampleSetFlag":true,"types":["string"]},"repeat-stop-time":{"type":"string","description":"For repeat scheduling, the time after which the job should not be repeated (in 0HHMMSS format)","example":"0140000","exampleSetFlag":true,"types":["string"]},"sequence-timestamp":{"type":"string","description":"Can be used to sequence the schedule ids into the order in which they were created. This date/time stamp does not indicate when the schedule id was created, but only the order in which they were created","example":"2021-01-15 14:06:24.741028","exampleSetFlag":true,"types":["string"]},"description":{"type":"string","description":"The description of this type of schedule element.
Valid values are:
ANNUAL
DAILY
MONTHLY
SYMMETRIC
WEEKLY
","example":"WEEKLY","exampleSetFlag":true,"types":["string"]},"do-not-run-on-days":{"type":"string","description":"An indication of whether rday or day indicates days not to run (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"uses-relative-days":{"type":"string","description":"An indication of whether scheduling is using relative days of the month (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"uses-days":{"type":"string","description":"An indication of whether scheduling is using specific days of the annual schedule (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"sunday":{"type":"string","description":"An indication of whether weekly scheduling on Sunday was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"monday":{"type":"string","description":"An indication of whether weekly scheduling on Monday was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"tuesday":{"type":"string","description":"An indication of whether weekly scheduling on Tuesday was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"wednesday":{"type":"string","description":"An indication of whether weekly scheduling on Wednesday was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"thursday":{"type":"string","description":"An indication of whether weekly scheduling on Thursday was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"friday":{"type":"string","description":"An indication of whether weekly scheduling on Friday was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"saturday":{"type":"string","description":"An indication of whether weekly scheduling on Saturday was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"january":{"type":"string","description":"An indication of whether monthly scheduling in January was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"february":{"type":"string","description":"An indication of whether monthly scheduling in February was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"march":{"type":"string","description":"An indication of whether monthly scheduling in March was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"april":{"type":"string","description":"An indication of whether monthly scheduling in April was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"may":{"type":"string","description":"An indication of whether monthly scheduling in May was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"june":{"type":"string","description":"An indication of whether monthly scheduling in June was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"july":{"type":"string","description":"An indication of whether monthly scheduling in July was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"august":{"type":"string","description":"An indication of whether monthly scheduling in August was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"september":{"type":"string","description":"An indication of whether monthly scheduling in September was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"october":{"type":"string","description":"An indication of whether monthly scheduling in October was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"november":{"type":"string","description":"An indication of whether monthly scheduling in November was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"december":{"type":"string","description":"An indication of whether monthly scheduling in December was specified (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"day-number-is-negative":{"type":"string","description":"An indication of whether the day/relative day shown in day-number is negative (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"week-number-is-negative":{"type":"string","description":"An indication of whether the week shown in week-number is negative (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"day-number":{"type":"string","description":"The day or relative day number","example":"15","exampleSetFlag":true,"types":["string"]},"week-number":{"type":"string","description":"The week number","example":"-2","exampleSetFlag":true,"types":["string"]},"symmetric-start":{"type":"string","description":"The Julian day of the year on which the symmetric schedule is to begin for symmetric scheduling","example":"181","exampleSetFlag":true,"types":["string"]},"symmetric-span":{"type":"string","description":"The number of days between scheduled processing cycles for symmetric scheduling","example":"10","exampleSetFlag":true,"types":["string"]}},"description":"The list of schedules for the scheduled job","exampleSetFlag":false,"types":["object"]},"CA7ScheduledJob":{"type":"object","properties":{"job":{"type":"string","description":"The scheduled job name","example":"JOBA","exampleSetFlag":true,"types":["string"]},"default-schedule-calendar-id":{"type":"string","description":"The default schedule calendar ID of the scheduled job","example":"SCAL21AP","exampleSetFlag":true,"types":["string"]},"schedule-lock":{"type":"string","description":"An indication whether the schedule has been updated and needs to be resolved (Y/N).
Valid values are:
Y - The schedule has been updated and needs to be resolved
N - The schedule is resolved
","example":"N","exampleSetFlag":true,"types":["string"]},"last-schedule-resolve-time":{"type":"string","description":"The date and time when the job's schedule was last resolved (in YYYY-MM-DD HH:MM:SS format)","example":"2021-01-15 13:42:35","exampleSetFlag":true,"types":["string"]},"job-schedule-count":{"type":"integer","description":"The number of schedules for the scheduled job","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"job-schedules":{"type":"array","description":"The list of schedules for the scheduled job","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7JobSchedule","exampleSetFlag":false},"types":["array"]}},"description":"The list of scheduled jobs","exampleSetFlag":false,"types":["object"]},"CA7ScheduledJobsListResponse":{"type":"object","properties":{"scheduled-job-count":{"type":"integer","description":"The number of scheduled jobs that match the selection criteria","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"scheduled-jobs":{"type":"array","description":"The list of scheduled jobs","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7ScheduledJob","exampleSetFlag":false},"types":["array"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"database-name":{"type":"string","description":"The CA 7 logical database name","example":"DB1","exampleSetFlag":true,"types":["string"]},"database-url":{"type":"string","description":"The Database URL","example":"jdbc:datacom://domain:port/ServerName=DCName","exampleSetFlag":true,"types":["string"]}},"exampleSetFlag":false,"types":["object"]},"CA7JobResourceJob":{"type":"object","properties":{"job":{"type":"string","description":"The name of the job","example":"JOBA","exampleSetFlag":true,"types":["string"]},"resource-count":{"type":"integer","description":"The number of resources for the job","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"resources":{"type":"array","description":"The list of resources for the job","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Ca7JobResource","exampleSetFlag":false},"types":["array"]}},"description":"The list of jobs that match the selection criteria","exampleSetFlag":false,"types":["object"]},"CA7JobResourceListResponse":{"type":"object","properties":{"job-count":{"type":"integer","description":"The number of jobs that match the selection criteria","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"jobs":{"type":"array","description":"The list of jobs that match the selection criteria","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7JobResourceJob","exampleSetFlag":false},"types":["array"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"database-name":{"type":"string","description":"The CA 7 logical database name","example":"DB1","exampleSetFlag":true,"types":["string"]},"database-url":{"type":"string","description":"The Database URL","example":"jdbc:datacom://domain:port/ServerName=DCName","exampleSetFlag":true,"types":["string"]}},"exampleSetFlag":false,"types":["object"]},"Ca7JobResource":{"type":"object","properties":{"resource":{"type":"string","description":"The name of the virtual resource connected to this job","example":"FILE.SERVER","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"The schedule ID associated with this resource","example":"10","exampleSetFlag":true,"types":["string"]},"resource-count":{"type":"string","description":"For count resources, the quantity of the resource required by this job","example":"2","exampleSetFlag":true,"types":["string"]},"internal-user-id":{"type":"string","description":"The CA 7 internal user security designation","example":"0","exampleSetFlag":true,"types":["string"]},"step-name":{"type":"string","description":"Step name after which the resource is released","example":"BACKUP","exampleSetFlag":true,"types":["string"]},"type":{"type":"string","description":"The type of virtual resource.
Valid values are:
A = address space
C = resource count
Q = co-requisite
S = shared access
X = exclusive access
","example":"S","exampleSetFlag":true,"types":["string"]},"free":{"type":"string","description":"The FREE option controlling when the virtual resource is released from the job.
For type S (shared access) and X (exclusive access):
Valid values are:
A = Free if any step abends
F = Free when any job ends, either successfully or unsuccessfully
N = Do not free the resource at a successful job completion. The resource can be freed with the PRSCF command
Y = Free at a successful job completion
For type Q (co-requisite):
Valid values are:
A = Submitted if the resource is active
I = Submitted if the resource is inactive
For type A (address space):
Valid values are:
A = Submitted only if the resource is active on the same system as CA Workload Automation CA 7 Edition
I = Submitted if the resource is inactive on the same system as CA Workload Automation CA 7 Edition
For type C (resource count):
Valid values are:
A = Decrement the resource count when the job abends
F = Decrement the resource count when the job completes, either successfully or unsuccessfully
N = Do not decrement when the job completes
Y = Decrement when the job or step ends successfully
","example":"A","exampleSetFlag":true,"types":["string"]}},"description":"The list of resources for the job","exampleSetFlag":false,"types":["object"]},"CA7PredecessorJob":{"type":"object","properties":{"job":{"type":"string","description":"The predecessor job name","example":"JOBA","exampleSetFlag":true,"types":["string"]},"successor-job-count":{"type":"integer","description":"The number of jobs that are successors to this job","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"successor-jobs":{"type":"array","description":"The list of jobs that are successors to this job","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7SuccessorJob","exampleSetFlag":false},"types":["array"]}},"description":"The list of predecessor jobs","exampleSetFlag":false,"types":["object"]},"CA7RequirementSuccessorJobsListResponse":{"type":"object","properties":{"predecessor-job-count":{"type":"integer","description":"The number of predecessor jobs that match the selection criteria","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"predecessor-jobs":{"type":"array","description":"The list of predecessor jobs","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7PredecessorJob","exampleSetFlag":false},"types":["array"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"database-name":{"type":"string","description":"The CA 7 logical database name","example":"DB1","exampleSetFlag":true,"types":["string"]},"database-url":{"type":"string","description":"The Database URL","example":"jdbc:datacom://domain:port/ServerName=DCName","exampleSetFlag":true,"types":["string"]}},"exampleSetFlag":false,"types":["object"]},"CA7SuccessorJob":{"type":"object","properties":{"job":{"type":"string","description":"The name of the successor job","example":"JOBZ","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"The schedule ID of the successor job","example":"20","exampleSetFlag":true,"types":["string"]},"skip-run":{"type":"string","description":"An indication of whether this requirement should be skipped for the next execution of the successor job (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"next-only":{"type":"string","description":"An indication of whether this requirement is only for the next execution of the successor job (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"negative":{"type":"string","description":"An indication of whether this is a negative requirement (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"weak":{"type":"string","description":"An indication of whether this is a conditional (weak) requirement (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"lead-time":{"type":"string","description":"The lead time of the successor job in DDDHHMMSSNNNNNN format","example":"001003000000000","exampleSetFlag":true,"types":["string"]}},"description":"The list of jobs that are successors to this job","exampleSetFlag":false,"types":["object"]},"CA7RequirementPredecessor":{"type":"object","properties":{"type":{"type":"string","description":"The type of the predecessor object (JOB/DSN/USER)","example":"DSN","exampleSetFlag":true,"types":["string"]},"name":{"type":"string","description":"The name of the predecessor object","example":"DATASET.JOBZ","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"The schedule ID of the predecessor object","example":"20","exampleSetFlag":true,"types":["string"]},"time-created":{"type":"string","description":"The date and time this requirement was created","example":"2021-01-01 12:00:00.00","exampleSetFlag":true,"types":["string"]},"dataset-permanent":{"type":"string","description":"An indication of whether this predecessor dataset is permanent (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"dataset-sysin":{"type":"string","description":"An indication of whether this predecessor dataset is SYSIN (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"dataset-gdg":{"type":"string","description":"An indication of whether this predecessor dataset is a GDG (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"dataset-on-tape":{"type":"string","description":"An indication of whether this predecessor dataset is on tape (Y/N)","example":"Y","exampleSetFlag":true,"types":["string"]},"skip-run":{"type":"string","description":"An indication of whether this requirement should be skipped for the next execution of the predecessor job (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"next-only":{"type":"string","description":"An indication of whether this requirement is only for the next execution of the predecessor job (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"negative":{"type":"string","description":"An indication of whether this is a negative requirement (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"weak":{"type":"string","description":"An indication of whether this is a conditional (weak) requirement (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"lead-time":{"type":"string","description":"The lead time of the predecessor job in DDDHHMMSSNNNNNN format","example":"000100000000000","exampleSetFlag":true,"types":["string"]},"manually-added":{"type":"string","description":"An indication of whether this requirement was added manually (Y/N)","example":"N","exampleSetFlag":true,"types":["string"]},"dataset-creator":{"type":"string","description":"The name of the job that creates the dataset","example":"JOBZ","exampleSetFlag":true,"types":["string"]},"dataset-number":{"type":"string","description":"The internal number CA 7 has assigned to this dataset","example":"11","exampleSetFlag":true,"types":["string"]}},"description":"The list of predecessors to this job","exampleSetFlag":false,"types":["object"]},"CA7RequirementPredecessorListResponse":{"type":"object","properties":{"successor-job-count":{"type":"integer","description":"The number of successor jobs that match the selection criteria","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"successor-jobs":{"type":"array","description":"The list of successor jobs","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7RequirementPredecessorSuccessor","exampleSetFlag":false},"types":["array"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"database-name":{"type":"string","description":"The CA 7 logical database name","example":"DB1","exampleSetFlag":true,"types":["string"]},"database-url":{"type":"string","description":"The Database URL","example":"jdbc:datacom://domain:port/ServerName=DCName","exampleSetFlag":true,"types":["string"]}},"exampleSetFlag":false,"types":["object"]},"CA7RequirementPredecessorSuccessor":{"type":"object","properties":{"job":{"type":"string","description":"The successor job name","example":"JOBA","exampleSetFlag":true,"types":["string"]},"predecessor-count":{"type":"integer","description":"The number of predecessors to this job","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"predecessors":{"type":"array","description":"The list of predecessors to this job","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7RequirementPredecessor","exampleSetFlag":false},"types":["array"]}},"description":"The list of successor jobs","exampleSetFlag":false,"types":["object"]},"CA7Prose":{"type":"object","properties":{"prose-line-number":{"type":"string","description":"The line number of the prose statement","example":"20","exampleSetFlag":true,"types":["string"]},"prose-text":{"type":"string","description":"The text of the prose statement","example":"FLJOB00 IS THE FIRST OF 10 JOBS IN THE FLJOBSYS.","exampleSetFlag":true,"types":["string"]}},"description":"The prose statement information","exampleSetFlag":false,"types":["object"]},"CA7ProseJob":{"type":"object","properties":{"job":{"type":"string","description":"The job name","example":"JOBA","exampleSetFlag":true,"types":["string"]},"prose-dataset-number":{"type":"string","description":"The prose data set number","example":"17","exampleSetFlag":true,"types":["string"]},"prose-statement-count":{"type":"integer","description":"The number of prose statements for the job","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"prose-statements":{"type":"array","description":"The prose statements for the job","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7Prose","exampleSetFlag":false},"types":["array"]}},"description":"Prose information for the selected job","exampleSetFlag":false,"types":["object"]},"CA7ProseJobListResponse":{"type":"object","properties":{"job-count":{"type":"integer","description":"The number of jobs that match the selection criteria","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"jobs":{"type":"array","description":"The list of jobs that match the selection criteria","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7ProseJob","exampleSetFlag":false},"types":["array"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"database-name":{"type":"string","description":"The CA 7 logical database name","example":"DB1","exampleSetFlag":true,"types":["string"]},"database-url":{"type":"string","description":"The Database URL","example":"jdbc:datacom://domain:port/ServerName=DCName","exampleSetFlag":true,"types":["string"]}},"exampleSetFlag":false,"types":["object"]},"CA7JobDefintionListResponse":{"type":"object","properties":{"job-defintion-count":{"type":"integer","description":"The number of job definitions that match the selection criteria","format":"int32","example":1,"exampleSetFlag":true,"types":["integer"]},"job-definitions":{"type":"array","description":"The list of job defintions","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Ca7JobDefintion","exampleSetFlag":false},"types":["array"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]},"database-name":{"type":"string","description":"The CA 7 logical database name","example":"DB1","exampleSetFlag":true,"types":["string"]},"database-url":{"type":"string","description":"The Database URL","example":"jdbc:datacom://domain:port/ServerName=DCName","exampleSetFlag":true,"types":["string"]}},"exampleSetFlag":false,"types":["object"]},"Ca7JobDefintion":{"type":"object","properties":{"job":{"type":"string","description":"The z/OS job name","example":"PAYROLL","exampleSetFlag":true,"types":["string"]},"long-name":{"type":"string","description":"An alias name for this job. This name may be used by scheduling engines on other platforms,such as AutoSys.","example":"PAYROLLFROMUNIX","exampleSetFlag":true,"types":["string"]},"job-type":{"type":"string","description":"The type of the job, one of CPU, XPJOB or AGENT","example":"CPU","exampleSetFlag":true,"types":["string"]},"agent-job-type":{"type":"string","description":"The type of the agent job","example":"UNIX_JOB","exampleSetFlag":true,"types":["string"]},"system":{"type":"string","description":"The user-defined application system associated with this job","example":"ABC","exampleSetFlag":true,"types":["string"]},"owner":{"type":"string","description":"The ID identifying ownership of this job","example":"JOHN01","exampleSetFlag":true,"types":["string"]},"jobnet":{"type":"string","description":"The name of CPU job network of which this job is a part","example":"NET1","exampleSetFlag":true,"types":["string"]},"jcl-member":{"type":"string","description":"Raw data at JQREC.JQJCLMEM.","example":"CA75LG31","exampleSetFlag":true,"types":["string"]},"last-update-user":{"type":"string","description":"Userid that last updated the prose element","example":"MIKE01","exampleSetFlag":true,"types":["string"]},"arfset":{"type":"string","description":"The collection of ARF definitions that apply to this job","example":"ARFCA7","exampleSetFlag":true,"types":["string"]},"drclass":{"type":"string","description":"The job's disaster recovery class","example":"A","exampleSetFlag":true,"types":["string"]},"lterm":{"type":"string","description":"The logical terminal name to which messages about this job should be routed.","example":"MASTER","exampleSetFlag":true,"types":["string"]},"mainid":{"type":"string","description":"A number.If positive, the CPU number on which the job may execute. If negative, the CPU number on which the job may not execute.","example":"0","exampleSetFlag":true,"types":["string"]},"uid":{"type":"string","description":"The CA 7 internal user security designation","example":"0","exampleSetFlag":true,"types":["string"]},"prior-run-ca7#":{"type":"string","description":"The CA 7 job number for the last execution of this job","example":"34","exampleSetFlag":true,"types":["string"]},"job-region":{"type":"string","description":"Amount of storage (in kilobytes) requested for this job","example":"6363","exampleSetFlag":true,"types":["string"]},"workload-balancing-priority":{"type":"string","description":"CA 7 Workload Balancing priority assigned to this job.","example":"2","exampleSetFlag":true,"types":["string"]},"condition-code":{"type":"string","description":"Return code value used to determine if the job succeeded or failed","example":"0","exampleSetFlag":true,"types":["string"]},"number-runs":{"type":"string","description":"Number of times this job has been executed","example":"15","exampleSetFlag":true,"types":["string"]},"number-late":{"type":"string","description":"Number of times this job has been marked late.","example":"2","exampleSetFlag":true,"types":["string"]},"number-restart":{"type":"string","description":"Number of times this job has been restarted.","example":"5","exampleSetFlag":true,"types":["string"]},"average-cpu-time":{"type":"string","description":"Average CPU time per execution of this job.Format is DDD HH MM SS.NNNNNN","example":"1000000","exampleSetFlag":true,"types":["string"]},"number-1-tape-man":{"type":"string","description":"Number of type 1 tape drives required by this job. This number is manually entered","example":"0","exampleSetFlag":true,"types":["string"]},"number-1-tape-calc":{"type":"string","description":"Number of type 1 tape drives used by this job, as indicated by LOAD or analyze","example":"0","exampleSetFlag":true,"types":["string"]},"number-2-tape-man":{"type":"string","description":"Number of type 2 tape drives required by this job. This number is manually entered","example":"1","exampleSetFlag":true,"types":["string"]},"number-2-tape-calc":{"type":"string","description":"Number of type 2 tape drives used by this job, as indicated by LOAD or analyze","example":"2","exampleSetFlag":true,"types":["string"]},"prose-number":{"type":"string","description":"Number of the prose text associated with this job, or zero","example":"3","exampleSetFlag":true,"types":["string"]},"jcl-library":{"type":"string","description":"Either an ampersand (&) followed by the name of the JCL library, or a three digit number of the JCL library","example":"&JFMCNTL or 145","exampleSetFlag":true,"types":["string"]},"last-update-time":{"type":"string","description":"The date and time of the last update to the job definition.","example":"2020-09-24 10:32:40.0","exampleSetFlag":true,"types":["string"]},"end-time":{"type":"string","description":"The date and time of the last completion of the job.","example":"1970-01-01 00:00:00.0","exampleSetFlag":true,"types":["string"]},"start-time":{"type":"string","description":"The date and time when the job last started.","example":"2020-11-02 13:24:54.9","exampleSetFlag":true,"types":["string"]},"sched-last-resolved-time":{"type":"string","description":"The date and time when the job's schedule was last resolved","example":"1970-01-01 00:00:00.0","exampleSetFlag":true,"types":["string"]},"elapsed-time":{"type":"string","description":"The average amount of time for the job to complete, stored as DDD HH MM SS NNNNNN.","example":"100000000","exampleSetFlag":true,"types":["string"]},"schedule-before-time":{"type":"string","description":"The don't schedule before date and time for the job.","example":"2021-01-01 01:00:00.0","exampleSetFlag":true,"types":["string"]},"schedule-expiration-date":{"type":"string","description":"Schedule Expiration Date. Used to determine if SCHDMOD OVERLAID status should be reset after a RESOLV is done.","example":"1970-01-01","exampleSetFlag":true,"types":["string"]},"job-requirement-lead-time":{"type":"string","description":"Job requirement lead time, in format DDD HH MM SS.NNNNNN.","example":"0","exampleSetFlag":true,"types":["string"]},"dataset-requirement-lead-time":{"type":"string","description":"Dataset requirement lead time, in format DDD HH MM SS.NNNNNN","exampleSetFlag":false,"types":["string"]},"timezone-offset":{"type":"string","description":"If TZONE_EXISTS is set to Y, then this field contains the HHMM (+/-) time zone offset","example":"0500","exampleSetFlag":true,"types":["string"]},"timezone-exists":{"type":"string","description":"Y if TZONE_OFFSET contains a time zone offset, or N if not.","example":"Y","exampleSetFlag":true,"types":["string"]},"wlb-job-class":{"type":"string","description":"CA 7 Workload Balancing class","example":"A","exampleSetFlag":true,"types":["string"]},"message-class":{"type":"string","description":"The job's MSGCLASS, informational only, no validation performed.","example":"N","exampleSetFlag":true,"types":["string"]},"relational-operator":{"type":"string","description":"Relational operator to be used with COND_CODE to determine if the job has successfully completed or not.
Valid values are:
0, 00, or IG - no test;
GT - greater than; GE - greater than or equal;
EQ - equal; LT - less than; LE - Less than or equal;
NE - not equal;
#S - use #SCC cards in job's JCL","example":"NE","exampleSetFlag":true,"types":["string"]},"last-maintenance-type":{"type":"string","description":"The type of the last maintenance done to this job.
Valid values are: A - ANALYZE;
L - LOAD; M - database maintenance;
S - SMF updates","example":"L","exampleSetFlag":true,"types":["string"]},"job-lock":{"type":"string","description":"Y if job is locked, N if not","example":"Y","exampleSetFlag":true,"types":["string"]},"job-restart":{"type":"string","description":"Y if job can be restarted, N if not","example":"N","exampleSetFlag":true,"types":["string"]},"next-cycle-off":{"type":"string","description":"Y if scheduling for this job has been turned off, N if not","example":"N","exampleSetFlag":true,"types":["string"]},"next-cycle-skip":{"type":"string","description":"Y if scheduling for the next cycle of this job should be skipped, N if not","example":"Y","exampleSetFlag":true,"types":["string"]},"start-time-set":{"type":"string","description":"'Y' indicates a start date/time has been set for the last time job ran to successful completion.","example":"Y","exampleSetFlag":true,"types":["string"]},"job-scheduled":{"type":"string","description":"Y if job is scheduled, N if not","example":"N","exampleSetFlag":true,"types":["string"]},"ca11-job":{"type":"string","description":"If 'Y', the RESTART keyword was set to 'Y' in the batch job definition. RESTART is an alias of INSRTRMS.","example":"Y","exampleSetFlag":true,"types":["string"]},"has-triggers":{"type":"string","description":"Y if the job triggers other objects, N if not.","example":"Y","exampleSetFlag":true,"types":["string"]},"job-override":{"type":"string","description":"Y if the job marked for override, N if not.","example":"N","exampleSetFlag":true,"types":["string"]},"non-executable":{"type":"string","description":"Y if job marked non-executable, N if job is executable.","example":"Y","exampleSetFlag":true,"types":["string"]},"job-verify":{"type":"string","description":"Y if job marked for verification, N if not.","example":"Y","exampleSetFlag":true,"types":["string"]},"insert-ca11-rms":{"type":"string","description":"Y if the CA 11 Run Management Step (RMS) should be inserted, N if not.","example":"Y","exampleSetFlag":true,"types":["string"]},"hold":{"type":"string","description":"Y if job is held on entry to the queues, N if not.","example":"N","exampleSetFlag":true,"types":["string"]},"ignore-requirements":{"type":"string","description":"Y if job ignores requirements, N if not.","example":"Y","exampleSetFlag":true,"types":["string"]},"jcl-prior-run-queue":{"type":"string","description":"Y if the job's JCL is retained in the prior run queue, N if not.","example":"Y","exampleSetFlag":true,"types":["string"]},"job-jcl-in-override-library":{"type":"string","description":"Y if the job's JCL is in the override library, N if not.","example":"N","exampleSetFlag":true,"types":["string"]},"load-status":{"type":"string","description":"Y if the job is load status, N if not","example":"Y","exampleSetFlag":true,"types":["string"]},"schedule-lock":{"type":"string","description":"'Y' indicates schedule has been updated and RESOLV is needed.","example":"Y","exampleSetFlag":true,"types":["string"]},"need-load":{"type":"string","description":"Y if the job needs to be loaded, N if not.
Set to 'Y' job is first added to CA 7 database.","example":"Y","exampleSetFlag":true,"types":["string"]},"need-reload":{"type":"string","description":" Set to 'Y' if RELOAD=Y, or if SASSSM5C invoked,else is 'N'","example":"N","exampleSetFlag":true,"types":["string"]},"no-load":{"type":"string","description":"Set to 'Y' if RELOAD=X, else set to 'N'","example":"Y","exampleSetFlag":true,"types":["string"]},"ca7touni-job":{"type":"string","description":"Y if job is a CA7TOUNI job, N if not.","example":"Y","exampleSetFlag":true,"types":["string"]},"xpsi-job":{"type":"string","description":"Y if the job is an XPSI job, N if not.","example":"N","exampleSetFlag":true,"types":["string"]},"xpsi-no-prmlib":{"type":"string","description":"If 'N' there is no XPJOB PARMLIB member.
If 'Y' a PARMLIB member and library specified in the job definition.","example":"Y","exampleSetFlag":true,"types":["string"]},"xpsi-no-prmdef":{"type":"string","description":"If 'N', there is no XPJOB XP PARM data.
If 'Y'there is data in the XPJOB XP PARM field.","example":"Y","exampleSetFlag":true,"types":["string"]},"xpsi-su-type":{"type":"string","description":"Type of 'switch user' command to execute.
'Y'executes SU including .PROFILE.
'N' just executes SU.","exampleSetFlag":false,"types":["string"]},"print-requirements":{"type":"string","description":"Y if the job's requirements are printed in the browse log on entry to the queues, N if not.","example":"Y","exampleSetFlag":true,"types":["string"]},"issue-prompts":{"type":"string","description":"Y if prompts are issued if the job is late, N if not.","example":"Y","exampleSetFlag":true,"types":["string"]},"suppress-error-requirements":{"type":"string","description":"If 'Y', list error messages for job requirements not used.
If 'N', suppress messages for job requirements not used.","example":"Y","exampleSetFlag":true,"types":["string"]},"suppress-error-dsn-requirements":{"type":"string","description":" If 'Y', then list error messages for DSNs used at.
execution but not found in the CA 7 database.
If 'N' suppress errors.","example":"Y","exampleSetFlag":true,"types":["string"]},"xpsi-node":{"type":"string","description":"Primary XPSI node for this job.","example":"A11SENF","exampleSetFlag":true,"types":["string"]},"xpsi-exec":{"type":"string","description":"Executable for this XPSI job.","example":"ca75xp78,monitor=ca7ca78","exampleSetFlag":true,"types":["string"]},"xpsi-param":{"type":"string","description":"PARM1 value from the DB.10 screen.","example":"t=30","exampleSetFlag":true,"types":["string"]},"agent-name":{"type":"string","description":"The name of the agent where this job will execute.","example":"unixag","exampleSetFlag":true,"types":["string"]},"agent-user":{"type":"string","description":"The userid with which this agent job will execute.","example":"unixusr","exampleSetFlag":true,"types":["string"]},"executable":{"type":"string","description":"Y if job marked as executable, N if not.","example":"Y","exampleSetFlag":true,"types":["string"]},"schedule-after-time":{"type":"string","description":"The don't schedule after date and time for the job.","example":"2021-01-01 01:00:00.0","exampleSetFlag":true,"types":["string"]}},"description":"The list of job defintions","exampleSetFlag":false,"types":["object"]},"CA7LogList":{"type":"object","properties":{"logs":{"type":"array","description":"Log file name","example":["receiver.log","transmitter.log"],"exampleSetFlag":true,"items":{"type":"string","exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"A list of the Agent's log files","exampleSetFlag":false,"types":["object"]},"CA7AgentDetails":{"type":"object","properties":{"installDate":{"type":"string","description":"The date and time when the Agent was installed","example":"Wed Mar 30 14:27:58 UTC 2022","exampleSetFlag":true,"types":["string"]},"jreVersion":{"type":"string","description":"The version of the Java Runtime Environment the Agent is executing in","example":"1.8.0_252","exampleSetFlag":true,"types":["string"]},"jreBundled":{"type":"string","description":"An indication of whether the Agent is executing in the JRE that was bundled with the Agent.

true - The Agent is executing in the JRE that was bundled with the Agent
false - The Agent is executing in a JRE other than the JRE that was bundled with the Agent
","example":"true","exampleSetFlag":true,"types":["string"]},"osArch":{"type":"string","description":"The operating system architecture of the Agent machine","example":"x86_64","exampleSetFlag":true,"types":["string"]},"bootTime":{"type":"string","description":"The operating system restart date and time of the Agent machine","example":"2022-08-30 15:24:33","exampleSetFlag":true,"types":["string"]},"startTime":{"type":"string","description":"The date and time when the Agent was last started","example":"2022-08-30 15:24:33","exampleSetFlag":true,"types":["string"]},"pid":{"type":"string","description":"The process ID (PID) of the Agent","example":"11002","exampleSetFlag":true,"types":["string"]}},"exampleSetFlag":false,"types":["object"]},"CA7Agent":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Agent as known by CA 7","example":"AGENT_01","exampleSetFlag":true,"types":["string"]},"host":{"type":"string","description":"The TCP/IP address or hostname of the machine where the Agent is running","example":"agent01.company.com","exampleSetFlag":true,"types":["string"]},"port":{"type":"integer","description":"The TCP/IP port used for communication with the Agent","format":"int32","example":7520,"exampleSetFlag":true,"types":["integer"]},"status":{"type":"string","description":"The status of the Agent","example":"Up","exampleSetFlag":true,"types":["string"],"enum":["Up","Down","Unknown"]},"statusDetails":{"type":"string","description":"The status details of the Agent","example":"Active\nTime last message sent to Agent: 2023-01-09 11:14:51\nTime last message received from Agent: 2023-01-09 11:14:52","exampleSetFlag":true,"types":["string"]},"os":{"type":"string","description":"The operating system of the machine where the Agent is running","example":"Linux for amd64","exampleSetFlag":true,"types":["string"]},"version":{"type":"string","description":"The version of the Agent","example":"12.0","exampleSetFlag":true,"types":["string"]},"build":{"type":"string","description":"The build number of the Agent","example":"6181","exampleSetFlag":true,"types":["string"]}},"description":"The list of Agents defined to this instance of CA 7","exampleSetFlag":false,"types":["object"]},"CA7AgentList":{"type":"object","properties":{"agents":{"type":"array","description":"The list of Agents defined to this instance of CA 7","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/CA7Agent","exampleSetFlag":false},"types":["array"]}},"exampleSetFlag":false,"types":["object"]},"VersionControllerResponse":{"type":"object","properties":{"Product Version":{"type":"string","description":"The CA 7 Rest API version","readOnly":true,"example":"12.1.06","exampleSetFlag":true,"types":["string"]},"Build Number":{"type":"string","description":"The build number","readOnly":true,"example":"1111","exampleSetFlag":true,"types":["string"]},"Build Time":{"type":"string","description":"The date and time when the build was done, GMT","readOnly":true,"example":"2020-01-01 12:00","exampleSetFlag":true,"types":["string"]},"CA 7 Supported Version":{"type":"string","description":"The minimum CA 7 version","readOnly":true,"example":"12.1.01","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest API Version Response","exampleSetFlag":false,"types":["object"]},"UniqueKeyResponse":{"type":"object","properties":{"time":{"type":"string","description":"The date and time when key was generated","readOnly":true,"example":"2022-09-12-10.25.03","exampleSetFlag":true,"types":["string"]},"transaction-key":{"type":"string","description":"The unique transaction key","readOnly":true,"example":"c2f6ea1c-53ae-11ed-86ca-8f0804f57d80","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Information Response","exampleSetFlag":false,"types":["object"]},"CommandCountResourceDeleteResponse":{"type":"object","properties":{"ca7messages":{"type":"string","description":"CA 7 Response to the Delete Resource Count Resource command","example":"- 22062 173447 RM.7;RSC7-00 FORMAT FUNCTION SUCCESSFUL;- 22062 173451 UPD,RM.7,OPT=D,DSN=PAYROLL.RCT,TOTAL=125;RSC7-00 UPDATE FUNCTION SUCCESSFUL","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 Delete Resource Count Resource command","example":"RM.7;UPD,RM.7,OPT=D,DSN=PAYROLL.RCT","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Delete Resource Count Resource Request Response","exampleSetFlag":false,"types":["object"]},"CommandCountResourceDeleteError":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: - 22062 174226 RM.7;RSC7-00 FORMAT FUNCTION SUCCESSFUL;- 22062 174226 UPD,RM.7,OPT=D,DSN=ATEST.RCT;RSC7-04 TOTAL AND IN USE COUNTS MUST BE ZERO TO DELETE","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandCountResourceDelete":{"required":["resource-name"],"type":"object","properties":{"resource-name":{"type":"string","description":"Specifies the name of the Resource Count Resource to delete.
Limits: 1 to 39 alphanumeric characters and periods","example":"PAYROLL.RCT","exampleSetFlag":true,"types":["string"]}},"description":"Delete Resource Count Resource parameters","exampleSetFlag":false,"types":["object"]},"CommandJobTriggerDeleteResponse":{"type":"object","properties":{"ca7messages":{"type":"string","description":"CA 7 Response to the Delete Job Trigger command","example":"- 22080 175418 SCHD;SM70-00 ENTER SCHEDULE TYPE;- 22080 175418 TRGR;SM75-00 FORMAT FUNCTION SUCCESSFUL;ENTER INPUT FOR NEXT REQUEST;- 22080 175418 UPD,JTRG,OPT=D,JOB=JOBA,SCHID=42,TJOB=JOBB;SM75-00 UPD FUNCTION SUCCESSFUL;ENTER INPUT FOR NEXT REQUEST;- 22080 175418 DBM;SDM0-00 ENTER CA-7 TRANSACTION","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 Delete Job Trigger command","example":"SCHD;TRGR;UPD,JTRG,OPT=D,JOB=JOBA,SCHID=42,TJOB=JOBB;DBM","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Delete Job Trigger Request Response","exampleSetFlag":false,"types":["object"]},"CommandJobTriggerDeleteError":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: - 22080 175449 SCHD;SM70-00 ENTER SCHEDULE TYPE;- 22080 175449 TRGR;SM75-00 FORMAT FUNCTION SUCCESSFUL;ENTER INPUT FOR NEXT REQUEST;- 22080 175449 UPD,JTRG,OPT=D,JOB=JOBA,SCHID=42,TJOB=JOBB;SM75-02 TRGD-JOB NOT FOUND;- 22080 175449 DBM;SDM0-00 ENTER CA-7 TRANSACTION","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandJobTriggerDelete":{"required":["job","triggered-job"],"type":"object","properties":{"job":{"type":"string","description":"Specifies the job name whose successful completion causes triggering.
Limits: 1 to 8 alphanumeric characters","example":"JOBA","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"(Optional) Specifies for which schedule ID of the triggering job the triggered-job is scheduled.
Default: 0 (all schedule IDs)
Limits: 1 to 3 numeric characters from 0 through 999","example":"42","exampleSetFlag":true,"types":["string"]},"triggered-job":{"type":"string","description":"Specifies the job name that the completion of the triggering job triggers.
Limits: 1 to 8 alphanumeric characters","example":"JOBB","exampleSetFlag":true,"types":["string"]}},"description":"Delete Job Trigger parameters","exampleSetFlag":false,"types":["object"]},"CommandScheduleDeleteResponse":{"type":"object","properties":{"ca7messages":{"type":"string","description":"CA 7 Response to the Delete Schedule API","example":"- 22055 145547 LSCHD,JOB=CA75SCHD;1LSCHD,JOB=CA75SCHD;LIST= JOB=CA75SCHD DATE=22.055 PAGE 0001;JOB SYSTEM SCHEDULE #SCH -BASE CALENDAR- PROSE COMMENTS;NAME NAME IDS USERID B-DATE NUM;CA75SCHD YES 002 SCAL 03 00000 *NONE* NXTCYC=SKP;SCHED NEEDS RESOL;SLIG-00 REQUEST COMPLETED AT 14:55:47 ON 22.055;- 22055 145547 SCHD;SM70-00 ENTER SCHEDULE TYPE;- 22055 145547 JOB;SM71-00 ENTER INPUT DATA;- 22055 145548 CLEAR;SM71-00 CLEAR FUNCTION SUCCESSFUL;- 22055 145548 FETCH,JOB=CA75SCHD;SM71-00 FETCH FUNCTION SUCCESSFUL;- 22055 145548 EDIT;SM72-00 LIST FUNCTION SUCCESSFUL;- 22055 145549 DELETE,SCHID=071;SM72-00 DELETE FUNCTION SUCCESSFUL;- 22055 145549 SAVE;SM71-00 ENTER INPUT DATA;- 22055 145549 REPL,JOB=CA75SCHD,SCAL=03;SM71-00 REPL FUNCTION SUCCESSFUL;SCHEDULE MUST BE RESOLVED;- 22055 145550 DBM;SDM0-00 ENTER CA-7 TRANSACTION","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 Delete command","example":"DELETE,SCHID=071","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Delete Schedule Request Response","exampleSetFlag":false,"types":["object"]},"CommandScheduleDeleteError":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"The 091 schid is not found.","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandScheduleDelete":{"required":["job","schid"],"type":"object","properties":{"job":{"type":"string","description":"The name of the job","example":"JOBA","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"Specifies the numeric schedule ID on which the user wants to perform the specified action.
Limits:
1 to 3 numeric characters from 1 through 999 ","example":"01","exampleSetFlag":true,"types":["string"]}},"description":"Delete schedule parameters","exampleSetFlag":false,"types":["object"]},"CommandVariableResourceDeleteResponse":{"type":"object","properties":{"ca7messages":{"type":"string","description":"CA 7 Response to the Delete Variable Resource command","example":"- 22076 170432 RM.1;1,RM.1,,SCHID= DATE=22.076 PAGE 0001;RSC1-00 FORMAT FUNCTION SUCCESSFUL;- 22076 170433 UPD,RM.1,OPT=D,TYPE=VAR,JOB=JOBA,SCHID=42,RSRC=SCHENV.VARNAME;1UPD,RM.1,JOBA,SCHID=042 DATE=22.076 PAGE 0001;RSC1-00 UPD FUNCTION SUCCESSFUL","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 Delete Variable Resource command","example":"RM.1;UPD,RM.1,OPT=D,TYPE=VAR,JOB=JOBA,SCHID=42,RSRC=SCHENV.VARNAME","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Delete Variable Resource Request Response","exampleSetFlag":false,"types":["object"]},"CommandVariableResourceDeleteError":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: - 22076 170332 RM.1;1,RM.1,,SCHID= DATE=22.076 PAGE 0001;RSC1-00 FORMAT FUNCTION SUCCESSFUL;- 22076 170332 UPD,RM.1,OPT=D,TYPE=VAR,JOB=JOBA,SCHID=42,RSRC=SCHENV.VARNAME;1UPD,RM.1,JOBA,SCHID=042 DATE=22.076 PAGE 0001;RSC1-02 RESOURCE NOT FOUND","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandVariableResourceDelete":{"required":["job","resource-name"],"type":"object","properties":{"job":{"type":"string","description":"Specifies the job name on which the indicated function is performed.
Limits: 1 to 8 alphanumeric characters","example":"JOBA","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
Default: 0, which indicates that the requirement holds for all schedule IDs
Limits: 1 to 3 numeric characters from 0 through 999","example":"42","exampleSetFlag":true,"types":["string"]},"resource-name":{"type":"string","description":"Specifies the resource name being connected to the job.
Limits: \"SCHENV.\" followed by 1 to 16 alphanumeric and @, #, $, _ characters","example":"SCHENV.VARNAME","exampleSetFlag":true,"types":["string"]}},"description":"Delete Job Variable Resource parameters","exampleSetFlag":false,"types":["object"]},"CommandSharedResourceDeleteResponse":{"type":"object","properties":{"ca7messages":{"type":"string","description":"CA 7 Response to the Delete Shared Resource command","example":"- 22075 154159 RM.1;1,RM.1,,SCHID= DATE=22.075 PAGE 0001;RSC1-00 FORMAT FUNCTION SUCCESSFUL;- 22075 154159 UPD,RM.1,OPT=D,TYPE=SHR,JOB=JOBA,SCHID=42,RSRC=PAYROLL.SHR;1UPD,RM.1,JOBA,SCHID=042 DATE=22.075 PAGE 0001;RSC1-00 UPD FUNCTION SUCCESSFUL","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 Delete Shared Resource command","example":"RM.1;UPD,RM.1,OPT=D,TYPE=SHR,JOB=JOBA,SCHID=42,RSRC=PAYROLL.SHR","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Delete Shared Resource Request Response","exampleSetFlag":false,"types":["object"]},"CommandSharedResourceDeleteError":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: - 22075 153118 RM.1;1,RM.1,,SCHID= DATE=22.075 PAGE 0001;RSC1-00 FORMAT FUNCTION SUCCESSFUL;- 22075 153119 UPD,RM.1,OPT=D,TYPE=SHR,JOB=JOBA,SCHID=42,RSRC=PAYROLL.SHR;1UPD,RM.1,JOBA,SCHID=042 DATE=22.075 PAGE 0001;RSC1-02 RESOURCE NOT FOUND","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandSharedResourceDelete":{"required":["job","resource-name"],"type":"object","properties":{"job":{"type":"string","description":"Specifies the job name on which the indicated function is performed.
Limits: 1 to 8 alphanumeric characters","example":"JOBA","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
Default: 0, which indicates that the requirement holds for all schedule IDs
Limits: 1 to 3 numeric characters from 0 through 999","example":"42","exampleSetFlag":true,"types":["string"]},"resource-name":{"type":"string","description":"Specifies the resource name being connected to the job.
Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks","example":"PAYROLL.SHR","exampleSetFlag":true,"types":["string"]}},"description":"Delete Job Shared Resource parameters","exampleSetFlag":false,"types":["object"]},"CommandJobCountResourceDeleteResponse":{"type":"object","properties":{"ca7messages":{"type":"string","description":"CA 7 Response to the Delete job Resource Count resource command","example":"- 22073 182841 RM.1;1,RM.1,,SCHID= DATE=22.073 PAGE 0001;RSC1-00 FORMAT FUNCTION SUCCESSFUL;- 22073 182842 UPD,RM.1,OPT=D,TYPE=RCT,JOB=JRESRCT,SCHID=42,RSRC=PAYROLL.RCT/1;1UPD,RM.1,JRESRCT,SCHID=042 DATE=22.073 PAGE 0001;RSC1-00 UPD FUNCTION SUCCESSFUL","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 Delete job Resource Count resource command","example":"RM.1;UPD,RM.1,OPT=D,TYPE=RCT,JOB=JRESRCT,SCHID=42,RSRC=PAYROLL.RCT/1","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Delete job Resource Count resource Request Response","exampleSetFlag":false,"types":["object"]},"CommandJobCountResourceDeleteError":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: - 22073 182806 RM.1;1,RM.1,,SCHID= DATE=22.073 PAGE 0001;RSC1-00 FORMAT FUNCTION SUCCESSFUL;- 22073 182806 UPD,RM.1,OPT=D,TYPE=RCT,JOB=JRESRCT,SCHID=44,RSRC=PAYROLL.RCT/1;1UPD,RM.1,JRESRCT,SCHID=044 DATE=22.073 PAGE 0001;RSC1-02 RESOURCE NOT FOUND","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandJobCountResourceDelete":{"required":["job","resource-name"],"type":"object","properties":{"job":{"type":"string","description":"Specifies the job name on which the indicated function is performed.
Limits: 1 to 8 alphanumeric characters","example":"JOBA","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
Default: 0, which indicates that the requirement holds for all schedule IDs
Limits: 1 to 3 numeric characters from 0 through 999","example":"42","exampleSetFlag":true,"types":["string"]},"resource-name":{"type":"string","description":"Specifies the resource name being connected to the job.
Limits: 1 to 39 characters, the first character must be non-blank, and no embedded blanks","example":"PAYROLL.RCT","exampleSetFlag":true,"types":["string"]}},"description":"Delete Job Resource Count Resource parameters","exampleSetFlag":false,"types":["object"]},"CommandExclusiveResourceDeleteResponse":{"type":"object","properties":{"ca7messages":{"type":"string","description":"CA 7 Response to the Delete Exclusive Resource command","example":"- 22077 122940 RM.1;1,RM.1,,SCHID= DATE=22.077 PAGE 0001;RSC1-00 FORMAT FUNCTION SUCCESSFUL;- 22077 122941 UPD,RM.1,OPT=D,TYPE=EXC,JOB=JOBA,SCHID=42,RSRC=PAYROLL.EXC;1UPD,RM.1,JOBA,SCHID=042 DATE=22.077 PAGE 0001;RSC1-00 UPD FUNCTION SUCCESSFUL","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 Delete Exclusive Resource command","example":"RM.1;UPD,RM.1,OPT=D,TYPE=EXC,JOB=JOBA,SCHID=42,RSRC=PAYROLL.EXC","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Delete Exclusive Resource Request Response","exampleSetFlag":false,"types":["object"]},"CommandExclusiveResourceDeleteError":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: - 22077 105655 RM.1;1,RM.1,,SCHID= DATE=22.077 PAGE 0001;RSC1-00 FORMAT FUNCTION SUCCESSFUL;- 22077 105655 UPD,RM.1,OPT=D,TYPE=EXC,JOB=JOBA,SCHID=42,RSRC=PAYROLL.EXC;1UPD,RM.1,JOBA,SCHID=042 DATE=22.077 PAGE 0001;RSC1-02 RESOURCE NOT FOUND","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandExclusiveResourceDelete":{"required":["job","resource-name"],"type":"object","properties":{"job":{"type":"string","description":"Specifies the job name on which the indicated function is performed.
Limits: 1 to 8 alphanumeric characters","example":"JOBA","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
Default: 0, which indicates that the requirement holds for all schedule IDs
Limits: 1 to 3 numeric characters from 0 through 999","example":"42","exampleSetFlag":true,"types":["string"]},"resource-name":{"type":"string","description":"Specifies the resource name being connected to the job.
Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks","example":"PAYROLL.EXC","exampleSetFlag":true,"types":["string"]}},"description":"Delete Job Exclusive Resource parameters","exampleSetFlag":false,"types":["object"]},"CommandResourceCorequisiteDeleteResponse":{"type":"object","properties":{"ca7messages":{"type":"string","description":"CA 7 Response to the Delete Corequisite Resource Response command","example":"- 22062 173447 UPD,RM.1,RSRC=JRESCRQ.RCT,JOB=JRESCRQ,SCHID=3,TYPE=CRQ,OPT=D;1UPD,RM.1,JRESCRQ,SCHID=003 PAGE 0001;RSC1-00 UPD FUNCTION SUCCESSFUL","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 Delete Corequisite Resource Command ","example":"UPD,RM.1,RSRC=JRESCRQ.RCT,JOB=JRESCRQ,SCHID=3,TYPE=CRQ,OPT=D","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Delete Corequisite Resource Response","exampleSetFlag":false,"types":["object"]},"CommandResourceCorequisiteDeleteError":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: -22073 143526 RM.1;1,RM.1,,SCHID= DATE=22.073 PAGE 0001;RSC1-00 FORMAT FUNCTION SUCCESSFUL;- 22073 143526 UPD,RM.1,RSRC=JRESCRQ.RCT,JOB=JRESCRQ,SCHID=77,TYPE=CRQ,OPT=D;1UPD,RM.1,JRESCRQ,SCHID=077 DATE=22.073 PAGE 0001;RSC1-02 RESOURCE NOT FOUND","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandResourceCorequisiteDelete":{"required":["job-name","resource-name"],"type":"object","properties":{"job-name":{"type":"string","description":"Specifies the job name on which the indicated function is performed.
Limits: 1 to 8 alphanumeric characters","example":"PAYROLL","exampleSetFlag":true,"types":["string"]},"resource-name":{"type":"string","description":"Specifies the resource name being connected to the job.
Limits: 1 to 44 characters, the first character must be nonblank, and no embedded blanks
Exception: If the resource connection is made to a resource count resource,
the resource name can be from 1 to 39 characters followed by a / (slash) and
a 1 through 4 numeric value indicating the number of occurrences for the resource that the job uses.
","example":"PAYROLL.RCT","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied.
A zero default cannot be specified for one connection and a nonzero schedule ID used for
a subsequent connection to the same job with the same user requirement description.
An attempt to make such a connection results in an error message that is issued.
Default: 0, which indicates that the requirement holds for all schedule IDs
Limits: 1 to 3 numeric characters from 0 through 999","example":"3","exampleSetFlag":true,"types":["string"]}},"description":"Delete Job Corequisite Resource parameters","exampleSetFlag":false,"types":["object"]},"CommandAddressSpaceResourceDeleteResponse":{"type":"object","properties":{"ca7messages":{"type":"string","description":"CA 7 Response to the Delete Address Space Resource command","example":"- 22070 110108 RM.1;1,RM.1,,SCHID= DATE=22.070 PAGE 0001;RSC1-00 FORMAT FUNCTION SUCCESSFUL;- 22070 110108 UPD,RM.1,OPT=D,TYPE=ASX,JOB=JOBA,SCHID=42,RSRC=PAYROLL.ASX;1UPD,RM.1,JOBA,SCHID=042 DATE=22.070 PAGE 0001;RSC1-00 UPD FUNCTION SUCCESSFUL","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 Delete Address Space Resource command","example":"RM.1;UPD,RM.1,OPT=D,TYPE=ASX,JOB=JOBA,SCHID=42,RSRC=PAYROLL.ASX","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Delete Address Space Resource Request Response","exampleSetFlag":false,"types":["object"]},"CommandAddressSpaceResourceDeleteError":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: - 22070 110338 RM.1;1,RM.1,,SCHID= DATE=22.070 PAGE 0001;RSC1-00 FORMAT FUNCTION SUCCESSFUL;- 22070 110339 UPD,RM.1,OPT=D,TYPE=ASX,JOB=JOBA,SCHID=42,RSRC=PAYROLL.ASX;1UPD,RM.1,JOBA,SCHID=042 DATE=22.070 PAGE 0001;RSC1-02 RESOURCE NOT FOUND","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandAddressSpaceResourceDelete":{"required":["job","resource-name"],"type":"object","properties":{"job":{"type":"string","description":"Specifies the job name on which the indicated function is performed.
Limits: 1 to 8 alphanumeric characters","example":"JOBA","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
Default: 0, which indicates that the requirement holds for all schedule IDs
Limits: 1 to 3 numeric characters from 0 through 999","example":"42","exampleSetFlag":true,"types":["string"]},"resource-name":{"type":"string","description":"Specifies the resource name being connected to the job.
Limits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks","example":"PAYROLLJ","exampleSetFlag":true,"types":["string"]}},"description":"Delete Job Address Space Resource parameters","exampleSetFlag":false,"types":["object"]},"CommandDeleteRequirementsResponse":{"type":"object","properties":{"ca7#":{"type":"string","description":"The CA 7 job number","example":"0001","exampleSetFlag":true,"types":["string"]},"ca7messages":{"type":"string","description":"CA 7 Response to the Update Requirements command","example":"SM61-00 FORMAT FUNCTION SUCCESSFUL
UPD,USR,MARCUS,OPT=D,SCHID=2,NEXTRUN=ONLY,USR=Free form text","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 Update Requirements command","example":"JOBCONN;UPD,USR,MARCUS,OPT=D,SCHID=2,NEXTRUN=ONLY,USR=Free form text","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Delete Requirements Request Response","exampleSetFlag":false,"types":["object"]},"ErrorDeleteRequirementsResponse":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: SM61-02 TESTJOB NOT FOUND","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandDeleteRequirements":{"required":["job","nextrun","predobject","predtype","schid"],"type":"object","properties":{"job":{"type":"string","description":"The name of the job that requires the predecessor","example":"PAYROLL","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"The schedule id of requiring job","example":"0009","exampleSetFlag":true,"types":["string"]},"predtype":{"type":"string","description":"The predecessor type","example":"USER","exampleSetFlag":true,"types":["string"],"enum":["JOB","DSN","USER"]},"nextrun":{"type":"string","description":"The status of predecessor for next run of job","example":"ONLY","exampleSetFlag":true,"types":["string"],"enum":["YES","ONLY","SKIP"]},"predobject":{"type":"string","description":"The predecessor. Values vary with predtype.
When “predtype”:”JOB”, “predobject” is 1-8 character name of required job.
When “predtype”:”DSN”,”predobject” is 1-44 name of required dataset.
When “predtype”:”USER” then “predobject” is 1-44 character user requirement text.","example":"USER","exampleSetFlag":true,"types":["string"]},"leadtime":{"type":"string","description":"The satisfaction lead time in hours.
This may be honored when “predtype” is “job or “DSN”","example":"04","exampleSetFlag":true,"types":["string"]},"permanent":{"type":"string","description":"Indicates that this predecessor is permanent, that is always considered satisfied.
This parameter only applies when “predtype” is “DSN”.","example":"Y","exampleSetFlag":true,"types":["string"],"enum":["Y","N"]}},"description":"Delete requirements parameters","exampleSetFlag":false,"types":["object"]},"CommandJobDeleteResponse":{"type":"object","properties":{"ca7messages":{"type":"string","description":"CA 7 Response to the Delete Job Definition command","example":"- 22054 151340 JOB;SM20-00 ENTER INPUT DATA;- 22054 151341 DELETE,JOBA;SM20-00 DELETE SUCCESSFUL;- 22054 151341 DBM;SDM0-00 ENTER CA-7 TRANSACTION","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 Delete Job Definition command","example":"JOB;DELETE,JOBA;DBM","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Delete Job Definition Request Response","exampleSetFlag":false,"types":["object"]},"CommandJobDeleteError":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"o be able to delete a job, you need to specify both the job name and delete type. The delete type must be one of DELETE, DD or PURGE","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandJobDelete":{"required":["job","type"],"type":"object","properties":{"job":{"type":"string","description":"The name of the job","example":"JOBA","exampleSetFlag":true,"types":["string"]},"type":{"type":"string","description":"The type of deletion.
Valid values are:
DELETE
Deletes a job and its associated data from the database (documentation, schedules, and so forth).
DD
Same as DELETE, but deletes any data sets that this job references if the data sets have no users and
no documentation, and do not cause job triggering.
This includes all virtual resources that are connected to the job.
PURGE
Same as DD, but also deletes job trigger definitions that trigger the job being deleted,
job requirement definitions that require the job being deleted;
and, if the WA Restart Option interface is active, deletes the WA Restart Option
CMT member for the job being deleted.
","example":"DELETE","exampleSetFlag":true,"types":["string"],"enum":["DELETE","DD","PURGE"]}},"description":"Delete job definition parameters","exampleSetFlag":false,"types":["object"]},"CommandDatasetTriggerDeleteResponse":{"type":"object","properties":{"ca7messages":{"type":"string","description":"CA 7 Response to the Delete Dataset Trigger command","example":"- 22083 152734 SCHD;SM70-00 ENTER SCHEDULE TYPE;- 22083 152734 TRGR;SM75-00 FORMAT FUNCTION SUCCESSFUL;ENTER INPUT FOR NEXT REQUEST;- 22083 152734 UPD,DTRG,OPT=D,DSN=DATA.SET.NAME,SCHID=42,TJOB=JOBA;SM75-00 UPD FUNCTION SUCCESSFUL;ENTER INPUT FOR NEXT REQUEST;- 22083 152734 DBM;SDM0-00 ENTER CA-7 TRANSACTION","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 Delete Dataset Trigger command","example":"SCHD;TRGR;UPD,DTRG,OPT=D,DSN=DATA.SET.NAME,SCHID=42,TJOB=JOBA;DBM","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Delete Dataset Trigger Request Response","exampleSetFlag":false,"types":["object"]},"CommandDatasetTriggerDeleteError":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: - 22083 152910 SCHD;SM70-00 ENTER SCHEDULE TYPE;- 22083 152910 TRGR;SM75-00 FORMAT FUNCTION SUCCESSFUL;ENTER INPUT FOR NEXT REQUEST;- 22083 152910 UPD,DTRG,OPT=D,DSN=DATA.SET.NAME,SCHID=42,TJOB=JOBA;SM75-15 TRGD-JOB AND SCHID COMBINATION NOT FOUND;- 22083 152910 DBM;SDM0-00 ENTER CA-7 TRANSACTION","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandDatasetTriggerDelete":{"required":["triggered-job"],"type":"object","properties":{"dataset-name":{"type":"string","description":"(Required if dataset-number is omitted) Specifies the data set name whose creation/update causes triggering of a job.
Note: For VSAM files, specify the cluster name.
Limits: 1 to 44 alphanumeric characters","example":"DATA.SET.NAME","exampleSetFlag":true,"types":["string"]},"dataset-number":{"type":"string","description":"(Required if dataset-name is omitted) Specifies the existing data set number whose creation causes triggering. The number is the value that CA 7 assigned to the data set.
Limits: 1 to 8 numeric characters","example":"1701","exampleSetFlag":true,"types":["string"]},"schid":{"type":"string","description":"(Optional) Specifies for which schedule ID of the triggering dataset the triggered-job is scheduled.
Note: If the data set is one that is tracked with use of SASSXDSN (externally tracked data sets), the schid field must be 000 for the trigger to work
Default: 0 (all schedule IDs)
Limits: 1 to 3 numeric characters from 0 through 999","example":"42","exampleSetFlag":true,"types":["string"]},"triggered-job":{"type":"string","description":"Specifies the job name that the completion of the triggering dataset triggers.
Limits: 1 to 8 alphanumeric characters","example":"JOBA","exampleSetFlag":true,"types":["string"]}},"description":"Delete Dataset Trigger definition parameters","exampleSetFlag":false,"types":["object"]},"CommandDatasetDeleteResponse":{"type":"object","properties":{"ca7messages":{"type":"string","description":"CA 7 Response to the Delete Dataset Definition command","example":"- 22084 150010 DBM;SDM0-00 ENTER CA-7 TRANSACTION;- 22084 150011 DSN;SM30-00 ENTER INPUT DATA;- 22084 150011 DELETE,DSN=DATA.SET.NAME;SM30-00 DELETE FUNCTION SUCCESSFUL;- 22084 150011 DBM;SDM0-00 ENTER CA-7 TRANSACTION","exampleSetFlag":true,"types":["string"]},"command":{"type":"string","description":"CA 7 Delete Dataset Definition command","example":"DBM;DSN;DELETE,DSN=DATA.SET.NAME;DBM","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The CA 7 configuration name","example":"CA7LPAR1","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Delete Dataset Definition Request Response","exampleSetFlag":false,"types":["object"]},"CommandDatasetDeleteError":{"type":"object","properties":{"error":{"type":"string","description":"The HTTP error","example":"Bad Request","exampleSetFlag":true,"types":["string"]},"message":{"type":"string","description":"CA 7 Error Message","example":"CA 7 Exception: - 22084 150114 DBM;SDM0-00 ENTER CA-7 TRANSACTION;- 22084 150114 DSN;SM30-00 ENTER INPUT DATA;- 22084 150115 DELETE,DSN=DATA.SET.NAME;SM30-02 DSN NOT FOUND;- 22084 150115 DBM;SDM0-00 ENTER CA-7 TRANSACTION","exampleSetFlag":true,"types":["string"]},"status":{"type":"string","description":"The http status of the request","example":"400","exampleSetFlag":true,"types":["string"]},"timestamp":{"type":"string","description":"The time of the request","example":"2019-09-09T14:24:49.722Z","exampleSetFlag":true,"types":["string"]},"ca7-configuration-name":{"type":"string","description":"The name of CA 7 instance where the command was sent","example":"DEFAULT_INSTANCE","exampleSetFlag":true,"types":["string"]}},"description":"CA 7 Rest Api Request Error Response","exampleSetFlag":false,"types":["object"]},"CommandDatasetDelete":{"type":"object","properties":{"dataset-name":{"type":"string","description":"(Required if dataset-number is omitted) Specifies the data set and must be the fully qualified data set name.
Limits: 1 to 44 alphanumeric characters
Note: dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.","example":"DATA.SET.NAME","exampleSetFlag":true,"types":["string"]},"dataset-number":{"type":"string","description":"(Required if dataset-name is omitted) Specifies the data set to use. The value must be the numeric value that CA 7 already assigned.
Limits: 1 to 8 numeric characters","example":"1701","exampleSetFlag":true,"types":["string"]}},"description":"Delete Dataset definition parameters","exampleSetFlag":false,"types":["object"]}},"securitySchemes":{"basicScheme":{"type":"http","scheme":"basic"}},"extensions":{}}}

On this page

Swagger

Use Cases

CA 7 REST APIs: A Comprehensive Guide to Streamlining Workload Automation

Learn more from TechDocs

Getting Started (2)

Videos (1)