UNPKG

@zowe/cics-for-zowe-sdk

Version:
227 lines (226 loc) 6.1 kB
/** * 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. * */ /** * Constants to be used by the API */ export declare const CicsCmciConstants: { /** * Specifies the required part of the REST interface URI */ CICS_SYSTEM_MANAGEMENT: string; /** * Specifies the required part of the REST interface URI to access system initialization parameters */ CICS_SYSTEM_PARAMETER: string; /** * Specifies the required part of the REST interface URI to access program definitions */ CICS_DEFINITION_PROGRAM: string; /** * Specifies the required part of the REST interface URI to update installed transactions */ CICS_LOCAL_TRANSACTION: string; /** * Specifies the required part of the REST interface URI to access transaction definitions */ CICS_DEFINITION_TRANSACTION: string; /** * Specifies the required part of the REST interface URI to access program resources */ CICS_PROGRAM_RESOURCE: string; /** * Specifies the required part of the REST interface URI to access library resources */ CICS_LIBRARY_RESOURCE: string; /** * Specifies the required part of the REST interface URI to access library dataset resources */ CICS_LIBRARY_DATASET_RESOURCE: string; /** * Specifies the required part of the REST interface URI to access URIMap definitions */ CICS_DEFINITION_URIMAP: string; /** * Specifies the required part of the REST interface URI to access webservice definitions */ CICS_DEFINITION_WEBSERVICE: string; /** * Specifies the required part of the REST interface URI to access program definitions */ CICS_DEFINITION_BUNDLE: string; /** * Specifies the required part of the REST interface URI to access tcp/ip service resources */ CICS_TCPIPSERVICE_RESOURCE: string; /** * Specifies the required part of the REST interface URI to access pipeline service resources */ CICS_PIPELINE_RESOURCE: string; /** * Specifies the required part of the REST interface URI to access pipeline service resources */ CICS_WEBSERVICE_RESOURCE: string; /** * Specifies the required part of the REST interface URI to access JVM server resources */ CICS_JVMSERVER_RESOURCE: string; CICS_URIMAP: string; CICS_CMCI_REGION_GROUP: string; CICS_CMCI_CICS_PLEX: string; CICS_CMCI_MANAGED_REGION: string; CICS_CMCI_REGION: string; /** * Specifies the required part of the REST interface URI to access CSD Group definitions */ CICS_CSDGROUP: string; /** * Specifies the required part of the REST interface URI to access CSD Group in list definitions */ CICS_CSDGROUP_IN_LIST: string; /** * Specifies the Result Cache part of the URI */ CICS_RESULT_CACHE: string; /** * ORDERBY parameter */ ORDER_BY: string; /** * SUMMONLY parameter */ SUMM_ONLY: string; /** * NODISCARD parameter */ NO_DISCARD: string; /** * OVERRIDEWARNINGCOUNT parameter */ OVERRIDE_WARNING_COUNT: string; /** * CRITERIA parameter */ CRITERIA: string; /** * PARAMETER parameter */ PARAMETER: string; /** * The CICS CMCI external resource names */ CICS_CMCI_EXTERNAL_RESOURCES: string[]; /** * The CICS CMCI transaction definition */ CICS_CMCI_TRANSACTION_DEFINITION: string; /** * The CICS CMCI local transaction */ CICS_CMCI_LOCAL_TRANSACTION: string; /** * The CICS CMCI remote transaction */ CICS_CMCI_REMOTE_TRANSACTION: string; /** * The CICS CMCI local file */ CICS_CMCI_LOCAL_FILE: string; /** * The criteria field name for local file resources */ CICS_LOCAL_FILE_CRITERIA_FIELD: string; /** * Valid BUSY parameter values for closing local files */ CICS_LOCAL_FILE_BUSY_VALUES: string[]; /** * Maximum length for CICS local file names */ CICS_LOCAL_FILE_MAX_LENGTH: number; /** * Valid action types for local file operations */ CICS_LOCAL_FILE_ACTIONS: string[]; /** * The CICS CMCI remote file */ CICS_CMCI_REMOTE_FILE: string; /** * CICSTask parameter */ CICS_CMCI_TASK: string; /** * The CICS CMCI pipeline */ CICS_CMCI_PIPELINE: string; /** * The CICS CMCI web service */ CICS_CMCI_WEB_SERVICE: string; /** * The CICS CMCI web service */ CICS_CMCI_TS_QUEUE: string; /** * The CICS CMCI web service */ CICS_CMCI_SHARED_TS_QUEUE: string; /** * CICSBundle parameter */ CICS_CMCI_BUNDLE: string; /** * CICSBundlePart parameter */ CICS_CMCI_BUNDLE_PART: string; /** * CICSJVMEndpoint parameter */ CICS_CMCI_JVM_ENDPOINT: string; /** * CICS CMCI Response 1 Codes */ RESPONSE_1_CODES: { /** * CMCI RESP 1 Code for OK */ OK: number; /** * CMCI RESP 1 Code for NODATA */ NODATA: number; /** * CMCI RESP 1 Code for INVALIDPARM */ INVALIDPARM: number; /** * CMCI RESP 1 Code for NOTPERMIT */ NOTPERMIT: number; /** * CMCI RESP 1 Code for NOTAVAILABLE */ NOTAVAILABLE: number; /** * CMCI RESP 1 Code for INVALIDDATA */ INVALIDDATA: number; }; DEFAULT_RESP_CODE: string; /** * Resource type constant for GET operations documentation */ DOC_RESOURCE_TYPE_GET: string; }; /** * Valid local file action types */ export type LocalFileAction = "CLOSE" | "OPEN" | "ENABLE" | "DISABLE";