zowe › ca7 › batch › batch🖨️

Call multiple APIs in the same CA 7 session

Usage

zowe ca7 batch batch [options]

Options

• --ca7Id (string)

  • CA 7 instance
    All API requests in the request body will be routed to the ca7Id specified.
    If ca7Id is not specified, all requests will be routed to the DEFAULT_INSTANCE.

• --body (array)

  • 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.Required if the method is POST, PUT, or DELETE
    Invalid if the method is GET

• --parameters (array)

  • Name/value pairs specified using standard JSON format enclosed in curly brackets { }
    Optional depending upon the path and method

Required Options

• --path (array)

  • The path as shown in Swagger for the endpoint associated with this API request

• --method (array)

  • The API method
    Valid values are POST, PUT or DELETE.

CA7 Connection Options

• --host | -H (string)

  • Host name of the CA7 API service that is running on the mainframe system.

• --port | -P (number)

  • Port for the CA7 API service that is running on the mainframe system.

• --user | -u (string)

  • User name for authenticating connections to the CA7 API service that is running on the mainframe system.

• --password | --pass | --pw (string)

  • Password for authenticating connections to the CA7 API service that is running on the mainframe system.

• --base-path | --bp (string)

  • The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.

• --protocol | -o (string)

  • Specifies protocol to use for CA7 connection (http or https).

    Allowed values: http, https

Profile Options

• --ca7-profile | --ca7-p (string)

  • The name of a (ca7) profile to load for this command execution.

• --base-profile | --base-p (string)

  • The name of a (base) profile to load for this command execution.

Base Connection Options

• --reject-unauthorized | --ru (boolean)

  • Reject self-signed certificates.

    Default value: true

• --token-type | --tt (string)

  • The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.

• --token-value | --tv (string)

  • The value of the token to pass to the API.

• --cert-file (local file path)

  • The file path to a certificate file to use for authentication.

    Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

• --cert-key-file (local file path)

  • The file path to a certificate key file to use for authentication

• --cert-account (string)

  • The account name for PKCS 12 certificate stored in credential manager

Examples

• Call multiple APIs(with details of path, method, body, and/or parameters) in the same CA 7 session on Instance1:

  • zowe ca7 batch batch --ca7Id Instance1 --path path1 --path path2 --method POST --method PUT --body "{body parameters}" --body "{body parameters}" Copy