V11 SP8
Loading...

REST API - POST Lock / Unlock MM Configuration

Description

This operation locks or unlocks media management (MM) configuration.

Request

Syntax

POST <webservice>/LockMMConfiguration HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml

<mm_configuration_template.xml>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name Description
Host The host name of the Web Server or Web Console used in the API request.
Accept The format of the response. Valid values are: application/xml or application/json.
Authtoken The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.
Content-type The media type contained in the request body.

XML

Download the mm_configuration_template.xml file required for this request. The following table displays the parameters for the mm_configuration_template.xml file.

Name Description Element Parent Element
lockType Valid value are:

0, to unlock

1, to lock

2, to force lock

configLockUnlock EVGui_MMConfigurationLockUnlockReq

Response

Response Parameters

Parameter Description Element
errorMessage The description of the error code. Not all error codes have an error message. CVGui_GenericResp
errorCode
  • 0, successful completion.
  • 1, failure.
  • CVGui_GenericResp

    Examples

    Sample Request

    POST <webservice>/LockMMConfiguration HTTP/1.1
    Host: client.mydomain.com
    Accept: application/xml
    Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
    0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
    8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
    40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
    68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
    3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
    Content-type: application/xml

    <EVGui_MMConfigurationLockUnlockReq>
        <configLockUnlock>
            <lockType>1</lockType>
        </configLockUnlock>
    </EVGui_MMConfigurationLockUnlockReq>

    Sample Response

    This is the response when the configuration is locked.

    {
    "errorMessage":"","errorCode":0
    }

    This is one of the responses when the configuration is not locked.

     {
    "errorMessage":"Another instance of 'Expert Storage Configuration' is being used by User [admin]. Do you want to close it and start a new instance?","errorCode":-1
    }