バージョン 7.8.2

Back | 

WsFolder

URL

https://otcloud.olympusattelecom.com/ws/ws_folder/mode/json/apiv/5.0?method=put&
Use "request" param as post variable for submitting json/xml request payload for all PUT requests.

Parameters

  • folderid => folder id of the folder to be updated

    name => Name of the folder

    description => description of the folder.

    shared_clients => Array of clients ids with which the folder needs to be shared. Folder can only be shared with child clients of a given account/client

Request

Update folder info

Request format

{
  "request": {
    "authentication": {
      "app_token": "#app_token#",
      "client_token": "#client_token#",
      "user_token": "#user_token#"
    },
    "header": {
      "header_version": 1,
      "api_version": "5",
      "no_cache": true
    },
    "ws_folder": {
      "folderid": 14579,
      "name": "dscsdcsdcsdc",
      "shared_clients": [
        
      ]
    }
  }
}

Test Example

{ "request": { "authentication": { "app_token": "#app_token#", "client_token": "#client_token#", "user_token": "#user_token#" }, "header": { "header_version": 1, "api_version": "5", "no_cache": true }, "ws_folder": { "folderid": 14579, "name": "dscsdcsdcsdc", "shared_clients": [ 3848 ] } } }

Response

Response format

{
  "success": {
    "code": 530,
    "message": "Folder Created\/Updated",
    "details": ""
  },
  "WsFolderResponse": {
    "folder": {
      "id": 14579,
      "name": "dscsdcsdcsdc",
      "description": "description",
      "clientid": 73,
      "lastModified": "2014-04-29T17:13:09Z",
      "shared_clients": [
        "3848"
      ]
    }
  }
}