@zowe/cics-for-zowe-sdk/lib/constants/CicsCmci.constants.js

Zowe SDK for IBM CICS Transaction Server

"use strict";
/**
 * 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.
 *
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.CicsCmciConstants = void 0;
/**
 * Constants to be used by the API
 */
exports.CicsCmciConstants = {
    /**
     * Specifies the required part of the REST interface URI
     */
    CICS_SYSTEM_MANAGEMENT: "CICSSystemManagement",
    /**
     * Specifies the required part of the REST interface URI to access system initialization parameters
     */
    CICS_SYSTEM_PARAMETER: "CICSSystemParameter",
    /**
     * Specifies the required part of the REST interface URI to access program definitions
     */
    CICS_DEFINITION_PROGRAM: "CICSDefinitionProgram",
    /**
     * Specifies the required part of the REST interface URI to update installed transactions
     */
    CICS_LOCAL_TRANSACTION: "CICSLocalTransaction",
    /**
     * Specifies the required part of the REST interface URI to access transaction definitions
     */
    CICS_DEFINITION_TRANSACTION: "CICSDefinitionTransaction",
    /**
     * Specifies the required part of the REST interface URI to access program resources
     */
    CICS_PROGRAM_RESOURCE: "CICSProgram",
    /**
     * Specifies the required part of the REST interface URI to access library resources
     */
    CICS_LIBRARY_RESOURCE: "CICSLibrary",
    /**
     * Specifies the required part of the REST interface URI to access library dataset resources
     */
    CICS_LIBRARY_DATASET_RESOURCE: "CICSLibraryDatasetName",
    /**
     * Specifies the required part of the REST interface URI to access URIMap definitions
     */
    CICS_DEFINITION_URIMAP: "CICSDefinitionURIMap",
    /**
     * Specifies the required part of the REST interface URI to access webservice definitions
     */
    CICS_DEFINITION_WEBSERVICE: "CICSDefinitionWebService",
    /**
     * Specifies the required part of the REST interface URI to access program definitions
     */
    CICS_DEFINITION_BUNDLE: "CICSDefinitionBundle",
    /**
     * Specifies the required part of the REST interface URI to access tcp/ip service resources
     */
    CICS_TCPIPSERVICE_RESOURCE: "CICSTCPIPService",
    /**
     * Specifies the required part of the REST interface URI to access pipeline service resources
     */
    CICS_PIPELINE_RESOURCE: "CICSPipeline",
    /**
     * Specifies the required part of the REST interface URI to access pipeline service resources
     */
    CICS_WEBSERVICE_RESOURCE: "CICSWebService",
    /**
     * Specifies the required part of the REST interface URI to access JVM server resources
     */
    CICS_JVMSERVER_RESOURCE: "CICSJVMServer",
    /*
     * Specifies the required part of the REST interface URI to access URIMaps
     */
    CICS_URIMAP: "CICSURIMap",
    /*
     * Specifies the required part of the REST interface URI to access Region Groups
     */
    CICS_CMCI_REGION_GROUP: "CICSRegionGroup",
    /*
     * Specifies the required part of the REST interface URI to access CICS Plexes
     */
    CICS_CMCI_CICS_PLEX: "CICSCICSPlex",
    /*
     * Specifies the required part of the REST interface URI to access Managed Regions
     */
    CICS_CMCI_MANAGED_REGION: "CICSManagedRegion",
    /*
     * Specifies the required part of the REST interface URI to access Regions
     */
    CICS_CMCI_REGION: "CICSRegion",
    /**
     * Specifies the required part of the REST interface URI to access CSD Group definitions
     */
    CICS_CSDGROUP: "CICSCSDGroup",
    /**
     * Specifies the required part of the REST interface URI to access CSD Group in list definitions
     */
    CICS_CSDGROUP_IN_LIST: "CICSCSDGroupInList",
    /**
     * Specifies the Result Cache part of the URI
     */
    CICS_RESULT_CACHE: "CICSResultCache",
    /**
     * ORDERBY parameter
     */
    ORDER_BY: "ORDERBY",
    /**
     * SUMMONLY parameter
     */
    SUMM_ONLY: "SUMMONLY",
    /**
     * NODISCARD parameter
     */
    NO_DISCARD: "NODISCARD",
    /**
     * OVERRIDEWARNINGCOUNT parameter
     */
    OVERRIDE_WARNING_COUNT: "OVERRIDEWARNINGCOUNT",
    /**
     * CRITERIA parameter
     */
    CRITERIA: "CRITERIA",
    /**
     * PARAMETER parameter
     */
    PARAMETER: "PARAMETER",
    /**
     * The CICS CMCI external resource names
     */
    CICS_CMCI_EXTERNAL_RESOURCES: ["CICSLocalTransaction", "CICSRemoteTransaction", "CICSDefinitionTransaction", "CICSLocalFile"],
    /**
     * The CICS CMCI transaction definition
     */
    CICS_CMCI_TRANSACTION_DEFINITION: "CICSDefinitionTransaction",
    /**
     * The CICS CMCI local transaction
     */
    CICS_CMCI_LOCAL_TRANSACTION: "CICSLocalTransaction",
    /**
     * The CICS CMCI remote transaction
     */
    CICS_CMCI_REMOTE_TRANSACTION: "CICSRemoteTransaction",
    /**
     * The CICS CMCI local file
     */
    CICS_CMCI_LOCAL_FILE: "CICSLocalFile",
    /**
     * The criteria field name for local file resources
     */
    CICS_LOCAL_FILE_CRITERIA_FIELD: "file",
    /**
     * Valid BUSY parameter values for closing local files
     */
    CICS_LOCAL_FILE_BUSY_VALUES: ["WAIT", "NOWAIT", "FORCE"],
    /**
     * Maximum length for CICS local file names
     */
    CICS_LOCAL_FILE_MAX_LENGTH: 8,
    /**
     * Valid action types for local file operations
     */
    CICS_LOCAL_FILE_ACTIONS: ["CLOSE", "OPEN", "ENABLE", "DISABLE"],
    /**
     * The CICS CMCI remote file
     */
    CICS_CMCI_REMOTE_FILE: "CICSRemoteFile",
    /**
     * CICSTask parameter
     */
    CICS_CMCI_TASK: "CICSTask",
    /**
     * The CICS CMCI pipeline
     */
    CICS_CMCI_PIPELINE: "CICSPipeline",
    /**
     * The CICS CMCI web service
     */
    CICS_CMCI_WEB_SERVICE: "CICSWebService",
    /**
     * The CICS CMCI web service
     */
    CICS_CMCI_TS_QUEUE: "CICSTSQueue",
    /**
     * The CICS CMCI web service
     */
    CICS_CMCI_SHARED_TS_QUEUE: "CICSSharedTSQueue",
    /**
     * CICSBundle parameter
     */
    CICS_CMCI_BUNDLE: "CICSBundle",
    /**
     * CICSBundlePart parameter
     */
    CICS_CMCI_BUNDLE_PART: "CICSBundlePart",
    /**
     * CICSJVMEndpoint parameter
     */
    CICS_CMCI_JVM_ENDPOINT: "CICSJVMEndpoint",
    /**
     * CICS CMCI Response 1 Codes
     */
    RESPONSE_1_CODES: {
        /**
         * CMCI RESP 1 Code for OK
         */
        OK: 1024,
        /**
         * CMCI RESP 1 Code for NODATA
         */
        NODATA: 1027,
        /**
         * CMCI RESP 1 Code for INVALIDPARM
         */
        INVALIDPARM: 1028,
        /**
         * CMCI RESP 1 Code for NOTPERMIT
         */
        NOTPERMIT: 1031,
        /**
         * CMCI RESP 1 Code for NOTAVAILABLE
         */
        NOTAVAILABLE: 1034,
        /**
         * CMCI RESP 1 Code for INVALIDDATA
         */
        INVALIDDATA: 1041,
    },
    /*
     * Default Resp Code
     */
    DEFAULT_RESP_CODE: "0000",
    /**
     * Resource type constant for GET operations documentation
     */
    DOC_RESOURCE_TYPE_GET: "get",
};
//# sourceMappingURL=CicsCmci.constants.js.map