Variable (PATCH)

Patches a context variable by replacing the specified record. You can use the optional parameter to specify a record to patch. The response is empty.

Request

PATCH /v1/contexts/{contextPath}/variables/{variable}

Replace {contextPath} with a full context path.

For the Root Context, use server as {contextPath}.

Replace {variable} with a variable name.

Request Header Fields

  • Authorization — Authentication token. For more information about authentication, see Authenticating.

Request Parameters

  • record — Record to patch. By default, this parameter is 0 and the first record is patched.

Request Body

New value for the record.

Example Request

Request:

   PATCH https://localhost:8443/rest/v1/contexts/users.admin.models.example/variables/exampleTable?record=2

Example request body JSON:

    {
        "name": "Room_3",
        "description": "Oxygen Plant"
    }

Was this page helpful?