@zowe/cics-for-zowe-sdk/lib/methods/get/Get.d.ts

IBM CICS for Zowe SDK

/**
 * This program and the accompanying materials are made available under the terms of the
 * Eclipse Public License v2.0 which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-v20.html
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Copyright Contributors to the Zowe Project.
 *
 */
import { AbstractSession } from "@zowe/imperative";
import { ICMCIApiResponse, IResourceParms } from "../../doc";
import { ICMCIRequestOptions } from "../../doc/ICMCIRequestOptions";
/**
 * Get resources on in CICS through CMCI REST API
 * @param {AbstractSession} session - the session to connect to CMCI with
 * @param {IResourceParms} parms - parameters for getting resources
 * @returns {Promise<ICMCIApiResponse>} promise that resolves to the response (XML parsed into a javascript object)
 *                          when the request is complete
 * @throws {ImperativeError} CICS resource name not defined or blank
 * @throws {ImperativeError} CICS region name not defined or blank
 * @throws {ImperativeError} CicsCmciRestClient request fails
 */
export declare function getResource(session: AbstractSession, parms: IResourceParms, requestOptions?: ICMCIRequestOptions): Promise<ICMCIApiResponse>;