CMCI PUT request URI

Options

/CICSSystemManagement

Indicates that the request is accessing the CICS management client interface. CICSSystemManagement is case-sensitive.

resource_name

Specifies the external resource name that is associated with the CICS or CICSPlex SM resource that is being updated. For example, specifying the resource name CICSRegion associates the request with the CICSPlex SM CICSRGN resource table, and CICSResourceAssignmentDefinition associates the request with the RASGNDEF resource table. See CMCI resource names for a complete list of external resource names.

The HTTP PUT method is not valid for all resources. To determine whether or not this HTTP method is valid for a particular resource, see the description of the resource in CICSPlex SM resource tables.

Resource names are not case-sensitive. If the client specifies an incorrect resource name, an HTTP 404 (Not Found) response is returned.

context

If CMCI is installed in a CICSPlex SM environment, context is the name of the CICSplex or CMAS associated with the request; for example, PLEX1.

If CMCI is installed as a single server, context is the application ID of the CICS region associated with the request.

The value of context must not contain spaces. It is not case-sensitive.

scope

Specifies the name of a CICSplex, CICS group, CICS region, or logical scope associated with the request. The scope is a subset of the context and limits the request to particular CICS systems or resources. Scope is not mandatory. If it is absent, the request is limited by the value of the context alone. The scope must not contain spaces. It is not case-sensitive.

Query parameters

Refine the scope and nature of the request. The constituent parts of the query section can occur in any order, but each can occur only once in a URI. Query parameters are separated with an ampersand (&). Although query parameter values are not case-sensitive, certain attribute values must have the correct capitalization because some attributes such as TRANID and DESC can hold mixed-case values. The query parameters are as follows:

CRITERIA=escaped_criteria_string

A string of logical expressions that filters the data returned on the request. The string that makes up the value of the CRITERIA parameter follows the same rules as the filter expressions in the CICSPlex SM application programming interface. For more guidance about specifying filter expressions using the CICSPlex SM API, see How to build a filter expression.

You must replace certain restricted characters with escape sequences to ensure that they can be interpreted correctly by the server. See CMCI escape sequences for guidance about using escape sequences in CICS management client interface URIs.

PARAMETER=escaped_parameter_string

A string of one or more parameters and values of the form parameter_name(data_value) that refines the request. The rules for specifying these parameters are the same as in the CICSPlex SM application programming interface. For more guidance about specifying parameter expressions using the CICSPlex SM API, see Performing an action against a resource.

As with the criteria string, you must encode certain characters with escape characters. See CMCI escape sequences for guidance about using escape sequences in CICS management client interface URIs.

OVERRIDEWARNINGCOUNT

Bypasses the warning count limit mechanism and allows the request to execute as if the default warning count limits were not specified. This option is effective only when the CICSPlex SM Web User Interface server initialization parameter RESOURCELIMIT is set to WARNING.

SUMMONLY

Indicates that only a result summary is returned by the request. No detailed records are included in the response.

Although specifying the SUMMONLY option prevents records being displayed for a request, it does not alter the number of records requested and does not affect the warning count mechanism. A request that includes SUMMONLY fails if the number of records requested exceeds the warning count value.