{ "item": [ { "id": "68db5535-490e-46d4-9820-cb0adc8c5f8f", "name": "Editions", "description": { "content": "Read and create editions, and check edition join-request status.", "type": "text/plain" }, "item": [ { "id": "38a618cd-fbae-4ea5-b01c-95abd9815914", "name": "Read whether access-request handling is switched on for the edition. Use to check the org-level toggle before a user tries to request access to a team or space.", "request": { "name": "Read whether access-request handling is switched on for the edition. Use to check the org-level toggle before a user tries to request access to a team or space.", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "38a9365b-3582-429a-a0a4-74748c918a24", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"96499735\",\n \"status\": \"true\"\n },\n \"message\": \"Requests status fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/requests/status\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31cee063-92f3-4566-a412-f84be24239a6", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33084ee5-711e-40a7-8f9e-b1d617430a4a", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af3af650-7749-49bf-a40b-c956f5597b6b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfc6114e-eb55-4568-b3bb-81bb466a51a2", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "940dabbe-9bcb-4ea2-b474-bffc75ff9a9f", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2f0c375-1322-48c1-929b-bd9bdac837c8", "name": "Approve or reject an edition join request", "request": { "name": "Approve or reject an edition join request", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "70c4e5e5-7fac-4472-af82-5b2b61b63de1", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"96499735\",\n \"status\": \"false\"\n },\n \"message\": \"Requests status updated successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/requests/status\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89536454-9f86-4fb5-924d-a527c428d34e", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0aa4777-4ccf-4bfc-b40a-37069133d09d", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/112255940/requests/status\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b06a19ab-b39d-4d56-8350-afc2d71535de", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f30f4c40-aec9-4f90-9386-bd24ef3216ea", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"E1015\",\n \"message\": \"Team Request status is already in the requested state\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/requests/status\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "523c1327-4866-4a96-b1ea-ab98ced63a46", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4aeeb897-b0c0-447e-b1c0-3c397a9c76e2", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "requests", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1328e295-8d7e-4430-b223-7c63ce15c723", "name": "Get an edition", "request": { "name": "Get an edition", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "edition_id", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: state, created_time, last_modified_time, edition_type_name, edition_name, edition_role_name, edition_id, edition_owner_id, is_default, uri" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "0087f18a-44e7-49b2-b027-4c6ddd5999a6", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_info\": {\n \"state\": \"ACTIVE\",\n \"edition_name\": \"QA TEAM\",\n \"edition_owner_id\": \"96384499\"\n }\n },\n \"message\": \"Editions fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/60029715808\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73a2f352-9a9c-4e08-a0a4-e957ef567c81", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdf0036f-fd24-47d3-95a1-e073e6b1dc6a", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"error_code\": \"A1008\",\n \"message\": \"Given API Key is not valid.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c226b398-d79a-47a0-8dde-7bffe42dc3df", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4970fff0-f870-47ea-b763-44160d818c0a", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2e47afe-4c02-4785-99a1-b8c15302c8f7", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a3a46de-bb95-4544-ad91-3c6f294e2c78", "name": "Create a new edition", "request": { "name": "Create a new edition", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"team_name\": \"ﴊ빣ŵ笪寒Ố䔹\",\n \"plan_type\": \"TRIAL\",\n \"description\": \"蜲㉬솠㕋\\udde5缷㥏\",\n \"from_integration\": \"MICROSOFT_TEAMS\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c5d394e8-875d-4e2b-a4e9-1ed74470e8ed", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"team_name\": \"ﴊ빣ŵ笪寒Ố䔹\",\n \"plan_type\": \"TRIAL\",\n \"description\": \"蜲㉬솠㕋\\udde5缷㥏\",\n \"from_integration\": \"MICROSOFT_TEAMS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"98723605\",\n \"current_user_id\": \"98722154\",\n \"team_id\": 5265000000002003,\n \"team_name\": \"TeamEdition\"\n },\n \"message\": \"Team edition created successfully\",\n \"request_uri\": \"/vani/api/v1/editions\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "487246ed-47f0-46e6-80e3-7134085360e9", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"team_name\": \"ﴊ빣ŵ笪寒Ố䔹\",\n \"plan_type\": \"TRIAL\",\n \"description\": \"蜲㉬솠㕋\\udde5缷㥏\",\n \"from_integration\": \"MICROSOFT_TEAMS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1031\",\n \"attribute\": \"team_name\",\n \"message\": \"The required parameter is missing\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9901fcea-1b55-4253-8125-85942e226275", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"team_name\": \"ﴊ빣ŵ笪寒Ố䔹\",\n \"plan_type\": \"TRIAL\",\n \"description\": \"蜲㉬솠㕋\\udde5缷㥏\",\n \"from_integration\": \"MICROSOFT_TEAMS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b040edfb-cfd4-4243-97c9-8fedfab1f12b", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"team_name\": \"ﴊ빣ŵ笪寒Ố䔹\",\n \"plan_type\": \"TRIAL\",\n \"description\": \"蜲㉬솠㕋\\udde5缷㥏\",\n \"from_integration\": \"MICROSOFT_TEAMS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"current_user_id\": \"98722154\",\n \"error_code\": \"E1001\",\n \"message\": \"User has already created an edition\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d3ab41b-0f85-47f6-a53a-136b46c71d51", "name": "Rate limit exceeded - this operation allows 10 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"team_name\": \"ﴊ빣ŵ笪寒Ố䔹\",\n \"plan_type\": \"TRIAL\",\n \"description\": \"蜲㉬솠㕋\\udde5缷㥏\",\n \"from_integration\": \"MICROSOFT_TEAMS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b83e597e-03a4-48dd-b875-5ba18b80ab41", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"team_name\": \"ﴊ빣ŵ笪寒Ố䔹\",\n \"plan_type\": \"TRIAL\",\n \"description\": \"蜲㉬솠㕋\\udde5缷㥏\",\n \"from_integration\": \"MICROSOFT_TEAMS\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2399a522-094e-4e21-a1cb-bef6542d5140", "name": "Get all editions the user belongs to", "request": { "name": "Get all editions the user belongs to", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "edition_id", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: state, created_time, last_modified_time, edition_type_name, edition_name, edition_role_name, edition_id, edition_owner_id, is_default, uri" } ], "variable": [ { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "cd5a5a64-7c5e-4d50-8df5-14e29cbc0e44", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_id" } ], "variable": [ { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"editions_info\": {}\n },\n \"message\": \"Editions fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "728ee722-878b-42b5-baac-2fb26d8e9c5a", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_id" } ], "variable": [ { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2c11f2a-cec6-42e0-84cb-fcbc392a4bdf", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_id" } ], "variable": [ { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25f04028-f57c-42de-ac69-8aac6cacc21d", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_id" } ], "variable": [ { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbf3eea5-2e07-4bdd-84bd-05ad5b95d87e", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "edition_id" } ], "variable": [ { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c201d7be-ce3b-40ed-8605-2592a93f7138", "name": "Subscription", "description": { "content": "Read the edition's subscription details.", "type": "text/plain" }, "item": [ { "id": "8ace61b3-3a47-45a9-96e6-fed4680a07da", "name": "Get the edition's subscription details", "request": { "name": "Get the edition's subscription details", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "members_count", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: status, members_count, edition_id, purchase_date, plan_name, plan_type, expiry_date" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "e5095ec0-4c4a-47b5-8e52-9b131bd4687f", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "members_count" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"subscription_info\": {\n \"plan_type\": \"Yearly\",\n \"edition_id\": \"112255940\",\n \"expiry_date\": \"Sat, 19 Jun 2027, 00:00:00\",\n \"members_count\": \"5\",\n \"purchase_date\": \"Fri, 19 Jun 2026, 18:56:49\",\n \"plan_name\": \"BUSINESS_PLAN\",\n \"status\": \"Active\"\n }\n },\n \"message\": \"Subscription details fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/112255940/subscription\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98a1887e-26ad-40c4-86a2-b8213198d39d", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "members_count" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a2303e8-0882-4376-8d3c-d243ef66de1d", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "members_count" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e1852cf-3a09-4df8-80bb-68091a43853e", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "members_count" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcf79316-9850-43d5-886a-90cf06b2cda2", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "members_count" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6233c1e6-bedf-451b-b2a7-8278d6c405e7", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "members_count" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "614bc9b0-9573-4f91-9d58-a170850d35b3", "name": "Templates", "description": { "content": "List and read the templates available in an edition.", "type": "text/plain" }, "item": [ { "id": "d915335e-67c9-4f3d-9327-af65b5f515ff", "name": "Get the templates available in an edition", "request": { "name": "Get the templates available in an edition", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "id", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: id, description, name, is_available_for_edition" }, { "disabled": false, "key": "from", "value": "4622", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "94", "description": "The maximum number of results to return in the response. Default value is 20" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "d95faa2f-4fd7-4569-968d-9985a12a0601", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"templates\": [\n {\n \"name\": \"Eisenhower matrix\",\n \"description\": \"The Eisenhower Matrix, also known as the Urgent-Important Matrix, is a productivity tool used to prioritize tasks based on their urgency and importance.\",\n \"id\": \"2227813839241884264\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"1-on-1 feedback\",\n \"description\": \"Help your mentor or teammate get an idea of what you're going to discuss with them in your 1-on-1 feedback sessions.\",\n \"id\": \"415170746673786701\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"5 whys\",\n \"description\": \"Find the root cause of a problem by asking "Why?" questions.\",\n \"id\": \"8825346814681087568\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Guess the Doodle\",\n \"description\": \"Just want to chill with the team for a while? This visual game will help you and your team relax and bond with each other.\",\n \"id\": \"7193564480716665813\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Impact Effort Matrix\",\n \"description\": \"An impact effort matrix is a tool used in project management to help prioritize tasks based on their level of impact and effort required.\",\n \"id\": \"4880489140950000824\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Customer problem statement\",\n \"description\": \"Get into your customer's shoes to better understand their problems. \",\n \"id\": \"3570349084835838944\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Marketing release checklist\",\n \"description\": \"Got an upcoming release? Here's an easier way to plan and execute\\nyour marketing goals, so that you get everything covered.\",\n \"id\": \"5252159967532415789\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Never Have I Ever\",\n \"description\": \"Never Have I Ever is a popular card game designed to reveal interesting and embarrassing secrets about the players. It's a great icebreaker and often opens up fun, entertaining conversations.\",\n \"id\": \"9068022063805355070\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"New teammate onboarding\",\n \"description\": \"Onboard new members of your team with this fun template.\",\n \"id\": \"8077947179536093903\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"New teammate project milestones\",\n \"description\": \"Help your new teammate understand all about your team's projects, the stuff they need to work on, and the expectations you've set for them.\\r\\n\",\n \"id\": \"2197960956629199196\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Sales call follow-up\",\n \"description\": \"This is a quick way to share insights after a sales call and discuss them with your team.\",\n \"id\": \"1758538615716321335\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Product positioning\",\n \"description\": \"Working on a new product or revising an existing one? Here are some positioning exercises for you and your teammates to brainstorm and fill in.\\r\\n\",\n \"id\": \"4786897632740503006\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Strategic goal board\",\n \"description\": \"Chart out some goals and work together with your teammates towards achieving them.\\r\\n\",\n \"id\": \"146806559048094029\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Team bookshelf\",\n \"description\": \"Build your team library with book recommendations from everyone.\",\n \"id\": \"2601700237097182900\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Team coffee discussion\",\n \"description\": \"Bond with your team over coffee, or just about anything you want, and have fun discussions.\",\n \"id\": \"6282257423499599528\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Team priority : Now, Next, Later\",\n \"description\": \"Working on your next team project? Quickly list down tasks and details, sort the most-important things to do, and keep track of the progress.\\r\\n\",\n \"id\": \"1189335149816408152\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Team recipe board\",\n \"description\": \"A fun team activity to share the best and favorite recipes with each other.\",\n \"id\": \"709495071782421321\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Website signup flow\",\n \"description\": \"A simple sign up flow to capture the visitor-to-subscriber conversion.\",\n \"id\": \"5772067647393374657\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Weekly team planner\",\n \"description\": \"Plan your week with your teammates using this template.\\r\\n\",\n \"id\": \"3212028571933595674\",\n \"is_available_for_edition\": \"true\"\n },\n {\n \"name\": \"Book Club Meeting\",\n \"description\": \"Use this template to jot down your bookish discussions and thoughts on what you are reading and keep track of your literary adventures. It is your cozy digital den for all things book-related.\",\n \"id\": \"2053719903222126011\",\n \"is_available_for_edition\": \"true\"\n }\n ]\n },\n \"message\": \"Templates fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/888012145/templates\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5198968-98d2-40a7-8045-357f2bb0be49", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d976cf81-c8ad-41e0-931c-1f2425f66752", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "faa8bb88-afe4-46c5-a963-dad6b40853ac", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86712bf0-db37-4443-bd17-2593e3c8c681", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0f7906a-0d68-4037-9ec4-dcc6d46c05cb", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94151a8c-eca4-4c64-bdd7-15a7b5815eb0", "name": "Get a template", "request": { "name": "Get a template", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "id", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: id, description, name, is_available_for_edition" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) The unique identifier of the template" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "f9bf7b64-6751-4dfc-856f-da09ba561d48", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) The unique identifier of the template" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"template\": {\n \"name\": \"1-on-1 feedback\",\n \"description\": \"Help your mentor or teammate get an idea of what you're going to discuss with them in your 1-on-1 feedback sessions.\",\n \"id\": \"415170746673786701\",\n \"is_available_for_edition\": \"true\"\n }\n },\n \"message\": \"Template fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/888012145/templates/415170746673786701\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ab7a2dc-b55d-4886-aaa8-16c7c49f8e9d", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) The unique identifier of the template" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50e2216f-c6b1-49f3-b4fe-eb2b364856a3", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) The unique identifier of the template" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85058e97-565c-4e7a-b2f9-ac147cb39cb5", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) The unique identifier of the template" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"888012145\",\n \"current_user_id\": \"888015717\",\n \"error_code\": \"S1030\",\n \"message\": \"Template not found\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/888012145/templates/339360394209299546\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4628840-141d-4394-88bc-b1b46a79c519", "name": "Rate limit exceeded - this operation allows 500 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) The unique identifier of the template" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d2d1db6-245b-4d69-8910-4ca89c75ce0b", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "template_id", "description": "(Required) The unique identifier of the template" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8aa1b014-c020-4840-b4f5-0240c6b0402e", "name": "Teams", "description": { "content": "Read and update teams, and resolve a user's role within them.", "type": "text/plain" }, "item": [ { "id": "75131407-ecd9-40e5-91ce-ec9350fff9c7", "name": "Get a team", "request": { "name": "Get a team", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "zsoid", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: created_by, created_by_name, created_time, team_member_count, zsoid, team_name, team_id, uri" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "47e7c8c3-8def-41a6-a922-b9547c10f8a5", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zsoid" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"team\": {\n \"team_member_count\": \"5\",\n \"team_id\": \"1303000000002003\",\n \"created_by_name\": \"Dan\",\n \"team_name\": \"GraphZen\"\n }\n },\n \"message\": \"Teams fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/60029715808/teams/1303000000002003\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8974c0c5-09a7-4374-9f6d-46056e216ae9", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zsoid" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc4f6df9-d673-454d-aafa-0759387d3687", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zsoid" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"T1006\",\n \"team_id\": \"693000000008463\",\n \"message\": \"User is not a member of the team\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/teams/693000000008463\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b6e5e71-b2b4-463b-a944-57f4e988f7ab", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zsoid" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"T1008\",\n \"team_id\": \"300900000000200\",\n \"message\": \"Team not found\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/300900000000200\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b63627ba-0d6f-48f4-9717-20e970e4b1a8", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zsoid" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0116e9ab-6a99-4728-80cd-769dd34accd0", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zsoid" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe530583-1319-432e-bd85-848a1cf3600c", "name": "Update a team's name or settings", "request": { "name": "Update a team's name or settings", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"䃛쩞㷍삍ꆗ媵\",\n \"team_name\": \"㛗㦨﫬⣁鰤縄퐴҆ﾅ\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "01791f7c-2bee-43aa-923e-6a1630743daa", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"䃛쩞㷍삍ꆗ媵\",\n \"team_name\": \"㛗㦨﫬⣁鰤縄퐴҆ﾅ\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"team_id\": \"1505000000002005\",\n \"new_description\": \"Visualize Graph Instantly\"\n },\n \"message\": \"Team updated successfully\",\n \"request_uri\": \"/vani/api/v1/editions/97375109/teams/1505000000002005\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c811de9-8791-4a71-8150-00f4493e24d1", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"䃛쩞㷍삍ꆗ媵\",\n \"team_name\": \"㛗㦨﫬⣁鰤縄퐴҆ﾅ\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6f02683-54c8-4f24-8530-fc3eb6653c65", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"䃛쩞㷍삍ꆗ媵\",\n \"team_name\": \"㛗㦨﫬⣁鰤縄퐴҆ﾅ\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c879e102-4a0b-4c3d-afd8-e3db928ae4f9", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"䃛쩞㷍삍ꆗ媵\",\n \"team_name\": \"㛗㦨﫬⣁鰤縄퐴҆ﾅ\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"T1008\",\n \"team_id\": \"442100000000200\",\n \"message\": \"Team not found\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/teams/442100000000200\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c08456c-1a7a-472e-b4b6-6ca41c4fa624", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"䃛쩞㷍삍ꆗ媵\",\n \"team_name\": \"㛗㦨﫬⣁鰤縄퐴҆ﾅ\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "446eb2c1-9420-4114-b966-2fb6d32918b3", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"䃛쩞㷍삍ꆗ媵\",\n \"team_name\": \"㛗㦨﫬⣁鰤縄퐴҆ﾅ\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f72abbaf-092f-4278-9f0e-111cbb2e34f7", "name": "Get the current user's role in a team", "request": { "name": "Get the current user's role in a team", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "72636ce8-e7a1-44a0-ad49-5c245be327fd", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"user_permission_info\": {\n \"edition_id\": \"96499735\",\n \"role\": \"TEAM_ADMIN\",\n \"current_user_id\": \"96384499\",\n \"team_id\": \"3009000000002003\"\n }\n },\n \"message\": \"User permissions fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/users/me/permission\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfc69da6-0d1f-4255-8214-982564e2ec70", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dad7ac77-28bb-4156-8842-f98140ed0578", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"T1006\",\n \"team_id\": \"693000000002001\",\n \"message\": \"User is not a member of the team\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/teams/693000000002001/users/me/permission\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad4b4aeb-b7f7-4ab3-9e3c-b2f6490e0ad7", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"T1008\",\n \"team_id\": \"300900000002003\",\n \"message\": \"Team not found\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/300900000002003/users/me/permission\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fef4462-9454-4e9e-8b42-c602c4e62d19", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a08d9fc-9adc-40d7-a58f-d952c45e0b03", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf96bc51-91bf-411f-a008-c9d06ef511f9", "name": "Get a user's role in a team", "request": { "name": "Get a user's role in a team", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "users", ":user_id", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) The unique identifier of the user" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "7610c617-bc80-4f9f-9c1f-b7a763c26210", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "users", ":user_id", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) The unique identifier of the user" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"user_permission_info\": {\n \"edition_id\": \"96499735\",\n \"role\": \"TEAM_ADMIN\",\n \"current_user_id\": \"96384499\",\n \"team_id\": \"3009000000002003\",\n \"zuid\": \"80215739\"\n }\n },\n \"message\": \"User permissions fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/users/80215739/permission\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37b4e2dd-da8e-44af-b159-c45827cfccf9", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "users", ":user_id", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) The unique identifier of the user" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3913e26c-f80f-43c9-a2e8-d24d3ea6e80a", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "users", ":user_id", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) The unique identifier of the user" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"T1006\",\n \"team_id\": \"3009000000002003\",\n \"message\": \"User is not a member of the team\",\n \"zuid\": \"80585905\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/users/80585905/permission\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78cff809-16c6-4b62-9ac1-58852e9ff603", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "users", ":user_id", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) The unique identifier of the user" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dfda253-e2b2-42ed-9deb-808ccea40ecf", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "users", ":user_id", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) The unique identifier of the user" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "509b25c8-de65-4554-bc0c-39517d409fa0", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "users", ":user_id", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) The unique identifier of the user" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78b68344-6dcd-4ec0-8b4d-f548e69e8740", "name": "Get the current user's role across all teams", "request": { "name": "Get the current user's role across all teams", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "e4a7c1e7-426b-407f-9578-01395b5c81e1", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"user_permission_info\": {\n \"edition_id\": \"75918186\",\n \"teams\": [\n {\n \"role\": \"TEAM_ADMIN\",\n \"team_id\": 693000000435005\n },\n {\n \"role\": \"MEMBER\",\n \"team_id\": 693000000436009\n },\n {\n \"role\": \"MEMBER\",\n \"team_id\": 693000000450001\n }\n ],\n \"current_user_id\": \"96384499\"\n }\n },\n \"message\": \"User permissions fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/75918186/teams/users/me/permission\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b339220b-28d3-48d8-a525-4546f32f1273", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f7210d3-8b79-472b-be4b-108c3ad61c6f", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13f7ea8e-e8a1-4329-a79d-53b1b2d023b7", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"current_user_id\": \"96384499\",\n \"error_code\": \"E1017\",\n \"message\": \"Invalid edition\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/02345/teams/users/me/permission\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fcd3a4a-6264-45d3-befe-09b350d5154f", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d25bf92-f2f8-45d7-8fe9-ec780c203324", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77440d5a-2b33-41a4-a122-f2b35a4490c2", "name": "Get all teams in an edition", "request": { "name": "Get all teams in an edition", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "zsoid", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: created_by, created_by_name, created_time, team_member_count, zsoid, team_name, team_id, uri" }, { "disabled": false, "key": "from", "value": "4622", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "94", "description": "The maximum number of results to return in the response. Default value is 20" }, { "disabled": false, "key": "sort_by", "value": "name", "description": "Specifies the field used to sort the results. Allowed values: name, created_time" }, { "disabled": false, "key": "order_by", "value": "asc", "description": "Specifies the sorting order. Allowed values: asc, desc" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "2d8bf7e8-c2c8-4554-ac63-c11051ab6288", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zsoid" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "sort_by", "value": "name" }, { "key": "order_by", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"teams\": [\n {\n \"created_time\": \"Wed, 12 Jun 2024, 11:22:30\",\n \"team_member_count\": \"8\",\n \"team_id\": \"1303000000003021\",\n \"created_by_name\": \"Alice\",\n \"zsoid\": \"60029715808\",\n \"created_by\": \"60029269987\",\n \"uri\": \"/vani/api/v1/editions/60029715808/teams/1303000000003021\",\n \"team_name\": \"CloudSpark\"\n },\n {\n \"created_time\": \"Tue, 28 May 2024, 15:34:44\",\n \"team_member_count\": \"5\",\n \"team_id\": \"1303000000002003\",\n \"is_default\": \"true\",\n \"created_by_name\": \"Dan\",\n \"zsoid\": \"60029715808\",\n \"created_by\": \"60029267674\",\n \"uri\": \"/vani/api/v1/editions/60029715808/teams/1303000000002003\",\n \"team_name\": \"GraphZen\"\n }\n ]\n },\n \"message\": \"Teams fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/60029715808/teams\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb94f5fd-4336-4583-a52b-b4ff03668bcb", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zsoid" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "sort_by", "value": "name" }, { "key": "order_by", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfc8cb18-b821-47dd-86f8-5c98c8c076b3", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zsoid" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "sort_by", "value": "name" }, { "key": "order_by", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d75871e9-7db0-46e9-aae5-bd9d55848b67", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zsoid" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "sort_by", "value": "name" }, { "key": "order_by", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "266332b7-6254-4a19-8618-50c9b816e54c", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zsoid" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "sort_by", "value": "name" }, { "key": "order_by", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8b46062-785a-4a56-b288-beb63ac88ecc", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zsoid" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "sort_by", "value": "name" }, { "key": "order_by", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "36450539-c78c-47ad-bfe6-32994d77282d", "name": "Team Members", "description": { "content": "Add, update, remove, and list the members of a team.", "type": "text/plain" }, "item": [ { "id": "699fb01b-f55f-4368-99ea-4fea6631b928", "name": "Add members to a team", "request": { "name": "Add members to a team", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"mail_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9565306f-8b73-4d13-943d-8583c6105889", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"mail_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"added_members\": [\n {\n \"role_name\": \"MEMBER\",\n \"invited_time\": \"Mon, 03 Feb 2025, 23:17:12\",\n \"edition_id\": \"97375109\",\n \"mail_id\": \"sophia.bennett@boxicle.com\",\n \"added_by\": \"96384499\",\n \"team_id\": \"1505000000051031\"\n }\n ]\n },\n \"message\": \"Team member added successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/97375109/teams/1505000000051031/members\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e541ec0-6b96-41c6-aa34-dc0fba694746", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"mail_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Partial Content", "code": 206, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"failed_members\": [\n {\n \"error_message\": \"Member already invited\",\n \"mail_id\": \"sophia.bennett@boxicle.com\",\n \"error_code\": \"T1014\"\n }\n ],\n \"added_members\": [\n {\n \"role_name\": \"MEMBER\",\n \"invited_time\": \"Mon, 03 Feb 2025, 23:16:13\",\n \"edition_id\": \"97375109\",\n \"mail_id\": \"olivia.morgan@boxicle.com\",\n \"added_by\": \"96384499\",\n \"team_id\": \"1505000000051031\"\n },\n {\n \"role_name\": \"TEAM_ADMIN\",\n \"added_time\": \"Mon, 03 Feb 2025, 23:16:12\",\n \"mail_id\": \"liam.parker@boxicle.com\",\n \"added_by\": \"96384499\",\n \"team_id\": \"1505000000051031\"\n }\n ]\n },\n \"message\": \"Partial success: Some members added, others failed.\",\n \"request_uri\": \"/vani/api/v1/editions/97375109/teams/1505000000051031/members\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3282e926-cca8-4dfb-9f53-aa59ca1c629e", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"mail_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"failed_members\": [\n {\n \"error_message\": \"Member already part of team\",\n \"mail_id\": \"olivia.morgan@boxicle.com\",\n \"error_code\": \"T1013\"\n }\n ],\n \"error_code\": \"T1017\",\n \"message\": \"Team member add failed\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e51041e0-0088-4f23-b31a-196d4564eed4", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"mail_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"97377569\",\n \"error_code\": \"A1003\",\n \"team_id\": \"3009000000002003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67073020-abef-4055-91b6-d7e4c7f5d577", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"mail_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "298e689f-5ccb-42b7-985a-9497928fa5b1", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"mail_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cef6402-7baa-43a9-bb1f-ef8c8cbdd1fa", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"mail_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d543f427-fc0e-4b96-97ee-4281184a10f1", "name": "Get the members of a team", "request": { "name": "Get the members of a team", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "member_type", "value": "TEAM_ADMIN", "description": "Role of the member to be fetched. The value TEAM_ADMIN retrieves only the team admins. Allowed values: TEAM_ADMIN, MEMBER, TEAM_GUEST" }, { "disabled": false, "key": "subscriber_state", "value": "ACTIVE", "description": "Parameter: subscriber_state. Allowed values: ACTIVE, INACTIVE" }, { "disabled": false, "key": "roles", "value": "TEAM_ADMIN", "description": "Parameter: roles. Allowed values: TEAM_ADMIN, MEMBER, TEAM_GUEST" }, { "disabled": false, "key": "sort_by", "value": "ROLE_DESC", "description": "Specifies the field used to sort the results. Allowed values: ROLE_ASC, ROLE_DESC, NAME_ASC, NAME_DESC" }, { "disabled": false, "key": "search", "value": "荜歺瀬퍪䗶", "description": "The keyword or phrase to search for" }, { "disabled": false, "key": "fields", "value": "zuid", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: zuid, role_name, added_time, added_by, modified_time, display_name, mail_id, edition_id, team_id, invited_time" }, { "disabled": false, "key": "from", "value": "4622", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "94", "description": "The maximum number of results to return in the response. Default value is 20" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "c1e62299-09ee-4e7f-82aa-317a9f791528", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "member_type", "value": "TEAM_ADMIN" }, { "key": "subscriber_state", "value": "ACTIVE" }, { "key": "roles", "value": "TEAM_ADMIN" }, { "key": "sort_by", "value": "ROLE_DESC" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "fields", "value": "zuid" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"team_members\": [\n {\n \"role_name\": \"MEMBER\",\n \"added_time\": \"Tue, 21 Jan 2025, 13:29:58\",\n \"modified_time\": \"Tue, 21 Jan 2025, 13:29:58\",\n \"mail_id\": \"emma.carter@boxicle.com\",\n \"added_by\": \"85572741\",\n \"display_name\": \"Emma Carter\",\n \"zuid\": \"96384499\"\n }\n ]\n },\n \"message\": \"Team members fetched successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/75918186/teams/693000000450001/members\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "677aab66-cacc-4a63-967e-fe642010ee27", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "member_type", "value": "TEAM_ADMIN" }, { "key": "subscriber_state", "value": "ACTIVE" }, { "key": "roles", "value": "TEAM_ADMIN" }, { "key": "sort_by", "value": "ROLE_DESC" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "fields", "value": "zuid" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36bc870b-481a-470a-8b50-864e124524eb", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "member_type", "value": "TEAM_ADMIN" }, { "key": "subscriber_state", "value": "ACTIVE" }, { "key": "roles", "value": "TEAM_ADMIN" }, { "key": "sort_by", "value": "ROLE_DESC" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "fields", "value": "zuid" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"T1006\",\n \"team_id\": \"693000000008463\",\n \"message\": \"User is not a member of the team\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/teams/693000000008463/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "684d5507-1768-4d8c-a0cd-693d164002d5", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "member_type", "value": "TEAM_ADMIN" }, { "key": "subscriber_state", "value": "ACTIVE" }, { "key": "roles", "value": "TEAM_ADMIN" }, { "key": "sort_by", "value": "ROLE_DESC" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "fields", "value": "zuid" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"T1008\",\n \"team_id\": \"69300000045001\",\n \"message\": \"Team not found\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/teams/69300000045001/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a52ff70-024b-4207-a0f0-63de2294ee2c", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "member_type", "value": "TEAM_ADMIN" }, { "key": "subscriber_state", "value": "ACTIVE" }, { "key": "roles", "value": "TEAM_ADMIN" }, { "key": "sort_by", "value": "ROLE_DESC" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "fields", "value": "zuid" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e8bcaab-81f7-454b-b000-85de1e364298", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "member_type", "value": "TEAM_ADMIN" }, { "key": "subscriber_state", "value": "ACTIVE" }, { "key": "roles", "value": "TEAM_ADMIN" }, { "key": "sort_by", "value": "ROLE_DESC" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "fields", "value": "zuid" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15c084fb-a4c6-4885-9a86-eadb2a03f917", "name": "Remove a member from a team", "request": { "name": "Remove a member from a team", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7742a712-e142-4259-a8d7-0d865afb42f3", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"97375109\",\n \"removed_zuid\": \"97377569\",\n \"current_user_id\": \"96384499\",\n \"team_id\": \"1505000000051031\"\n },\n \"message\": \"Team member deleted successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/97375109/teams/1505000000051031/members\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "970f6f63-7fde-4013-8403-042bf63327e3", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13bbb93f-768a-4375-8cd6-83ab49abff6f", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/112255940/teams/5777000000002017/members/80022267\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "571602b3-192e-472f-a78c-0f1b50054d1a", "name": "Forbidden - the caller is authenticated but not allowed to perform this operation", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1004\",\n \"team_id\": \"3009000000002003\",\n \"message\": \"Super admin can't be removed from the team\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f6c9e3c-a489-4538-bac9-c797e0abb134", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"T1012\",\n \"team_id\": \"1505000000051031\",\n \"message\": \"Member not part of team\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/teams/1505000000051031/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "340ffa96-34a2-4670-9361-eb3d1e7f524e", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fdd0906-dab4-4d57-b091-97d345180d29", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c630de54-2633-4f74-9750-d07e9cdc356f", "name": "Update a team member's role", "request": { "name": "Update a team member's role", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"role\": \"MEMBER\",\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "49ef0dc7-18a5-4f18-86c0-7c4cbe2312af", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"MEMBER\",\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"new_role\": \"MEMBER\",\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"team_id\": \"1505000000051031\",\n \"zuid\": \"98722154\"\n },\n \"message\": \"Team member updated successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/97375109/teams/1505000000051031/members\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "323d905e-d0e5-49bd-9108-a8bee67d1536", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"MEMBER\",\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e82fc1fa-7855-4ca7-b91b-685db713c3fe", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"MEMBER\",\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"T1006\",\n \"team_id\": \"693000000436009\",\n \"message\": \"User is not a member of the team\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/teams/693000000436009/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a33d9d19-bbc7-441a-9074-8ac4a8e19803", "name": "Forbidden - the caller is authenticated but not allowed to perform this operation", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"MEMBER\",\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"112255940\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"M1003\",\n \"team_id\": \"5777000000002017\",\n \"message\": \"Inactive user role cannot be updated\",\n \"zuid\": \"64167940\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/112255940/teams/5777000000002017/members/64167940\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e6ec2e7-a93e-410a-8383-d24c2d9d9550", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"MEMBER\",\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"T1012\",\n \"team_id\": \"1505000000051031\",\n \"message\": \"Member not part of team\",\n \"zuid\": \"80215739\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/teams/1505000000051031/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89f49802-b80d-4e83-9439-45b0c87a62e6", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"MEMBER\",\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"M1001\",\n \"team_id\": \"693000000436009\",\n \"message\": \"The member already has the specified role\",\n \"zuid\": \"81479212\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/teams/693000000436009/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c064b30-157b-4b23-b57d-8c754e1ede80", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"MEMBER\",\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2be3343-4a54-4af7-8c03-bf5343d01ceb", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"MEMBER\",\n \"assign_to_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d357f027-0ed5-4e44-b248-ebce441c1577", "name": "Team Requests", "description": { "content": "Raise, list, accept, and reject requests to join a team.", "type": "text/plain" }, "item": [ { "id": "590fb36c-8162-43e2-9609-c7dd9dff3a81", "name": "Get the current user's join requests for a team", "request": { "name": "Get the current user's join requests for a team", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", "my-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "requested_time", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: requested_time, requested_by, name, request_id, status" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "8bdc4d93-783d-4f02-aaf2-9a1c22870e63", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", "my-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "requested_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"requests\": {\n \"status\": \"REQUESTED\"\n }\n },\n \"message\": \"Team requests fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/80473965/teams/1664000000002003/requests/my-requests\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29d240bc-855e-4fae-be4a-49c3a9673140", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", "my-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "requested_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46f804e0-881b-4dfd-ba70-e47d35294c3d", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", "my-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "requested_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa54f38c-e209-457a-bed6-f47e4bef0f3c", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", "my-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "requested_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"80473960\",\n \"error_code\": \"R1007\",\n \"team_id\": \"3009000000002003\",\n \"message\": \"Team join request not found\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/requests/my-requests\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55674498-3ab4-4087-9e8d-97cb11a261f5", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", "my-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "requested_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"80473960\",\n \"error_code\": \"T1013\",\n \"team_id\": \"3009000000002003\",\n \"message\": \"Member already part of team\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/requests/my-requests\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62eac557-b30c-40ec-9ead-2af6d58d2b9b", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", "my-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "requested_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb8865f8-af09-4f56-aacf-995bfb66c407", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", "my-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "requested_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1c56f2d-891d-4ac2-8d8e-e9b0a8bb8065", "name": "Approve a pending team join request by request id and assign the requester a team role of TEAM_ADMIN, MEMBER or TEAM_GUEST. Admits them without a separate createTeamMember call.", "request": { "name": "Approve a pending team join request by request id and assign the requester a team role of TEAM_ADMIN, MEMBER or TEAM_GUEST. Admits them without a separate createTeamMember call.", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"role\": \"TEAM_ADMIN\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "20e31bd6-40a3-4f71-b1da-d0dc847e69c9", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"role\": \"TEAM_ADMIN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"role_name\": \"MEMBER\",\n \"edition_id\": \"112255940\",\n \"updated_at\": \"Fri, 21 Aug 2026, 20:04:43\",\n \"team_id\": \"5777000000002017\",\n \"request_id\": \"730000017057001\",\n \"zuid\": \"97049596\",\n \"status\": \"ACCEPTED\"\n },\n \"message\": \"Team join request accepted successfully\",\n \"request_uri\": \"/vani/api/v1/editions/112255940/teams/5777000000002017/requests/730000017057001/accept\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d93a0f62-44ed-4a28-a2a0-221e4ddba2b6", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"role\": \"TEAM_ADMIN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"R1003\",\n \"team_id\": \"3009000000002003\",\n \"message\": \"Invalid request ID\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/requests/730000009261019/accept\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb533a85-7350-4645-8552-a54cd57a8696", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"role\": \"TEAM_ADMIN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"team_id\": \"3009000000002003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/requests/730000009261019/accept\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb44a3a3-f460-4716-989c-81afc4bf086c", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"role\": \"TEAM_ADMIN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8457c7b0-d2b0-4ac2-a5a6-0c1abc4369de", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"role\": \"TEAM_ADMIN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"L1001\",\n \"team_id\": \"3009000000002003\",\n \"message\": \"License limit reached\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/requests/730000009261019/accept\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f085605-b89d-4c51-a46f-a8fdbc7e7aaf", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"role\": \"TEAM_ADMIN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f4d5fbe-9828-4e7a-87a8-d18864f93b08", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"role\": \"TEAM_ADMIN\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f417b41b-5b44-42f5-a145-f566ea5f0f58", "name": "Decline a pending team join request by request id, leaving the requester outside the team. Use in place of acceptTeamRequest when access should not be granted.", "request": { "name": "Decline a pending team join request by request id, leaving the requester outside the team. Use in place of acceptTeamRequest when access should not be granted.", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "0786603b-10d3-4006-836e-a4166b1d8727", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"112255940\",\n \"updated_at\": \"Fri, 21 Aug 2026, 19:49:36\",\n \"team_id\": \"5777000000002017\",\n \"request_id\": \"730000017057001\",\n \"zuid\": \"97049596\",\n \"status\": \"REJECTED\"\n },\n \"message\": \"Team join request rejected successfully\",\n \"request_uri\": \"/vani/api/v1/editions/112255940/teams/5777000000002017/requests/730000017057001/reject\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89fc9d7c-2993-418b-921d-88026fd118f6", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"R1003\",\n \"team_id\": \"3009000000002003\",\n \"message\": \"Invalid request ID\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/requests/73000000926104/reject\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65137176-8f70-43ce-a4d2-4eba6f5b89de", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"team_id\": \"3009000000002003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/requests/730000009261019/reject\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e4e5a1c-94d3-42fd-8c1c-c759d33ed3bd", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c43bb1d2-2aa3-43f5-8762-bd8f9fb7e269", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"R1012\",\n \"team_id\": \"3009000000002003\",\n \"message\": \"Team join request is already rejected\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/requests/730000009261046/reject\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbabfa7b-224e-45b6-833d-d75c32ae775a", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcbe3670-0ded-40a6-b8be-7c85e3b6e54e", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de8db4fd-c8a0-4778-b25c-04ea44cf4a69", "name": "Raise a request for the calling user to join a team they cannot yet reach. A team admin then settles it with acceptTeamRequest or rejectTeamRequest.", "request": { "name": "Raise a request for the calling user to join a team they cannot yet reach. A team admin then settles it with acceptTeamRequest or rejectTeamRequest.", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "f37f44c1-194a-4636-88d9-c8a458539117", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"96499735\",\n \"updated_at\": \"Wed, 06 Aug 2025, 10:07:21\",\n \"team_id\": \"3009000000002003\",\n \"request_id\": \"730000009272001\",\n \"zuid\": \"80473960\",\n \"status\": \"PENDING\"\n },\n \"message\": \"Team join request created successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/requests\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4652a927-1d1b-4318-83e4-daffc7c8f6b7", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b6efa33-8637-4dbf-b145-21638c1049e3", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f64f31b-4ba8-422f-8b16-1b5ad5cc09e3", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb6bbb50-fe12-45cd-9d39-c9691865934d", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"80473960\",\n \"error_code\": \"T1013\",\n \"team_id\": \"3009000000002003\",\n \"message\": \"Member already part of team\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/requests\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "689a2e10-a812-4da5-bff0-bc5ef674efff", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bd91979-c2e8-4611-b0a6-360696524e3b", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "295b2325-22c5-4fa5-a5a2-b60951e66da9", "name": "Get the join requests for a team", "request": { "name": "Get the join requests for a team", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "requested_time", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: requested_time, requested_by, name, request_id, status" }, { "disabled": false, "key": "from", "value": "4622", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "94", "description": "The maximum number of results to return in the response. Default value is 20" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "44e9ad88-0138-45f5-b4d8-5e640fc66e3e", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "requested_time" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"requests\": [\n {\n \"name\": \"Emma Carter\",\n \"status\": \"REQUESTED\"\n }\n ]\n },\n \"message\": \"Team requests fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/requests\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26af5df1-a92f-41d0-9541-0ef68c0461d4", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "requested_time" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a328341-4c0b-4610-bd16-7ec264369234", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "requested_time" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1002\",\n \"team_id\": \"3009000000002003\",\n \"message\": \"Only admin can do this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/requests\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80b3b012-e793-4287-a0fb-7511a85f41ac", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "requested_time" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d577eda6-aa0c-47fb-aa1c-bfcf509759ce", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "requested_time" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6b1990c-c2dd-42cb-b76e-eac098c33ebc", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "requested_time" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b7f9a857-c3af-4663-9781-7a2c693b8cbc", "name": "Spaces", "description": { "content": "Create, read, duplicate, and update spaces, and resolve a user's role within them.", "type": "text/plain" }, "item": [ { "id": "24040cff-e6ad-4b3d-840b-8dfeef8a4337", "name": "Duplicate a space", "request": { "name": "Duplicate a space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"duplicate_space\": {\n \"space_name\": \"㫊库亯嬮篤阴ܫ糩\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"copy_members\": false,\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ee156f75-29d3-47aa-bbc8-9de0b5a479bf", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duplicate_space\": {\n \"space_name\": \"㫊库亯嬮篤阴ܫ糩\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"copy_members\": false,\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"space_info\": {\n \"created_time\": \"Sat, 08 Mar 2025, 17:40:07\",\n \"last_modified_time\": \"Sat, 08 Mar 2025, 17:40:07\",\n \"is_favorite\": \"false\",\n \"space_name\": \"Vision board - 1\",\n \"publish\": \"false\",\n \"owner_zuid\": \"80215739\",\n \"can_edit\": \"true\",\n \"team_id\": \"3009000000002003\",\n \"allow_embed\": \"false\",\n \"space_id\": \"3009000000239341\",\n \"last_author_zuid\": \"80215739\",\n \"status\": \"ACTIVE\"\n }\n },\n \"message\": \"Space duplicated successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000232005/duplicate\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a975f64-2fa2-4982-a7bc-7659c4cfab48", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duplicate_space\": {\n \"space_name\": \"㫊库亯嬮篤阴ܫ糩\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"copy_members\": false,\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d940b6b7-67c7-4558-b383-96e5a21f1248", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duplicate_space\": {\n \"space_name\": \"㫊库亯嬮篤阴ܫ糩\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"copy_members\": false,\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"80215739\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"3009000000093003\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000093003/duplicate\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48012aa2-7b87-45d5-870a-ca70e01c967b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duplicate_space\": {\n \"space_name\": \"㫊库亯嬮篤阴ܫ糩\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"copy_members\": false,\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"80215739\",\n \"error_code\": \"S1009\",\n \"message\": \"Space not found\",\n \"space_id\": \"300900000093003\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/300900000093003/duplicate\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4911ada9-13b7-41f8-903c-1112d904a86b", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duplicate_space\": {\n \"space_name\": \"㫊库亯嬮篤阴ܫ糩\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"copy_members\": false,\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fe6edff-e472-4630-b76a-c3b8d4c49adc", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duplicate_space\": {\n \"space_name\": \"㫊库亯嬮篤阴ܫ糩\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"copy_members\": false,\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "22ea0d6d-fded-4f2c-a92f-e2d40f18cbd6", "name": "Get a space", "request": { "name": "Get a space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "last_published_time", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: space_name, space_id, owner_zuid, team_id, last_author_zuid, created_time, last_modified_time, last_saved_version, publish, published_version_id, last_published_time, thumb_image_id, client_import_id, is_private_space, file_size, allow_embed, status, can_edit, is_favorite, space_member_count, state_modified_time, uri, open_url" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "160a3a2c-b5de-471e-a2cb-d4e377921772", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_published_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"space_info\": {\n \"is_favorite\": \"false\",\n \"can_edit\": \"true\",\n \"team_id\": \"1303000000002003\"\n }\n },\n \"message\": \"Space fetched successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/60029715808/spaces/1303000000492291\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03dc7c59-b7a0-4f44-8428-d44167f38498", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_published_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d63dbf7d-037a-41ac-9201-6aa6258d735a", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_published_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/300900000009300\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "999d5ee2-27a4-4e0f-8ec8-c10dab122db2", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_published_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7155ce30-0cd4-4989-b716-4fe83f79cdaa", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_published_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0c839cf-22f0-4d7f-944d-faf5734a8dcb", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "last_published_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ff64a0c-54b1-4a62-af24-a3c6e4864aed", "name": "Get the current user's role in a space", "request": { "name": "Get the current user's role in a space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "cdc6b865-96c3-409f-a407-541555a0de69", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"user_permission_info\": {\n \"edition_id\": \"96499735\",\n \"role\": \"CREATOR\",\n \"current_user_id\": \"96384499\",\n \"space_id\": \"3009000000093003\"\n }\n },\n \"message\": \"User permissions fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000093003/users/me/permission\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bee932c-f765-4861-b30b-8da8ade87888", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a7c9929-44e2-4ab4-b7a2-1ce82fd6726b", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f922041a-51fd-4c47-8c8a-3952e6c4359b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1015\",\n \"message\": \"Member is not part of the Space\",\n \"space_id\": \"3009000000298005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000298005/users/me/permission\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "374e9221-36ab-4e27-9732-b2d7ab2881a1", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "333dd4f4-56c5-4d8d-9fb6-4079ff1ed756", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "users", "me", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb359963-aa8e-4a7d-8d07-1417490ddeca", "name": "Get a user's role in a space", "request": { "name": "Get a user's role in a space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "users", ":user_id", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) The unique identifier of the user" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "93802731-a05e-40c4-9c16-85b77f56acdc", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "users", ":user_id", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) The unique identifier of the user" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"user_permission_info\": {\n \"edition_id\": \"96499735\",\n \"role\": \"EDITOR\",\n \"current_user_id\": \"96384499\",\n \"space_id\": \"3009000000303003\",\n \"zuid\": \"80215739\"\n }\n },\n \"message\": \"User permissions fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000303003/users/80215739/permission\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12144873-6441-4094-a4b2-4428b6919837", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "users", ":user_id", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) The unique identifier of the user" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad5f3beb-d94b-40a2-9b37-48f2816a40dc", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "users", ":user_id", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) The unique identifier of the user" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1020\",\n \"message\": \"User is not the owner of the Space\",\n \"space_id\": \"3009000000298005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000298005/users/80215739/permission\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a947b1fd-2720-4769-bb94-ebf14cb44104", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "users", ":user_id", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) The unique identifier of the user" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1015\",\n \"message\": \"Member is not part of the Space\",\n \"space_id\": \"3009000000303003\",\n \"zuid\": \"80215739\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000303003/users/80215739/permission\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff104df6-3a67-4475-ab7e-e47a976e035a", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "users", ":user_id", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) The unique identifier of the user" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "152f7c69-dee3-48a1-9e5d-518134e37965", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "users", ":user_id", "permission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "user_id", "description": "(Required) The unique identifier of the user" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bffc2acb-9fcb-41df-8bc0-f13cd3e2990c", "name": "Update space metadata", "request": { "name": "Update space metadata", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"action_type\": \"SPACE_NAME\",\n \"space_name\": \"令慙κ㯒坩祣Ⱶ\",\n \"value\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "34bbbe56-0774-46a6-a19c-75b9aea248c6", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"action_type\": \"SPACE_NAME\",\n \"space_name\": \"令慙κ㯒坩祣Ⱶ\",\n \"value\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"is_favourite\": false,\n \"space_id\": \"3009000000141003\"\n },\n \"message\": \"Space meta updated successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000141003/meta\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15fed569-e14e-4ea5-9977-031c193e3801", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"action_type\": \"SPACE_NAME\",\n \"space_name\": \"令慙κ㯒坩祣Ⱶ\",\n \"value\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "834d92c1-420b-404c-8344-2934795c5730", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"action_type\": \"SPACE_NAME\",\n \"space_name\": \"令慙κ㯒坩祣Ⱶ\",\n \"value\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"300900000014100\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/300900000014100/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17643f16-5380-4d0f-bcb0-deaaca6bbc29", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"action_type\": \"SPACE_NAME\",\n \"space_name\": \"令慙κ㯒坩祣Ⱶ\",\n \"value\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2c2ac74-712e-4554-b862-d87db9df90a8", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"action_type\": \"SPACE_NAME\",\n \"space_name\": \"令慙κ㯒坩祣Ⱶ\",\n \"value\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1018\",\n \"message\": \"Space is not favourite\",\n \"space_id\": \"3009000000141003\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000141003/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a9d567f-2f95-445e-aa9f-d4c402cef596", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"action_type\": \"SPACE_NAME\",\n \"space_name\": \"令慙κ㯒坩祣Ⱶ\",\n \"value\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae0568dd-359e-42c4-9c24-0bf29bca66ef", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"action_type\": \"SPACE_NAME\",\n \"space_name\": \"令慙κ㯒坩祣Ⱶ\",\n \"value\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78387245-8318-4c83-8864-a3714ab6335e", "name": "Create a new space", "request": { "name": "Create a new space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"create_space\": {\n \"team_id\": \"string\",\n \"workspace_id\": \"string\",\n \"template_name\": \"웩먡\",\n \"space_name\": \"重殊\",\n \"zone_name\": \"幁뻔躡匄䧴먊䦛\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b74cb45a-74ef-4d18-9671-5e052e31e9ed", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_space\": {\n \"team_id\": \"string\",\n \"workspace_id\": \"string\",\n \"template_name\": \"웩먡\",\n \"space_name\": \"重殊\",\n \"zone_name\": \"幁뻔躡匄䧴먊䦛\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"space_id\": \"3009000000145003\",\n \"uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000145003\"\n },\n \"message\": \"Space created successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "477572d9-625e-479d-9046-84e9910e10a6", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_space\": {\n \"team_id\": \"string\",\n \"workspace_id\": \"string\",\n \"template_name\": \"웩먡\",\n \"space_name\": \"重殊\",\n \"zone_name\": \"幁뻔躡匄䧴먊䦛\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ece92c66-e9bf-455f-91d2-3395e3d12041", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_space\": {\n \"team_id\": \"string\",\n \"workspace_id\": \"string\",\n \"template_name\": \"웩먡\",\n \"space_name\": \"重殊\",\n \"zone_name\": \"幁뻔躡匄䧴먊䦛\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"current_user_id\": \"96384499\",\n \"error_code\": \"T1006\",\n \"message\": \"User is not a member of the team\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/spaces/\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbbaa45e-33ca-4599-a95d-5e5ef279ef2a", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_space\": {\n \"team_id\": \"string\",\n \"workspace_id\": \"string\",\n \"template_name\": \"웩먡\",\n \"space_name\": \"重殊\",\n \"zone_name\": \"幁뻔躡匄䧴먊䦛\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"60029715808\",\n \"current_user_id\": \"60029267674\",\n \"error_code\": \"S1030\",\n \"message\": \"Template not found\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/60029715808/spaces/\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff4bc662-2f07-4be9-aa63-db07eaae3d43", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_space\": {\n \"team_id\": \"string\",\n \"workspace_id\": \"string\",\n \"template_name\": \"웩먡\",\n \"space_name\": \"重殊\",\n \"zone_name\": \"幁뻔躡匄䧴먊䦛\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "830d8453-f915-45ab-bc2b-a4c486e3b102", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_space\": {\n \"team_id\": \"string\",\n \"workspace_id\": \"string\",\n \"template_name\": \"웩먡\",\n \"space_name\": \"重殊\",\n \"zone_name\": \"幁뻔躡匄䧴먊䦛\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9976aaa9-b932-4c33-9dea-c7ea46427173", "name": "Get all spaces in an edition", "request": { "name": "Get all spaces in an edition", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "team_id", "value": "string", "description": "The ID of the team within the edition" }, { "disabled": false, "key": "action_type", "value": "ALL_SPACES", "description": "(Required) Specifies the category or context of Spaces. Allowed values: ALL_SPACES, SHARED_SPACES, SHARED_BY_ME, SHARED_BY_OTHERS, PUBLISHED_WITH_TEAM, PUBLISHED_WITH_ORG, FAVOURITES, DRAFT_SPACES, RECENT_ALL_SPACES_ORG, RECENTLY_TRASHED_SPACES, RECENTLY_TRASHED, RECENTLY_TRASHED_ZONES, NON_TEAM_MEMBER_SHARED_SPACE" }, { "disabled": false, "key": "sort_by", "value": "TIME_CREATED", "description": "(Required) Specifies the field used to sort the results. Allowed values: TIME_CREATED, TIME_DELETED_ASC, TIME_DELETED_DESC, A_Z, Z_A, RECENTLY_OPENED, RECENTLY_TRASHED, RECENTLY_ACCESSED_BY_USER, RECENTLY_MODIFIED_BY_USER" }, { "disabled": false, "key": "filter_by", "value": "string", "description": "Parameter: filter_by. Max length: 100" }, { "disabled": false, "key": "search", "value": "䷱洍⓸೒醠⛨㛃聶靐", "description": "The keyword or phrase to search for" }, { "disabled": false, "key": "from", "value": "4622", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "94", "description": "The maximum number of results to return in the response. Default value is 20" }, { "disabled": false, "key": "need_total_count", "value": "false", "description": "Set this to true if you want to include the total count of items in the response. By default, this is false" }, { "disabled": false, "key": "fields", "value": "last_published_time", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: space_name, space_id, owner_zuid, team_id, last_author_zuid, created_time, last_modified_time, last_saved_version, publish, published_version_id, last_published_time, thumb_image_id, client_import_id, is_private_space, file_size, allow_embed, status, can_edit, is_favorite, space_member_count, state_modified_time, uri, open_url" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "17c36fff-dc99-45df-866c-fa240bb77e0e", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "string" }, { "key": "action_type", "value": "ALL_SPACES" }, { "key": "sort_by", "value": "TIME_CREATED" }, { "key": "filter_by", "value": "string" }, { "key": "search", "value": "䷱洍⓸೒醠⛨㛃聶靐" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "need_total_count", "value": "false" }, { "key": "fields", "value": "last_published_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"space_count\": 1,\n \"spaces_info\": [\n {\n \"created_time\": \"Fri, 24 Jan 2025, 12:25:29\",\n \"last_modified_time\": \"Fri, 24 Jan 2025, 12:25:29\",\n \"is_favorite\": \"true\",\n \"space_name\": \"Business case template\",\n \"publish\": \"false\",\n \"owner_zuid\": \"96384499\",\n \"can_edit\": \"true\",\n \"team_id\": \"3009000000002003\",\n \"space_member_count\": \"1\",\n \"space_id\": \"3009000000093779\",\n \"last_author_zuid\": \"96384499\",\n \"status\": \"ACTIVE\"\n }\n ]\n },\n \"message\": \"Space fetched successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a84ecf51-9c1b-4933-8aea-47be18b2ec1b", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "string" }, { "key": "action_type", "value": "ALL_SPACES" }, { "key": "sort_by", "value": "TIME_CREATED" }, { "key": "filter_by", "value": "string" }, { "key": "search", "value": "䷱洍⓸೒醠⛨㛃聶靐" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "need_total_count", "value": "true" }, { "key": "fields", "value": "last_published_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "751877a8-ccc0-46e2-97ae-5dad97fe99bf", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "string" }, { "key": "action_type", "value": "ALL_SPACES" }, { "key": "sort_by", "value": "TIME_CREATED" }, { "key": "filter_by", "value": "string" }, { "key": "search", "value": "䷱洍⓸೒醠⛨㛃聶靐" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "need_total_count", "value": "true" }, { "key": "fields", "value": "last_published_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e8643b7-519f-474d-9715-c9bd7f5f9d39", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "string" }, { "key": "action_type", "value": "ALL_SPACES" }, { "key": "sort_by", "value": "TIME_CREATED" }, { "key": "filter_by", "value": "string" }, { "key": "search", "value": "䷱洍⓸೒醠⛨㛃聶靐" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "need_total_count", "value": "true" }, { "key": "fields", "value": "last_published_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc2003ca-ff18-4044-a105-6ab5c9bd8abc", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "string" }, { "key": "action_type", "value": "ALL_SPACES" }, { "key": "sort_by", "value": "TIME_CREATED" }, { "key": "filter_by", "value": "string" }, { "key": "search", "value": "䷱洍⓸೒醠⛨㛃聶靐" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "need_total_count", "value": "true" }, { "key": "fields", "value": "last_published_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76154a15-c31a-47c4-8809-aacf28b2b0e2", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "string" }, { "key": "action_type", "value": "ALL_SPACES" }, { "key": "sort_by", "value": "TIME_CREATED" }, { "key": "filter_by", "value": "string" }, { "key": "search", "value": "䷱洍⓸೒醠⛨㛃聶靐" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "need_total_count", "value": "true" }, { "key": "fields", "value": "last_published_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5577577d-b04d-43f7-a1d5-a1b4c7b14385", "name": "Update space state", "request": { "name": "Update space state", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"space_state\": \"RESTORE\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4d87f4d1-2b99-4500-855f-eab0773a21c0", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"space_state\": \"RESTORE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"96499735\",\n \"space_state\": \"RESTORE\",\n \"current_user_id\": \"96384499\",\n \"space_id\": \"3009000000093854\"\n },\n \"message\": \"Space state updated successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000093854/state\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "884d48df-dc56-454c-bde4-536c33850e33", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"space_state\": \"RESTORE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1012\",\n \"message\": \"Space is not in an active state\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000093854/state\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9bb67c5-ce65-4c54-bab3-4ddf4eed2f7c", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"space_state\": \"RESTORE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/300900000000003/state\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62222279-3b2d-43c8-aef3-be5594f78da3", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"space_state\": \"RESTORE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd9357b7-90a1-421e-a669-148970368fb3", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"space_state\": \"RESTORE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd655568-5421-489b-914f-296a2b545535", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"space_state\": \"RESTORE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4c0f6386-73a4-432a-bc19-12d64b5df1a8", "name": "Space Members", "description": { "content": "Add, update, remove, and list the members of a space.", "type": "text/plain" }, "item": [ { "id": "690cce8f-0933-47ac-b981-d173b312153e", "name": "Remove a member from a space", "request": { "name": "Remove a member from a space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "9ab8858c-fc83-4b04-b661-5979b75a700d", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"97375109\",\n \"removed_zuid\": \"80473960\",\n \"current_user_id\": \"96384499\",\n \"space_id\": \"1505000000039107\"\n },\n \"message\": \"Space member deleted successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000039107/members\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f0b62d6-0fd7-4f22-aec8-f1a3d35daa6f", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "621db908-5d84-4369-a9b0-4b54225a92e7", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"1505000000045043\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000045043/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6289654-3c5e-456b-b7d3-148a3fed0d4b", "name": "Forbidden - the caller is authenticated but not allowed to perform this operation", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1002\",\n \"message\": \"Space owner cannot be removed\",\n \"space_id\": \"1505000000045043\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000045043/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4710bc5-1f7b-4d09-aad0-58f6843a1920", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1015\",\n \"message\": \"Member is not part of the Space\",\n \"space_id\": \"1505000000039107\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000039107/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a935ac9-53bf-4754-9a20-7eeb96401662", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46a6a9aa-fb41-4db7-b433-1cb36213cd11", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88836c6d-d186-4753-b01c-3a9d4cb7e225", "name": "Update a space member's role", "request": { "name": "Update a space member's role", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "adefea4b-a8ea-4917-8d31-3b70235e312a", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"new_role\": \"EDITOR\",\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"space_id\": \"1505000000005005\",\n \"zuid\": \"80473960\"\n },\n \"message\": \"Space member updated successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000005005/members\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e474db8b-8748-4014-b0e9-f3aa734179bd", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4efed5c5-55d5-4191-bc0e-ccdcd83eba07", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"693000000536005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/spaces/693000000536005/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42ed0065-ba20-4111-87a4-319fb05f86c2", "name": "Forbidden - the caller is authenticated but not allowed to perform this operation", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"R1001\",\n \"message\": \"Cannot update own role\",\n \"space_id\": \"1505000000045043\",\n \"zuid\": \"96384499\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000045043/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12725970-4c5a-43d5-8b45-ae23c4c26ccd", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1015\",\n \"message\": \"Member is not part of the Space\",\n \"space_id\": \"3009000000067027\",\n \"zuid\": \"80585905\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000067027/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baa29091-0512-445b-998c-973f3e28d5c3", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"M1001\",\n \"message\": \"The member already has the specified role\",\n \"space_id\": \"1505000000005005\",\n \"zuid\": \"80473960\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000005005/members/80473960\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cda1b66-73e5-4492-b772-1714a531de30", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f8a91c1-df89-4728-91b1-1d84445e1284", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79c556be-cde2-42f0-a7c1-f8dc4e6ab230", "name": "Add members to a space", "request": { "name": "Add members to a space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"zuid\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"restrict_zone_ids\": {\n \"value\": \"\"\n },\n \"access_state\": {\n \"value\": \"\"\n }\n }\n ],\n \"requester_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fd268e41-4f3e-4e5b-95e2-8a3b9e5038f5", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"zuid\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"restrict_zone_ids\": {\n \"value\": \"\"\n },\n \"access_state\": {\n \"value\": \"\"\n }\n }\n ],\n \"requester_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"added_members\": [\n {\n \"role_name\": \"VIEWER\",\n \"added_type_name\": \"USER\",\n \"added_time\": \"Tue, 04 Feb 2025, 11:18:40\",\n \"mail_id\": \"lucas.bryant@boxicle.com\",\n \"added_by\": \"96384499\",\n \"display_name\": \"Lucas Bryant\",\n \"zuid\": \"98722154\"\n },\n {\n \"role_name\": \"EDITOR\",\n \"added_type_name\": \"TEAM\",\n \"added_time\": \"Tue, 04 Feb 2025, 11:18:40\",\n \"added_by\": \"96384499\",\n \"display_name\": \"TEAM VANI\",\n \"zuid\": \"1505000000002005\"\n }\n ]\n },\n \"message\": \"Space member added successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000039170/members\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c5d6a3f-caed-476c-a755-133d412c83f3", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"zuid\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"restrict_zone_ids\": {\n \"value\": \"\"\n },\n \"access_state\": {\n \"value\": \"\"\n }\n }\n ],\n \"requester_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Partial Content", "code": 206, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"failed_members\": [\n {\n \"error_message\": \"Member already part of Space\",\n \"error_code\": \"S1019\",\n \"zuid\": \"98722154\"\n }\n ],\n \"added_members\": [\n {\n \"role_name\": \"EDITOR\",\n \"added_type_name\": \"TEAM\",\n \"added_time\": \"Tue, 04 Feb 2025, 11:14:23\",\n \"added_by\": \"96384499\",\n \"display_name\": \"CloudSpark\",\n \"zuid\": \"1505000000002005\"\n }\n ]\n },\n \"message\": \"Partial success: Some members added, others failed.\",\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000039170/members\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f35c9d3-8147-4487-9775-6678f543b559", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"zuid\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"restrict_zone_ids\": {\n \"value\": \"\"\n },\n \"access_state\": {\n \"value\": \"\"\n }\n }\n ],\n \"requester_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"failed_members\": [\n {\n \"error_message\": \"User is inactive and cannot be added to project\",\n \"error_code\": \"U1001\",\n \"zuid\": \"80215739\"\n }\n ],\n \"error_code\": \"S1008\",\n \"message\": \"Space member add failed\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/spaces/693000000536104/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "081d8600-5d59-4054-a3e5-b17098662b2a", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"zuid\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"restrict_zone_ids\": {\n \"value\": \"\"\n },\n \"access_state\": {\n \"value\": \"\"\n }\n }\n ],\n \"requester_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"300900000014503\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/300900000014503/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc198582-c721-4ecc-bf3b-6d0b5a79bf74", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"zuid\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"restrict_zone_ids\": {\n \"value\": \"\"\n },\n \"access_state\": {\n \"value\": \"\"\n }\n }\n ],\n \"requester_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "467c84a7-3906-4b70-91db-5bf14fbe9972", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"zuid\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"restrict_zone_ids\": {\n \"value\": \"\"\n },\n \"access_state\": {\n \"value\": \"\"\n }\n }\n ],\n \"requester_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ffc7f8e-dcf7-4b06-ac6c-0d8f3010442a", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"zuid\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"restrict_zone_ids\": {\n \"value\": \"\"\n },\n \"access_state\": {\n \"value\": \"\"\n }\n }\n ],\n \"requester_zuid\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe26382b-0d3e-4024-8321-7a23805e0f76", "name": "Get the members of a space", "request": { "name": "Get the members of a space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "roles", "value": "EDITOR", "description": "Parameter: roles. Allowed values: CREATOR, EDITOR, COMMENTER, VIEWER, ORGANISER" }, { "disabled": false, "key": "sort_by", "value": "ROLE_ASC", "description": "Specifies the field used to sort the results. Allowed values: ROLE_ASC, ROLE_DESC" }, { "disabled": false, "key": "search", "value": "荜歺瀬퍪䗶", "description": "The keyword or phrase to search for" }, { "disabled": false, "key": "fields", "value": "added_by", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: added_type_name, display_name, zuid, added_time, mail_id, role_name, added_by" }, { "disabled": false, "key": "from", "value": "4622", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "94", "description": "The maximum number of results to return in the response. Default value is 20" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "c3806704-fe41-47cc-85e3-95876ea37561", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "roles", "value": "EDITOR" }, { "key": "sort_by", "value": "ROLE_ASC" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "fields", "value": "added_by" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"space_members\": [\n {\n \"role_name\": \"EDITOR\",\n \"display_name\": \"Emma Carter\",\n \"zuid\": \"80473960\"\n },\n {\n \"role_name\": \"VIEWER\",\n \"display_name\": \"CloudSpark\",\n \"zuid\": \"1505000000002005\"\n },\n {\n \"role_name\": \"CREATOR\",\n \"display_name\": \"Ryan Mitchell\",\n \"zuid\": \"96384499\"\n }\n ]\n },\n \"message\": \"Space members fetched successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000022005/members\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "386aeb51-9eb4-4dbd-a0cf-77df06b7daa7", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "roles", "value": "EDITOR" }, { "key": "sort_by", "value": "ROLE_ASC" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "fields", "value": "added_by" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67a48924-ae87-45b5-8b23-e3ff87607b51", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "roles", "value": "EDITOR" }, { "key": "sort_by", "value": "ROLE_ASC" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "fields", "value": "added_by" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"300900000038005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/300900000038005/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa5269fd-7705-4265-ab0c-a7f675d48998", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "roles", "value": "EDITOR" }, { "key": "sort_by", "value": "ROLE_ASC" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "fields", "value": "added_by" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01db0b65-afb0-4450-a7b8-4a8275777bdf", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "roles", "value": "EDITOR" }, { "key": "sort_by", "value": "ROLE_ASC" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "fields", "value": "added_by" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21225946-b75d-408c-85c5-aebe929de3dd", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "roles", "value": "EDITOR" }, { "key": "sort_by", "value": "ROLE_ASC" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "fields", "value": "added_by" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ec44e716-6cb7-45e3-b1e7-f82b7eea56f3", "name": "Space Requests", "description": { "content": "Raise, list, accept, and reject requests to join a space.", "type": "text/plain" }, "item": [ { "id": "b505c217-bf62-4cf6-bfbe-14873dca8ec6", "name": "Raise a request to join a space", "request": { "name": "Raise a request to join a space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3f432386-6867-4de6-a2ea-2b1eb5618e93", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"96499735\",\n \"updated_at\": \"Wed, 06 Aug 2025, 10:12:18\",\n \"request_id\": \"3009000000793049\",\n \"space_id\": \"3009000000694083\",\n \"zuid\": \"80473960\",\n \"status\": \"PENDING\"\n },\n \"message\": \"Space join request created successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000694083/requests\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a77dff0d-1a24-4d31-8c74-a105430696dc", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9a29312-fe83-48fc-8b3f-5e88bb581785", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5649e85f-cdb9-42cf-8de3-6c9dfcec2e72", "name": "Forbidden - the caller is authenticated but not allowed to perform this operation", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"80473960\",\n \"error_code\": \"R1011\",\n \"message\": \"Requesting for downgrade is not allowed\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000694083/requests\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05e813b1-d288-49c0-ae6a-121a02d82b7f", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"80473960\",\n \"error_code\": \"T1012\",\n \"message\": \"Member not part of team\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000694083/requests\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f677eea-cfb2-4c4a-925b-b24e278537e6", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"80473960\",\n \"error_code\": \"M1001\",\n \"message\": \"The member already has the specified role\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000694083/requests\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "065077c1-42a1-4cad-835d-1d571937aa31", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02bceafa-0537-4e1f-8b6c-8c9ea1c20593", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"role\": \"ORGANISER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40136283-1a76-4eb4-a28a-38d14b4d04bf", "name": "Get the join requests for a space", "request": { "name": "Get the join requests for a space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "request_id", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: requested_time, requested_by, name, request_id, status, role" }, { "disabled": false, "key": "from", "value": "4622", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "94", "description": "The maximum number of results to return in the response. Default value is 20" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "e9f38fd0-8e4b-4973-9d65-458beae5d491", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "request_id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"requests\": [\n {\n \"requested_time\": \"Wed, 06 Aug 2025, 16:05:37\",\n \"requested_by\": \"80215739\",\n \"role\": \"VIEWER\",\n \"name\": \"naga.vg\",\n \"request_id\": \"3009000000789151\",\n \"status\": \"PENDING\"\n },\n {\n \"requested_time\": \"Wed, 06 Aug 2025, 16:10:51\",\n \"requested_by\": \"80473960\",\n \"role\": \"VIEWER\",\n \"name\": \"naga.vg\",\n \"request_id\": \"3009000000789147\",\n \"status\": \"PENDING\"\n }\n ]\n },\n \"message\": \"Space join requests fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000701079/requests\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "134a903b-1965-4a74-b3ee-4c094408ea73", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "request_id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f166cb48-e248-4472-8231-27777dfb92db", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "request_id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"80473960\",\n \"error_code\": \"A1003\",\n \"team_id\": \"3009000000694083\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000694083/requests\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b64c86a7-50de-422c-8aff-9dfcdbb7557b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "request_id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1009\",\n \"team_id\": \"300900000064083\",\n \"message\": \"Space not found\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/300900000064083/requests\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b94868e7-b872-4ebc-bb31-81f29b00a5d2", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "request_id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "836e840d-1b2d-4764-a2af-256a9f78f84a", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "request_id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0c5da12-bce9-4f03-a796-d6508ca8d56d", "name": "Accept a request to join a space", "request": { "name": "Accept a request to join a space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", ":request_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "cc3aaab5-b2bc-40fd-b2e7-9b5bf6e4d2e9", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", ":request_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"role_name\": \"VIEWER\",\n \"edition_id\": \"96499735\",\n \"updated_at\": \"Wed, 06 Aug 2025, 20:07:20\",\n \"request_id\": \"3009000000789147\",\n \"space_id\": \"3009000000701079\",\n \"zuid\": \"80473960\",\n \"status\": \"ACCEPTED\"\n },\n \"message\": \"Space join request accepted successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000701079/requests/3009000000789147/accept\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a73bd367-d385-464b-bcae-14946aa54cd5", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", ":request_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"R1003\",\n \"team_id\": \"3009000000694083\",\n \"message\": \"Invalid request ID\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000694083/requests/3009000000777013/accept\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e818c9a8-31d3-41ef-ae5c-646db1791a1c", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", ":request_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"80473960\",\n \"error_code\": \"A1003\",\n \"team_id\": \"3009000000694083\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000694083/requests/3009000000777109/accept\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74ca7e60-d395-4201-a9fe-71ec3da5c55d", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", ":request_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a558a67-0c7c-4203-89de-c8c11fd91442", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", ":request_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56171ed9-6581-4421-ac55-7a851704c034", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", ":request_id", "accept" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a19e2ef1-4c1f-4c12-8eb6-cb17e1c8d6b5", "name": "Get the current user's join requests for a space", "request": { "name": "Get the current user's join requests for a space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", "my-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "request_id", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: requested_time, requested_by, name, request_id, status, role" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "59720f79-92d6-4883-aa4c-6a55f6d92df6", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", "my-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "request_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"requests\": {\n \"requested_time\": \"Wed, 06 Aug 2025, 16:10:51\",\n \"requested_by\": \"80473960\",\n \"role\": \"VIEWER\",\n \"request_id\": \"3009000000789147\",\n \"status\": \"PENDING\"\n }\n },\n \"message\": \"Space join request fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000701079/requests/my-requests\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cef5d32-ea76-41a6-a657-f8cc2b471035", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", "my-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "request_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7bf1de7-e37d-4a77-afe2-80dab1f55024", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", "my-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "request_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30dfde9e-f0cf-4fa7-9c00-3d9c906a375b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", "my-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "request_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"80473960\",\n \"error_code\": \"R1014\",\n \"team_id\": \"3009000000694083\",\n \"message\": \"Space join request not found\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000694083/requests/my-requests\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2871a7fb-4ff3-4c28-83d0-2c50f4a52d9d", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", "my-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "request_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "856a6ba7-b51a-4564-8585-deb0f7dbe8f4", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", "my-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "request_id" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52bd68b4-ed8e-4bbc-b2b6-53a2f2cf46a3", "name": "Reject a request to join a space", "request": { "name": "Reject a request to join a space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "c15ed70f-eff2-497c-ae23-2bf486898ff2", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"112255940\",\n \"updated_at\": \"Fri, 21 Aug 2026, 20:10:08\",\n \"request_id\": \"5777000000922022\",\n \"space_id\": \"5777000000919096\",\n \"zuid\": \"97049596\",\n \"status\": \"REJECTED\"\n },\n \"message\": \"Space join request rejected successfully\",\n \"request_uri\": \"/vani/api/v1/editions/112255940/spaces/5777000000919096/requests/5777000000922022/reject\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e93609c-bdfc-4fe5-b2a9-e1b5d032125d", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32ae9b7d-ca89-4fb3-bd5f-23da64c73d2a", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"80473960\",\n \"error_code\": \"A1003\",\n \"team_id\": \"3009000000694083\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000694083/requests/3009000000777117/reject\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beaab9bc-21d1-4040-9f2d-ae9574886f67", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02835b39-5f09-406e-ba29-64e4f0d73fe1", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"R1015\",\n \"team_id\": \"3009000000694083\",\n \"message\": \"Space join request is already rejected\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000694083/requests/3009000000777117/reject\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e3d849b-527a-41c3-8006-278394ae0cad", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec380b1a-6aa7-412f-930b-e1574cc68dcc", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "requests", ":request_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) The unique identifier of the request" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3673cdbd-abe7-4b00-8bfc-de6de6a724c6", "name": "Zones", "description": { "content": "Create, duplicate, move, and update zones, read their metadata, and insert templates into them.", "type": "text/plain" }, "item": [ { "id": "c7afee7f-44ea-4526-ac46-8a85881e5d29", "name": "Move a zone to another space", "request": { "name": "Move a zone to another space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"move_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"쟵揣ແꉗ蘀漞⺪띜㻚\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e33c2674-c093-449f-a4ea-a7a20707306b", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"move_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"쟵揣ແꉗ蘀漞⺪띜㻚\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"space_info\": {\n \"created_time\": \"Mon, 10 Mar 2025, 10:42:20\",\n \"last_modified_time\": \"Mon, 10 Mar 2025, 10:42:20\",\n \"is_favorite\": \"false\",\n \"space_name\": \"Project proposal\",\n \"publish\": \"false\",\n \"owner_zuid\": \"96384499\",\n \"can_edit\": \"true\",\n \"allow_embed\": \"false\",\n \"team_id\": \"693000000435005\",\n \"space_id\": \"693000000569361\",\n \"last_author_zuid\": \"96384499\",\n \"status\": \"ACTIVE\"\n }\n },\n \"message\": \"Zone moved successfully\",\n \"request_uri\": \"/vani/api/v1/editions/75918186/spaces/693000000569005/zones/4a971774-9ea7-4f1b-94c8-7199a254d6ba/move\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d349486f-1c44-4b58-b11a-0d28168fa56c", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"move_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"쟵揣ແꉗ蘀漞⺪띜㻚\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9285b87-b502-46b5-82b0-2f90be31a62e", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"move_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"쟵揣ແꉗ蘀漞⺪띜㻚\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"693000000481013\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/spaces/693000000481013/zones/61fae7ca-ebcc-4ab9-881c-07b1aa9c814b/move\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6122d5c-86a2-4260-9ebf-10e4abefd213", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"move_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"쟵揣ແꉗ蘀漞⺪띜㻚\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1009\",\n \"message\": \"Space not found\",\n \"space_id\": \"69300000569005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/spaces/69300000569005/zones/b313272b-fa45-4111-b61d-de64a0044260/move\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54b8e1b6-55e2-468d-961e-cb38c9e22ea4", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"move_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"쟵揣ແꉗ蘀漞⺪띜㻚\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5409d560-911e-4501-912d-3504c17f93d4", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"move_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"쟵揣ແꉗ蘀漞⺪띜㻚\",\n \"deep_copy\": false,\n \"team_id\": \"string\",\n \"destination_space_id\": \"string\",\n \"copy_comments\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2fd9ebaf-4ff6-46f0-80ca-6646628e378f", "name": "Create a new zone", "request": { "name": "Create a new zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"create_zone\": {\n \"zone_name\": \"嗣\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3d70d99d-2fac-4a3d-9542-97c1c75a80d4", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_zone\": {\n \"zone_name\": \"嗣\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"zone_info\": {\n \"created_time\": \"Fri, 25 Jul 2025, 06:01:52\",\n \"zone_id\": \"ee01ded6-158e-4729-99b0-257ab23be6d1\",\n \"last_modified_time\": \"Fri, 25 Jul 2025, 06:01:52\",\n \"zone_name\": \"Zone 2\",\n \"space_id\": \"4855000000088149\",\n \"last_author_zuid\": \"888015717\",\n \"author_zuid\": \"888015717\",\n \"status\": \"ACTIVE\"\n }\n },\n \"message\": \"Zone created successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/888012145/spaces/4855000000088149/zones\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7c1c486-caa6-40b2-9c3b-078bc113432b", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_zone\": {\n \"zone_name\": \"嗣\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5cc717b-72f9-473f-b092-fa7899d960c5", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_zone\": {\n \"zone_name\": \"嗣\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"300900000005397\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/300900000005397/zones\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5da2f550-64a6-4954-84ee-196ce965a2d8", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_zone\": {\n \"zone_name\": \"嗣\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1030\",\n \"message\": \"Template not found\",\n \"space_id\": \"3009000000419047\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000419047/zones\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6861534f-8284-4512-af12-9e1fcb4e6076", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_zone\": {\n \"zone_name\": \"嗣\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"85572652\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"Z1010\",\n \"message\": \"Zone creation limit reached\",\n \"space_id\": \"1600000000657005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/85572652/spaces/1600000000657005/zones\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43ad790f-a5b3-49eb-ae6b-dcd7d29a7e66", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_zone\": {\n \"zone_name\": \"嗣\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a95a045-424a-48a4-9808-cde98064722c", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_zone\": {\n \"zone_name\": \"嗣\",\n \"template_id\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0a86e1e-bdc3-41f9-9e13-5f9492ccecd6", "name": "Get zone metadata", "request": { "name": "Get zone metadata", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "e9554204-76e6-4773-9d06-a66a5912afb4", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"zone_info\": {\n \"created_time\": \"Tue, 15 Jul 2025, 10:49:13\",\n \"zone_id\": \"c606cdb1-ae46-47a6-847b-0a36caf9f797\",\n \"last_modified_time\": \"Tue, 29 Jul 2025, 13:46:46\",\n \"zone_key\": \"3009000000701095\",\n \"zone_name\": \"Zone 1\",\n \"space_id\": \"3009000000701079\",\n \"author_zuid\": \"96384499\",\n \"last_author_zuid\": \"96384499\",\n \"status\": \"ACTIVE\"\n }\n },\n \"message\": \"Zone metadata fetched successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000701079/zones/c606cdb1-ae46-47a6-847b-0a36caf9f797/meta\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eeef8830-224e-4665-b52c-9f7c7cb0e6f8", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"Z1011\",\n \"message\": \"Zone is not in an active state\",\n \"space_id\": \"3009000000789069\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000789069/zones/e42f51ec-e4dc-4dc5-9587-7a2e49dcdc2e/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cac35553-26e9-4bcf-897f-01040ed812c5", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"3009000000789069\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000789069/zones/e42f51ec-e4dc-4dc5-9587-7a2e49dcdc2e/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "020379b7-66a6-48fd-bfc6-18d449ca9dd0", "name": "Forbidden - the caller is authenticated but not allowed to perform this operation", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1033\",\n \"message\": \"Restricted zone\",\n \"space_id\": \"3009000000789069\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000789069/zones/e42f51ec-e4dc-4dc5-9587-7a2e49dcdc2e/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24c500f4-c584-42eb-be7e-c34167efaeb3", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5ef8382-93c3-4663-b47d-749844c026f0", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd7ced13-c2e4-41fc-9ccc-c3215260a189", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8dd4477b-bb1c-4553-9f12-979237bff91b", "name": "Update zone metadata", "request": { "name": "Update zone metadata", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"zone_name\": \"쟼缡\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "392200f0-bb8d-43a8-8389-8deed4dfbe2a", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"zone_name\": \"쟼缡\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"zone_id\": \"598356E6-5F86-45FA-A7D5-ED8BB6D40DAE\",\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"space_id\": \"1505000000022005\",\n \"new_name\": \"Budget Report\"\n },\n \"message\": \"Zone name updated successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/598356E6-5F86-45FA-A7D5-ED8BB6D40DAE/meta\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c94ead1-96a2-4c2d-aa95-d89410602ab3", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"zone_name\": \"쟼缡\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52dfeea5-80e1-406c-a9a1-ece060a91db6", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"zone_name\": \"쟼缡\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"zone_id\": \"a5fcca17-e9dd-414f-850d-0b920645b05d\",\n \"edition_id\": \"98723605\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"5265000000003011\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/98723605/spaces/5265000000003011/zones/a5fcca17-e9dd-414f-850d-0b920645b05d/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "402826dc-1f44-4cfd-8a4c-566426ae1ff0", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"zone_name\": \"쟼缡\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"zone_id\": \"198356E6-5F86-45FA-A7D5-ED8BB6D40DAE\",\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"1505000000022005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/198356E6-5F86-45FA-A7D5-ED8BB6D40DAE/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a219205f-858f-4280-8223-bc799fd179c9", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"zone_name\": \"쟼缡\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"zone_id\": \"598356E6-5F86-45FA-A7D5-ED8BB6D40DAE\",\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"Z1001\",\n \"message\": \"Zone name is same as the new name\",\n \"space_id\": \"1505000000022005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/598356E6-5F86-45FA-A7D5-ED8BB6D40DAE/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4b76727-488c-4910-934c-efb2ec17ef79", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"zone_name\": \"쟼缡\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acf1fa71-235b-4938-ab79-06a4cb3603d1", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "meta" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"zone_name\": \"쟼缡\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b5f2b69-3751-4185-9b15-bf0fbfd33c53", "name": "Insert a template into a zone", "request": { "name": "Insert a template into a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"template_id\": \"68\",\n \"placement\": \"NEAR_POSITION\",\n \"position\": {\n \"top\": 5960.458109284228,\n \"left\": 1690.065447159157\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0470959c-9c5c-4f28-9c3f-6e547dbc9351", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"68\",\n \"placement\": \"NEAR_POSITION\",\n \"position\": {\n \"top\": 5960.458109284228,\n \"left\": 1690.065447159157\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84b6f346-b678-402a-9954-7e47807e80d0", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"68\",\n \"placement\": \"NEAR_POSITION\",\n \"position\": {\n \"top\": 5960.458109284228,\n \"left\": 1690.065447159157\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0589edda-aa4c-472d-afec-9feae8fe0157", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"68\",\n \"placement\": \"NEAR_POSITION\",\n \"position\": {\n \"top\": 5960.458109284228,\n \"left\": 1690.065447159157\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf3aba9b-876a-4eff-8245-0f00b4a4e685", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"68\",\n \"placement\": \"NEAR_POSITION\",\n \"position\": {\n \"top\": 5960.458109284228,\n \"left\": 1690.065447159157\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff314dbb-a7ea-4fad-ac43-8179908e76ad", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"68\",\n \"placement\": \"NEAR_POSITION\",\n \"position\": {\n \"top\": 5960.458109284228,\n \"left\": 1690.065447159157\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec1d5b9e-3c5a-4892-aae8-5ce35cf24d24", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"68\",\n \"placement\": \"NEAR_POSITION\",\n \"position\": {\n \"top\": 5960.458109284228,\n \"left\": 1690.065447159157\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e0615253-132a-4a5c-b96e-c2b862dd9a5d", "name": "Update zone state", "request": { "name": "Update zone state", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"zone_state\": \"DELETE\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "37162a90-ceea-4e92-8699-4ed939921266", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"zone_state\": \"DELETE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"zone_id\": \"598356E6-5F86-45FA-A7D5-ED8BB6D40DAE\",\n \"edition_id\": \"97375109\",\n \"space_state\": \"TRASH\",\n \"current_user_id\": \"96384499\",\n \"space_id\": \"1505000000022005\"\n },\n \"message\": \"Zone state updated successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/598356E6-5F86-45FA-A7D5-ED8BB6D40DAE/state\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0633fa2b-99ce-4cb9-a882-e842d754e95d", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"zone_state\": \"DELETE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"zone_id\": \"6F961124-4598-47D6-9BDA-1705DFBA07D7\",\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"Z1009\",\n \"message\": \"Zone threshold violation\",\n \"space_id\": \"1505000000022005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/6F961124-4598-47D6-9BDA-1705DFBA07D7/state\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47d13c51-2fb2-4e2c-8d05-6d7676e08049", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"zone_state\": \"DELETE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"zone_id\": \"05A61516-A352-44C6-94C3-BE44F728C9D9\",\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"300900000009397\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/300900000009397/zones/05A61516-A352-44C6-94C3-BE44F728C9D9/state\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38c28401-0aec-49ce-a405-9f799cd0f379", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"zone_state\": \"DELETE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df00c569-f70b-425f-bb1b-8f5ca065260b", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"zone_state\": \"DELETE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ae3de12-130c-4ac7-aa48-0ab6a12bc3d5", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"zone_state\": \"DELETE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25947cd0-91de-4941-87ee-e87908d7dd32", "name": "Get metadata for all zones in a space", "request": { "name": "Get metadata for all zones in a space", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "zone_name", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: created_time, last_modified_time, zone_name, author_zuid, status, last_author_zuid, space_id, state_modified_time" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "b3e76b7f-4fbd-4b93-bec6-a1551a99a50f", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zone_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"zones_info\": {\n \"zone_order\": [\n \"0e1e3a8a-a115-463e-bdb6-f540ab37eeb6\",\n \"6F961124-4598-47D6-9BDA-1705DFBA07D7\",\n \"598356E6-5F86-45FA-A7D5-ED8BB6D40DAE\"\n ],\n \"zone_meta\": {\n \"598356E6-5F86-45FA-A7D5-ED8BB6D40DAE\": {\n \"created_time\": \"Tue, 04 Feb 2025, 11:34:28\",\n \"zone_name\": \"Zone 3\"\n },\n \"0e1e3a8a-a115-463e-bdb6-f540ab37eeb6\": {\n \"created_time\": \"Tue, 28 Jan 2025, 11:59:50\",\n \"zone_name\": \"Zone 1\"\n },\n \"6F961124-4598-47D6-9BDA-1705DFBA07D7\": {\n \"created_time\": \"Tue, 04 Feb 2025, 11:34:26\",\n \"zone_name\": \"Zone 2\"\n }\n }\n }\n },\n \"message\": \"Zone metadata fetched successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000095397/zones/meta\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b42fb270-ac98-43a4-a258-c08dea454cbd", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zone_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04f7c11a-92cb-4d2e-a761-4a82edeb33d6", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zone_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"97375109\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"1505000000022005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/meta\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53520e47-847b-4755-af77-900a3a892586", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zone_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fa124ea-9b72-43ce-89bf-cc876f4a4572", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zone_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e7b110c-f9df-4a8d-b51b-d44b26b8899b", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zone_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "85d502e0-f3a4-424a-a1c6-0760e0d20835", "name": "Duplicate a zone", "request": { "name": "Duplicate a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"duplicate_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"휿뚐ꏭᗸ檋ⷹ\",\n \"deep_copy\": true,\n \"zone_name\": \"\\uddda嬔ǐ\",\n \"version_id\": \"string\",\n \"team_id\": \"string\",\n \"copy_members\": false,\n \"destination_space_id\": \"string\",\n \"copy_comments\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "54ecaee1-e4e7-42f3-9231-8e089db5ec2e", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duplicate_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"휿뚐ꏭᗸ檋ⷹ\",\n \"deep_copy\": true,\n \"zone_name\": \"\\uddda嬔ǐ\",\n \"version_id\": \"string\",\n \"team_id\": \"string\",\n \"copy_members\": false,\n \"destination_space_id\": \"string\",\n \"copy_comments\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"space_id\": \"693000000598369\",\n \"uri\": \"/vani/api/v1/editions/75918186/spaces/693000000598369/zones/meta\"\n },\n \"message\": \"Zone duplicated successfully\",\n \"request_uri\": \"/vani/api/v1/editions/75918186/spaces/693000000562161/zones/8915a5e7-ba1a-4ef9-8f25-75a873ff7f10/duplicate\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2072955-3aeb-450f-9a03-1d523d42ffae", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duplicate_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"휿뚐ꏭᗸ檋ⷹ\",\n \"deep_copy\": true,\n \"zone_name\": \"\\uddda嬔ǐ\",\n \"version_id\": \"string\",\n \"team_id\": \"string\",\n \"copy_members\": false,\n \"destination_space_id\": \"string\",\n \"copy_comments\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ce15dbb-c70d-4a80-99a7-004fb9882756", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duplicate_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"휿뚐ꏭᗸ檋ⷹ\",\n \"deep_copy\": true,\n \"zone_name\": \"\\uddda嬔ǐ\",\n \"version_id\": \"string\",\n \"team_id\": \"string\",\n \"copy_members\": false,\n \"destination_space_id\": \"string\",\n \"copy_comments\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"69300000562248\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/spaces/69300000562248/zones/91c26965-0165-4b48-b976-16c924498a8c/duplicate\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58161c9a-d325-4bc4-a3e2-f75ea90c7ee0", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duplicate_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"휿뚐ꏭᗸ檋ⷹ\",\n \"deep_copy\": true,\n \"zone_name\": \"\\uddda嬔ǐ\",\n \"version_id\": \"string\",\n \"team_id\": \"string\",\n \"copy_members\": false,\n \"destination_space_id\": \"string\",\n \"copy_comments\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"693000000562248\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/spaces/693000000562248/zones/11c26965-0165-4b48-b976-16c924498a8c/duplicate\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "373f898a-e1f9-44b3-a0c5-646784fdf392", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duplicate_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"휿뚐ꏭᗸ檋ⷹ\",\n \"deep_copy\": true,\n \"zone_name\": \"\\uddda嬔ǐ\",\n \"version_id\": \"string\",\n \"team_id\": \"string\",\n \"copy_members\": false,\n \"destination_space_id\": \"string\",\n \"copy_comments\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "422fd788-bab3-4fd8-b0c7-baf2c16fa968", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duplicate_zone\": {\n \"destination_type\": \"EXISTING_SPACE\",\n \"space_name\": \"휿뚐ꏭᗸ檋ⷹ\",\n \"deep_copy\": true,\n \"zone_name\": \"\\uddda嬔ǐ\",\n \"version_id\": \"string\",\n \"team_id\": \"string\",\n \"copy_members\": false,\n \"destination_space_id\": \"string\",\n \"copy_comments\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "fd8a2970-9415-4600-a720-cf77632cca38", "name": "Zone Versions", "description": { "content": "Read the current version of a zone.", "type": "text/plain" }, "item": [ { "id": "0b2567b8-c5ac-4c8f-937a-783561431cb9", "name": "Get the current version of a zone", "request": { "name": "Get the current version of a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "version" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "version_id", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: modified_by, version_id, version_time, description, uri" }, { "disabled": false, "key": "from", "value": "4622", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "94", "description": "The maximum number of results to return in the response. Default value is 20" }, { "disabled": false, "key": "from_date", "value": "string", "description": "Allows you to fetch only those Zone versions that have been created or modified since the given timestamp" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "1a5cc1c1-205a-4298-b2d3-5c0b1e4e4eb9", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "version_id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "from_date", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"zone_versions\": {\n \"restricted_versions\": [\n {\n \"modified_by\": \"80215739\",\n \"version_id\": \"1373000000529563\"\n }\n ],\n \"allowed_versions\": []\n }\n },\n \"message\": \"Zone versions fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/80585907/spaces/1373000000529203/zones/1b28dc96-a3bc-45c3-9977-e4089b513a31/version\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56d98254-1d60-4bb7-9133-010b30c09da4", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "version_id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "from_date", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb2517a7-86fc-40ab-ba59-eccb5db97a9c", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "version_id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "from_date", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"85572652\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"160000000657005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/85572652/spaces/160000000657005/zones/ef7b7fe1-327b-4ec1-904d-8232677d689c/version\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "016d6e8e-6050-4a3d-8f09-099979c58c22", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "version_id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "from_date", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"75434908\",\n \"current_user_id\": \"80215739\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"149000042348078\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75434908/spaces/149000042348078/zones/89cf103a-0701-41b3-823c-f2229436333e/version\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64e1bc0c-95f3-4837-90a3-ab58780591aa", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "version_id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "from_date", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d571a50c-9fc4-4350-9cad-5ae2e51906a0", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "version" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "version_id" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "from_date", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c511918c-ce97-4e93-aad7-05467139c8a5", "name": "Conditional Sharing", "description": { "content": "Share individual zones within a space with a specific member.", "type": "text/plain" }, "item": [ { "id": "7962404a-3b74-4abe-a1ec-83656449e16f", "name": "Share zones in a space with members", "request": { "name": "Share zones in a space with members", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"member_id\": {\n \"value\": \"\"\n },\n \"member_type\": {\n \"value\": \"\"\n },\n \"resource_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "47738446-f65a-4a13-9ae9-bf87f4d45e0b", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"member_id\": {\n \"value\": \"\"\n },\n \"member_type\": {\n \"value\": \"\"\n },\n \"resource_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"added_members\": [\n {\n \"member_id\": \"3009000000002003\",\n \"access_state\": \"PARTIAL ACCESS\",\n \"resources\": [\n {\n \"member_type\": \"TEAM\",\n \"added_time\": \"Tue, 08 Jul 2025, 01:58:52\",\n \"added_by\": \"96384499\",\n \"resource_type\": \"document\",\n \"resource_id\": \"6800EB6E-ED24-4EA6-91C6-805445418B17\",\n \"permission\": \"restricted\"\n }\n ]\n },\n {\n \"member_id\": \"62609972\",\n \"access_state\": \"PARTIAL ACCESS\",\n \"resources\": [\n {\n \"member_type\": \"USER\",\n \"added_time\": \"Mon, 07 Jul 2025, 18:16:32\",\n \"added_by\": \"80215739\",\n \"resource_type\": \"document\",\n \"resource_id\": \"6800EB6E-ED24-4EA6-91C6-805445418B17\",\n \"permission\": \"restricted\"\n }\n ]\n }\n ]\n },\n \"message\": \"Resource members added successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f56616d-1291-46f6-8bad-ef5569770f4a", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"member_id\": {\n \"value\": \"\"\n },\n \"member_type\": {\n \"value\": \"\"\n },\n \"resource_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Partial Content", "code": 206, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"failed_members\": [\n {\n \"error_message\": \"Resource member present\",\n \"error_code\": \"S1042\",\n \"zuid\": \"3009000000002003\"\n }\n ],\n \"added_members\": [\n {\n \"member_id\": \"85572741\",\n \"access_state\": \"PARTIAL ACCESS\",\n \"resources\": [\n {\n \"member_type\": \"USER\",\n \"added_time\": \"Wed, 09 Jul 2025, 15:52:18\",\n \"added_by\": \"96384499\",\n \"resource_type\": \"document\",\n \"resource_id\": \"d7ccf816-8293-4a2f-ae83-f10c0e3a6645\",\n \"permission\": \"restricted\"\n }\n ]\n }\n ]\n },\n \"message\": \"Partial success: Some resource members added, others failed.\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efc4107b-670b-4b4b-9ee4-2638c32d8ab7", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"member_id\": {\n \"value\": \"\"\n },\n \"member_type\": {\n \"value\": \"\"\n },\n \"resource_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"failed_members\": [\n {\n \"error_message\": \"Resource member present\",\n \"error_code\": \"S1042\",\n \"zuid\": \"3009000000002003\"\n },\n {\n \"error_message\": \"Resource member present\",\n \"error_code\": \"S1042\",\n \"zuid\": \"3009000000002003\"\n }\n ],\n \"error_code\": \"R1002\",\n \"message\": \"Resource member add failed\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9637226-ae69-42d9-9679-fe176eb18241", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"member_id\": {\n \"value\": \"\"\n },\n \"member_type\": {\n \"value\": \"\"\n },\n \"resource_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"3009000000607005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000607005/zones/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0765e7a-1e80-49bf-a750-3cb7ffb16567", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"member_id\": {\n \"value\": \"\"\n },\n \"member_type\": {\n \"value\": \"\"\n },\n \"resource_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1009\",\n \"message\": \"Space not found\",\n \"space_id\": \"300900000618005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/300900000618005/zones/members\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bd4715b-b7cd-4e85-a903-581b56a040b9", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"member_id\": {\n \"value\": \"\"\n },\n \"member_type\": {\n \"value\": \"\"\n },\n \"resource_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53ba50fe-16da-4ada-ad85-588952d55b3e", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"members_info\": [\n {\n \"member_id\": {\n \"value\": \"\"\n },\n \"member_type\": {\n \"value\": \"\"\n },\n \"resource_id\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"permission\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "932ec335-c8fb-4782-8ad9-4a577b70b4c7", "name": "Share every zone in a space with a member", "request": { "name": "Share every zone in a space with a member", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "9482619e-2279-4130-9107-f4677f7fcbe7", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"space_resource_info\": {\n \"member_id\": \"3009000000002003\",\n \"access_state\": \"FULL ACCESS\",\n \"resources\": [\n {\n \"member_type\": \"TEAM\",\n \"added_time\": \"Mon, 07 Jul 2025, 18:22:20\",\n \"added_by\": \"80215739\",\n \"resource_type\": \"document\",\n \"resource_id\": \"d7ccf816-8293-4a2f-ae83-f10c0e3a6645\",\n \"permission\": \"allowed\"\n },\n {\n \"member_type\": \"TEAM\",\n \"added_time\": \"Mon, 07 Jul 2025, 18:22:20\",\n \"added_by\": \"80215739\",\n \"resource_type\": \"document\",\n \"resource_id\": \"31E57A34-3405-41D2-A2B6-7BAACAE9EE02\",\n \"permission\": \"allowed\"\n },\n {\n \"member_type\": \"TEAM\",\n \"added_time\": \"Mon, 07 Jul 2025, 18:22:20\",\n \"added_by\": \"80215739\",\n \"resource_type\": \"document\",\n \"resource_id\": \"9E23791B-B3AE-4877-9119-3F636DC685AC\",\n \"permission\": \"allowed\"\n },\n {\n \"member_type\": \"TEAM\",\n \"added_time\": \"Mon, 07 Jul 2025, 18:22:08\",\n \"added_by\": \"80215739\",\n \"resource_type\": \"document\",\n \"resource_id\": \"6800EB6E-ED24-4EA6-91C6-805445418B17\",\n \"permission\": \"allowed\"\n }\n ],\n \"space_id\": \"3009000000618005\"\n }\n },\n \"message\": \"All resources shared successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/3009000000002003\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a96cca50-2b12-463b-9114-afc3d408017a", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb01d12a-dbea-4d4d-b7bd-06b36e382366", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"3009000000612023\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000612023/zones/members/3009000000002004\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9598308f-8bee-44f4-ae1b-95466ca4c492", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1015\",\n \"message\": \"member is not part of the Space\",\n \"space_id\": \"3009000000618005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/3009000000002004\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "998ac420-5633-437c-b788-f8cd5a587a45", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1045\",\n \"message\": \"Member already has full access\",\n \"space_id\": \"3009000000618005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/3009000000002003\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "def3e685-bddf-452d-9b0c-cebbfcac8850", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "796a052a-e633-403f-affb-436043e1e0f6", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "127ff1e0-4430-48b9-809d-44b6bc84c404", "name": "Get the zones in a space shared with a member", "request": { "name": "Get the zones in a space shared with a member", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "5398dd1b-dff3-45e8-bb97-59bac727c0d6", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"space_resource_info\": {\n \"member_id\": \"96384499\",\n \"access_state\": \"FULL ACCESS\",\n \"resources\": [],\n \"space_id\": \"3009000000618005\"\n }\n },\n \"message\": \"User resources fetched successfully.\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/96384499\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5f49497-32c7-46d2-8c12-507f4da320a2", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31d9b11f-962e-465d-a765-29da8a0e73f0", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"3009000000612023\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000612023/zones/members/9638449\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9e5aa60-bdfc-49f1-a73a-d011ad5d207e", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1015\",\n \"message\": \"member is not part of the Space\",\n \"space_id\": \"3009000000618005\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/9638449\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d96bbde1-3609-4390-b56e-4a9860f6edd2", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8accaae5-c941-4b0a-8323-411c5b8c97e0", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", "members", ":member_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "member_id", "description": "(Required) The unique identifier of the member" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8363df74-3de7-4e6c-b1f3-782ecd7f8fe2", "name": "Shapes", "description": { "content": "Insert, list, update, and delete shapes directly on a zone.", "type": "text/plain" }, "item": [ { "id": "e290aa3b-c920-4914-9531-e72b7703ad3b", "name": "Insert one or more shapes into a zone", "request": { "name": "Insert one or more shapes into a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"shape\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dd657561-9dc7-4bab-babf-5547a290b38f", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"shape\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"inserted_ids\": [\n \"e4163cc2-1d24-546b-a8a5-6b0817da7887\",\n \"d406b989-45f5-5018-a6b9-4f6671e32527\",\n \"0c568942-223e-5fec-9a5c-1989fe8c5f49\",\n \"5eeac863-9d71-5c23-8b30-6a0bc390b87f\",\n \"facef9f3-94dd-5fb6-bee7-c58cbd9f28b8\"\n ]\n },\n \"message\": \"Shapes inserted successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5247956-8be2-4e9e-a865-b29430cd5915", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"shape\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "416eabdd-cff3-46c6-890f-2d27e56b3b56", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"shape\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0cbb450-dc1f-4cd6-8531-277a53f64f70", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"shape\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0043c3d1-ad17-4f20-99db-34f82315d84d", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"shape\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "246330e6-b408-436e-87ad-3e861f55752e", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"shape\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e19dd09e-d1de-4bf9-8e6e-3621b13261d7", "name": "Get the shapes in a zone", "request": { "name": "Get the shapes in a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8", "description": "Optional comma-separated UUID list to fetch selected items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "63976853-1652-4fab-b233-c9d75c813471", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"total_count\": 3,\n \"elements\": [\n {\n \"shape\": {\n \"shape\": {\n \"flowchart\": {\n \"type\": \"PROCESS\"\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"a2893ee3-3085-5215-9254-e610c8589892\",\n \"portions\": [\n {\n \"style\": {\n \"fontweight\": \"NORMAL\",\n \"size\": 18,\n \"color\": {\n \"rgb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n },\n \"text\": \"Process\"\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 10,\n \"bottom\": 5,\n \"right\": 10\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"properties\": {\n \"layout\": {\n \"top\": 440,\n \"left\": 40,\n \"width\": 200,\n \"height\": 120\n },\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 76,\n \"green\": 175,\n \"blue\": 80\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"8740168d-dea1-58bc-b551-ed8847fa9ef2\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"block_arrow\": {\n \"single_arrow\": {}\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"64f7c556-37f0-5f0a-9881-8a582d18949e\",\n \"portions\": [\n {\n \"style\": {\n \"fontweight\": \"NORMAL\",\n \"size\": 18,\n \"color\": {\n \"rgb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n },\n \"text\": \"Next\"\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 10,\n \"bottom\": 5,\n \"right\": 10\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"properties\": {\n \"layout\": {\n \"top\": 440,\n \"left\": 280,\n \"width\": 200,\n \"height\": 120\n },\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 255,\n \"green\": 87,\n \"blue\": 34\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"d2f8315c-1743-5320-9287-b4574fdd8b8d\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"flowchart\": {\n \"type\": \"DECISION\"\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"id\": \"2f2eeccd-410c-419c-acd6-09d74343fa6e\",\n \"portions\": [\n {\n \"style\": {\n \"fontweight\": \"NORMAL\"\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 10,\n \"bottom\": 5,\n \"right\": 10\n }\n }\n },\n \"properties\": {\n \"layout\": {\n \"top\": 40,\n \"left\": 520,\n \"width\": 200,\n \"height\": 120\n }\n }\n }\n },\n \"id\": \"44444444-4444-5444-9444-444444444444\"\n }\n ]\n },\n \"message\": \"Shapes fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78fd7270-87cb-47f2-8272-6a9519bba769", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1011\",\n \"message\": \"Zone is not in an active state\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "114cdb7b-9351-4a9a-96ac-bf726e3e1bd1", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"2830000002600178\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "226aa07b-fde3-4baa-8d64-6daa6b741f0a", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07b65b21-95eb-4328-88ec-18c34e888a11", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dee97cc8-2515-46a0-8cf2-7be41847e8be", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83205f6d-0acf-4cd4-ae43-3c78a8d5dce3", "name": "Delete one or more shapes from a zone", "request": { "name": "Delete one or more shapes from a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "492b1d5b-c926-4a25-9c33-2bc9b220daf3", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"shape_id\": \"FE0C9EDB-D1BA-446A-A402-5C4CB87F9458\",\n \"status\": \"success\"\n },\n {\n \"shape_id\": \"1F9A7500-7CF3-4E9A-A946-524CD817744B\",\n \"status\": \"success\"\n },\n {\n \"shape_id\": \"937E51FD-6C25-4870-A936-D97522394925\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"Shapes deleted successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/shapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e9b3bd1-1bca-4946-ab6c-ceaa3922fb99", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f362969-1def-43f1-b44e-6ef127310728", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a81bdbc-44fc-44bc-911e-c6e5836c443b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b1a0844-bc85-4c7a-a538-f71c485550f6", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db61018a-f43e-431e-aded-326213008583", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "edc67e4b-8084-40be-a43b-d2e3b5430ef9", "name": "Update one or more shapes in a zone", "request": { "name": "Update one or more shapes in a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bc84eb2d-7386-494d-80a3-7b49392c77e5", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"id\": \"CF7D1480-628C-476D-9923-AEE7C5D3C742\",\n \"status\": \"success\"\n },\n {\n \"id\": \"49BA9283-408C-47B4-828D-4E9880A9161F\",\n \"status\": \"success\"\n },\n {\n \"id\": \"339D2634-16D3-4445-A675-4696B8FD4EBB\",\n \"status\": \"success\"\n },\n {\n \"id\": \"269FAC98-B4F5-41D1-9643-6368706BF69E\",\n \"status\": \"success\"\n },\n {\n \"id\": \"A16989F9-5C29-4141-A303-BA07C9A62AE9\",\n \"status\": \"success\"\n },\n {\n \"id\": \"10C43DC2-F3BD-470C-8929-85B593CBE9B1\",\n \"status\": \"success\"\n },\n {\n \"id\": \"04164FA1-35C8-4BE1-840C-78ACDA7CCCB6\",\n \"status\": \"success\"\n },\n {\n \"id\": \"D33D70D0-AEE6-4A8F-B882-546E2E66A6E0\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"Shapes updated successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1A0B4F55-BF08-4A1F-83B4-BCFC97EE3158/shapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6eb64edf-aba6-4475-89f6-7f79cd5a5d35", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34a02aa5-f71f-4bbf-86a1-443d2e090375", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86d3aefa-10df-4a52-9903-2e1e2e3a1ec0", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b7de611-796a-4401-b9ad-f322ca7b2b3e", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b7c3709-2ceb-47bc-8c0c-c4bedea78b71", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "dc2c007e-5075-4734-b88a-a163c64112c3", "name": "Connectors", "description": { "content": "Insert, list, update, and delete connectors directly on a zone.", "type": "text/plain" }, "item": [ { "id": "0ceba614-2c90-4def-b442-010c0a55e85e", "name": "Insert one or more connectors into a zone", "request": { "name": "Insert one or more connectors into a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"connector\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d093f82e-4892-47e6-b078-0607ad2dd312", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"connector\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"inserted_ids\": [\n \"0c1c8b83-2264-544f-a5a6-f0b09ff8df38\",\n \"fe557711-f11e-5cda-add7-62cbb92b93ea\",\n \"2394a2a8-7984-565a-9e10-bdc399a950de\",\n \"0f6bf425-0e92-50f6-bc3d-bfda4773fad8\",\n \"660e559f-e2fd-5d6e-a69a-e55a9d0e0ed8\"\n ]\n },\n \"message\": \"Connectors inserted successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d725acf8-3d4c-4283-825d-530aa46a5855", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"connector\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3de9f72d-df82-4c58-b171-7635740ecdf3", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"connector\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7e7cfe6-623f-4624-8795-f252497ba725", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"connector\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e33b5f6-b158-464a-9c90-16bc2a23200f", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"connector\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c70bdd4-2e90-49d1-b650-69cc6335d064", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"connector\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef6ba684-9ae6-4cfe-a36e-6fad41f6ca44", "name": "Get the connectors in a zone", "request": { "name": "Get the connectors in a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8", "description": "Optional comma-separated UUID list to fetch selected items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "3d3a4147-e2ce-4023-bcdd-f7830ef78464", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"total_count\": 3,\n \"elements\": [\n {\n \"connector\": {\n \"connected\": {\n \"first\": {\n \"marker\": \"DIAMOND\",\n \"shape_id\": \"6FE655E1-6039-46E1-BECA-30067ED96517\"\n },\n \"second\": {\n \"side\": \"WEST\",\n \"marker\": \"OVAL\",\n \"shape_id\": \"8BB93A22-6976-4976-AA4C-417D16BA8876\"\n }\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"halign\": \"CENTER\"\n },\n \"id\": \"a3333333-3333-5333-8333-333333333333\",\n \"portions\": [\n {\n \"style\": {\n \"fontweight\": \"NORMAL\"\n },\n \"text\": \"Curve (diamond → oval)\"\n }\n ]\n }\n ],\n \"properties\": {}\n },\n \"type\": \"CURVE\",\n \"stroke\": {\n \"captype\": \"CAPROUND\",\n \"width\": 3,\n \"type\": \"SQUARE_DOT\",\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 156,\n \"green\": 39,\n \"blue\": 176\n }\n }\n }\n }\n }\n },\n \"id\": \"2394a2a8-7984-565a-9e10-bdc399a950de\"\n },\n {\n \"connector\": {\n \"connected\": {\n \"first\": {\n \"side\": \"NORTH\",\n \"marker\": \"OPEN\",\n \"shape_id\": \"01EEDC0C-45EC-44A3-96F6-740155ACE02C\"\n },\n \"second\": {\n \"side\": \"SOUTH\",\n \"marker\": \"BLOCK\",\n \"shape_id\": \"B579FA1E-B4D2-41BC-B543-25B3C1790314\"\n }\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"halign\": \"CENTER\"\n },\n \"id\": \"3ab1987e-7e55-516b-a3c7-5248626bab9c\",\n \"portions\": [\n {\n \"style\": {\n \"fontweight\": \"NORMAL\"\n },\n \"text\": \"Elbow with label\"\n }\n ]\n }\n ],\n \"properties\": {}\n },\n \"type\": \"ELBOW\",\n \"stroke\": {\n \"width\": 2,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 76,\n \"green\": 175,\n \"blue\": 80\n }\n }\n }\n }\n }\n },\n \"id\": \"0f6bf425-0e92-50f6-bc3d-bfda4773fad8\"\n },\n {\n \"connector\": {\n \"connected\": {\n \"first\": {\n \"side\": \"EAST\",\n \"marker\": \"NONE\",\n \"shape_id\": \"62E4A270-79F6-44F8-A381-9BDB9718DFC4\"\n },\n \"second\": {\n \"side\": \"WEST\",\n \"marker\": \"CLASSIC\",\n \"shape_id\": \"F4F4F69D-2B6E-4241-9A87-79393F0D0F50\"\n }\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"halign\": \"CENTER\"\n },\n \"id\": \"a5555555-5555-5555-8555-555555555555\",\n \"portions\": [\n {\n \"style\": {\n \"fontweight\": \"NORMAL\"\n },\n \"text\": \"Line (point attach)\"\n }\n ]\n }\n ],\n \"properties\": {}\n },\n \"stroke\": {\n \"width\": 1,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 244,\n \"green\": 67,\n \"blue\": 54\n }\n }\n }\n }\n }\n },\n \"id\": \"660e559f-e2fd-5d6e-a69a-e55a9d0e0ed8\"\n }\n ]\n },\n \"message\": \"Connectors fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c79d52b6-5ccd-4d52-9619-d2965e75448b", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1011\",\n \"message\": \"Zone is not in an active state\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22edff89-7898-4938-8bff-c21e67246bcb", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"2830000002600178\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17874bb5-b78a-4e02-9bca-0fea235d7501", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b49f8da-ba76-42cb-bdfe-a86f47e188e4", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b37d3e8b-af92-4b6b-b622-6a57b6946c11", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ca60453-cdd8-4c46-b529-43f96a807957", "name": "Delete one or more connectors from a zone", "request": { "name": "Delete one or more connectors from a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "40db2633-cc66-43d5-84b2-79351e2ecd7b", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"shape_id\": \"2394a2a8-7984-565a-9e10-bdc399a950de\",\n \"status\": \"success\"\n },\n {\n \"shape_id\": \"27613A45-CC58-4EAA-9A13-60C865CE038A\",\n \"status\": \"success\"\n },\n {\n \"shape_id\": \"909813A9-CB90-4F51-BD7A-2D96E3F02B35\",\n \"status\": \"success\"\n },\n {\n \"shape_id\": \"EA5CEF19-D92C-4053-8410-EC29594F3DE6\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"Connectors deleted successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "234d0419-711b-4ebb-bc4c-94b0da506087", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44fe862c-caeb-44c3-8aa6-5d0cdc80b364", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a60217b-ffd5-4f1b-8d3f-f2ab9ac88c5b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1738ca9-fa2e-45a2-9476-6c3bda3edd47", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58035adb-1ba8-48f9-947a-6a319bc00abe", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c222da74-4cfb-43f0-8161-4018cb62b06a", "name": "Update one or more connectors in a zone", "request": { "name": "Update one or more connectors in a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "267c499f-7c1d-4090-b3a6-903116fdbb71", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"id\": \"0c1c8b83-2264-544f-a5a6-f0b09ff8df38\",\n \"status\": \"success\"\n },\n {\n \"id\": \"fe557711-f11e-5cda-add7-62cbb92b93ea\",\n \"status\": \"success\"\n },\n {\n \"id\": \"2394a2a8-7984-565a-9e10-bdc399a950de\",\n \"status\": \"success\"\n },\n {\n \"id\": \"0f6bf425-0e92-50f6-bc3d-bfda4773fad8\",\n \"status\": \"success\"\n },\n {\n \"id\": \"660e559f-e2fd-5d6e-a69a-e55a9d0e0ed8\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"Connectors updated successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "073858b2-efff-4ac4-86f0-56c6018ba0b5", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "581ff498-01f1-4533-93d0-46f2a5b77a81", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c2ae12d-150a-44b6-9ef4-bb99f56bb12b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "754f7fa8-2211-4267-8e41-a76c9714d1dc", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2719f74-5ebb-4c45-b082-e6795cc4f3a3", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "af33a009-a791-439c-88d1-7691da45b0ee", "name": "Group Shapes", "description": { "content": "Group and ungroup shapes directly on a zone.", "type": "text/plain" }, "item": [ { "id": "942eae56-5365-4095-8cf2-0d2f3b6a2fa3", "name": "Group or ungroup shapes in a zone (op-aware)", "request": { "name": "Group or ungroup shapes in a zone (op-aware)", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"op\": \"ungroup\",\n \"nested_groups\": [\n \"6D6869EC-dEFb-27Ff-ba3D-5Ce98b1CFbbE\"\n ],\n \"groups\": [\n \"cBCdf8f6-C2a1-afdF-B798-2feab2C9b273\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3ba87778-0907-4acc-bf79-7ec17708e0b5", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"op\": \"ungroup\",\n \"nested_groups\": [\n \"6D6869EC-dEFb-27Ff-ba3D-5Ce98b1CFbbE\"\n ],\n \"groups\": [\n \"cBCdf8f6-C2a1-afdF-B798-2feab2C9b273\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"groups\": [\n {\n \"group_id\": \"0f95159c-24f7-4b3d-b7b0-9a080dc9e011\",\n \"group_index\": 0,\n \"status\": \"success\"\n },\n {\n \"group_id\": \"18afea79-4ec1-447e-b740-d561a99ec2b0\",\n \"group_index\": 1,\n \"status\": \"success\"\n },\n {\n \"group_id\": \"225b1dfc-c5ea-4e61-8928-c973d75811a5\",\n \"group_index\": 2,\n \"status\": \"success\"\n },\n {\n \"group_id\": \"390f3d93-0c2a-4f10-869a-590522a4fd44\",\n \"group_index\": 3,\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"Shapes grouped successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "873f87e9-204b-4bd6-982b-d1c78459eeac", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"op\": \"ungroup\",\n \"nested_groups\": [\n \"6D6869EC-dEFb-27Ff-ba3D-5Ce98b1CFbbE\"\n ],\n \"groups\": [\n \"cBCdf8f6-C2a1-afdF-B798-2feab2C9b273\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/C1886757-1B63-4281-A6B7-B478147210EB/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2968c169-ac4a-4aa9-9fdb-d77117521614", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"op\": \"ungroup\",\n \"nested_groups\": [\n \"6D6869EC-dEFb-27Ff-ba3D-5Ce98b1CFbbE\"\n ],\n \"groups\": [\n \"cBCdf8f6-C2a1-afdF-B798-2feab2C9b273\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81275825-0aef-487c-96ed-b5ba8adf69c3", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"op\": \"ungroup\",\n \"nested_groups\": [\n \"6D6869EC-dEFb-27Ff-ba3D-5Ce98b1CFbbE\"\n ],\n \"groups\": [\n \"cBCdf8f6-C2a1-afdF-B798-2feab2C9b273\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ec56db4-532a-427c-b454-eea59640242b", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"op\": \"ungroup\",\n \"nested_groups\": [\n \"6D6869EC-dEFb-27Ff-ba3D-5Ce98b1CFbbE\"\n ],\n \"groups\": [\n \"cBCdf8f6-C2a1-afdF-B798-2feab2C9b273\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da8c65c4-ad53-4974-b292-8e5d7fc0eb54", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"op\": \"ungroup\",\n \"nested_groups\": [\n \"6D6869EC-dEFb-27Ff-ba3D-5Ce98b1CFbbE\"\n ],\n \"groups\": [\n \"cBCdf8f6-C2a1-afdF-B798-2feab2C9b273\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55765f98-97f2-47fb-b984-e3ec54f74d6b", "name": "Get the group shapes in a zone", "request": { "name": "Get the group shapes in a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8", "description": "Optional comma-separated UUID list to fetch selected items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "4c79d273-787c-4c81-b354-c8351b507e42", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"total_count\": 3,\n \"elements\": [\n {\n \"group_shape\": {\n \"layout\": {\n \"top\": -1703,\n \"left\": 619,\n \"width\": 1054.31,\n \"height\": 1168.577\n },\n \"objects\": [\n {\n \"group_shape\": {\n \"layout\": {\n \"top\": -389.62683,\n \"left\": 646.5,\n \"width\": 822.5403,\n \"height\": 544.8257\n },\n \"objects\": [\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"FCE56BCB-D8FB-4FBC-B189-72BF17DA39EC\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {},\n \"properties\": {\n \"layout\": {\n \"top\": -181,\n \"left\": 646.5,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"9B379582-B285-47D2-BF41-DD76EF9FE958\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"5134DB4A-26F3-4CDE-BDF6-D8137DF237F6\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {},\n \"properties\": {\n \"layout\": {\n \"top\": -389.62683,\n \"left\": 938.52606,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"gradient\": {\n \"stops\": [\n {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.65432,\n \"brightness\": 0.95294,\n \"hue\": 0.0283\n }\n },\n \"position\": 0.0581\n },\n {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.51479,\n \"brightness\": 0.66275,\n \"hue\": 0.48659\n }\n },\n \"position\": 0.9538\n }\n ],\n \"type\": \"RADIAL\"\n }\n }\n ]\n }\n }\n },\n \"id\": \"CC9425EB-D2F8-4439-8303-1CA336058EFB\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"star\": {\n \"type\": \"POINT\",\n \"point\": {\n \"type\": \"SEVEN_POINT\"\n }\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"9E2F0822-8E97-47E9-BB92-58A0F0BD421C\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n },\n \"text\": \"start\"\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"properties\": {\n \"layout\": {\n \"top\": 30.198849,\n \"left\": 1344.0403,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"FF0024A2-785E-464D-84CA-36BB1FBB9786\"\n }\n ]\n },\n \"id\": \"35C6DB02-F32C-443A-81EB-5D43E8021B8B\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"callout\": {\n \"type\": \"CLOUD_CALLOUT\"\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"BE56BD69-C330-489A-B98E-7CB175FFBD23\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"properties\": {\n \"layout\": {\n \"top\": 396.26172,\n \"left\": 1048.8867,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"77E4DF34-EB21-4F65-B75B-C1E447A12A7A\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"star\": {\n \"ribbon\": {\n \"type\": \"DOWN\"\n },\n \"type\": \"RIBBON\"\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"14C9561F-A2E9-473B-96CC-6382D957AC66\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"properties\": {\n \"layout\": {\n \"top\": 653.9501,\n \"left\": 1575.8098,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"05F382AB-F890-4823-81D3-510B0DE675AE\"\n }\n ]\n },\n \"id\": \"18afea79-4ec1-447e-b740-d561a99ec2b0\"\n },\n {\n \"group_shape\": {\n \"layout\": {\n \"top\": 945,\n \"left\": 1234,\n \"width\": 1193.688,\n \"height\": 996.707\n },\n \"objects\": [\n {\n \"group_shape\": {\n \"layout\": {\n \"top\": 953.56714,\n \"left\": 828.33813,\n \"width\": 383.9535,\n \"height\": 133.41003\n },\n \"objects\": [\n {\n \"shape\": {\n \"shape\": {\n \"mathematical_symbol\": {\n \"type\": \"MULTIPLY\"\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"43965B02-6A77-49A8-8FE3-B99BE06178C8\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"properties\": {\n \"layout\": {\n \"top\": 953.56714,\n \"left\": 1087.2916,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.44715,\n \"brightness\": 0.96471,\n \"hue\": 0.87273\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"5D923685-27EE-4905-8815-C16F1D8A8DCC\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"99D88FE8-CE11-4894-BFA6-D08D70ABE4E4\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {},\n \"properties\": {\n \"layout\": {\n \"top\": 961.9772,\n \"left\": 828.33813,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"EEBB15FC-D5CD-47B5-8B0C-9B765616B4B9\"\n }\n ]\n },\n \"id\": \"CBFE9913-4D10-486A-80F9-03D160C2C6A5\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"flowchart\": {\n \"type\": \"INTERNAL_STORAGE\"\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"6403E8B7-B380-42DF-8588-F480DA2BED8F\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"properties\": {\n \"layout\": {\n \"top\": 1244.6555,\n \"left\": 505.62988,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"6176DD11-BC4E-47A5-81AC-3EE7CCD5EDE6\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"FBFEBFF7-F671-45C8-A5CC-8A7DC4A51780\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {\n \"type\": \"CLOUD\"\n },\n \"properties\": {\n \"layout\": {\n \"top\": 1006.0866,\n \"left\": 1450.2146,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.07653,\n \"brightness\": 0.76863,\n \"hue\": 0.61111\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"62B4990B-D8FB-43D8-A135-726E3A37959C\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"A60696AF-9992-40D2-A24C-6353402C9C2C\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {\n \"type\": \"HEART\"\n },\n \"properties\": {\n \"layout\": {\n \"top\": 372.94846,\n \"left\": 1574.3179,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.93088,\n \"brightness\": 0.85098\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"6F518490-1979-4AB6-8700-DFE27480826D\"\n }\n ]\n },\n \"id\": \"225b1dfc-c5ea-4e61-8928-c973d75811a5\"\n },\n {\n \"group_shape\": {\n \"layout\": {\n \"top\": -389.62683,\n \"left\": 646.5,\n \"width\": 822.5403,\n \"height\": 544.8257\n },\n \"objects\": [\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"FCE56BCB-D8FB-4FBC-B189-72BF17DA39EC\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {},\n \"properties\": {\n \"layout\": {\n \"top\": -181,\n \"left\": 646.5,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"9B379582-B285-47D2-BF41-DD76EF9FE958\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"5134DB4A-26F3-4CDE-BDF6-D8137DF237F6\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {},\n \"properties\": {\n \"layout\": {\n \"top\": -389.62683,\n \"left\": 938.52606,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"gradient\": {\n \"stops\": [\n {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.65432,\n \"brightness\": 0.95294,\n \"hue\": 0.0283\n }\n },\n \"position\": 0.0581\n },\n {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.51479,\n \"brightness\": 0.66275,\n \"hue\": 0.48659\n }\n },\n \"position\": 0.9538\n }\n ],\n \"type\": \"RADIAL\"\n }\n }\n ]\n }\n }\n },\n \"id\": \"CC9425EB-D2F8-4439-8303-1CA336058EFB\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"star\": {\n \"type\": \"POINT\",\n \"point\": {\n \"type\": \"SEVEN_POINT\"\n }\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"9E2F0822-8E97-47E9-BB92-58A0F0BD421C\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n },\n \"text\": \"start\"\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"properties\": {\n \"layout\": {\n \"top\": 30.198849,\n \"left\": 1344.0403,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"FF0024A2-785E-464D-84CA-36BB1FBB9786\"\n }\n ]\n },\n \"id\": \"35C6DB02-F32C-443A-81EB-5D43E8021B8B\"\n }\n ]\n },\n \"message\": \"GroupShapes fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f7719b6-0f86-402a-a054-8702f64880ba", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1011\",\n \"message\": \"Zone is not in an active state\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "021c4ab7-df70-4e94-974f-bf4a15e27655", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"2830000002600178\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ac3931d-1e2e-4960-a204-e984642ce866", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3197b84f-69d4-420c-aa40-295a77b0b7b7", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62b13bf7-ec8f-4168-916f-af95d371679a", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6b479eb-2ee5-429e-99d2-07edde2bca1d", "name": "Delete one or more group shapes in a zone", "request": { "name": "Delete one or more group shapes in a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ac34420d-3431-4526-8901-6b36218d5fea", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"shape_id\": \"F0C973CE-B8A1-4117-B04A-7711FE6A020C\",\n \"status\": \"success\"\n },\n {\n \"shape_id\": \"BBCDD65F-C6BF-4D73-ACF9-FBB4608A444C\",\n \"status\": \"success\"\n },\n {\n \"shape_id\": \"89EC067F-EAEF-419A-B800-88045B81663F\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"Group shapes deleted successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cff3457-41ed-4a63-8a92-513a0a003144", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ff6cca2-ee6c-47c6-b24f-307a466287d9", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ada767a-8493-40cf-b562-d08a5adbe165", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dbc7b34-053c-455d-9b2b-ceb5127a6ed6", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e68803f1-45df-42f7-afc1-c9510d4c6bec", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f7f57e3-e585-4e2c-8d1c-025601e775bb", "name": "Update one or more group shapes in a zone", "request": { "name": "Update one or more group shapes in a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b607497a-0160-4d44-a5e0-2d7f313393de", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"id\": \"E0DD0833-18B6-4D09-A623-EF518293E06C\",\n \"errors\": [\n {\n \"error_code\": \"EL1006\",\n \"message\": \"Not a groupshape\",\n \"facet\": \"element\"\n }\n ],\n \"status\": \"failed\"\n },\n {\n \"id\": \"F5C83D11-D584-4BF0-865E-DC3A1C6D0EC2\",\n \"errors\": [\n {\n \"error_code\": \"EL1006\",\n \"message\": \"specialised STICKYNOTE container is not a groupshape\",\n \"facet\": \"element\"\n }\n ],\n \"status\": \"failed\"\n },\n {\n \"id\": \"8F28ED4F-69BB-49B2-81CE-D33E323892C8\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"Partial success: some operations failed\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7027631-b6b5-4709-a262-49664ebd2ee3", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4729094-8197-4099-a670-45049ae5c7b2", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7a4fb11-e3c5-496c-b29e-069e8877bf96", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2bbac31-154a-48bb-a90c-98441bbe65a7", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d50a9f1-a6e4-4fea-8cb5-bb8fa464ba58", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7169fe1d-0435-448a-b636-99e895780832", "name": "Frames", "description": { "content": "Insert, list, update, and delete zone-root frames.", "type": "text/plain" }, "item": [ { "id": "04ff94bc-db23-4ace-a424-d4ab7e978c30", "name": "Insert one or more zone-root frames into a zone", "request": { "name": "Insert one or more zone-root frames into a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"meta\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "59a9021d-c030-4a59-a643-a3e16cf70f07", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"meta\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"inserted_ids\": [\n \"f1f362c6-9a9f-58e5-8f47-149f741c91b8\",\n \"68747720-4a7f-5499-95b8-9ebf4b16fc7e\",\n \"6d198740-ac2c-5ac1-b7ab-90471f922f2b\",\n \"d2e81218-0c52-5fca-8e9b-bf68bccf38f0\",\n \"74b0dfa1-9186-5290-a16c-89b51db3bd31\"\n ]\n },\n \"message\": \"Frames inserted successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/DEDA88D7-7A93-4D83-B69A-F5218927091C/frames\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fbe77a7-fca0-431f-8a57-667d42eb7ab8", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"meta\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/DEDA88D7-7A93-4D83-B69A-F5218927091C/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e768d45c-29f3-4bea-b4a1-222c692d5fc0", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"meta\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49fbd2ba-d568-41f5-8019-bc180351231a", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"meta\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "715a12a8-671b-431b-ac00-db9bc4fb3114", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"meta\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5790d270-4f06-4dfa-bb9a-2e94db5d6e2f", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"meta\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9eb9c2e3-6343-47be-8f1d-cc56cc506e1e", "name": "Get the zone-root frames in a zone", "request": { "name": "Get the zone-root frames in a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8", "description": "Optional comma-separated UUID list to fetch selected items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "57382f50-3fa3-40ae-bea6-26f8a079f874", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"frames\": [\n {\n \"meta\": {\n \"name\": \"Slide Landscape\",\n \"id\": \"f1f362c6-9a9f-58e5-8f47-149f741c91b8\"\n },\n \"graphic_objects\": [\n {\n \"shape\": {\n \"shape\": {\n \"callout\": {\n \"type\": \"ROUNDED_RECTANGLE_CALLOUT\"\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"D767F5FA-82BF-4694-8690-220CBDC46E46\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"properties\": {\n \"layout\": {\n \"top\": 558.59375,\n \"left\": 1124.7266,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"11209A82-3D89-4384-AD8F-CDCF1B93C67C\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"FD77B19F-41DE-433B-A652-FF90D4306E56\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {\n \"type\": \"OVAL\"\n },\n \"properties\": {\n \"layout\": {\n \"top\": 159.45312,\n \"left\": 1533.0078,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"EF25C6E5-BDBE-423B-8244-818DB95FD79A\"\n }\n ],\n \"type\": \"CUSTOM\",\n \"properties\": {\n \"layout\": {\n \"width\": 1920,\n \"height\": 1080\n },\n \"strokes\": [\n {\n \"width\": 5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 17,\n \"green\": 24,\n \"blue\": 39\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 255,\n \"green\": 255,\n \"blue\": 255\n }\n }\n }\n }\n ]\n }\n },\n {\n \"meta\": {\n \"name\": \"Slide Portrait\",\n \"id\": \"68747720-4a7f-5499-95b8-9ebf4b16fc7e\"\n },\n \"type\": \"CUSTOM\",\n \"properties\": {\n \"layout\": {\n \"left\": 2000,\n \"width\": 1080,\n \"height\": 1920\n },\n \"strokes\": [\n {\n \"captype\": \"CAPROUND\",\n \"width\": 5,\n \"type\": \"DASH\",\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 29,\n \"green\": 78,\n \"blue\": 216\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"gradient\": {\n \"stops\": [\n {\n \"color\": {\n \"rgb\": {\n \"red\": 255,\n \"green\": 248,\n \"blue\": 225\n }\n }\n },\n {\n \"color\": {\n \"rgb\": {\n \"red\": 255,\n \"green\": 204,\n \"blue\": 128\n }\n },\n \"position\": 1\n }\n ]\n }\n }\n ]\n }\n },\n {\n \"meta\": {\n \"name\": \"A4\",\n \"id\": \"6d198740-ac2c-5ac1-b7ab-90471f922f2b\"\n },\n \"type\": \"CUSTOM\",\n \"properties\": {\n \"layout\": {\n \"top\": 2000,\n \"width\": 794,\n \"height\": 1123\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 4.5,\n \"position\": \"INSIDE\",\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.85,\n \"brightness\": 0.25,\n \"hue\": 0.0016975309\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"gradient\": {\n \"stops\": [\n {\n \"color\": {\n \"rgb\": {\n \"red\": 255,\n \"green\": 255,\n \"blue\": 255\n }\n }\n },\n {\n \"color\": {\n \"rgb\": {\n \"red\": 229,\n \"green\": 231,\n \"blue\": 235\n }\n },\n \"position\": 1\n }\n ],\n \"type\": \"RADIAL\"\n }\n }\n ]\n }\n }\n ],\n \"total_count\": 3\n },\n \"message\": \"Frames fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/DEDA88D7-7A93-4D83-B69A-F5218927091C/frames\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f578135-f308-4de5-8eab-5697501b0cdf", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1011\",\n \"message\": \"Zone is not in an active state\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7aaa8fee-80da-4335-9200-575e6dd70b4b", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"2830000002600178\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c21f2452-18d5-4f6f-b8a8-9f815825623f", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94c0aeca-55b2-468d-8776-935fde7db0ee", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b5c912e-031e-4282-b8f1-2ee0d297b326", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7af1a1a3-8a98-45ab-9c4f-85f12a0491ee", "name": "Delete one or more zone-root frames from a zone", "request": { "name": "Delete one or more zone-root frames from a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "570c1346-4145-48d7-b2ec-3451423c87e5", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"frame_id\": \"f1f362c6-9a9f-58e5-8f47-149f741c91b8\",\n \"status\": \"success\"\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"errors\": [\n {\n \"error_code\": \"EL1002\",\n \"message\": \"Frame not found\"\n }\n ],\n \"status\": \"failed\"\n }\n ]\n },\n \"message\": \"Partial success: some operations failed\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d28c447-acf1-491a-868e-499abd3880dc", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5022de3e-0e7c-47d6-83a2-a401f9fe03ca", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "641b0b3f-c1ef-4600-965c-76a1d6906025", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51574188-4368-4b97-8bdd-cb5a29525b49", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35fd8210-be92-4889-a6bd-32cd56ef2f52", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "140e176a-bc91-4216-be41-c33d57d59b2e", "name": "Update one or more zone-root frames in a zone", "request": { "name": "Update one or more zone-root frames in a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2486115f-8080-405f-adde-af534ed206f9", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"id\": \"6d198740-ac2c-5ac1-b7ab-90471f922f2b\",\n \"status\": \"success\"\n },\n {\n \"id\": \"d2e81218-0c52-5fca-8e9b-bf68bccf38f0\",\n \"status\": \"success\"\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"errors\": [\n {\n \"error_code\": \"EL1002\",\n \"message\": \"Frame not found\",\n \"facet\": \"frame\"\n }\n ],\n \"status\": \"failed\"\n },\n {\n \"id\": \"ffffffff-ffff-ffff-ffff-ffffffffffff\",\n \"errors\": [\n {\n \"error_code\": \"EL1002\",\n \"message\": \"Frame not found\",\n \"facet\": \"frame\"\n }\n ],\n \"status\": \"failed\"\n }\n ]\n },\n \"message\": \"Partial success: some operations failed\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4955e08b-4fc3-4d7e-b06c-0fa567b82cbd", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f4f8440-28c1-4959-95b0-1422e3209500", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35f29dd7-3b96-4b59-ae2f-9a8f76b5d046", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "455b7e9c-20e8-4a65-9eea-efdbb1d98a2f", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "488af482-75f4-4ab4-8ddd-6fe76c7180a2", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "be460a10-b8c4-4463-92ca-2ffe0756534c", "name": "Shapes on Frame", "description": { "content": "Insert, list, update, and delete shapes inside a frame.", "type": "text/plain" }, "item": [ { "id": "a8c2e81d-ed9a-4db9-aef5-4de934f7e621", "name": "Insert one or more shapes into a frame", "request": { "name": "Insert one or more shapes into a frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"shape\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0e035738-b212-4bfc-bf2e-f0cd7dd25be9", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"shape\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"shape_id\": \"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n },\n {\n \"shape_id\": \"b2c3d4e5-f6a7-4b90-9c1d-2e3f4a5b6c7d\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n },\n {\n \"shape_id\": \"c3d4e5f6-a7b8-4c9d-be1f-3a4b5c6d7e8f\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n },\n {\n \"shape_id\": \"d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n },\n {\n \"shape_id\": \"e5f6a7b8-c9d0-4e12-bd23-5a6b7c8d9e0f\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"Shapes inserted in frame successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8dc8aad0-3225-4a23-8d6a-b4af98aba210", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"shape\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44765667-af9a-4a6f-a602-3810ad96a751", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"shape\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ec07760-f8b7-4b9e-8a4e-da12f08726ae", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"shape\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9a9ede5-2c5c-41ca-83c7-d0111beef0ff", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"shape\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1115f574-c35d-465d-a78f-7dc0fc895f9d", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"shape\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "95f566a6-3205-4a08-b6f3-1d93f82eb2a7", "name": "Get the shapes in a frame", "request": { "name": "Get the shapes in a frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8", "description": "Optional comma-separated UUID list to fetch selected items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "be72095b-b717-4a40-8135-35148c5a49ad", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"total_count\": 3,\n \"elements\": [\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"f1a2b3c4-d5e6-4a89-b012-c3d4e5f6a7b8\",\n \"portions\": [\n {\n \"style\": {\n \"fontweight\": \"BOLD\",\n \"size\": 28,\n \"color\": {\n \"rgb\": {\n \"red\": 255,\n \"green\": 255,\n \"blue\": 255\n }\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n },\n \"text\": \"Rectangle\"\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 10,\n \"bottom\": 5,\n \"right\": 10\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {},\n \"properties\": {\n \"layout\": {\n \"top\": 100,\n \"left\": 100,\n \"width\": 900,\n \"fliph\": true,\n \"height\": 500\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 4,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {}\n }\n },\n \"alpha\": 0.2\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 40,\n \"green\": 10,\n \"blue\": 10\n }\n }\n },\n \"alpha\": 0.2\n }\n ]\n }\n }\n },\n \"id\": \"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"e2c3d4e5-f6a7-4b90-ac1d-2e3f4a5b6c7e\",\n \"portions\": [\n {\n \"style\": {\n \"fontweight\": \"BOLD\",\n \"size\": 28,\n \"color\": {\n \"rgb\": {\n \"red\": 255,\n \"green\": 255,\n \"blue\": 255\n }\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n },\n \"text\": \"Oval\"\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 10,\n \"bottom\": 5,\n \"right\": 10\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {\n \"type\": \"OVAL\"\n },\n \"properties\": {\n \"layout\": {\n \"top\": 100,\n \"left\": 1200,\n \"width\": 800,\n \"flipv\": true,\n \"height\": 500\n },\n \"strokes\": [\n {\n \"captype\": \"CAPROUND\",\n \"width\": 4,\n \"position\": \"INSIDE\",\n \"type\": \"DASH\",\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 2,\n \"green\": 30,\n \"blue\": 22\n }\n }\n },\n \"alpha\": 0.2\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.96,\n \"brightness\": 0.18,\n \"hue\": 0.43888888\n }\n }\n },\n \"alpha\": 0.2\n }\n ]\n }\n }\n },\n \"id\": \"b2c3d4e5-f6a7-4b90-9c1d-2e3f4a5b6c7d\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"star\": {\n \"type\": \"POINT\",\n \"point\": {\n \"type\": \"FIVE_POINT\"\n }\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"f6a7b8c9-d0e1-4f23-bd34-6b7c8d9e0f1a\",\n \"portions\": [\n {\n \"style\": {\n \"fontweight\": \"BOLD\",\n \"size\": 28,\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.27,\n \"brightness\": 0.95,\n \"hue\": 0.6111111\n }\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n },\n \"text\": \"Star\"\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 10,\n \"bottom\": 5,\n \"right\": 10\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"properties\": {\n \"layout\": {\n \"top\": 900,\n \"left\": 100,\n \"width\": 800,\n \"flipv\": true,\n \"fliph\": true,\n \"height\": 800\n },\n \"strokes\": [\n {\n \"captype\": \"CAPROUND\",\n \"width\": 4,\n \"type\": \"DASH\",\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 15,\n \"green\": 23,\n \"blue\": 42\n }\n }\n },\n \"alpha\": 0.2\n }\n }\n ],\n \"fills\": [\n {\n \"gradient\": {\n \"stops\": [\n {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.95,\n \"brightness\": 0.4,\n \"hue\": 0.125\n }\n }\n },\n {\n \"color\": {\n \"rgb\": {\n \"red\": 63,\n \"green\": 10,\n \"blue\": 10\n }\n },\n \"position\": 1\n }\n ],\n \"type\": \"RADIAL\"\n },\n \"alpha\": 0.2\n }\n ]\n }\n }\n },\n \"id\": \"e5f6a7b8-c9d0-4e12-bd23-5a6b7c8d9e0f\"\n }\n ]\n },\n \"message\": \"Shapes in frame fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c610aa6-948f-4c61-b52d-68bc61d84f1e", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1011\",\n \"message\": \"Zone is not in an active state\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d74329be-bb35-48d1-8679-0e0d80b15474", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"2830000002600178\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df7692e0-ee6f-42f9-b07e-686a9ae2292d", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c0e8ad4-6791-4afc-8fed-706ff3426053", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32868304-16ee-4bd9-b43e-d9d5644a71e6", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ee40c05-c226-41de-ac9b-843b1515692a", "name": "Delete one or more shapes from a frame", "request": { "name": "Delete one or more shapes from a frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6b3d27ad-24c5-4e62-899d-f4f09c64f1f4", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"shape_id\": \"d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n },\n {\n \"shape_id\": \"e5f6a7b8-c9d0-4e12-bd23-5a6b7c8d9e0f\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n },\n {\n \"shape_id\": \"64CC53D2-C341-4132-870B-30E516A54BEA\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"Shapes in frame deleted successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "680fc4fb-7d63-47f0-8990-92ad716e6359", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7070fcd9-e3b1-4eb0-8fcd-17a2aedc68d0", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a160a7e-821a-49b8-bc59-6d80e4c548f7", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1503666c-fc0f-4320-ae1e-52fbdf014e2a", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a0c01ee-59d8-4f33-a94f-4cedd7bd1e15", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c2b36523-6ab2-456e-8669-e1532bca38a9", "name": "Update one or more shapes in a frame", "request": { "name": "Update one or more shapes in a frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a5537191-c0d0-4125-9d5a-38330102f864", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"id\": \"b2c3d4e5-f6a7-4b90-9c1d-2e3f4a5b6c7d\",\n \"status\": \"success\"\n },\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"id\": \"c3d4e5f6-a7b8-4c9d-be1f-3a4b5c6d7e8f\",\n \"status\": \"success\"\n },\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"id\": \"d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f\",\n \"status\": \"success\"\n },\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"id\": \"e5f6a7b8-c9d0-4e12-bd23-5a6b7c8d9e0f\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"Shape in frame updated successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e4228ed-1e33-480d-8f94-b642a86c122d", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "910b334d-3369-4050-97e0-4998b438e23e", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c42932d3-0cf8-4efe-a06d-efbf5606f540", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93cf72e1-390b-4fce-ac73-4182716d1a88", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce0dbdaa-e1cc-4ced-b824-503ef0fc5929", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "shapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9cd1b528-afd5-4abb-bed7-e15f0496d8e8", "name": "Connectors on Frame", "description": { "content": "Insert, list, update, and delete connectors inside a frame.", "type": "text/plain" }, "item": [ { "id": "3f93e5a0-2f3b-4e95-ac9c-91bc27a534a1", "name": "Insert one or more connectors into a frame", "request": { "name": "Insert one or more connectors into a frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"connector\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d6763ed7-e167-40bf-93c0-6bfd51e17097", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"connector\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"connector_id\": \"22222222-1111-4111-8111-aaaaaaaaaaaa\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n },\n {\n \"connector_id\": \"22222222-2222-4222-8222-bbbbbbbbbbbb\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n },\n {\n \"connector_id\": \"22222222-3333-4333-8333-cccccccccccc\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n },\n {\n \"connector_id\": \"22222222-4444-4444-8444-dddddddddddd\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n },\n {\n \"connector_id\": \"22222222-5555-4555-8555-eeeeeeeeeeee\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"Connectors inserted in frame successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d5cee87-4889-48ef-9bc9-ac105707fcf1", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"connector\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e750e295-2140-4b43-82c0-5bcd7e15b6cb", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"connector\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17cac194-d7e1-4014-a1ab-96643a8a77e9", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"connector\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da640006-4509-44e9-995e-e7dab3f51201", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"connector\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb17da36-71fc-4fb9-9cba-de72be53e345", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"connector\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4dbee5a-1883-4475-99af-45996c603972", "name": "Get the connectors in a frame", "request": { "name": "Get the connectors in a frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8", "description": "Optional comma-separated UUID list to fetch selected items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "9457123a-a29f-4f04-bca8-9f64361dd064", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"total_count\": 4,\n \"elements\": [\n {\n \"connector\": {\n \"stroke\": {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n },\n \"id\": \"B37069B4-6676-4B1D-9DE8-13BF28854044\"\n },\n {\n \"connector\": {\n \"connected\": {\n \"first\": {\n \"side\": \"EAST\",\n \"marker\": \"NONE\",\n \"shape_id\": \"BAD2B78A-C17A-4A75-BFD7-89CD2ABDF7E8\"\n },\n \"second\": {\n \"side\": \"WEST\",\n \"marker\": \"OPEN\",\n \"shape_id\": \"848D9B76-A1D7-4A7A-B5CD-CEB4FF6452D5\"\n }\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"bbbbbbbb-2222-4222-8222-bbbbbbbbbbbb\",\n \"portions\": [\n {\n \"style\": {\n \"fontweight\": \"NORMAL\",\n \"size\": 12,\n \"color\": {\n \"rgb\": {\n \"red\": 30,\n \"green\": 30,\n \"blue\": 30\n }\n }\n },\n \"text\": \"Line A→C\"\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n }\n }\n },\n \"stroke\": {\n \"width\": 2,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 66,\n \"green\": 133,\n \"blue\": 244\n }\n }\n },\n \"alpha\": 1\n }\n }\n },\n \"id\": \"22222222-1111-4111-8111-aaaaaaaaaaaa\"\n },\n {\n \"connector\": {\n \"connected\": {\n \"first\": {\n \"side\": \"SOUTH\",\n \"marker\": \"BLOCK\",\n \"shape_id\": \"757F7D65-EDBB-4447-B743-5520B1BA3667\"\n },\n \"second\": {\n \"side\": \"NORTH\",\n \"marker\": \"CLASSIC\",\n \"shape_id\": \"C4A58170-EB6A-4C1F-8705-9DD091E900D4\"\n }\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"before\": 2,\n \"line\": 1.3\n },\n \"level\": 1\n },\n \"id\": \"cccccccc-3333-4333-8333-cccccccccccc\",\n \"portions\": [\n {\n \"style\": {\n \"fontweight\": \"BOLD\",\n \"size\": 13,\n \"color\": {\n \"rgb\": {\n \"red\": 33,\n \"green\": 33,\n \"blue\": 33\n }\n }\n },\n \"text\": \"Elbow \"\n },\n {\n \"style\": {\n \"fontweight\": \"NORMAL\",\n \"size\": 13,\n \"color\": {\n \"rgb\": {\n \"red\": 255,\n \"green\": 109\n }\n }\n },\n \"text\": \"D→F\"\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 2,\n \"left\": 4,\n \"bottom\": 2,\n \"right\": 4\n },\n \"auto_fit\": \"TEXT\",\n \"valign\": \"TOP\"\n }\n },\n \"type\": \"ELBOW\",\n \"stroke\": {\n \"captype\": \"CAPROUND\",\n \"jointype\": \"BEVEL\",\n \"width\": 2.5,\n \"position\": \"INSIDE\",\n \"type\": \"DASH\",\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 255,\n \"green\": 152\n }\n }\n }\n }\n }\n },\n \"id\": \"22222222-2222-4222-8222-bbbbbbbbbbbb\"\n },\n {\n \"connector\": {\n \"connected\": {\n \"first\": {\n \"side\": \"SOUTH\",\n \"marker\": \"NONE\",\n \"shape_id\": \"a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f014\"\n },\n \"second\": {\n \"side\": \"NORTH\",\n \"marker\": \"BLOCK\",\n \"shape_id\": \"a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f018\"\n }\n },\n \"type\": \"ELBOW\",\n \"stroke\": {\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 13,\n \"green\": 71,\n \"blue\": 161\n }\n }\n }\n }\n }\n },\n \"id\": \"33333333-1111-4111-8111-aaaaaaaaaaaa\"\n }\n ]\n },\n \"message\": \"Connectors in frame fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83802e17-5d9c-4f6d-99f9-4f95b1eeeb59", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1011\",\n \"message\": \"Zone is not in an active state\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acfa6ba7-3628-4eb9-9682-78f1664bd3ea", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"112255940\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"5777000000915007\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/112255940/spaces/5777000000915007/zones/492724BD-4FD7-4851-ACF9-50EB08B730D7/frames/00000000-0000-0000-0000-000000000000/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e6d90c6-a9e7-42f1-95a3-bc63f49c45da", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a082b801-fb07-44a9-b150-6208c633239f", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7e7d88b-0fbd-4566-88fb-bca469978a67", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "18d44e82-f0cb-4ae1-80ad-a602846195f2", "name": "Delete one or more connectors from a frame", "request": { "name": "Delete one or more connectors from a frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fba2a51d-d565-4415-a2ab-e331ded3f666", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"connector_id\": \"22222222-2222-4222-8222-bbbbbbbbbbbb\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n },\n {\n \"connector_id\": \"11111111-aaaa-4bbb-8ccc-111111111118\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"Connectors in frame deleted successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9027f109-8283-4d9e-a443-ce94c308fe54", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a692f3b8-2d64-4a5a-91b2-54ca17ed8855", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62ef3f9e-3f86-4ff2-8fbb-dd04d9810f23", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a0a3bc9-02b1-431f-92a3-8da143383f3b", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d0b181c-535a-4d67-a716-7aeb5275e4c6", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6eaaa1b0-df43-4b92-8450-698a1d4dc073", "name": "Update one or more connectors in a frame", "request": { "name": "Update one or more connectors in a frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "93a7f83a-eb78-4b54-8719-ff538597554b", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"id\": \"22222222-3333-4333-8333-cccccccccccc\",\n \"status\": \"success\"\n },\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"id\": \"11111111-aaaa-4bbb-8ccc-111111111112\",\n \"status\": \"success\"\n },\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"id\": \"22222222-4444-4444-8444-dddddddddddd\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"Connectors in frame updated successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3561b0b0-1bbb-4790-ab9d-c0c0d6db7ce7", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "536c0dda-3981-4ea8-810d-7d13794ef19a", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b808203-c2b0-4870-810b-55cd830f467f", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b52865b8-b610-4eba-bc76-43e1be66a7e6", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "409b53f1-c732-4dc1-b4dd-8f4bbca0b289", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b8d57179-c423-4136-a679-f941c661b85f", "name": "Group Shapes on Frame", "description": { "content": "Group and ungroup shapes inside a frame.", "type": "text/plain" }, "item": [ { "id": "d1de111f-8284-4a19-8272-e17216feab3c", "name": "Group or ungroup shapes in a frame (op-aware)", "request": { "name": "Group or ungroup shapes in a frame (op-aware)", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"op\": \"ungroup\",\n \"nested_groups\": [\n \"6D6869EC-dEFb-27Ff-ba3D-5Ce98b1CFbbE\"\n ],\n \"groups\": [\n \"cBCdf8f6-C2a1-afdF-B798-2feab2C9b273\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "225946a6-7eba-4a6b-b94a-9c5bc7f75ed1", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"op\": \"ungroup\",\n \"nested_groups\": [\n \"6D6869EC-dEFb-27Ff-ba3D-5Ce98b1CFbbE\"\n ],\n \"groups\": [\n \"cBCdf8f6-C2a1-afdF-B798-2feab2C9b273\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"ungrouped_shape_ids\": [\n \"a4f1c2d8-3b6e-3f02-9c1b-7d2a5e89f019\",\n \"a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f014\",\n \"bf55c824-2496-4268-abaf-3ba054bd19ba\",\n \"a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f019\",\n \"B37069B4-6676-4B1D-9DE8-13BF28854044\",\n \"a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f018\",\n \"f9dfbc1f-edae-40fb-b96b-9c6352571a30\",\n \"590A322C-1E47-425D-97C2-4DE977E3AE90\"\n ],\n \"results\": [\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"id\": \"21e04378-de72-4a85-8469-30de3ad8538b\",\n \"status\": \"success\"\n },\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"id\": \"b6f88c46-52c4-4a89-8c48-694457681236\",\n \"status\": \"success\"\n },\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"id\": \"6c44ecf4-6b5b-4361-b0c7-ebeb03a7b04b\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"Shapes ungrouped in frame successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d09b285c-e271-436a-83f5-a99a6b8f9134", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"op\": \"ungroup\",\n \"nested_groups\": [\n \"6D6869EC-dEFb-27Ff-ba3D-5Ce98b1CFbbE\"\n ],\n \"groups\": [\n \"cBCdf8f6-C2a1-afdF-B798-2feab2C9b273\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18a1c6a1-64e4-4565-aa6a-799752690c7a", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"op\": \"ungroup\",\n \"nested_groups\": [\n \"6D6869EC-dEFb-27Ff-ba3D-5Ce98b1CFbbE\"\n ],\n \"groups\": [\n \"cBCdf8f6-C2a1-afdF-B798-2feab2C9b273\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2523d3c3-f864-4247-bd39-9ae3978c0c82", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"op\": \"ungroup\",\n \"nested_groups\": [\n \"6D6869EC-dEFb-27Ff-ba3D-5Ce98b1CFbbE\"\n ],\n \"groups\": [\n \"cBCdf8f6-C2a1-afdF-B798-2feab2C9b273\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64337a6f-9632-4ee0-b89a-9cba9bafc2ed", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"op\": \"ungroup\",\n \"nested_groups\": [\n \"6D6869EC-dEFb-27Ff-ba3D-5Ce98b1CFbbE\"\n ],\n \"groups\": [\n \"cBCdf8f6-C2a1-afdF-B798-2feab2C9b273\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3655948-b138-43c1-b69b-19373ac87804", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"op\": \"ungroup\",\n \"nested_groups\": [\n \"6D6869EC-dEFb-27Ff-ba3D-5Ce98b1CFbbE\"\n ],\n \"groups\": [\n \"cBCdf8f6-C2a1-afdF-B798-2feab2C9b273\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd57e619-56e9-4e9a-9974-f42face6a265", "name": "Get the group shapes in a frame", "request": { "name": "Get the group shapes in a frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8", "description": "Optional comma-separated UUID list to fetch selected items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "3af1e326-fe09-4e07-a79c-4819f419a0fa", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"total_count\": 3,\n \"elements\": [\n {\n \"group_shape\": {\n \"layout\": {\n \"top\": 80,\n \"left\": 80,\n \"width\": 480,\n \"height\": 320\n },\n \"objects\": [\n {\n \"connector\": {\n \"connected\": {\n \"first\": {\n \"side\": \"EAST\",\n \"marker\": \"NONE\",\n \"shape_id\": \"BAD2B78A-C17A-4A75-BFD7-89CD2ABDF7E8\"\n },\n \"second\": {\n \"side\": \"WEST\",\n \"marker\": \"OPEN\",\n \"shape_id\": \"848D9B76-A1D7-4A7A-B5CD-CEB4FF6452D5\"\n }\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"bbbbbbbb-2222-4222-8222-bbbbbbbbbbbb\",\n \"portions\": [\n {\n \"style\": {\n \"fontweight\": \"NORMAL\",\n \"size\": 12,\n \"color\": {\n \"rgb\": {\n \"red\": 30,\n \"green\": 30,\n \"blue\": 30\n }\n }\n },\n \"text\": \"Line A→C\"\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n }\n }\n },\n \"stroke\": {\n \"jointype\": \"MITER\",\n \"width\": 3,\n \"type\": \"DASH\",\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"rgb\": {}\n }\n }\n }\n }\n },\n \"id\": \"22222222-1111-4111-8111-aaaaaaaaaaaa\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"d8e9f0a1-b2c3-4d45-9e67-12345678abcd\",\n \"portions\": [\n {\n \"style\": {\n \"fontweight\": \"BOLD\",\n \"size\": 36,\n \"color\": {\n \"rgb\": {\n \"red\": 255,\n \"green\": 255,\n \"blue\": 255\n }\n },\n \"font_name\": {\n \"name\": \"Inter\"\n }\n },\n \"text\": \"Single element\"\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 12,\n \"left\": 16,\n \"bottom\": 12,\n \"right\": 16\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {\n \"rounded_rectangle\": {},\n \"type\": \"ROUNDED_RECTANGLE\"\n },\n \"properties\": {\n \"layout\": {\n \"top\": 2588.8672,\n \"left\": 1478.9033,\n \"width\": 1000.001,\n \"height\": 500\n },\n \"strokes\": [\n {\n \"captype\": \"CAPROUND\",\n \"width\": 4,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 6,\n \"green\": 182,\n \"blue\": 212\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"gradient\": {\n \"stops\": [\n {\n \"color\": {\n \"rgb\": {\n \"red\": 15,\n \"green\": 23,\n \"blue\": 42\n }\n }\n },\n {\n \"color\": {\n \"rgb\": {\n \"red\": 30,\n \"green\": 41,\n \"blue\": 59\n }\n },\n \"position\": 1\n }\n ]\n },\n \"alpha\": 0.2\n }\n ]\n }\n }\n },\n \"id\": \"a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f013\"\n },\n {\n \"group_shape\": {\n \"layout\": {\n \"top\": 3453.8926,\n \"left\": 1292.2783,\n \"width\": 742.147,\n \"height\": 1625.703\n },\n \"objects\": [\n {\n \"group_shape\": {\n \"layout\": {\n \"top\": -2749.4653,\n \"left\": 3687.6516,\n \"width\": 559.37476,\n \"height\": 151.99219\n },\n \"objects\": [\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"7F5AF8E4-7B4E-447C-BB93-843977B33C99\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {},\n \"properties\": {\n \"layout\": {\n \"top\": -2722.4731,\n \"left\": 4122.0264,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"BAD2B78A-C17A-4A75-BFD7-89CD2ABDF7E8\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"70D504DE-58DE-4422-89CE-744F3AFDF1D0\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {\n \"type\": \"OVAL\"\n },\n \"properties\": {\n \"layout\": {\n \"top\": -2749.4653,\n \"left\": 3687.6516,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"EFC7A9A1-4294-4560-BD83-C9A8F0EFD3F3\"\n }\n ]\n },\n \"id\": \"c1944aee-6bc4-4514-b7ce-cdfa8a1cacbc\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"8253817E-D4BE-434D-BBB0-28A33D35FC12\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {\n \"type\": \"TRIANGLE\",\n \"triangle\": {}\n },\n \"properties\": {\n \"layout\": {\n \"top\": -1248.7622,\n \"left\": 4304.8,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"848D9B76-A1D7-4A7A-B5CD-CEB4FF6452D5\"\n }\n ]\n },\n \"id\": \"bf55c824-2496-4268-abaf-3ba054bd19ba\"\n }\n ]\n },\n \"id\": \"151E7B25-6454-426A-9B3E-2DF8266EA459\"\n },\n {\n \"group_shape\": {\n \"layout\": {\n \"rotate\": 12,\n \"top\": 337.53296,\n \"left\": 1236.9053,\n \"width\": 360,\n \"fliph\": true,\n \"height\": 260\n },\n \"objects\": [\n {\n \"shape\": {\n \"shape\": {\n \"callout\": {\n \"type\": \"ROUNDED_RECTANGLE_CALLOUT\"\n },\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"BF40EAE8-36EC-4940-9215-0DBDC1F136DC\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"properties\": {\n \"layout\": {\n \"top\": 4062.5254,\n \"left\": 4109.9414,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"9F02A23F-2616-4865-8939-1424C969B59A\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"89EC4CF3-461C-4C67-B041-A6F8B6D89B39\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {\n \"type\": \"OVAL\"\n },\n \"properties\": {\n \"layout\": {\n \"top\": 4345.963,\n \"left\": 4590.6836,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"B3FB1A32-09EC-4CDF-8BB4-215E1B8E77CC\"\n }\n ]\n },\n \"id\": \"483122b7-86d4-411a-b7a7-112c54d2d8a8\"\n },\n {\n \"group_shape\": {\n \"layout\": {\n \"rotate\": 352,\n \"top\": 1010,\n \"left\": 580.38965,\n \"width\": 420,\n \"flipv\": true,\n \"height\": 220\n },\n \"objects\": [\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"6E0315B8-AB67-4037-8197-169181A92CEB\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"basic\": {\n \"type\": \"DIAMOND\"\n },\n \"properties\": {\n \"layout\": {\n \"top\": 3792.4863,\n \"left\": 4734.8237,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"B364B947-10F0-42EE-9095-8918EE264986\"\n },\n {\n \"shape\": {\n \"shape\": {\n \"text\": {\n \"paragraphs\": [\n {\n \"style\": {\n \"spacing\": {\n \"line\": 1.2\n },\n \"level\": 1,\n \"halign\": \"CENTER\"\n },\n \"id\": \"ECA2FD88-8EDE-43CA-AF25-1AB79B30322D\",\n \"portions\": [\n {\n \"style\": {\n \"size\": 18,\n \"color\": {\n \"hsb\": {}\n },\n \"font_name\": {\n \"name\": \"Open Sans\"\n }\n }\n }\n ]\n }\n ],\n \"properties\": {\n \"inset\": {\n \"top\": 5,\n \"left\": 5,\n \"bottom\": 5,\n \"right\": 5\n },\n \"auto_fit\": \"TEXT\"\n }\n },\n \"block_arrow\": {\n \"single_arrow\": {}\n },\n \"properties\": {\n \"layout\": {\n \"top\": 3855.1426,\n \"left\": 5130.722,\n \"width\": 125,\n \"height\": 125\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1.5,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.3,\n \"brightness\": 0.286,\n \"hue\": 0.764\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"brightness\": 1\n }\n }\n }\n }\n ]\n }\n }\n },\n \"id\": \"D72350DD-CBD3-4164-AC99-08437A3D9679\"\n }\n ]\n },\n \"id\": \"816df1e3-f3d7-4682-b3ef-45f0dddb392a\"\n }\n ]\n },\n \"message\": \"GroupShapes in frame fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ecf838d-f2ca-4685-a239-cd6fe45a697a", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1011\",\n \"message\": \"Zone is not in an active state\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9bc6393-647e-41ad-a630-f29cbd36f03e", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"2830000002600178\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35cc9c97-2b4f-4ccf-a236-75ca9baeadea", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09e944c2-b99a-4c54-980e-370d91bb4e51", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27a4178d-6ccb-42ed-85d0-8c7fba3c7dac", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8306da78-3f01-4eda-bb55-3fa4d83bf99d", "name": "Delete one or more group shapes from a frame", "request": { "name": "Delete one or more group shapes from a frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d560e5b7-250c-46d9-bae5-1b4542bd1c2e", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"groupshape_id\": \"151E7B25-6454-426A-9B3E-2DF8266EA459\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n },\n {\n \"groupshape_id\": \"483122b7-86d4-411a-b7a7-112c54d2d8a8\",\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"GroupShapes in frame deleted successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42bb974b-e3b8-44e6-974e-6572c79861e8", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6b3e3a0-e9f0-4b89-88af-daf7afc85054", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f9e2683-c888-464f-ae4c-7defd4c60bec", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19a50223-b27a-4aa6-883d-1928ebe0e801", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2bb3ddd-f8e1-45e2-a9cc-0aeba6ec066b", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67b751a5-e82a-42db-85ab-9cc1be7efc67", "name": "Update one or more group shapes in a frame", "request": { "name": "Update one or more group shapes in a frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "96d61af9-f6f3-49f6-bcc3-4c974500c549", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"id\": \"151E7B25-6454-426A-9B3E-2DF8266EA459\",\n \"status\": \"success\"\n },\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"id\": \"483122b7-86d4-411a-b7a7-112c54d2d8a8\",\n \"status\": \"success\"\n },\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"id\": \"816df1e3-f3d7-4682-b3ef-45f0dddb392a\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"GroupShape in frame updated successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "832c04d6-92e1-4fe7-bccc-1eb32249409f", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d166f56-dd21-4d48-b03c-55d192bd242f", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2abb3905-2952-43d2-acc2-019afb40a4ed", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fea7aa08-3796-4fde-9314-4d61609888a1", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dbd87eb-9cd9-443d-866a-46638a62c689", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "groupshapes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"elements\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "189ab1fe-a0f5-4426-bca1-8f85e6a01695", "name": "Frames on Frame", "description": { "content": "Insert, list, update, and delete child frames inside a parent frame.", "type": "text/plain" }, "item": [ { "id": "22d787f8-4878-4314-83a6-7f7553273c94", "name": "Insert one or more child frames into a parent frame", "request": { "name": "Insert one or more child frames into a parent frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"meta\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a334674d-6fd9-4785-8d44-6042ab977848", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"meta\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"frame_id\": \"f1f362c6-9a9f-58e5-8f47-149f741c91b8\",\n \"status\": \"success\"\n },\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"frame_id\": \"68747720-4a7f-5499-95b8-9ebf4b16fc7e\",\n \"status\": \"success\"\n },\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"frame_id\": \"6d198740-ac2c-5ac1-b7ab-90471f922f2b\",\n \"status\": \"success\"\n },\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"frame_id\": \"d2e81218-0c52-5fca-8e9b-bf68bccf38f0\",\n \"status\": \"success\"\n },\n {\n \"parent_frame_id\": \"0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061\",\n \"frame_id\": \"74b0dfa1-9186-5290-a16c-89b51db3bd31\",\n \"status\": \"success\"\n }\n ]\n },\n \"message\": \"Nested frames inserted successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/E51ABCEF-C5A5-42D1-8686-9A6307E4B73A/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdc08661-9942-4866-b535-1b36440f9054", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"meta\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c065961-acc5-4318-b427-96a3513483c9", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"meta\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19ecdded-223e-4cfd-ac86-f822878ef664", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"meta\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ce1bd9a-8430-4c3b-842c-1c1ffe237a0b", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"meta\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de4980f7-eec3-496f-b404-96d811516e52", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"meta\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41a26f3b-ba0d-4928-9466-57a3127799fc", "name": "Get the child frames of a parent frame", "request": { "name": "Get the child frames of a parent frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8", "description": "Optional comma-separated UUID list to fetch selected items" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "05c52edd-d161-444d-972a-65d0f293c678", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"frames\": [\n {\n \"meta\": {\n \"name\": \"Single Child Frame\",\n \"id\": \"b5fc46d8-ab45-5e51-bff3-5a59345b3a03\"\n },\n \"type\": \"CUSTOM\",\n \"properties\": {\n \"layout\": {\n \"top\": 320,\n \"left\": 200,\n \"width\": 640,\n \"height\": 360\n },\n \"strokes\": [\n {\n \"width\": 1,\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 204,\n \"green\": 204,\n \"blue\": 204\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"solid\": {\n \"color\": {\n \"rgb\": {\n \"red\": 245,\n \"green\": 245,\n \"blue\": 250\n }\n }\n }\n }\n ]\n }\n },\n {\n \"meta\": {\n \"name\": \"Child A4\",\n \"id\": \"6d198740-ac2c-5ac1-b7ab-90471f922f2b\"\n },\n \"type\": \"CUSTOM\",\n \"properties\": {\n \"layout\": {\n \"top\": 2000,\n \"width\": 794,\n \"height\": 1123\n },\n \"strokes\": [\n {\n \"jointype\": \"MITER\",\n \"width\": 1,\n \"position\": \"INSIDE\",\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.85,\n \"brightness\": 0.25,\n \"hue\": 0.0016975309\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"gradient\": {\n \"stops\": [\n {\n \"color\": {\n \"rgb\": {\n \"red\": 255,\n \"green\": 255,\n \"blue\": 255\n }\n }\n },\n {\n \"color\": {\n \"rgb\": {\n \"red\": 229,\n \"green\": 231,\n \"blue\": 235\n }\n },\n \"position\": 1\n }\n ],\n \"type\": \"RADIAL\"\n }\n }\n ]\n }\n },\n {\n \"meta\": {\n \"name\": \"Child Custom\",\n \"id\": \"74b0dfa1-9186-5290-a16c-89b51db3bd31\"\n },\n \"type\": \"CUSTOM\",\n \"properties\": {\n \"layout\": {\n \"top\": 2000,\n \"left\": 1400,\n \"width\": 600,\n \"height\": 800\n },\n \"strokes\": [\n {\n \"captype\": \"SQUARE\",\n \"width\": 2,\n \"position\": \"OUTSIDE\",\n \"type\": \"SQUARE_DOT\",\n \"fill\": {\n \"solid\": {\n \"color\": {\n \"hsb\": {\n \"saturation\": 0.7,\n \"brightness\": 0.65,\n \"hue\": 0.0023148148\n }\n }\n }\n }\n }\n ],\n \"fills\": [\n {\n \"no_fill\": {}\n }\n ]\n }\n }\n ],\n \"total_count\": 3\n },\n \"message\": \"Nested frames fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "469c2cf1-8e2f-418c-85f1-1b13d4e54b8e", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1011\",\n \"message\": \"Zone is not in an active state\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddf2700c-cce1-4a0b-b2e4-8263c6b204b4", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"2830000002600178\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e4f4ff6-75c6-4971-948b-e6f5c7cd2760", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21831cd7-d62c-4c88-9168-ddcaf99887ff", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9596ca17-6938-4294-a8c9-920b86fc7c89", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ids", "value": "55ACd8Cd-a9bB-16EB-20a3-f8887b7FbD9C,67D3a1E1-DBf4-61ec-ebca-F376420e3E32,eBb5b929-96de-e6cE-e833-E336F0EcaEAF,3Dbcc491-3f40-3c3e-C4f8-76535aBfE7F4,dBb1cBf7-BD0E-d06b-fccC-FeA3AE629A97,eB5edFe6-ddC7-e1DE-4648-FeaAFBb435aE,65814539-dD02-5Afd-dDff-c0e79A3ab8" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77c20b4a-2388-4f82-a03e-5ae023e1fc68", "name": "Delete one or more child frames from a parent frame", "request": { "name": "Delete one or more child frames from a parent frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cf0c72ca-4add-44bf-98d0-ca37de353b38", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"parent_frame_id\": \"B25E9FE2-0605-4370-85E5-B142D133C3BC\",\n \"frame_id\": \"d2e81218-0c52-5fca-8e9b-bf68bccf38f0\",\n \"status\": \"success\"\n },\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567899\",\n \"errors\": [\n {\n \"error_code\": \"EL1002\",\n \"message\": \"Frame not found\"\n }\n ],\n \"status\": \"failed\"\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"errors\": [\n {\n \"error_code\": \"EL1002\",\n \"message\": \"Frame not found\"\n }\n ],\n \"status\": \"failed\"\n }\n ]\n },\n \"message\": \"Partial success: some operations failed\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a4f29bb-2615-4b5a-85f0-ac8f745ed8a8", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaed18a2-e913-4803-a708-3e8cbf8491ce", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ba8c0bb-7093-4690-b56f-b0854260c50b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10fe6964-41ed-4970-a5a6-ee8fbc35b0f4", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "384c4dd8-1cd7-493f-a528-dab00f7ee81a", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4950bb2f-bfba-4371-8098-cc03168232eb", "name": "Update one or more child frames of a parent frame", "request": { "name": "Update one or more child frames of a parent frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fc3b08e9-28f3-4721-9013-9d3d424c6f1f", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"results\": [\n {\n \"parent_frame_id\": \"B25E9FE2-0605-4370-85E5-B142D133C3BC\",\n \"id\": \"d2e81218-0c52-5fca-8e9b-bf68bccf38f0\",\n \"status\": \"success\"\n },\n {\n \"parent_frame_id\": \"B25E9FE2-0605-4370-85E5-B142D133C3BC\",\n \"id\": \"68747720-4a7f-5499-95b8-9ebf4b16fc7e\",\n \"status\": \"success\"\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"errors\": [\n {\n \"error_code\": \"EL1002\",\n \"message\": \"Frame not found\",\n \"facet\": \"frame\"\n }\n ],\n \"status\": \"failed\"\n },\n {\n \"id\": \"ffffffff-ffff-ffff-ffff-ffffffffffff\",\n \"errors\": [\n {\n \"error_code\": \"EL1002\",\n \"message\": \"Frame not found\",\n \"facet\": \"frame\"\n }\n ],\n \"status\": \"failed\"\n }\n ]\n },\n \"message\": \"Partial success: some operations failed\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51f323da-0c0f-495b-ab07-27a20c87e70b", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"IAM1050\",\n \"message\": \"The JSON content could not be parsed.\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e203032c-c30d-4086-a23e-89767f6b1f39", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d85a71fd-fea2-432a-99d3-c33867bf4049", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a36e035d-5af9-4a90-b27f-678863d67e1b", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f7aaa97-a618-4197-9cce-ff04b1cda9c4", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "frames" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frames\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"properties\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5c6b667b-f167-4790-8912-ed340da4a295", "name": "Element Text", "description": { "content": "Read the text of a text-bearing object on a zone or frame.", "type": "text/plain" }, "item": [ { "id": "f5e98b83-c398-4001-8281-3514a02734b9", "name": "Get text of a text-bearing object in a frame", "request": { "name": "Get text of a text-bearing object in a frame", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fetch_type", "value": "paragraph_text", "description": "Optional text fetch mode. Use one of: text, length, paragraph_count, paragraph_text. Defaults to text. Allowed values: text, length, paragraph_count, paragraph_text" }, { "disabled": false, "key": "text_query", "value": "string", "description": "`text_query` — JSON-encoded read options, URL-encoded. Whether it is required depends on fetch_type. REQUIRED with fetch_type=text: pass {\"payload\":{\"all_text\":true}} for the whole text, or {\"payload\":{\"range\":{\"start_index\":0,\"end_index\":5}}} for a character range. REQUIRED with fetch_type=paragraph_text: pass {\"payload\":{\"range\":{\"start_paragraph_index\":0,\"end_paragraph_index\":1}}}. Not needed with fetch_type=length or fetch_type=paragraph_count, which ignore it. Omitting it where it is required fails validation, so it is declared optional on the parameter only because two of the four modes do not use it. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "6bc4323b-08e0-4481-ba08-9e0cfb1726cf", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fetch_type", "value": "paragraph_text" }, { "key": "text_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"text\": \"Gem\\n\\nSilver\\n\"\n },\n \"message\": \"Text in frame resolved successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3131ce56-5364-4be5-914d-8ec8e9569e64", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fetch_type", "value": "paragraph_text" }, { "key": "text_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1011\",\n \"message\": \"Zone is not in an active state\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0e7c539-d42b-47b8-aa82-a26641dc990f", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fetch_type", "value": "paragraph_text" }, { "key": "text_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"2830000002600178\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07bf6c72-1e78-4c7e-a9bb-35fae5b19dcf", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fetch_type", "value": "paragraph_text" }, { "key": "text_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"EL1001\",\n \"message\": \"Element not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/00000000-0000-0000-0000-000000000000\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f36fec04-3b1e-4e16-a3f7-c782d86ba48f", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fetch_type", "value": "paragraph_text" }, { "key": "text_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94121cfd-ebb3-41a0-a027-6d77dcca6559", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fetch_type", "value": "paragraph_text" }, { "key": "text_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "487f5fac-5f3c-4135-a55f-59f86e8bf79f", "name": "Not implemented - this operation is not available for the requested resource", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "frames", ":frame_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fetch_type", "value": "paragraph_text" }, { "key": "text_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "frame_id", "description": "(Required) The unique identifier of the frame" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"EL1016\",\n \"message\": \"Not implemented for element type GROUPSHAPE\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/BE427379-279A-456E-9AA1-28E125A5B51C\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b701ab0-3620-41db-92c3-35b61b233494", "name": "Get text of a text-bearing object in a zone", "request": { "name": "Get text of a text-bearing object in a zone", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fetch_type", "value": "paragraph_text", "description": "Optional text fetch mode. Use one of: text, length, paragraph_count, paragraph_text. Defaults to text. Allowed values: text, length, paragraph_count, paragraph_text" }, { "disabled": false, "key": "text_query", "value": "string", "description": "`text_query` — JSON-encoded read options, URL-encoded. Whether it is required depends on fetch_type. REQUIRED with fetch_type=text: pass {\"payload\":{\"all_text\":true}} for the whole text, or {\"payload\":{\"range\":{\"start_index\":0,\"end_index\":5}}} for a character range. REQUIRED with fetch_type=paragraph_text: pass {\"payload\":{\"range\":{\"start_paragraph_index\":0,\"end_paragraph_index\":1}}}. Not needed with fetch_type=length or fetch_type=paragraph_count, which ignore it. Omitting it where it is required fails validation, so it is declared optional on the parameter only because two of the four modes do not use it. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "d001064c-8c17-431f-8d4d-839ad9794f62", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fetch_type", "value": "paragraph_text" }, { "key": "text_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"text\": \"Hello World\\nSecond paragraph line\"\n },\n \"message\": \"Text resolved successfully\",\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/text/a46f6013-6822-57cf-a71d-4dce016d3129\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c7216c6-c53c-41ac-bcfd-b08a613943c0", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fetch_type", "value": "paragraph_text" }, { "key": "text_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1011\",\n \"message\": \"Zone is not in an active state\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/text/18EC6574-83FD-4F7C-AD9E-F0022423F386\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "777a076a-4055-4b5a-8a2e-5d673c7b2abc", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fetch_type", "value": "paragraph_text" }, { "key": "text_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"112255940\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"A1003\",\n \"message\": \"The user doesn't have permission to perform this action\",\n \"space_id\": \"5777000000915007\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/112255940/spaces/5777000000915007/zones/492724BD-4FD7-4851-ACF9-50EB08B730D7/text/00000000-0000-0000-0000-000000000000\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "483f683b-18e5-42dc-90f1-be62e1f69006", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fetch_type", "value": "paragraph_text" }, { "key": "text_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"Z1008\",\n \"message\": \"Zone not found\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/text/18EC6574-83FD-4F7C-AD9E-F0022423F386\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0a824ba-8e4c-42d5-81c5-c3bd1da0b38c", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fetch_type", "value": "paragraph_text" }, { "key": "text_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64662d43-1225-4577-b8a0-bdc461bf56b6", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fetch_type", "value": "paragraph_text" }, { "key": "text_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70b541ae-506f-4a7a-aa6c-4ee1482536d9", "name": "Not implemented - this operation is not available for the requested resource", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", ":text_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fetch_type", "value": "paragraph_text" }, { "key": "text_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "disabled": false, "type": "any", "value": "string", "key": "text_id", "description": "(Required) The unique identifier of the text" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"88136506\",\n \"current_user_id\": \"85115776\",\n \"error_code\": \"EL1016\",\n \"message\": \"Not implemented for element type GROUPSHAPE\",\n \"space_id\": \"2830000002600126\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/text/64B04181-0A88-4DB4-85E6-984B95A69B5F\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "fa5aff92-7f7d-4574-9df1-5a23ce70aeb5", "name": "Search", "description": { "content": "Search a team's content, zones, frames, comments, and members.", "type": "text/plain" }, "item": [ { "id": "cc51500f-74f3-44a4-9a68-cedffcbd6c54", "name": "Search comment text in a team", "request": { "name": "Search comment text in a team", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "comments", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "search", "value": "荜歺瀬퍪䗶", "description": "(Required) The keyword or phrase to search for" }, { "disabled": false, "key": "from", "value": "4622", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "94", "description": "The maximum number of results to return in the response. Default value is 20" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "610e41b6-723d-4ea1-be68-ca2e3ad9750e", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "comments", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"search_result\": []\n },\n \"message\": \"Content search completed successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/comments/search\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf767e5a-5668-44bd-b506-b3c941d0bf41", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "comments", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ac66aeb-fae2-4b8a-aa65-9819d1df11d6", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "comments", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7721548-9db8-41d6-b56f-e332058b6f68", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "comments", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93d11c56-c183-43c5-a04b-9700bbf64b5b", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "comments", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb34ba61-3f11-4670-946f-41258d9e8a4e", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "comments", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fdb48d92-221f-4b03-869c-fa34fe3333c2", "name": "Search zone names and content in a team", "request": { "name": "Search zone names and content in a team", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "zones", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "search", "value": "荜歺瀬퍪䗶", "description": "(Required) The keyword or phrase to search for" }, { "disabled": false, "key": "from", "value": "4622", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "94", "description": "The maximum number of results to return in the response. Default value is 20" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "ac7c92dc-91e1-41cc-83ce-7831edd2dc57", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "zones", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"search_result\": []\n },\n \"message\": \"Content search completed successfully\",\n \"request_uri\": \"/vani/api/v1/editions/75918186/teams/693000000002001/zones/search\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5db84d71-4931-4ad4-9072-f53b7e6dc620", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "zones", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46125b89-f12b-4edd-9697-69c7f5472319", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "zones", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9157e342-e707-421d-874e-d55d831f5076", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "zones", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39670dce-2c23-47a1-b2ae-18b34d7b7bf2", "name": "Rate limit exceeded - this operation allows 500 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "zones", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d264d1b-cbbb-490e-a068-39e07810bb98", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "zones", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40d46662-6b43-4b88-be00-9b345461a071", "name": "Search frame content in a team", "request": { "name": "Search frame content in a team", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "frames", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "search", "value": "荜歺瀬퍪䗶", "description": "(Required) The keyword or phrase to search for" }, { "disabled": false, "key": "from", "value": "4622", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "94", "description": "The maximum number of results to return in the response. Default value is 20" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "e6614e26-1522-4173-a816-19e6ee785d9a", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "frames", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"search_result\": []\n },\n \"message\": \"Content search completed successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/frames/search\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8207039a-0a3e-40c6-a9ce-70b8ebbbf5a1", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "frames", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "134b0927-7b01-4a93-aa4e-5ea3938b4ca4", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "frames", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bfedfc1-fdc4-4dec-94c4-e2f080d4ad15", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "frames", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0982243-bd11-4198-af8b-d0466543df51", "name": "Rate limit exceeded - this operation allows 500 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "frames", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e51fe02a-b5a1-4e17-bac1-d23d3b2a9add", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "frames", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d504abb3-3f27-4a18-a328-8021bb5d4a74", "name": "Search all content in a team", "request": { "name": "Search all content in a team", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "search", "value": "荜歺瀬퍪䗶", "description": "(Required) The keyword or phrase to search for" }, { "disabled": false, "key": "from", "value": "4622", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "94", "description": "The maximum number of results to return in the response. Default value is 20" }, { "disabled": false, "key": "types", "value": "zones", "description": "Comma-separated list of fields to include in the response. Allowed values: frames, comments, zones, shapes" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "9e442efc-af29-449c-85ef-582837353d4b", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "types", "value": "zones" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"search_result\": {}\n },\n \"message\": \"Content search completed successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/teams/3009000000002003/search\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc0f05a7-6694-47b6-8d39-d1d8f2fe84dd", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "types", "value": "zones" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "361aec9b-5043-45d8-96c4-a184de85967b", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "types", "value": "zones" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4b14417-d154-437c-b456-3bdd3ff19ba8", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "types", "value": "zones" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31e8fbe7-e584-45b1-a707-6364d7c6b03d", "name": "Rate limit exceeded - this operation allows 500 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "types", "value": "zones" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14886751-bfd6-4204-bb64-2d23af4bd987", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" }, { "key": "types", "value": "zones" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c979cddd-9eb7-47e3-b56c-acbe7ea0bc28", "name": "Search the members of a team", "request": { "name": "Search the members of a team", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "zuid", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: zuid, role_name, added_time, added_by, modified_time, display_name, mail_id, edition_id, team_id, invited_time" }, { "disabled": false, "key": "search", "value": "荜歺瀬퍪䗶", "description": "(Required) The keyword or phrase to search for" }, { "disabled": false, "key": "roles", "value": "TEAM_ADMIN", "description": "Parameter: roles. Allowed values: TEAM_ADMIN, MEMBER, TEAM_GUEST" }, { "disabled": false, "key": "subscriber_state", "value": "ACTIVE", "description": "Parameter: subscriber_state. Allowed values: ACTIVE, INACTIVE" }, { "disabled": false, "key": "from", "value": "4622", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "94", "description": "The maximum number of results to return in the response. Default value is 20" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "43be1dd4-2e03-4a50-b2b3-ece221a2ea35", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zuid" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "roles", "value": "TEAM_ADMIN" }, { "key": "subscriber_state", "value": "ACTIVE" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"next_from\": 0,\n \"search_result\": []\n },\n \"message\": \"Team member search completed successfully\",\n \"request_uri\": \"/vani/api/v1/editions/112255940/teams/5777000000002017/members/search\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fe19b3e-9af3-46da-917d-de53eec42f1d", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zuid" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "roles", "value": "TEAM_ADMIN" }, { "key": "subscriber_state", "value": "ACTIVE" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "559ff09f-db4b-403b-bf2a-38808e6470ed", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zuid" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "roles", "value": "TEAM_ADMIN" }, { "key": "subscriber_state", "value": "ACTIVE" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"75918186\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"T1006\",\n \"team_id\": \"693000000002001\",\n \"message\": \"User is not a member of the team\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/75918186/teams/693000000002001/members/search\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ac53b83-6fa9-4805-87e0-daa88b946bc2", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zuid" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "roles", "value": "TEAM_ADMIN" }, { "key": "subscriber_state", "value": "ACTIVE" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"112255940\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"T1023\",\n \"message\": \"Invalid team\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/112255940/teams/5777000000009999/members/search\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9a1fa35-ef8c-4165-b910-8ef91b602bae", "name": "Rate limit exceeded - this operation allows 500 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zuid" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "roles", "value": "TEAM_ADMIN" }, { "key": "subscriber_state", "value": "ACTIVE" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "277ed185-55e1-43be-9ae1-d8a12def1e9e", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "members", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "zuid" }, { "key": "search", "value": "荜歺瀬퍪䗶" }, { "key": "roles", "value": "TEAM_ADMIN" }, { "key": "subscriber_state", "value": "ACTIVE" }, { "key": "from", "value": "4622" }, { "key": "limit", "value": "94" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0d06e824-a918-4c77-9575-be99694274e0", "name": "External Share", "description": { "content": "Publish, update, revoke, and inspect external shares.", "type": "text/plain" }, "item": [ { "id": "f626c422-bee5-4d89-aa24-27075e77fbfe", "name": "Check whether external sharing is allowed for the edition and team", "request": { "name": "Check whether external sharing is allowed for the edition and team", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "external_share_allowed", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: external_share_edition_enabled, external_share_team_enabled, external_share_allowed" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "e67c605e-ff76-4ada-8f18-cc554eb1e8b7", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "external_share_allowed" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"external_share_edition_enabled\": true\n },\n \"message\": \"External share status fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/888012145/teams/4855000000002003/externalshares/status\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48237d85-ea49-4802-bf7f-925f86a27b05", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "external_share_allowed" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4a07341-75f5-4a95-a4fe-a0ca9ded7db5", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "external_share_allowed" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f96ccc30-1465-42cd-bc1b-0a169b5dc0a9", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "external_share_allowed" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f27e18b-dc41-434e-a2f8-8601e61dc2c7", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "external_share_allowed" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "742ebdbf-1400-46da-829d-cebc92829b25", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "external_share_allowed" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0034acaf-cac4-4b05-a8a3-b8d80315d423", "name": "Publish a space as an external share", "request": { "name": "Publish a space as an external share", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ffdf410b-0557-4c37-b782-0ae69aad5a21", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"is_password_enabled\": true,\n \"zone_ids\": [\n {\n \"zone_id\": \"9e7a947b-470b-46e7-be64-4a617abadf43\",\n \"permission\": \"VIEWER\"\n }\n ],\n \"password\": \"1\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"shared_time\": 1752045010623,\n \"external_share_url\": \"https://app.vanipublic.com/external/open/92c8c172434d1eb794100b0e52303ddaf6ec81d29608502e2b8bce9a5aab731144024ea162631784c784141d8d79c5e3e433279e6f2a4f0841ecfb01ea995155\",\n \"expiration_time\": 1754627011000,\n \"shared_by\": 82512958,\n \"permission\": \"VIEWER\",\n \"space_id\": \"1629000000297013\"\n },\n \"message\": \"Space externally shared successfully\",\n \"request_uri\": \"/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a18f038c-f7db-4cdc-ba75-6cc8acf91ee5", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"82513223\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"EX1006\",\n \"message\": \"External share zones are invalid or not available\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c944d6fa-501a-4abc-bed6-8f8d5f4c8412", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bafc3f9-736e-43eb-803e-4337715a5523", "name": "Forbidden - the caller is authenticated but not allowed to perform this operation", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"82513223\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"EX1003\",\n \"message\": \"External share is not allowed for this team\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dd7ef3d-bc3f-48c7-87ad-1ab348de7ccd", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19399950-c4f1-4c29-9518-9d28da9a3072", "name": "Conflict - the requested change conflicts with the current resource state", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"112255940\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"EX1019\",\n \"message\": \"External share limit reached for the project.\",\n \"space_id\": \"5777000000929039\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/112255940/spaces/5777000000929039/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "414876cd-af95-4604-9439-cb34efd731c1", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d9fcb0f-3049-429c-9607-bc2f181ce81f", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46479448-40ba-498c-b6db-32e21788af5e", "name": "Get a space's external share details", "request": { "name": "Get a space's external share details", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "fields", "value": "shared_by", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: space_id, position, shared_by, permission, share_type, is_password_enabled, password, expiration_time, shared_time, external_share_url, zone_ids, link_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "1aeccd7f-3365-46bf-919b-5d0a4a0c4337", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "shared_by" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"shared_time\": 1753678990289,\n \"space_id\": \"4855000000088149\"\n },\n \"message\": \"External share space info fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/888012145/spaces/4855000000088149/externalshares\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03997fb7-8886-4435-9a92-63abe55d320c", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "shared_by" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"82513223\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"S1046\",\n \"message\": \"Space is not externally shared\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a2102c6-f3f1-467d-9a89-77142b7aef3e", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "shared_by" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"888012145\",\n \"current_user_id\": \"888015717\",\n \"error_code\": \"EX1007\",\n \"message\": \"The user doesn't have permission to fetch external share info\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/888012145/spaces/485500000008849/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf299e2a-2825-4d7f-af00-0ecd1e866b2d", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "shared_by" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32966bbe-184d-4e2e-b1a8-73139a88f1aa", "name": "Rate limit exceeded - this operation allows 10 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "shared_by" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ad8a923-a967-4c1c-b5ba-c98cd9045642", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "fields", "value": "shared_by" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ab6bc52-c525-400e-bc98-2a7183bba6b3", "name": "Revoke a space's external share", "request": { "name": "Revoke a space's external share", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"external_share_id\": \"li.1y\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a4497495-670f-4ff3-9a26-d968f598ce8a", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"external_share_id\": \"li.1y\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"space_id\": \"3009000000675145\",\n \"external_share_removed\": true\n },\n \"message\": \"External share space removed successfully\",\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/3009000000675145/externalshares\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5eb3be5-5f1c-4685-ae5e-f355dac52c6a", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"external_share_id\": \"li.1y\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"82513223\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"S1046\",\n \"message\": \"Space is not externally shared\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd08308e-7661-42e8-9d1b-052a91c9968a", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"external_share_id\": \"li.1y\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4644287-ed6f-43bc-9179-723e1e01956e", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"external_share_id\": \"li.1y\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"96499735\",\n \"current_user_id\": \"96384499\",\n \"error_code\": \"S1009\",\n \"message\": \"Space not found\",\n \"space_id\": \"300900000675145\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/96499735/spaces/300900000675145/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ce354c3-8e70-4230-b91a-ce6a448162ab", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"external_share_id\": \"li.1y\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84d4ffd3-6d63-4bbf-a183-f8d5a06b0286", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"external_share_id\": \"li.1y\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d278c78-4396-44d6-a78d-33f65130cb28", "name": "Update a space's external share", "request": { "name": "Update a space's external share", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b4811926-30e7-4d7d-93ad-5ec0722ddebe", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"is_password_enabled\": true,\n \"zone_ids\": [\n {\n \"zone_id\": \"9e7a947b-470b-46e7-be64-4a617abadf43\",\n \"permission\": \"COMMENTER\"\n }\n ],\n \"password\": \"1\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"shared_time\": 1752045307273,\n \"external_share_url\": \"https://app.localvanipublic.net/external/open/ea6e71f11f7803677667dec29fc1ea2ea829c2b748a992203c8a3eea26b853568c231f96663a6b841b11c071352ee65b844d010ea52cf7e3810a7bc43c2b8c7f\",\n \"expiration_time\": 1754627011000,\n \"shared_by\": 82512958,\n \"permission\": \"COMMENTER\",\n \"space_id\": \"1629000000297013\"\n },\n \"message\": \"External share space updated successfully\",\n \"request_uri\": \"/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "853a592e-39d0-40bc-966e-b7079acb4e64", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"edition_id\": \"82513223\",\n \"current_user_id\": \"82512958\",\n \"error_code\": \"EX1006\",\n \"message\": \"External share zones are invalid or not available\"\n }\n },\n \"request_uri\": \"/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2fbbfec-4bf1-41fb-9ce9-7d8ae15cf0f2", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ea12fee-c0fa-456b-a856-2687e849822c", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7570cf0-1224-4cd9-b9a9-587ce22a33fa", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "287b5793-cdd2-4be4-bbe8-5d1bec3c840f", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "spaces", ":space_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"permission\": \"COMMENTER\",\n \"share_type\": \"PARTIAL_ZONES\",\n \"is_password_enabled\": false,\n \"zone_ids\": \"d4DaABFc-cB62-10de-a4F6-84F250B53Ea3,CACdbdFC-5f4a-9BED-Ffda-916D963D3cDF\",\n \"password\": \".w:\",\n \"expiration_time\": \"string\",\n \"link_name\": \"71Hc]RoC\",\n \"external_share_id\": \"8zYkiIbwPKM.rUIe\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e7fde26-7267-4884-a15f-27d1c5919482", "name": "Get the external shares of a team's spaces", "request": { "name": "Get the external shares of a team's spaces", "description": {}, "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "from", "value": "string", "description": "The starting index from where the results should be fetched. Default value is 0" }, { "disabled": false, "key": "limit", "value": "100", "description": "The maximum number of results to return in the response. Default value is 20" }, { "disabled": false, "key": "fields", "value": "shared_by", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: space_id, position, shared_by, permission, share_type, is_password_enabled, password, expiration_time, shared_time, external_share_url, zone_ids, link_name" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "5c938737-5790-4ea4-b7a8-192d0c000bf0", "name": "Successful response", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "string" }, { "key": "limit", "value": "100" }, { "key": "fields", "value": "shared_by" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"external_share_info\": [\n {\n \"external_share_url\": \"https://app.vanipublic.com/external/open/418a5ec6abf2bb5b7a0486d5aaae300bcb97a2672a1086e25a81c5853896c92d27a8a01fcb9e42a82fe59e5a3c050fb2390d261c80ae2d4f33b09a56b27f58a5\",\n \"permission\": \"VIEWER\",\n \"space_id\": \"1629000000491005\"\n },\n {\n \"external_share_url\": \"https://app.vanipublic.com/external/open/f42bcd0a8025fe33bd45bcb176e270275b48312abef2bf9d468a4939709cf9a68db1f73db4f8bdfee7fc07d948d360e083ee198913c863c624304fc274c8d289\",\n \"permission\": \"VIEWER\",\n \"space_id\": \"1629000000309025\"\n },\n {\n \"external_share_url\": \"https://app.vanipublic.com/external/open/c7dab478035f95d89f1ad22b507b7bf98bd26c5f33c8d5123f5e85c34ae796ea09b9dd26ae6c0e6ac575a8e387eb98073530e803ecdd2cfa1ba7747726529492\",\n \"permission\": \"COMMENTER\",\n \"space_id\": \"1629000000297013\"\n }\n ]\n },\n \"message\": \"External share spaces fetched successfully\",\n \"request_uri\": \"/vani/api/v1/editions/82513223/teams/1629000000002003/externalshares\",\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7489bd6-f8e8-4a98-a4ec-7202c973ce58", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "string" }, { "key": "limit", "value": "100" }, { "key": "fields", "value": "shared_by" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3df1dd8-f0eb-43ea-abd3-7c76e6d8e700", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "string" }, { "key": "limit", "value": "100" }, { "key": "fields", "value": "shared_by" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "926cbb20-78a2-427d-99f4-88d6f065b64d", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "string" }, { "key": "limit", "value": "100" }, { "key": "fields", "value": "shared_by" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5b014c8-7a34-4008-94b5-3f6f5cc7bc74", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "string" }, { "key": "limit", "value": "100" }, { "key": "fields", "value": "shared_by" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccae56d3-579c-4323-bf62-83bb4c83ee93", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "vani", "api", "v1", "editions", ":edition_id", "teams", ":team_id", "externalshares" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "from", "value": "string" }, { "key": "limit", "value": "100" }, { "key": "fields", "value": "shared_by" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "team_id", "description": "(Required) The unique identifier of the team" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "dc0a8164-ddf5-4f26-afab-f1cfe950b777", "name": "Structured Creation", "description": { "content": "Create mindmaps, flowcharts, kanban boards, stacks, tables, and database tables in one call.", "type": "text/plain" }, "item": [ { "id": "e0736a52-9432-4c85-9536-754b2984d5f4", "name": "Create a flowchart from node and edge graph specifications", "request": { "name": "Create a flowchart from node and edge graph specifications", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "flowchart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"nodes\": [\n {\n \"value\": \"\"\n }\n ],\n \"edges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"layout_direction\": \"TOP_DOWN\",\n \"title\": \"ᩉ´肇顡毞敝諮ⶓ\"\n },\n \"percent_bounds\": {\n \"right_pct\": 1737.5563065351773,\n \"top_pct\": 4611.622498783959,\n \"bottom_pct\": 631.5048621338049,\n \"left_pct\": 7901.810014894983\n },\n \"absolute_bounds\": {\n \"x\": 5924.858616571926,\n \"width\": 9210.686796053082,\n \"y\": 1644.8224291460224,\n \"height\": 9360.244146826473\n },\n \"target\": {\n \"insert_index\": 2615,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"A7acE251-Bcd1-6196-Ba7f-4AEFa67D0AcD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "070b137f-8e5c-4a96-a619-20d8bc572b4a", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "flowchart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"nodes\": [\n {\n \"value\": \"\"\n }\n ],\n \"edges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"layout_direction\": \"TOP_DOWN\",\n \"title\": \"ᩉ´肇顡毞敝諮ⶓ\"\n },\n \"percent_bounds\": {\n \"right_pct\": 1737.5563065351773,\n \"top_pct\": 4611.622498783959,\n \"bottom_pct\": 631.5048621338049,\n \"left_pct\": 7901.810014894983\n },\n \"absolute_bounds\": {\n \"x\": 5924.858616571926,\n \"width\": 9210.686796053082,\n \"y\": 1644.8224291460224,\n \"height\": 9360.244146826473\n },\n \"target\": {\n \"insert_index\": 2615,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"A7acE251-Bcd1-6196-Ba7f-4AEFa67D0AcD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d34ad6ed-1f6a-4c06-a203-9a4136a9f512", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "flowchart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"nodes\": [\n {\n \"value\": \"\"\n }\n ],\n \"edges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"layout_direction\": \"TOP_DOWN\",\n \"title\": \"ᩉ´肇顡毞敝諮ⶓ\"\n },\n \"percent_bounds\": {\n \"right_pct\": 1737.5563065351773,\n \"top_pct\": 4611.622498783959,\n \"bottom_pct\": 631.5048621338049,\n \"left_pct\": 7901.810014894983\n },\n \"absolute_bounds\": {\n \"x\": 5924.858616571926,\n \"width\": 9210.686796053082,\n \"y\": 1644.8224291460224,\n \"height\": 9360.244146826473\n },\n \"target\": {\n \"insert_index\": 2615,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"A7acE251-Bcd1-6196-Ba7f-4AEFa67D0AcD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48b768b1-cf32-4a1c-bd30-c91bdd7d124d", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "flowchart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"nodes\": [\n {\n \"value\": \"\"\n }\n ],\n \"edges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"layout_direction\": \"TOP_DOWN\",\n \"title\": \"ᩉ´肇顡毞敝諮ⶓ\"\n },\n \"percent_bounds\": {\n \"right_pct\": 1737.5563065351773,\n \"top_pct\": 4611.622498783959,\n \"bottom_pct\": 631.5048621338049,\n \"left_pct\": 7901.810014894983\n },\n \"absolute_bounds\": {\n \"x\": 5924.858616571926,\n \"width\": 9210.686796053082,\n \"y\": 1644.8224291460224,\n \"height\": 9360.244146826473\n },\n \"target\": {\n \"insert_index\": 2615,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"A7acE251-Bcd1-6196-Ba7f-4AEFa67D0AcD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fc83beb-bfb3-42f5-b314-8c3ce9ed871a", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "flowchart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"nodes\": [\n {\n \"value\": \"\"\n }\n ],\n \"edges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"layout_direction\": \"TOP_DOWN\",\n \"title\": \"ᩉ´肇顡毞敝諮ⶓ\"\n },\n \"percent_bounds\": {\n \"right_pct\": 1737.5563065351773,\n \"top_pct\": 4611.622498783959,\n \"bottom_pct\": 631.5048621338049,\n \"left_pct\": 7901.810014894983\n },\n \"absolute_bounds\": {\n \"x\": 5924.858616571926,\n \"width\": 9210.686796053082,\n \"y\": 1644.8224291460224,\n \"height\": 9360.244146826473\n },\n \"target\": {\n \"insert_index\": 2615,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"A7acE251-Bcd1-6196-Ba7f-4AEFa67D0AcD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d73167d-62c0-408c-8b42-7ec197731055", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "flowchart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"nodes\": [\n {\n \"value\": \"\"\n }\n ],\n \"edges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"layout_direction\": \"TOP_DOWN\",\n \"title\": \"ᩉ´肇顡毞敝諮ⶓ\"\n },\n \"percent_bounds\": {\n \"right_pct\": 1737.5563065351773,\n \"top_pct\": 4611.622498783959,\n \"bottom_pct\": 631.5048621338049,\n \"left_pct\": 7901.810014894983\n },\n \"absolute_bounds\": {\n \"x\": 5924.858616571926,\n \"width\": 9210.686796053082,\n \"y\": 1644.8224291460224,\n \"height\": 9360.244146826473\n },\n \"target\": {\n \"insert_index\": 2615,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"A7acE251-Bcd1-6196-Ba7f-4AEFa67D0AcD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8222cd80-c683-4ebf-8519-2c800b007845", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "flowchart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"nodes\": [\n {\n \"value\": \"\"\n }\n ],\n \"edges\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"layout_direction\": \"TOP_DOWN\",\n \"title\": \"ᩉ´肇顡毞敝諮ⶓ\"\n },\n \"percent_bounds\": {\n \"right_pct\": 1737.5563065351773,\n \"top_pct\": 4611.622498783959,\n \"bottom_pct\": 631.5048621338049,\n \"left_pct\": 7901.810014894983\n },\n \"absolute_bounds\": {\n \"x\": 5924.858616571926,\n \"width\": 9210.686796053082,\n \"y\": 1644.8224291460224,\n \"height\": 9360.244146826473\n },\n \"target\": {\n \"insert_index\": 2615,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"A7acE251-Bcd1-6196-Ba7f-4AEFa67D0AcD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ed0b1af-f6a7-4cd9-852b-cfa9d06da93d", "name": "Create a new table on the board by parsing raw CSV, TSV or pipe-delimited text, with optional header row, whitespace trimming and ragged-row padding. Use for a plain layout table; use createDatabaseTable for a typed, queryable one.", "request": { "name": "Create a new table on the board by parsing raw CSV, TSV or pipe-delimited text, with optional header row, whitespace trimming and ragged-row padding. Use for a plain layout table; use createDatabaseTable for a typed, queryable one.", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "table" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"input\": {\n \"raw_text\": {\n \"value\": \"\"\n },\n \"pad_missing_cells\": {\n \"value\": \"\"\n },\n \"format_hint\": {\n \"value\": \"\"\n },\n \"first_row_is_header\": {\n \"value\": \"\"\n },\n \"trim_whitespace\": {\n \"value\": \"\"\n }\n },\n \"title\": \"载譇鄑\"\n },\n \"percent_bounds\": {\n \"right_pct\": 3974.7361408932957,\n \"top_pct\": 6117.14637744355,\n \"bottom_pct\": 2493.338240349301,\n \"left_pct\": 9232.374864373598\n },\n \"absolute_bounds\": {\n \"x\": 5961.662815888431,\n \"width\": 1593.6897382538984,\n \"y\": 4568.306090761543,\n \"height\": 4478.503109057823\n },\n \"target\": {\n \"insert_index\": 4601,\n \"target_type\": \"FRAME\",\n \"frame_id\": \"ede13bC3-c716-5f57-E0F5-5a6da14Ea743\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0056687d-aba9-4fad-99fb-496660a56340", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "table" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"input\": {\n \"raw_text\": {\n \"value\": \"\"\n },\n \"pad_missing_cells\": {\n \"value\": \"\"\n },\n \"format_hint\": {\n \"value\": \"\"\n },\n \"first_row_is_header\": {\n \"value\": \"\"\n },\n \"trim_whitespace\": {\n \"value\": \"\"\n }\n },\n \"title\": \"载譇鄑\"\n },\n \"percent_bounds\": {\n \"right_pct\": 3974.7361408932957,\n \"top_pct\": 6117.14637744355,\n \"bottom_pct\": 2493.338240349301,\n \"left_pct\": 9232.374864373598\n },\n \"absolute_bounds\": {\n \"x\": 5961.662815888431,\n \"width\": 1593.6897382538984,\n \"y\": 4568.306090761543,\n \"height\": 4478.503109057823\n },\n \"target\": {\n \"insert_index\": 4601,\n \"target_type\": \"FRAME\",\n \"frame_id\": \"ede13bC3-c716-5f57-E0F5-5a6da14Ea743\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3af156f-96b9-4924-83c0-6448adc53506", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "table" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"input\": {\n \"raw_text\": {\n \"value\": \"\"\n },\n \"pad_missing_cells\": {\n \"value\": \"\"\n },\n \"format_hint\": {\n \"value\": \"\"\n },\n \"first_row_is_header\": {\n \"value\": \"\"\n },\n \"trim_whitespace\": {\n \"value\": \"\"\n }\n },\n \"title\": \"载譇鄑\"\n },\n \"percent_bounds\": {\n \"right_pct\": 3974.7361408932957,\n \"top_pct\": 6117.14637744355,\n \"bottom_pct\": 2493.338240349301,\n \"left_pct\": 9232.374864373598\n },\n \"absolute_bounds\": {\n \"x\": 5961.662815888431,\n \"width\": 1593.6897382538984,\n \"y\": 4568.306090761543,\n \"height\": 4478.503109057823\n },\n \"target\": {\n \"insert_index\": 4601,\n \"target_type\": \"FRAME\",\n \"frame_id\": \"ede13bC3-c716-5f57-E0F5-5a6da14Ea743\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd470b5c-1270-405c-acf8-3e0189a6edf2", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "table" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"input\": {\n \"raw_text\": {\n \"value\": \"\"\n },\n \"pad_missing_cells\": {\n \"value\": \"\"\n },\n \"format_hint\": {\n \"value\": \"\"\n },\n \"first_row_is_header\": {\n \"value\": \"\"\n },\n \"trim_whitespace\": {\n \"value\": \"\"\n }\n },\n \"title\": \"载譇鄑\"\n },\n \"percent_bounds\": {\n \"right_pct\": 3974.7361408932957,\n \"top_pct\": 6117.14637744355,\n \"bottom_pct\": 2493.338240349301,\n \"left_pct\": 9232.374864373598\n },\n \"absolute_bounds\": {\n \"x\": 5961.662815888431,\n \"width\": 1593.6897382538984,\n \"y\": 4568.306090761543,\n \"height\": 4478.503109057823\n },\n \"target\": {\n \"insert_index\": 4601,\n \"target_type\": \"FRAME\",\n \"frame_id\": \"ede13bC3-c716-5f57-E0F5-5a6da14Ea743\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cec0cbf8-ba22-4e9e-9d21-f7587487c9db", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "table" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"input\": {\n \"raw_text\": {\n \"value\": \"\"\n },\n \"pad_missing_cells\": {\n \"value\": \"\"\n },\n \"format_hint\": {\n \"value\": \"\"\n },\n \"first_row_is_header\": {\n \"value\": \"\"\n },\n \"trim_whitespace\": {\n \"value\": \"\"\n }\n },\n \"title\": \"载譇鄑\"\n },\n \"percent_bounds\": {\n \"right_pct\": 3974.7361408932957,\n \"top_pct\": 6117.14637744355,\n \"bottom_pct\": 2493.338240349301,\n \"left_pct\": 9232.374864373598\n },\n \"absolute_bounds\": {\n \"x\": 5961.662815888431,\n \"width\": 1593.6897382538984,\n \"y\": 4568.306090761543,\n \"height\": 4478.503109057823\n },\n \"target\": {\n \"insert_index\": 4601,\n \"target_type\": \"FRAME\",\n \"frame_id\": \"ede13bC3-c716-5f57-E0F5-5a6da14Ea743\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f70755d5-da27-418b-8512-0a5263153e59", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "table" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"input\": {\n \"raw_text\": {\n \"value\": \"\"\n },\n \"pad_missing_cells\": {\n \"value\": \"\"\n },\n \"format_hint\": {\n \"value\": \"\"\n },\n \"first_row_is_header\": {\n \"value\": \"\"\n },\n \"trim_whitespace\": {\n \"value\": \"\"\n }\n },\n \"title\": \"载譇鄑\"\n },\n \"percent_bounds\": {\n \"right_pct\": 3974.7361408932957,\n \"top_pct\": 6117.14637744355,\n \"bottom_pct\": 2493.338240349301,\n \"left_pct\": 9232.374864373598\n },\n \"absolute_bounds\": {\n \"x\": 5961.662815888431,\n \"width\": 1593.6897382538984,\n \"y\": 4568.306090761543,\n \"height\": 4478.503109057823\n },\n \"target\": {\n \"insert_index\": 4601,\n \"target_type\": \"FRAME\",\n \"frame_id\": \"ede13bC3-c716-5f57-E0F5-5a6da14Ea743\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "713e2bd3-1673-4014-84d8-466de6c77740", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "table" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"input\": {\n \"raw_text\": {\n \"value\": \"\"\n },\n \"pad_missing_cells\": {\n \"value\": \"\"\n },\n \"format_hint\": {\n \"value\": \"\"\n },\n \"first_row_is_header\": {\n \"value\": \"\"\n },\n \"trim_whitespace\": {\n \"value\": \"\"\n }\n },\n \"title\": \"载譇鄑\"\n },\n \"percent_bounds\": {\n \"right_pct\": 3974.7361408932957,\n \"top_pct\": 6117.14637744355,\n \"bottom_pct\": 2493.338240349301,\n \"left_pct\": 9232.374864373598\n },\n \"absolute_bounds\": {\n \"x\": 5961.662815888431,\n \"width\": 1593.6897382538984,\n \"y\": 4568.306090761543,\n \"height\": 4478.503109057823\n },\n \"target\": {\n \"insert_index\": 4601,\n \"target_type\": \"FRAME\",\n \"frame_id\": \"ede13bC3-c716-5f57-E0F5-5a6da14Ea743\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3cea9d01-b188-42c9-a102-5b575f736663", "name": "Create a stack structure from an ordered list of item specifications", "request": { "name": "Create a stack structure from an ordered list of item specifications", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "stack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"content\": {\n \"value\": \"\"\n }\n }\n ],\n \"percent_bounds\": {\n \"right_pct\": 5562.451399325077,\n \"top_pct\": 8452.257664171175,\n \"bottom_pct\": 3898.643094516754,\n \"left_pct\": 7469.909059046691\n },\n \"spacing\": {\n \"manual_spacing\": 4934.87638832095,\n \"auto_spacing\": {}\n },\n \"title\": \"\",\n \"absolute_bounds\": {\n \"x\": 6623.050571837807,\n \"width\": 4389.474737342955,\n \"y\": 9748.813820386727,\n \"height\": 3313.630600923947\n },\n \"layout_hint\": \"STACK_VERTICAL\",\n \"target\": {\n \"insert_index\": 6700,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"093B99BC-9DAD-5cc7-EfFc-b99a2E9CDDbB\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3f06fe9c-3e97-464b-8d62-8342a9e42a15", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "stack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"content\": {\n \"value\": \"\"\n }\n }\n ],\n \"percent_bounds\": {\n \"right_pct\": 5562.451399325077,\n \"top_pct\": 8452.257664171175,\n \"bottom_pct\": 3898.643094516754,\n \"left_pct\": 7469.909059046691\n },\n \"spacing\": {\n \"manual_spacing\": 4934.87638832095,\n \"auto_spacing\": {}\n },\n \"title\": \"\",\n \"absolute_bounds\": {\n \"x\": 6623.050571837807,\n \"width\": 4389.474737342955,\n \"y\": 9748.813820386727,\n \"height\": 3313.630600923947\n },\n \"layout_hint\": \"STACK_VERTICAL\",\n \"target\": {\n \"insert_index\": 6700,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"093B99BC-9DAD-5cc7-EfFc-b99a2E9CDDbB\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f043fa05-b8da-4c13-bb97-b4de195bc606", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "stack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"content\": {\n \"value\": \"\"\n }\n }\n ],\n \"percent_bounds\": {\n \"right_pct\": 5562.451399325077,\n \"top_pct\": 8452.257664171175,\n \"bottom_pct\": 3898.643094516754,\n \"left_pct\": 7469.909059046691\n },\n \"spacing\": {\n \"manual_spacing\": 4934.87638832095,\n \"auto_spacing\": {}\n },\n \"title\": \"\",\n \"absolute_bounds\": {\n \"x\": 6623.050571837807,\n \"width\": 4389.474737342955,\n \"y\": 9748.813820386727,\n \"height\": 3313.630600923947\n },\n \"layout_hint\": \"STACK_VERTICAL\",\n \"target\": {\n \"insert_index\": 6700,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"093B99BC-9DAD-5cc7-EfFc-b99a2E9CDDbB\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48de9a39-f034-4a65-97dc-386b0a6ca13d", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "stack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"content\": {\n \"value\": \"\"\n }\n }\n ],\n \"percent_bounds\": {\n \"right_pct\": 5562.451399325077,\n \"top_pct\": 8452.257664171175,\n \"bottom_pct\": 3898.643094516754,\n \"left_pct\": 7469.909059046691\n },\n \"spacing\": {\n \"manual_spacing\": 4934.87638832095,\n \"auto_spacing\": {}\n },\n \"title\": \"\",\n \"absolute_bounds\": {\n \"x\": 6623.050571837807,\n \"width\": 4389.474737342955,\n \"y\": 9748.813820386727,\n \"height\": 3313.630600923947\n },\n \"layout_hint\": \"STACK_VERTICAL\",\n \"target\": {\n \"insert_index\": 6700,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"093B99BC-9DAD-5cc7-EfFc-b99a2E9CDDbB\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f832191c-7e2d-417d-99cb-fcc552d77cbd", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "stack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"content\": {\n \"value\": \"\"\n }\n }\n ],\n \"percent_bounds\": {\n \"right_pct\": 5562.451399325077,\n \"top_pct\": 8452.257664171175,\n \"bottom_pct\": 3898.643094516754,\n \"left_pct\": 7469.909059046691\n },\n \"spacing\": {\n \"manual_spacing\": 4934.87638832095,\n \"auto_spacing\": {}\n },\n \"title\": \"\",\n \"absolute_bounds\": {\n \"x\": 6623.050571837807,\n \"width\": 4389.474737342955,\n \"y\": 9748.813820386727,\n \"height\": 3313.630600923947\n },\n \"layout_hint\": \"STACK_VERTICAL\",\n \"target\": {\n \"insert_index\": 6700,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"093B99BC-9DAD-5cc7-EfFc-b99a2E9CDDbB\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eda99475-f3f3-442c-be47-2416a44c731a", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "stack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"content\": {\n \"value\": \"\"\n }\n }\n ],\n \"percent_bounds\": {\n \"right_pct\": 5562.451399325077,\n \"top_pct\": 8452.257664171175,\n \"bottom_pct\": 3898.643094516754,\n \"left_pct\": 7469.909059046691\n },\n \"spacing\": {\n \"manual_spacing\": 4934.87638832095,\n \"auto_spacing\": {}\n },\n \"title\": \"\",\n \"absolute_bounds\": {\n \"x\": 6623.050571837807,\n \"width\": 4389.474737342955,\n \"y\": 9748.813820386727,\n \"height\": 3313.630600923947\n },\n \"layout_hint\": \"STACK_VERTICAL\",\n \"target\": {\n \"insert_index\": 6700,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"093B99BC-9DAD-5cc7-EfFc-b99a2E9CDDbB\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2757e4c5-c59e-4f82-8b45-8ec12a700748", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "stack" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"content\": {\n \"value\": \"\"\n }\n }\n ],\n \"percent_bounds\": {\n \"right_pct\": 5562.451399325077,\n \"top_pct\": 8452.257664171175,\n \"bottom_pct\": 3898.643094516754,\n \"left_pct\": 7469.909059046691\n },\n \"spacing\": {\n \"manual_spacing\": 4934.87638832095,\n \"auto_spacing\": {}\n },\n \"title\": \"\",\n \"absolute_bounds\": {\n \"x\": 6623.050571837807,\n \"width\": 4389.474737342955,\n \"y\": 9748.813820386727,\n \"height\": 3313.630600923947\n },\n \"layout_hint\": \"STACK_VERTICAL\",\n \"target\": {\n \"insert_index\": 6700,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"093B99BC-9DAD-5cc7-EfFc-b99a2E9CDDbB\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86046ee4-40ea-4de4-9a88-316a9d725106", "name": "Create a kanban board structure from column and item specifications", "request": { "name": "Create a kanban board structure from column and item specifications", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "kanban" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"title\": {\n \"value\": \"\"\n },\n \"items\": {\n \"value\": \"\"\n }\n }\n ],\n \"percent_bounds\": {\n \"right_pct\": 3901.592772626199,\n \"top_pct\": 4700.8878557707785,\n \"bottom_pct\": 3143.474327769937,\n \"left_pct\": 7317.40211873879\n },\n \"spacing\": {\n \"manual_spacing\": 8235.359633726313,\n \"auto_spacing\": {}\n },\n \"title\": \"列ᐭ˙\",\n \"absolute_bounds\": {\n \"x\": 7770.96681320154,\n \"width\": 4517.578695710456,\n \"y\": 4790.70840481489,\n \"height\": 2611.5992394803466\n },\n \"layout_hint\": \"HORIZONTAL\",\n \"target\": {\n \"insert_index\": 455,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"5cd6A27b-fbdC-f1af-c969-D6BFCBD4BcBA\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "99a5d983-28d7-4380-a689-f5d8bb13175c", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "kanban" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"title\": {\n \"value\": \"\"\n },\n \"items\": {\n \"value\": \"\"\n }\n }\n ],\n \"percent_bounds\": {\n \"right_pct\": 3901.592772626199,\n \"top_pct\": 4700.8878557707785,\n \"bottom_pct\": 3143.474327769937,\n \"left_pct\": 7317.40211873879\n },\n \"spacing\": {\n \"manual_spacing\": 8235.359633726313,\n \"auto_spacing\": {}\n },\n \"title\": \"列ᐭ˙\",\n \"absolute_bounds\": {\n \"x\": 7770.96681320154,\n \"width\": 4517.578695710456,\n \"y\": 4790.70840481489,\n \"height\": 2611.5992394803466\n },\n \"layout_hint\": \"HORIZONTAL\",\n \"target\": {\n \"insert_index\": 455,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"5cd6A27b-fbdC-f1af-c969-D6BFCBD4BcBA\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0efca85-41d5-4978-b61e-2f26f141e1db", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "kanban" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"title\": {\n \"value\": \"\"\n },\n \"items\": {\n \"value\": \"\"\n }\n }\n ],\n \"percent_bounds\": {\n \"right_pct\": 3901.592772626199,\n \"top_pct\": 4700.8878557707785,\n \"bottom_pct\": 3143.474327769937,\n \"left_pct\": 7317.40211873879\n },\n \"spacing\": {\n \"manual_spacing\": 8235.359633726313,\n \"auto_spacing\": {}\n },\n \"title\": \"列ᐭ˙\",\n \"absolute_bounds\": {\n \"x\": 7770.96681320154,\n \"width\": 4517.578695710456,\n \"y\": 4790.70840481489,\n \"height\": 2611.5992394803466\n },\n \"layout_hint\": \"HORIZONTAL\",\n \"target\": {\n \"insert_index\": 455,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"5cd6A27b-fbdC-f1af-c969-D6BFCBD4BcBA\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc2aeb41-0269-43af-a836-e339fe8ec1ab", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "kanban" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"title\": {\n \"value\": \"\"\n },\n \"items\": {\n \"value\": \"\"\n }\n }\n ],\n \"percent_bounds\": {\n \"right_pct\": 3901.592772626199,\n \"top_pct\": 4700.8878557707785,\n \"bottom_pct\": 3143.474327769937,\n \"left_pct\": 7317.40211873879\n },\n \"spacing\": {\n \"manual_spacing\": 8235.359633726313,\n \"auto_spacing\": {}\n },\n \"title\": \"列ᐭ˙\",\n \"absolute_bounds\": {\n \"x\": 7770.96681320154,\n \"width\": 4517.578695710456,\n \"y\": 4790.70840481489,\n \"height\": 2611.5992394803466\n },\n \"layout_hint\": \"HORIZONTAL\",\n \"target\": {\n \"insert_index\": 455,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"5cd6A27b-fbdC-f1af-c969-D6BFCBD4BcBA\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69ce24a0-d7f2-41e1-a9af-da3763e5de30", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "kanban" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"title\": {\n \"value\": \"\"\n },\n \"items\": {\n \"value\": \"\"\n }\n }\n ],\n \"percent_bounds\": {\n \"right_pct\": 3901.592772626199,\n \"top_pct\": 4700.8878557707785,\n \"bottom_pct\": 3143.474327769937,\n \"left_pct\": 7317.40211873879\n },\n \"spacing\": {\n \"manual_spacing\": 8235.359633726313,\n \"auto_spacing\": {}\n },\n \"title\": \"列ᐭ˙\",\n \"absolute_bounds\": {\n \"x\": 7770.96681320154,\n \"width\": 4517.578695710456,\n \"y\": 4790.70840481489,\n \"height\": 2611.5992394803466\n },\n \"layout_hint\": \"HORIZONTAL\",\n \"target\": {\n \"insert_index\": 455,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"5cd6A27b-fbdC-f1af-c969-D6BFCBD4BcBA\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "981a7471-8be0-40a7-85c7-85ae0e2a217b", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "kanban" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"title\": {\n \"value\": \"\"\n },\n \"items\": {\n \"value\": \"\"\n }\n }\n ],\n \"percent_bounds\": {\n \"right_pct\": 3901.592772626199,\n \"top_pct\": 4700.8878557707785,\n \"bottom_pct\": 3143.474327769937,\n \"left_pct\": 7317.40211873879\n },\n \"spacing\": {\n \"manual_spacing\": 8235.359633726313,\n \"auto_spacing\": {}\n },\n \"title\": \"列ᐭ˙\",\n \"absolute_bounds\": {\n \"x\": 7770.96681320154,\n \"width\": 4517.578695710456,\n \"y\": 4790.70840481489,\n \"height\": 2611.5992394803466\n },\n \"layout_hint\": \"HORIZONTAL\",\n \"target\": {\n \"insert_index\": 455,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"5cd6A27b-fbdC-f1af-c969-D6BFCBD4BcBA\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a502d41-e0d9-43bf-b2fb-786cdfb3e395", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "kanban" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": [\n {\n \"title\": {\n \"value\": \"\"\n },\n \"items\": {\n \"value\": \"\"\n }\n }\n ],\n \"percent_bounds\": {\n \"right_pct\": 3901.592772626199,\n \"top_pct\": 4700.8878557707785,\n \"bottom_pct\": 3143.474327769937,\n \"left_pct\": 7317.40211873879\n },\n \"spacing\": {\n \"manual_spacing\": 8235.359633726313,\n \"auto_spacing\": {}\n },\n \"title\": \"列ᐭ˙\",\n \"absolute_bounds\": {\n \"x\": 7770.96681320154,\n \"width\": 4517.578695710456,\n \"y\": 4790.70840481489,\n \"height\": 2611.5992394803466\n },\n \"layout_hint\": \"HORIZONTAL\",\n \"target\": {\n \"insert_index\": 455,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"5cd6A27b-fbdC-f1af-c969-D6BFCBD4BcBA\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "60034545-adc4-4d05-8c6f-559e457ca9a5", "name": "Create a mindmap structure from a hierarchical outline specification", "request": { "name": "Create a mindmap structure from a hierarchical outline specification", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "mindmap" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"root\": {\n \"notes\": \"ᒼ煝声\",\n \"link_url\": \"https:///Bxe=vLx]So4{huvi]`g&hMT$fqj@S54GzKCVoT+B'GIQUj`m+c4;LH\\\\x)3aA(qYv%PLG]Zw]s]kT-6'2~a,-E[kagpr@+fs[Q|(6`qbNWYQSv(BZ$}3Zl0{b[HTKFb(lT9{Gz!gLMKdiUn[E/iO3|s`|ud!fF`I{gzE-JeB=MoapkQKF4Sb[5bsbJ`ww8WAh5_o\\\\8+1(Y4I4WQX.4;!0a_i#4Z-ZY|/eBlzysS#Fueu?OeuX;*hQ4Gm\",\n \"text\": \"\\udeccᝥ쨎餲솢灞쳹ꍹ뙄\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"percent_bounds\": {\n \"right_pct\": 5597.658834040993,\n \"top_pct\": 2803.644096960365,\n \"bottom_pct\": 3431.153431716234,\n \"left_pct\": 7407.160088966393\n },\n \"spacing\": {\n \"manual_spacing\": 1934.5383382928549,\n \"auto_spacing\": {}\n },\n \"top\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"left\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"bottom\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"top_down\": {\n \"top\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bottom\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"right\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"title\": \"屟㐇䰄䆁\",\n \"absolute_bounds\": {\n \"x\": 9338.918972428391,\n \"width\": 3573.4414775130886,\n \"y\": 5138.213511566179,\n \"height\": 6197.260183912949\n },\n \"left_right\": {\n \"left\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"right\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"target\": {\n \"insert_index\": 8280,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"BDAE94E0-7dBf-5FdB-0FBf-A3d5a5CF363a\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c40ea2a0-e977-4ee8-b609-9a5e4455378d", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "mindmap" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"root\": {\n \"notes\": \"ᒼ煝声\",\n \"link_url\": \"https:///Bxe=vLx]So4{huvi]`g&hMT$fqj@S54GzKCVoT+B'GIQUj`m+c4;LH\\\\x)3aA(qYv%PLG]Zw]s]kT-6'2~a,-E[kagpr@+fs[Q|(6`qbNWYQSv(BZ$}3Zl0{b[HTKFb(lT9{Gz!gLMKdiUn[E/iO3|s`|ud!fF`I{gzE-JeB=MoapkQKF4Sb[5bsbJ`ww8WAh5_o\\\\8+1(Y4I4WQX.4;!0a_i#4Z-ZY|/eBlzysS#Fueu?OeuX;*hQ4Gm\",\n \"text\": \"\\udeccᝥ쨎餲솢灞쳹ꍹ뙄\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"percent_bounds\": {\n \"right_pct\": 5597.658834040993,\n \"top_pct\": 2803.644096960365,\n \"bottom_pct\": 3431.153431716234,\n \"left_pct\": 7407.160088966393\n },\n \"spacing\": {\n \"manual_spacing\": 1934.5383382928549,\n \"auto_spacing\": {}\n },\n \"top\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"left\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"bottom\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"top_down\": {\n \"top\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bottom\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"right\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"title\": \"屟㐇䰄䆁\",\n \"absolute_bounds\": {\n \"x\": 9338.918972428391,\n \"width\": 3573.4414775130886,\n \"y\": 5138.213511566179,\n \"height\": 6197.260183912949\n },\n \"left_right\": {\n \"left\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"right\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"target\": {\n \"insert_index\": 8280,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"BDAE94E0-7dBf-5FdB-0FBf-A3d5a5CF363a\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aae6d356-65e3-477a-b75d-834cf8fbf651", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "mindmap" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"root\": {\n \"notes\": \"ᒼ煝声\",\n \"link_url\": \"https:///Bxe=vLx]So4{huvi]`g&hMT$fqj@S54GzKCVoT+B'GIQUj`m+c4;LH\\\\x)3aA(qYv%PLG]Zw]s]kT-6'2~a,-E[kagpr@+fs[Q|(6`qbNWYQSv(BZ$}3Zl0{b[HTKFb(lT9{Gz!gLMKdiUn[E/iO3|s`|ud!fF`I{gzE-JeB=MoapkQKF4Sb[5bsbJ`ww8WAh5_o\\\\8+1(Y4I4WQX.4;!0a_i#4Z-ZY|/eBlzysS#Fueu?OeuX;*hQ4Gm\",\n \"text\": \"\\udeccᝥ쨎餲솢灞쳹ꍹ뙄\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"percent_bounds\": {\n \"right_pct\": 5597.658834040993,\n \"top_pct\": 2803.644096960365,\n \"bottom_pct\": 3431.153431716234,\n \"left_pct\": 7407.160088966393\n },\n \"spacing\": {\n \"manual_spacing\": 1934.5383382928549,\n \"auto_spacing\": {}\n },\n \"top\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"left\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"bottom\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"top_down\": {\n \"top\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bottom\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"right\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"title\": \"屟㐇䰄䆁\",\n \"absolute_bounds\": {\n \"x\": 9338.918972428391,\n \"width\": 3573.4414775130886,\n \"y\": 5138.213511566179,\n \"height\": 6197.260183912949\n },\n \"left_right\": {\n \"left\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"right\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"target\": {\n \"insert_index\": 8280,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"BDAE94E0-7dBf-5FdB-0FBf-A3d5a5CF363a\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8374a76e-e09e-4d42-a663-912ac5e0b68e", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "mindmap" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"root\": {\n \"notes\": \"ᒼ煝声\",\n \"link_url\": \"https:///Bxe=vLx]So4{huvi]`g&hMT$fqj@S54GzKCVoT+B'GIQUj`m+c4;LH\\\\x)3aA(qYv%PLG]Zw]s]kT-6'2~a,-E[kagpr@+fs[Q|(6`qbNWYQSv(BZ$}3Zl0{b[HTKFb(lT9{Gz!gLMKdiUn[E/iO3|s`|ud!fF`I{gzE-JeB=MoapkQKF4Sb[5bsbJ`ww8WAh5_o\\\\8+1(Y4I4WQX.4;!0a_i#4Z-ZY|/eBlzysS#Fueu?OeuX;*hQ4Gm\",\n \"text\": \"\\udeccᝥ쨎餲솢灞쳹ꍹ뙄\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"percent_bounds\": {\n \"right_pct\": 5597.658834040993,\n \"top_pct\": 2803.644096960365,\n \"bottom_pct\": 3431.153431716234,\n \"left_pct\": 7407.160088966393\n },\n \"spacing\": {\n \"manual_spacing\": 1934.5383382928549,\n \"auto_spacing\": {}\n },\n \"top\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"left\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"bottom\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"top_down\": {\n \"top\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bottom\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"right\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"title\": \"屟㐇䰄䆁\",\n \"absolute_bounds\": {\n \"x\": 9338.918972428391,\n \"width\": 3573.4414775130886,\n \"y\": 5138.213511566179,\n \"height\": 6197.260183912949\n },\n \"left_right\": {\n \"left\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"right\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"target\": {\n \"insert_index\": 8280,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"BDAE94E0-7dBf-5FdB-0FBf-A3d5a5CF363a\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9123f08-0a4f-4c3e-b60e-537a9c4dae4f", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "mindmap" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"root\": {\n \"notes\": \"ᒼ煝声\",\n \"link_url\": \"https:///Bxe=vLx]So4{huvi]`g&hMT$fqj@S54GzKCVoT+B'GIQUj`m+c4;LH\\\\x)3aA(qYv%PLG]Zw]s]kT-6'2~a,-E[kagpr@+fs[Q|(6`qbNWYQSv(BZ$}3Zl0{b[HTKFb(lT9{Gz!gLMKdiUn[E/iO3|s`|ud!fF`I{gzE-JeB=MoapkQKF4Sb[5bsbJ`ww8WAh5_o\\\\8+1(Y4I4WQX.4;!0a_i#4Z-ZY|/eBlzysS#Fueu?OeuX;*hQ4Gm\",\n \"text\": \"\\udeccᝥ쨎餲솢灞쳹ꍹ뙄\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"percent_bounds\": {\n \"right_pct\": 5597.658834040993,\n \"top_pct\": 2803.644096960365,\n \"bottom_pct\": 3431.153431716234,\n \"left_pct\": 7407.160088966393\n },\n \"spacing\": {\n \"manual_spacing\": 1934.5383382928549,\n \"auto_spacing\": {}\n },\n \"top\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"left\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"bottom\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"top_down\": {\n \"top\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bottom\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"right\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"title\": \"屟㐇䰄䆁\",\n \"absolute_bounds\": {\n \"x\": 9338.918972428391,\n \"width\": 3573.4414775130886,\n \"y\": 5138.213511566179,\n \"height\": 6197.260183912949\n },\n \"left_right\": {\n \"left\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"right\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"target\": {\n \"insert_index\": 8280,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"BDAE94E0-7dBf-5FdB-0FBf-A3d5a5CF363a\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dee07327-3ec9-4fbf-85d6-64df4aa79b72", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "mindmap" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"root\": {\n \"notes\": \"ᒼ煝声\",\n \"link_url\": \"https:///Bxe=vLx]So4{huvi]`g&hMT$fqj@S54GzKCVoT+B'GIQUj`m+c4;LH\\\\x)3aA(qYv%PLG]Zw]s]kT-6'2~a,-E[kagpr@+fs[Q|(6`qbNWYQSv(BZ$}3Zl0{b[HTKFb(lT9{Gz!gLMKdiUn[E/iO3|s`|ud!fF`I{gzE-JeB=MoapkQKF4Sb[5bsbJ`ww8WAh5_o\\\\8+1(Y4I4WQX.4;!0a_i#4Z-ZY|/eBlzysS#Fueu?OeuX;*hQ4Gm\",\n \"text\": \"\\udeccᝥ쨎餲솢灞쳹ꍹ뙄\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"percent_bounds\": {\n \"right_pct\": 5597.658834040993,\n \"top_pct\": 2803.644096960365,\n \"bottom_pct\": 3431.153431716234,\n \"left_pct\": 7407.160088966393\n },\n \"spacing\": {\n \"manual_spacing\": 1934.5383382928549,\n \"auto_spacing\": {}\n },\n \"top\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"left\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"bottom\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"top_down\": {\n \"top\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bottom\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"right\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"title\": \"屟㐇䰄䆁\",\n \"absolute_bounds\": {\n \"x\": 9338.918972428391,\n \"width\": 3573.4414775130886,\n \"y\": 5138.213511566179,\n \"height\": 6197.260183912949\n },\n \"left_right\": {\n \"left\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"right\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"target\": {\n \"insert_index\": 8280,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"BDAE94E0-7dBf-5FdB-0FBf-A3d5a5CF363a\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edf2e01f-f43a-4205-9825-72fe84bcdfb1", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "mindmap" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"root\": {\n \"notes\": \"ᒼ煝声\",\n \"link_url\": \"https:///Bxe=vLx]So4{huvi]`g&hMT$fqj@S54GzKCVoT+B'GIQUj`m+c4;LH\\\\x)3aA(qYv%PLG]Zw]s]kT-6'2~a,-E[kagpr@+fs[Q|(6`qbNWYQSv(BZ$}3Zl0{b[HTKFb(lT9{Gz!gLMKdiUn[E/iO3|s`|ud!fF`I{gzE-JeB=MoapkQKF4Sb[5bsbJ`ww8WAh5_o\\\\8+1(Y4I4WQX.4;!0a_i#4Z-ZY|/eBlzysS#Fueu?OeuX;*hQ4Gm\",\n \"text\": \"\\udeccᝥ쨎餲솢灞쳹ꍹ뙄\",\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"percent_bounds\": {\n \"right_pct\": 5597.658834040993,\n \"top_pct\": 2803.644096960365,\n \"bottom_pct\": 3431.153431716234,\n \"left_pct\": 7407.160088966393\n },\n \"spacing\": {\n \"manual_spacing\": 1934.5383382928549,\n \"auto_spacing\": {}\n },\n \"top\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"left\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"bottom\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"top_down\": {\n \"top\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"bottom\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"right\": {\n \"children\": [\n {\n \"value\": \"\"\n }\n ]\n },\n \"title\": \"屟㐇䰄䆁\",\n \"absolute_bounds\": {\n \"x\": 9338.918972428391,\n \"width\": 3573.4414775130886,\n \"y\": 5138.213511566179,\n \"height\": 6197.260183912949\n },\n \"left_right\": {\n \"left\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"right\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"target\": {\n \"insert_index\": 8280,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"BDAE94E0-7dBf-5FdB-0FBf-A3d5a5CF363a\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "efdd72d5-ba0e-4992-b303-2af0b3853fde", "name": "Create a typed database_table from raw tabular text data", "request": { "name": "Create a typed database_table from raw tabular text data", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "database-table" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"input\": {\n \"raw_text\": {\n \"value\": \"\"\n },\n \"pad_missing_cells\": {\n \"value\": \"\"\n },\n \"format_hint\": {\n \"value\": \"\"\n },\n \"first_row_is_header\": {\n \"value\": \"\"\n },\n \"trim_whitespace\": {\n \"value\": \"\"\n }\n },\n \"name\": \"ꀱ\"\n },\n \"percent_bounds\": {\n \"right_pct\": 7884.374477957901,\n \"top_pct\": 5334.531716442079,\n \"bottom_pct\": 4414.978150635553,\n \"left_pct\": 9619.100706309833\n },\n \"absolute_bounds\": {\n \"x\": 8019.58606620734,\n \"width\": 5750.042220807488,\n \"y\": 4567.24992779392,\n \"height\": 6043.916156348548\n },\n \"target\": {\n \"insert_index\": 507,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"9814EF55-c06b-693F-fD52-11De585F809d\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7ebe352d-408b-44a4-b554-ab9e8af3fb2e", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "database-table" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"input\": {\n \"raw_text\": {\n \"value\": \"\"\n },\n \"pad_missing_cells\": {\n \"value\": \"\"\n },\n \"format_hint\": {\n \"value\": \"\"\n },\n \"first_row_is_header\": {\n \"value\": \"\"\n },\n \"trim_whitespace\": {\n \"value\": \"\"\n }\n },\n \"name\": \"ꀱ\"\n },\n \"percent_bounds\": {\n \"right_pct\": 7884.374477957901,\n \"top_pct\": 5334.531716442079,\n \"bottom_pct\": 4414.978150635553,\n \"left_pct\": 9619.100706309833\n },\n \"absolute_bounds\": {\n \"x\": 8019.58606620734,\n \"width\": 5750.042220807488,\n \"y\": 4567.24992779392,\n \"height\": 6043.916156348548\n },\n \"target\": {\n \"insert_index\": 507,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"9814EF55-c06b-693F-fD52-11De585F809d\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23bb65cd-08e8-410d-8029-ca58bfe158c6", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "database-table" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"input\": {\n \"raw_text\": {\n \"value\": \"\"\n },\n \"pad_missing_cells\": {\n \"value\": \"\"\n },\n \"format_hint\": {\n \"value\": \"\"\n },\n \"first_row_is_header\": {\n \"value\": \"\"\n },\n \"trim_whitespace\": {\n \"value\": \"\"\n }\n },\n \"name\": \"ꀱ\"\n },\n \"percent_bounds\": {\n \"right_pct\": 7884.374477957901,\n \"top_pct\": 5334.531716442079,\n \"bottom_pct\": 4414.978150635553,\n \"left_pct\": 9619.100706309833\n },\n \"absolute_bounds\": {\n \"x\": 8019.58606620734,\n \"width\": 5750.042220807488,\n \"y\": 4567.24992779392,\n \"height\": 6043.916156348548\n },\n \"target\": {\n \"insert_index\": 507,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"9814EF55-c06b-693F-fD52-11De585F809d\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4847699a-3fb7-48fc-b6f4-245ad5fee756", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "database-table" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"input\": {\n \"raw_text\": {\n \"value\": \"\"\n },\n \"pad_missing_cells\": {\n \"value\": \"\"\n },\n \"format_hint\": {\n \"value\": \"\"\n },\n \"first_row_is_header\": {\n \"value\": \"\"\n },\n \"trim_whitespace\": {\n \"value\": \"\"\n }\n },\n \"name\": \"ꀱ\"\n },\n \"percent_bounds\": {\n \"right_pct\": 7884.374477957901,\n \"top_pct\": 5334.531716442079,\n \"bottom_pct\": 4414.978150635553,\n \"left_pct\": 9619.100706309833\n },\n \"absolute_bounds\": {\n \"x\": 8019.58606620734,\n \"width\": 5750.042220807488,\n \"y\": 4567.24992779392,\n \"height\": 6043.916156348548\n },\n \"target\": {\n \"insert_index\": 507,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"9814EF55-c06b-693F-fD52-11De585F809d\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a72c4034-6848-4a2f-bca2-b537b1d2e1ba", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "database-table" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"input\": {\n \"raw_text\": {\n \"value\": \"\"\n },\n \"pad_missing_cells\": {\n \"value\": \"\"\n },\n \"format_hint\": {\n \"value\": \"\"\n },\n \"first_row_is_header\": {\n \"value\": \"\"\n },\n \"trim_whitespace\": {\n \"value\": \"\"\n }\n },\n \"name\": \"ꀱ\"\n },\n \"percent_bounds\": {\n \"right_pct\": 7884.374477957901,\n \"top_pct\": 5334.531716442079,\n \"bottom_pct\": 4414.978150635553,\n \"left_pct\": 9619.100706309833\n },\n \"absolute_bounds\": {\n \"x\": 8019.58606620734,\n \"width\": 5750.042220807488,\n \"y\": 4567.24992779392,\n \"height\": 6043.916156348548\n },\n \"target\": {\n \"insert_index\": 507,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"9814EF55-c06b-693F-fD52-11De585F809d\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24909f38-67ee-45ec-911f-82941c35cc18", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "database-table" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"input\": {\n \"raw_text\": {\n \"value\": \"\"\n },\n \"pad_missing_cells\": {\n \"value\": \"\"\n },\n \"format_hint\": {\n \"value\": \"\"\n },\n \"first_row_is_header\": {\n \"value\": \"\"\n },\n \"trim_whitespace\": {\n \"value\": \"\"\n }\n },\n \"name\": \"ꀱ\"\n },\n \"percent_bounds\": {\n \"right_pct\": 7884.374477957901,\n \"top_pct\": 5334.531716442079,\n \"bottom_pct\": 4414.978150635553,\n \"left_pct\": 9619.100706309833\n },\n \"absolute_bounds\": {\n \"x\": 8019.58606620734,\n \"width\": 5750.042220807488,\n \"y\": 4567.24992779392,\n \"height\": 6043.916156348548\n },\n \"target\": {\n \"insert_index\": 507,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"9814EF55-c06b-693F-fD52-11De585F809d\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b29fb64-8a15-44bc-9d6c-06cb9c7417d4", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "create", "database-table" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"input\": {\n \"raw_text\": {\n \"value\": \"\"\n },\n \"pad_missing_cells\": {\n \"value\": \"\"\n },\n \"format_hint\": {\n \"value\": \"\"\n },\n \"first_row_is_header\": {\n \"value\": \"\"\n },\n \"trim_whitespace\": {\n \"value\": \"\"\n }\n },\n \"name\": \"ꀱ\"\n },\n \"percent_bounds\": {\n \"right_pct\": 7884.374477957901,\n \"top_pct\": 5334.531716442079,\n \"bottom_pct\": 4414.978150635553,\n \"left_pct\": 9619.100706309833\n },\n \"absolute_bounds\": {\n \"x\": 8019.58606620734,\n \"width\": 5750.042220807488,\n \"y\": 4567.24992779392,\n \"height\": 6043.916156348548\n },\n \"target\": {\n \"insert_index\": 507,\n \"target_type\": \"ZONE_ROOT\",\n \"frame_id\": \"9814EF55-c06b-693F-fD52-11De585F809d\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a8f7a725-65a2-444d-9a94-c3a16daa3a08", "name": "Anchoring", "description": { "content": "Place, align, and tidy frames and objects relative to one another, with feasibility previews.", "type": "text/plain" }, "item": [ { "id": "6ca35285-671f-43dc-804c-cc43caee6359", "name": "Check whether selected frames already satisfy a requested alignment mode and optional target bounds", "request": { "name": "Check whether selected frames already satisfy a requested alignment mode and optional target bounds", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "alignment-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "anchoring_query", "value": "string", "description": "(Required) `anchoring_query` — JSON-encoded GetFrameAlignmentStatus request: frame_ids, mode, optional target. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "bad17159-f5a9-4cfc-8179-16c2da26f3bd", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "alignment-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72e5a9c3-135a-4121-828f-497c6c598e36", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "alignment-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c75ecfe-6718-4b6a-bd29-40fc47a3fd73", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "alignment-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c9a4c60-c238-4d12-9e3f-1ab78a2be631", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "alignment-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a332e82e-db43-4f3f-8555-d9bc56de14e4", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "alignment-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baf9e621-f01c-467f-a459-0fbb9f2831e0", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "alignment-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "309deead-aabc-48a5-bb96-215569419bad", "name": "Apply tidy grid layout to selected frames using requested spacing and direction policy", "request": { "name": "Apply tidy grid layout to selected frames using requested spacing and direction policy", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "tidy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"frame_ids\": [\n \"cED36Ccf-2AD8-b73C-0bbA-f13fdaaBFf74\",\n \"30A9dFdA-7eeA-e67E-b338-F7ad7fC086Aa\"\n ],\n \"fixed_spacing\": 5165.075729818192,\n \"direction\": \"TIDY_DIRECTION_AUTO\",\n \"spacing_mode\": \"TIDY_SPACING_MODE_UNSPECIFIED\",\n \"preserve_order\": false,\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d4a71e80-1f94-4573-b7da-71037eb9aea4", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "tidy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frame_ids\": [\n \"cED36Ccf-2AD8-b73C-0bbA-f13fdaaBFf74\",\n \"30A9dFdA-7eeA-e67E-b338-F7ad7fC086Aa\"\n ],\n \"fixed_spacing\": 5165.075729818192,\n \"direction\": \"TIDY_DIRECTION_AUTO\",\n \"spacing_mode\": \"TIDY_SPACING_MODE_UNSPECIFIED\",\n \"preserve_order\": false,\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "688d2646-c408-43a6-8158-d96b8bffff3c", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "tidy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frame_ids\": [\n \"cED36Ccf-2AD8-b73C-0bbA-f13fdaaBFf74\",\n \"30A9dFdA-7eeA-e67E-b338-F7ad7fC086Aa\"\n ],\n \"fixed_spacing\": 5165.075729818192,\n \"direction\": \"TIDY_DIRECTION_AUTO\",\n \"spacing_mode\": \"TIDY_SPACING_MODE_UNSPECIFIED\",\n \"preserve_order\": false,\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "214bcecd-c2fe-4049-8c63-57e91d5df151", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "tidy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frame_ids\": [\n \"cED36Ccf-2AD8-b73C-0bbA-f13fdaaBFf74\",\n \"30A9dFdA-7eeA-e67E-b338-F7ad7fC086Aa\"\n ],\n \"fixed_spacing\": 5165.075729818192,\n \"direction\": \"TIDY_DIRECTION_AUTO\",\n \"spacing_mode\": \"TIDY_SPACING_MODE_UNSPECIFIED\",\n \"preserve_order\": false,\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf21085f-ce06-47a7-baf5-c27d70d3c627", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "tidy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frame_ids\": [\n \"cED36Ccf-2AD8-b73C-0bbA-f13fdaaBFf74\",\n \"30A9dFdA-7eeA-e67E-b338-F7ad7fC086Aa\"\n ],\n \"fixed_spacing\": 5165.075729818192,\n \"direction\": \"TIDY_DIRECTION_AUTO\",\n \"spacing_mode\": \"TIDY_SPACING_MODE_UNSPECIFIED\",\n \"preserve_order\": false,\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "789b4ea2-f59f-4954-941b-aca80319c443", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "tidy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frame_ids\": [\n \"cED36Ccf-2AD8-b73C-0bbA-f13fdaaBFf74\",\n \"30A9dFdA-7eeA-e67E-b338-F7ad7fC086Aa\"\n ],\n \"fixed_spacing\": 5165.075729818192,\n \"direction\": \"TIDY_DIRECTION_AUTO\",\n \"spacing_mode\": \"TIDY_SPACING_MODE_UNSPECIFIED\",\n \"preserve_order\": false,\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d18fa9b-b5ba-4349-8c47-a3a9069d092c", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "tidy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frame_ids\": [\n \"cED36Ccf-2AD8-b73C-0bbA-f13fdaaBFf74\",\n \"30A9dFdA-7eeA-e67E-b338-F7ad7fC086Aa\"\n ],\n \"fixed_spacing\": 5165.075729818192,\n \"direction\": \"TIDY_DIRECTION_AUTO\",\n \"spacing_mode\": \"TIDY_SPACING_MODE_UNSPECIFIED\",\n \"preserve_order\": false,\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "edd2a0ea-cdac-4025-ab8c-9de5275944f1", "name": "Apply tidy grid layout to selected objects using requested spacing and direction policy", "request": { "name": "Apply tidy grid layout to selected objects using requested spacing and direction policy", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "tidy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"objects\": [\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n },\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"fixed_spacing\": 2456.12313668603,\n \"direction\": \"TIDY_DIRECTION_AUTO\",\n \"spacing_mode\": \"TIDY_SPACING_MODE_UNSPECIFIED\",\n \"preserve_order\": false,\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1a495db3-3b2e-4532-a7b5-83e6f7952e0c", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "tidy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"objects\": [\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n },\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"fixed_spacing\": 2456.12313668603,\n \"direction\": \"TIDY_DIRECTION_AUTO\",\n \"spacing_mode\": \"TIDY_SPACING_MODE_UNSPECIFIED\",\n \"preserve_order\": false,\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "944296b9-4c19-4e59-96b5-587c727f5738", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "tidy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"objects\": [\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n },\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"fixed_spacing\": 2456.12313668603,\n \"direction\": \"TIDY_DIRECTION_AUTO\",\n \"spacing_mode\": \"TIDY_SPACING_MODE_UNSPECIFIED\",\n \"preserve_order\": false,\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e882590-5b79-4a36-8e67-bffb76e93ca0", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "tidy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"objects\": [\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n },\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"fixed_spacing\": 2456.12313668603,\n \"direction\": \"TIDY_DIRECTION_AUTO\",\n \"spacing_mode\": \"TIDY_SPACING_MODE_UNSPECIFIED\",\n \"preserve_order\": false,\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8b4dfcd-88ee-45f9-b9b8-864290885076", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "tidy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"objects\": [\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n },\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"fixed_spacing\": 2456.12313668603,\n \"direction\": \"TIDY_DIRECTION_AUTO\",\n \"spacing_mode\": \"TIDY_SPACING_MODE_UNSPECIFIED\",\n \"preserve_order\": false,\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75f55254-d677-4226-9043-7f2c29b4f617", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "tidy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"objects\": [\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n },\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"fixed_spacing\": 2456.12313668603,\n \"direction\": \"TIDY_DIRECTION_AUTO\",\n \"spacing_mode\": \"TIDY_SPACING_MODE_UNSPECIFIED\",\n \"preserve_order\": false,\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c69b1fb-59dc-4f2c-9f4f-66a440c1c677", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "tidy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"objects\": [\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n },\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"fixed_spacing\": 2456.12313668603,\n \"direction\": \"TIDY_DIRECTION_AUTO\",\n \"spacing_mode\": \"TIDY_SPACING_MODE_UNSPECIFIED\",\n \"preserve_order\": false,\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e8a3f89-81b7-4ee6-a1fc-043958b699b1", "name": "Check whether a source frame can be placed relative to a target frame without violating constraints", "request": { "name": "Check whether a source frame can be placed relative to a target frame without violating constraints", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "anchoring_query", "value": "string", "description": "(Required) `anchoring_query` — JSON-encoded GetFramePlacementFeasibility request: source_frame_id, target_frame_id, relation, optional constraint. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "6b1b4cca-379f-48ad-a263-4ddc45b68c9f", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36004ad0-2f53-4692-aa0b-19ca529e2b21", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3f39f50-910e-46c8-9440-1f28ae36ca7b", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f60ffced-0429-47a1-a963-66e7b5f591d3", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f679258-9364-42b7-b5d3-505c5f56a4d9", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10630f72-8812-42d7-b6a7-e8b02c38c92f", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b47251e4-42e4-4848-8b9a-b389906a4d2e", "name": "Align selected frames using a requested alignment mode and optional target bounds", "request": { "name": "Align selected frames using a requested alignment mode and optional target bounds", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "align" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"frame_ids\": [\n \"9B1EDc76-Ab63-13eE-FEB6-DDFf8c4AC39F\",\n \"344cFE30-39Fd-f3FF-2CBD-FdAB1Af1C49d\"\n ],\n \"mode\": \"ALIGN_BOTTOM_EDGE\",\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "efcf768d-3ca0-4d48-8717-589337e72410", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "align" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frame_ids\": [\n \"9B1EDc76-Ab63-13eE-FEB6-DDFf8c4AC39F\",\n \"344cFE30-39Fd-f3FF-2CBD-FdAB1Af1C49d\"\n ],\n \"mode\": \"ALIGN_BOTTOM_EDGE\",\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a9c441f-3c90-4d08-af92-d5ea3deb499c", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "align" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frame_ids\": [\n \"9B1EDc76-Ab63-13eE-FEB6-DDFf8c4AC39F\",\n \"344cFE30-39Fd-f3FF-2CBD-FdAB1Af1C49d\"\n ],\n \"mode\": \"ALIGN_BOTTOM_EDGE\",\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecd9a06b-db08-4b58-afd1-440f6d65d18a", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "align" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frame_ids\": [\n \"9B1EDc76-Ab63-13eE-FEB6-DDFf8c4AC39F\",\n \"344cFE30-39Fd-f3FF-2CBD-FdAB1Af1C49d\"\n ],\n \"mode\": \"ALIGN_BOTTOM_EDGE\",\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af8b740d-2588-45b5-9817-c3e41dfe3929", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "align" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frame_ids\": [\n \"9B1EDc76-Ab63-13eE-FEB6-DDFf8c4AC39F\",\n \"344cFE30-39Fd-f3FF-2CBD-FdAB1Af1C49d\"\n ],\n \"mode\": \"ALIGN_BOTTOM_EDGE\",\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d4a820a-52d5-43cc-8b93-6d0a91c049a2", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "align" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frame_ids\": [\n \"9B1EDc76-Ab63-13eE-FEB6-DDFf8c4AC39F\",\n \"344cFE30-39Fd-f3FF-2CBD-FdAB1Af1C49d\"\n ],\n \"mode\": \"ALIGN_BOTTOM_EDGE\",\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a57aea9c-4d8a-4a2f-93f7-5982e5b04c17", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "align" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"frame_ids\": [\n \"9B1EDc76-Ab63-13eE-FEB6-DDFf8c4AC39F\",\n \"344cFE30-39Fd-f3FF-2CBD-FdAB1Af1C49d\"\n ],\n \"mode\": \"ALIGN_BOTTOM_EDGE\",\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d807396-889d-4e95-84b2-7d61848ad6b0", "name": "Move a source object relative to a target object using an anchor relation and optional placement constraints", "request": { "name": "Move a source object relative to a target object using an anchor relation and optional placement constraints", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"source_object\": {\n \"zone_id\": \"57B523F8-64E1-aCAa-fEce-FBfefb7cAfAf\",\n \"object_id\": \"0fAF19Ff-EA42-4fe8-DedC-1ab5C6EFcf98\",\n \"frame_id\": \"2Aec0da8-adE1-e18C-68a7-ae5c8b65B5cE\"\n },\n \"target_object\": {\n \"zone_id\": \"fFF0DeeC-347e-F0f4-DcDb-9aFf8bD0923c\",\n \"object_id\": \"06B6D78f-6D4e-bE0D-42b8-A2cEd3Cc0C78\",\n \"frame_id\": \"2ACA4315-Eb39-0d28-A292-255fE6D97Cab\"\n },\n \"relation\": \"ANCHOR_RELATION_TOP\",\n \"constraint\": {\n \"keep_inside_container\": false,\n \"avoid_overlap\": true,\n \"cross_axis_alignment\": \"CENTER\",\n \"gap\": 8839.10175407587,\n \"snap_to_grid\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ca852145-66f4-4d9d-be74-9cd6f472b734", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"source_object\": {\n \"zone_id\": \"57B523F8-64E1-aCAa-fEce-FBfefb7cAfAf\",\n \"object_id\": \"0fAF19Ff-EA42-4fe8-DedC-1ab5C6EFcf98\",\n \"frame_id\": \"2Aec0da8-adE1-e18C-68a7-ae5c8b65B5cE\"\n },\n \"target_object\": {\n \"zone_id\": \"fFF0DeeC-347e-F0f4-DcDb-9aFf8bD0923c\",\n \"object_id\": \"06B6D78f-6D4e-bE0D-42b8-A2cEd3Cc0C78\",\n \"frame_id\": \"2ACA4315-Eb39-0d28-A292-255fE6D97Cab\"\n },\n \"relation\": \"ANCHOR_RELATION_TOP\",\n \"constraint\": {\n \"keep_inside_container\": false,\n \"avoid_overlap\": true,\n \"cross_axis_alignment\": \"CENTER\",\n \"gap\": 8839.10175407587,\n \"snap_to_grid\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76968687-c38b-4a48-814d-74e577d646fd", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"source_object\": {\n \"zone_id\": \"57B523F8-64E1-aCAa-fEce-FBfefb7cAfAf\",\n \"object_id\": \"0fAF19Ff-EA42-4fe8-DedC-1ab5C6EFcf98\",\n \"frame_id\": \"2Aec0da8-adE1-e18C-68a7-ae5c8b65B5cE\"\n },\n \"target_object\": {\n \"zone_id\": \"fFF0DeeC-347e-F0f4-DcDb-9aFf8bD0923c\",\n \"object_id\": \"06B6D78f-6D4e-bE0D-42b8-A2cEd3Cc0C78\",\n \"frame_id\": \"2ACA4315-Eb39-0d28-A292-255fE6D97Cab\"\n },\n \"relation\": \"ANCHOR_RELATION_TOP\",\n \"constraint\": {\n \"keep_inside_container\": false,\n \"avoid_overlap\": true,\n \"cross_axis_alignment\": \"CENTER\",\n \"gap\": 8839.10175407587,\n \"snap_to_grid\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "add31597-ea1c-4973-b2f4-8b70507186b9", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"source_object\": {\n \"zone_id\": \"57B523F8-64E1-aCAa-fEce-FBfefb7cAfAf\",\n \"object_id\": \"0fAF19Ff-EA42-4fe8-DedC-1ab5C6EFcf98\",\n \"frame_id\": \"2Aec0da8-adE1-e18C-68a7-ae5c8b65B5cE\"\n },\n \"target_object\": {\n \"zone_id\": \"fFF0DeeC-347e-F0f4-DcDb-9aFf8bD0923c\",\n \"object_id\": \"06B6D78f-6D4e-bE0D-42b8-A2cEd3Cc0C78\",\n \"frame_id\": \"2ACA4315-Eb39-0d28-A292-255fE6D97Cab\"\n },\n \"relation\": \"ANCHOR_RELATION_TOP\",\n \"constraint\": {\n \"keep_inside_container\": false,\n \"avoid_overlap\": true,\n \"cross_axis_alignment\": \"CENTER\",\n \"gap\": 8839.10175407587,\n \"snap_to_grid\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3791796-e27a-4299-890f-ac76c563b276", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"source_object\": {\n \"zone_id\": \"57B523F8-64E1-aCAa-fEce-FBfefb7cAfAf\",\n \"object_id\": \"0fAF19Ff-EA42-4fe8-DedC-1ab5C6EFcf98\",\n \"frame_id\": \"2Aec0da8-adE1-e18C-68a7-ae5c8b65B5cE\"\n },\n \"target_object\": {\n \"zone_id\": \"fFF0DeeC-347e-F0f4-DcDb-9aFf8bD0923c\",\n \"object_id\": \"06B6D78f-6D4e-bE0D-42b8-A2cEd3Cc0C78\",\n \"frame_id\": \"2ACA4315-Eb39-0d28-A292-255fE6D97Cab\"\n },\n \"relation\": \"ANCHOR_RELATION_TOP\",\n \"constraint\": {\n \"keep_inside_container\": false,\n \"avoid_overlap\": true,\n \"cross_axis_alignment\": \"CENTER\",\n \"gap\": 8839.10175407587,\n \"snap_to_grid\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdcbc418-9515-4af9-ab34-d9f31290904c", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"source_object\": {\n \"zone_id\": \"57B523F8-64E1-aCAa-fEce-FBfefb7cAfAf\",\n \"object_id\": \"0fAF19Ff-EA42-4fe8-DedC-1ab5C6EFcf98\",\n \"frame_id\": \"2Aec0da8-adE1-e18C-68a7-ae5c8b65B5cE\"\n },\n \"target_object\": {\n \"zone_id\": \"fFF0DeeC-347e-F0f4-DcDb-9aFf8bD0923c\",\n \"object_id\": \"06B6D78f-6D4e-bE0D-42b8-A2cEd3Cc0C78\",\n \"frame_id\": \"2ACA4315-Eb39-0d28-A292-255fE6D97Cab\"\n },\n \"relation\": \"ANCHOR_RELATION_TOP\",\n \"constraint\": {\n \"keep_inside_container\": false,\n \"avoid_overlap\": true,\n \"cross_axis_alignment\": \"CENTER\",\n \"gap\": 8839.10175407587,\n \"snap_to_grid\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dffedfba-38e8-4262-9cfb-dc8775f24bb8", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"source_object\": {\n \"zone_id\": \"57B523F8-64E1-aCAa-fEce-FBfefb7cAfAf\",\n \"object_id\": \"0fAF19Ff-EA42-4fe8-DedC-1ab5C6EFcf98\",\n \"frame_id\": \"2Aec0da8-adE1-e18C-68a7-ae5c8b65B5cE\"\n },\n \"target_object\": {\n \"zone_id\": \"fFF0DeeC-347e-F0f4-DcDb-9aFf8bD0923c\",\n \"object_id\": \"06B6D78f-6D4e-bE0D-42b8-A2cEd3Cc0C78\",\n \"frame_id\": \"2ACA4315-Eb39-0d28-A292-255fE6D97Cab\"\n },\n \"relation\": \"ANCHOR_RELATION_TOP\",\n \"constraint\": {\n \"keep_inside_container\": false,\n \"avoid_overlap\": true,\n \"cross_axis_alignment\": \"CENTER\",\n \"gap\": 8839.10175407587,\n \"snap_to_grid\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94c31bbe-030f-4912-850c-48c0c44829ae", "name": "Check whether selected objects already satisfy a requested alignment mode and optional target bounds", "request": { "name": "Check whether selected objects already satisfy a requested alignment mode and optional target bounds", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "alignment-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "anchoring_query", "value": "string", "description": "(Required) `anchoring_query` — JSON-encoded GetObjectAlignmentStatus request: objects, mode, optional target. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "bcf612b6-2847-4a6a-8358-f37d92dd7626", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "alignment-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dd4c976-0264-47cb-99e9-09e5949971a0", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "alignment-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f464787e-315c-4697-bfae-53d94a387471", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "alignment-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d739771-08f6-4a84-afed-7b1a9325d5a5", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "alignment-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "200da37c-2dc6-49cc-9666-ee0f36fa588c", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "alignment-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e86cee2d-9a13-433c-8b74-ff3040dcbb45", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "alignment-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a28064b-e6c4-4512-b918-f9ab73c62fb7", "name": "Preview the tidy grid layout for selected objects without applying it", "request": { "name": "Preview the tidy grid layout for selected objects without applying it", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "tidy-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "anchoring_query", "value": "string", "description": "(Required) `anchoring_query` — JSON-encoded GetObjectTidyFeasibility request: objects, optional direction/spacing/target. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "5ec34e32-ba3e-43dd-bd06-4cd2cbc4155c", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "tidy-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b287183-2e11-4f6c-a1b6-1e348f120210", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "tidy-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20c17010-6aac-4d98-a4a7-9e0808b7e451", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "tidy-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e64ec702-885b-4f00-ac11-0226b256581e", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "tidy-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "619b96fb-484e-4b28-b8ea-d9d44e781421", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "tidy-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60e568eb-0750-4e82-bba8-f7cebede81c6", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "tidy-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4c2fb7d-f733-431b-bf96-ea0ab8fa7dfc", "name": "Move a source frame relative to a target frame using an anchor relation and optional placement constraints", "request": { "name": "Move a source frame relative to a target frame using an anchor relation and optional placement constraints", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"source_frame_id\": \"BF381Ae2-EC7D-FAAa-Fc96-04360496c7D9\",\n \"target_frame_id\": \"d03d5a3F-702b-54Bc-3f2e-D3D5D7FcF0Ce\",\n \"relation\": \"ANCHOR_RELATION_BOTTOM\",\n \"constraint\": {\n \"keep_inside_container\": false,\n \"avoid_overlap\": true,\n \"cross_axis_alignment\": \"CENTER\",\n \"gap\": 6727.185882498427,\n \"snap_to_grid\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e3268956-c585-4efe-a0c8-3dea8a20e171", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"source_frame_id\": \"BF381Ae2-EC7D-FAAa-Fc96-04360496c7D9\",\n \"target_frame_id\": \"d03d5a3F-702b-54Bc-3f2e-D3D5D7FcF0Ce\",\n \"relation\": \"ANCHOR_RELATION_BOTTOM\",\n \"constraint\": {\n \"keep_inside_container\": false,\n \"avoid_overlap\": true,\n \"cross_axis_alignment\": \"CENTER\",\n \"gap\": 6727.185882498427,\n \"snap_to_grid\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b0693e1-39fc-4388-bc0f-10bc7437b5f1", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"source_frame_id\": \"BF381Ae2-EC7D-FAAa-Fc96-04360496c7D9\",\n \"target_frame_id\": \"d03d5a3F-702b-54Bc-3f2e-D3D5D7FcF0Ce\",\n \"relation\": \"ANCHOR_RELATION_BOTTOM\",\n \"constraint\": {\n \"keep_inside_container\": false,\n \"avoid_overlap\": true,\n \"cross_axis_alignment\": \"CENTER\",\n \"gap\": 6727.185882498427,\n \"snap_to_grid\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "205f5005-4334-45d0-b66f-76a44fec663b", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"source_frame_id\": \"BF381Ae2-EC7D-FAAa-Fc96-04360496c7D9\",\n \"target_frame_id\": \"d03d5a3F-702b-54Bc-3f2e-D3D5D7FcF0Ce\",\n \"relation\": \"ANCHOR_RELATION_BOTTOM\",\n \"constraint\": {\n \"keep_inside_container\": false,\n \"avoid_overlap\": true,\n \"cross_axis_alignment\": \"CENTER\",\n \"gap\": 6727.185882498427,\n \"snap_to_grid\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f36ad13-64ad-47f5-a0d2-54b539310356", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"source_frame_id\": \"BF381Ae2-EC7D-FAAa-Fc96-04360496c7D9\",\n \"target_frame_id\": \"d03d5a3F-702b-54Bc-3f2e-D3D5D7FcF0Ce\",\n \"relation\": \"ANCHOR_RELATION_BOTTOM\",\n \"constraint\": {\n \"keep_inside_container\": false,\n \"avoid_overlap\": true,\n \"cross_axis_alignment\": \"CENTER\",\n \"gap\": 6727.185882498427,\n \"snap_to_grid\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b38cc401-cf86-48fa-bc09-590a16d69ab5", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"source_frame_id\": \"BF381Ae2-EC7D-FAAa-Fc96-04360496c7D9\",\n \"target_frame_id\": \"d03d5a3F-702b-54Bc-3f2e-D3D5D7FcF0Ce\",\n \"relation\": \"ANCHOR_RELATION_BOTTOM\",\n \"constraint\": {\n \"keep_inside_container\": false,\n \"avoid_overlap\": true,\n \"cross_axis_alignment\": \"CENTER\",\n \"gap\": 6727.185882498427,\n \"snap_to_grid\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16c428d0-f8fd-41dc-b335-56a4ecadb359", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"source_frame_id\": \"BF381Ae2-EC7D-FAAa-Fc96-04360496c7D9\",\n \"target_frame_id\": \"d03d5a3F-702b-54Bc-3f2e-D3D5D7FcF0Ce\",\n \"relation\": \"ANCHOR_RELATION_BOTTOM\",\n \"constraint\": {\n \"keep_inside_container\": false,\n \"avoid_overlap\": true,\n \"cross_axis_alignment\": \"CENTER\",\n \"gap\": 6727.185882498427,\n \"snap_to_grid\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06d13c2a-a3dc-4001-a66d-931e6f540bf9", "name": "Align selected objects using a requested alignment mode and optional target bounds", "request": { "name": "Align selected objects using a requested alignment mode and optional target bounds", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "align" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"objects\": [\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n },\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"mode\": \"DISTRIBUTE_HORIZONTAL\",\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6496e7a4-d5ce-4ffe-955e-e9573b7e010f", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "align" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"objects\": [\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n },\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"mode\": \"DISTRIBUTE_HORIZONTAL\",\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f68480b-34d0-41ae-bd4a-ec72725a146f", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "align" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"objects\": [\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n },\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"mode\": \"DISTRIBUTE_HORIZONTAL\",\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7519f062-795b-46f3-95ae-955d4905c5f1", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "align" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"objects\": [\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n },\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"mode\": \"DISTRIBUTE_HORIZONTAL\",\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "255f7259-db83-4de3-9c6c-0d91475cd8a8", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "align" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"objects\": [\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n },\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"mode\": \"DISTRIBUTE_HORIZONTAL\",\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61cd058f-5881-4e87-a8ad-9f023daee198", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "align" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"objects\": [\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n },\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"mode\": \"DISTRIBUTE_HORIZONTAL\",\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bae714c2-1311-47f9-b84a-0fc89b3be07f", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "align" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"objects\": [\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n },\n {\n \"zone_id\": {\n \"value\": \"\"\n },\n \"object_id\": {\n \"value\": \"\"\n },\n \"frame_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"mode\": \"DISTRIBUTE_HORIZONTAL\",\n \"target\": {\n \"reference\": \"WITHIN_SELECTION\",\n \"target_bounds\": {\n \"x\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"y\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30f3f59a-31ec-46a1-9420-b773a4810fe8", "name": "Preview the tidy grid layout for selected frames without applying it", "request": { "name": "Preview the tidy grid layout for selected frames without applying it", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "tidy-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "anchoring_query", "value": "string", "description": "(Required) `anchoring_query` — JSON-encoded GetFrameTidyFeasibility request: frame_ids, optional direction/spacing/target. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "9fdbe69a-7a16-40c7-a0a8-66957247cfd1", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "tidy-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "268fa801-a215-43a5-b4ce-984ca892ef49", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "tidy-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6582efd-041b-4a8d-8268-f67a998ed18e", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "tidy-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10e79e97-e7e1-4a52-8d94-f1a8acc6f7cd", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "tidy-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83eedacb-99f8-45aa-b5ac-185e19f52e27", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "tidy-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60a8a991-1fab-4505-82da-fd38e95727be", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "frames", "tidy-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94010628-a36b-4cd9-abb9-5dcdff0fa163", "name": "Check whether a source object can be placed relative to a target object without violating overlap or constraint rules", "request": { "name": "Check whether a source object can be placed relative to a target object without violating overlap or constraint rules", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "anchoring_query", "value": "string", "description": "(Required) `anchoring_query` — JSON-encoded GetObjectPlacementFeasibility request: source_object, target_object, relation, optional constraint. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "072bf2fa-09ae-4964-b4fb-f40aa311dee1", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b7e1cba-2df3-4aa4-be98-364b95547bfe", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a3c5dd9-b4fe-42db-af87-9cdcc156b760", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd3f64da-cd57-4140-b9e9-8b41d1e5f9ee", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23d4005a-787e-47eb-9838-38c097de411e", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccaa6e74-e6ce-44f2-bdd5-08413ceae8cb", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "anchoring", "objects", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "anchoring_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "46cf8357-597b-452d-b947-6a6f5e301136", "name": "Spatial Search", "description": { "content": "Query occupied and empty regions, clearances, and ranked placement candidates.", "type": "text/plain" }, "item": [ { "id": "6799f611-f54e-49b0-aa7f-444cb0a4e3a1", "name": "Get ranked placement candidates for several objects in one call", "request": { "name": "Get ranked placement candidates for several objects in one call", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "suggest-placement", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"object_type\": {\n \"value\": \"\"\n },\n \"near_object\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"fgh\",\n \"PyPZVx\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d92170f1-6a25-4cbe-83bd-e84ca98f99a4", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "suggest-placement", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"object_type\": {\n \"value\": \"\"\n },\n \"near_object\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"fgh\",\n \"PyPZVx\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bef23061-ab5a-403b-849a-28a3955e06d7", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "suggest-placement", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"object_type\": {\n \"value\": \"\"\n },\n \"near_object\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"fgh\",\n \"PyPZVx\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86b4368f-a32b-4289-ace6-2b35c397ceab", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "suggest-placement", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"object_type\": {\n \"value\": \"\"\n },\n \"near_object\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"fgh\",\n \"PyPZVx\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4f116d0-7f57-488b-889d-f7137747db3f", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "suggest-placement", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"object_type\": {\n \"value\": \"\"\n },\n \"near_object\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"fgh\",\n \"PyPZVx\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac972b36-78ef-49b8-81c6-795e26dd6b23", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "suggest-placement", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"object_type\": {\n \"value\": \"\"\n },\n \"near_object\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"fgh\",\n \"PyPZVx\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8104dcb9-ead0-4c7f-8c17-a0c7ca3598df", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "suggest-placement", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"object_type\": {\n \"value\": \"\"\n },\n \"near_object\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"fgh\",\n \"PyPZVx\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d24ade3-6d64-4cd3-ba9c-18f8278d5eec", "name": "Check whether a footprint fits within a scope without overlapping", "request": { "name": "Check whether a footprint fits within a scope without overlapping", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "spatial_query", "value": "string", "description": "(Required) `spatial_query` — JSON-encoded GetPlacementFeasibility request: required_width, required_height, optional scope/padding/object_type/near_object. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "9983ad70-991d-49db-bd11-5ab0cbd5b5f0", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0852fbe-c7bd-4907-a94f-a2403fb466be", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d23e91d7-d4cc-4d50-bee6-f4b8f93c3492", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a43c899-93a8-4142-8f9f-ea688432e7f8", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b335f4a-e22c-4a68-8d36-592e45b5762d", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6800e51e-0e94-4225-97e6-bc8800c004a6", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "placement-feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e8cbc784-d233-4344-bead-400ba6ca8087", "name": "Get ranked placement candidates for a new object", "request": { "name": "Get ranked placement candidates for a new object", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "suggest-placement" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "spatial_query", "value": "string", "description": "(Required) `spatial_query` — JSON-encoded SuggestPlacement request: required_width, required_height, optional scope/padding/object_type/near_object/max_results. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "fc664507-b1e8-4296-a3cf-4be60f52e086", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "suggest-placement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f78a81f9-5da5-4f6b-9327-804c36b6155d", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "suggest-placement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3738e7c-d497-4f3b-b065-6fc2a044656a", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "suggest-placement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee22d0fd-f1e0-4390-84ab-b28e1f1fd29b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "suggest-placement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bcb26ae-286f-4266-a5b5-781766a27a9f", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "suggest-placement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68d9cc5e-3b9c-4ef2-9c83-edac137da026", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "suggest-placement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5649276f-c891-4d68-834a-5650e40ce64d", "name": "Get ranked empty regions for several footprints in one call", "request": { "name": "Get ranked empty regions for several footprints in one call", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "empty-region", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"qplpmn3en\",\n \"Oa\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "23d11142-b41d-4376-aa7b-87987ad35a4e", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "empty-region", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"qplpmn3en\",\n \"Oa\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5611be4-50bb-4857-983d-1ad2936bc012", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "empty-region", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"qplpmn3en\",\n \"Oa\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "447cb12e-7308-4ceb-95b5-cc62e81d36bc", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "empty-region", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"qplpmn3en\",\n \"Oa\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb616e1c-d662-49c8-8906-82cbd23f8df8", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "empty-region", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"qplpmn3en\",\n \"Oa\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8c733b5-134d-428b-ba30-1c2ba6ac1cda", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "empty-region", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"qplpmn3en\",\n \"Oa\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "558ae288-874f-4ada-82e3-45c325261265", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "empty-region", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"qplpmn3en\",\n \"Oa\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4119b7b-e101-4ea7-84a2-4cab5b14d867", "name": "Get the objects within a spatial scope or region", "request": { "name": "Get the objects within a spatial scope or region", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "objects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "spatial_query", "value": "string", "description": "(Required) `spatial_query` — JSON-encoded GetObjects request: optional scope, object_types, visibility flags, max_results. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "d5a90ee4-a18e-432f-869e-27c26c97ec3c", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "objects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc855cf6-4e40-4bdc-990d-20eb860728e2", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "objects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb145d55-dde5-46c5-a1a3-5bab7816c5e8", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "objects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b238c25-e877-4af5-8e2d-ba1bdb5fcaac", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "objects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4eab6772-6da8-405e-8c58-f8bfa16e43d9", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "objects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "431c9f15-1964-4815-8396-526ce816182c", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "objects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7869b4ff-6adb-4eae-aec2-9aff6a559691", "name": "Get union bounding boxes for several scopes in one call", "request": { "name": "Get union bounding boxes for several scopes in one call", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "occupied-bounds", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"object_types\": {\n \"value\": \"\"\n },\n \"include_hidden\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"include_locked\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"Xs2mi7h\",\n \"8Z Z9\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0e163667-2c5f-4797-bb4e-4f15fc3f12b3", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "occupied-bounds", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"object_types\": {\n \"value\": \"\"\n },\n \"include_hidden\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"include_locked\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"Xs2mi7h\",\n \"8Z Z9\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42c981bb-3223-43b9-ae33-373acdb5b82b", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "occupied-bounds", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"object_types\": {\n \"value\": \"\"\n },\n \"include_hidden\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"include_locked\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"Xs2mi7h\",\n \"8Z Z9\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b47f4ecd-3baa-4090-8907-f1b391cbd2ec", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "occupied-bounds", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"object_types\": {\n \"value\": \"\"\n },\n \"include_hidden\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"include_locked\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"Xs2mi7h\",\n \"8Z Z9\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df693280-1d88-469d-bbb5-05d3586a5ce6", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "occupied-bounds", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"object_types\": {\n \"value\": \"\"\n },\n \"include_hidden\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"include_locked\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"Xs2mi7h\",\n \"8Z Z9\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "087678ae-8496-4ff6-8a6c-0b613440251f", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "occupied-bounds", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"object_types\": {\n \"value\": \"\"\n },\n \"include_hidden\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"include_locked\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"Xs2mi7h\",\n \"8Z Z9\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85a3bff6-dd0a-4898-9e5a-c3f460bf970a", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "occupied-bounds", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"object_types\": {\n \"value\": \"\"\n },\n \"include_hidden\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"include_locked\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"Xs2mi7h\",\n \"8Z Z9\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b4b101fc-15fa-494a-ab82-4065e0beb4b9", "name": "Get ranked empty regions that fit a requested footprint", "request": { "name": "Get ranked empty regions that fit a requested footprint", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "empty-region" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "spatial_query", "value": "string", "description": "(Required) `spatial_query` — JSON-encoded FindEmptyRegion request: required_width, required_height, optional scope/padding/max_results. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "dc394a78-7734-4823-81a7-1c81a39ee225", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "empty-region" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a35f238-1d63-4908-b2c6-42c6c2d47af2", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "empty-region" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d896ff56-049b-4148-b2c4-cb7e68cc4dcd", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "empty-region" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10c84991-c86b-46af-ae14-e12933dabe26", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "empty-region" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4a6a715-4c8d-4d47-bd95-1ed883811034", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "empty-region" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dec1bcc-cf25-478e-81cf-ec1a5924005b", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "empty-region" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94120968-69b6-4ce6-9b76-36c59e1e31b4", "name": "Get the union bounding box of all objects in a scope", "request": { "name": "Get the union bounding box of all objects in a scope", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "occupied-bounds" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "spatial_query", "value": "string", "description": "(Required) `spatial_query` — JSON-encoded GetOccupiedBounds request: optional scope, object_types, visibility flags. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "f0c9839f-9840-4f26-a765-a018e5c0dfbc", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "occupied-bounds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a85b72cf-6d4c-427a-bd7e-7638ff201e41", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "occupied-bounds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e03e4560-37f8-4914-95fc-bbff18cdec41", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "occupied-bounds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f9a5b29-1630-4440-9ca3-cea9bbcb8b3e", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "occupied-bounds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bae0f40-9363-4fcd-992d-0182a2f0793c", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "occupied-bounds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a817c73e-a673-491b-b888-c34b73924c49", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "occupied-bounds" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "28f9ad26-0bbf-4bb7-bc1a-5eda7a0f72ae", "name": "Get the directional gap distances around an object", "request": { "name": "Get the directional gap distances around an object", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "clearance" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "spatial_query", "value": "string", "description": "(Required) `spatial_query` — JSON-encoded GetClearanceAroundObject request: object, optional computation scope and blocker filters. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "159239af-6b22-493c-8113-ec7eaf4ae878", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "clearance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0ddafe8-decb-4650-a95b-62b62647610f", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "clearance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fda4be2-a493-4f45-8367-3f31574483ec", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "clearance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f76c27ba-88bf-485d-b071-963d2739e9ab", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "clearance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e63e567-e6cc-4203-b986-05f3349f091d", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "clearance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d781176b-03dc-4e45-b4a8-38aec6b7aa51", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "clearance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spatial_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c8e3252-de28-4b8a-94b8-25da1dc4db12", "name": "Run several object queries in one call", "request": { "name": "Run several object queries in one call", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "objects", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"object_types\": {\n \"value\": \"\"\n },\n \"include_hidden\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n },\n \"include_locked\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"OdaYh\",\n \"NLen7iGmyY\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9753a4ed-1b6c-4510-bf7a-fa5362e6a49b", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "objects", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"object_types\": {\n \"value\": \"\"\n },\n \"include_hidden\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n },\n \"include_locked\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"OdaYh\",\n \"NLen7iGmyY\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa3d9564-eedf-4789-9f8f-b681900034dc", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "objects", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"object_types\": {\n \"value\": \"\"\n },\n \"include_hidden\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n },\n \"include_locked\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"OdaYh\",\n \"NLen7iGmyY\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3681a05-2ad0-4ca9-97da-6606771f5929", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "objects", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"object_types\": {\n \"value\": \"\"\n },\n \"include_hidden\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n },\n \"include_locked\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"OdaYh\",\n \"NLen7iGmyY\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ebd2412-c006-42be-88fa-e1cdcc6f3342", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "objects", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"object_types\": {\n \"value\": \"\"\n },\n \"include_hidden\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n },\n \"include_locked\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"OdaYh\",\n \"NLen7iGmyY\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "016853ed-1449-446e-84d5-180848f3d7c3", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "objects", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"object_types\": {\n \"value\": \"\"\n },\n \"include_hidden\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n },\n \"include_locked\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"OdaYh\",\n \"NLen7iGmyY\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f287754-c631-40db-80b7-da4e5443a758", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "objects", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"object_types\": {\n \"value\": \"\"\n },\n \"include_hidden\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n },\n \"max_results\": {\n \"value\": \"\"\n },\n \"include_locked\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"OdaYh\",\n \"NLen7iGmyY\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e20d31b0-afed-4732-8fac-a6d6a6e19b29", "name": "Check several footprints for fit in one call", "request": { "name": "Check several footprints for fit in one call", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "placement-feasibility", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"object_type\": {\n \"value\": \"\"\n },\n \"near_object\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"XJ\",\n \"6EDXw\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f8f8b6cc-9b9f-438f-9ba9-25385dd63504", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "placement-feasibility", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"object_type\": {\n \"value\": \"\"\n },\n \"near_object\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"XJ\",\n \"6EDXw\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e11b626-0e69-4e8c-975a-18ba120be94a", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "placement-feasibility", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"object_type\": {\n \"value\": \"\"\n },\n \"near_object\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"XJ\",\n \"6EDXw\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e335905-3df0-4bb1-a32e-04a06f75d112", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "placement-feasibility", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"object_type\": {\n \"value\": \"\"\n },\n \"near_object\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"XJ\",\n \"6EDXw\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edeed80f-4526-41e0-98e2-320ffe3b0798", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "placement-feasibility", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"object_type\": {\n \"value\": \"\"\n },\n \"near_object\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"XJ\",\n \"6EDXw\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "657a677c-9d47-40fd-a7f5-1f250111d1d0", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "placement-feasibility", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"object_type\": {\n \"value\": \"\"\n },\n \"near_object\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"XJ\",\n \"6EDXw\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb3b9bd8-14a9-4335-8587-0ea69806d929", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "spatial-search", "placement-feasibility", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requests\": [\n {\n \"required_width\": {\n \"value\": \"\"\n },\n \"required_height\": {\n \"value\": \"\"\n },\n \"padding\": {\n \"value\": \"\"\n },\n \"object_type\": {\n \"value\": \"\"\n },\n \"near_object\": {\n \"value\": \"\"\n },\n \"scope\": {\n \"value\": \"\"\n }\n }\n ],\n \"request_item_ids\": [\n \"XJ\",\n \"6EDXw\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4dcf817a-6902-4dda-b0f7-bcac197e823c", "name": "Connections", "description": { "content": "Create, re-route, and feasibility-check connectors between objects.", "type": "text/plain" }, "item": [ { "id": "78857832-101b-4111-a9f8-72fa5836cf59", "name": "Move one end of an existing connection to another object", "request": { "name": "Move one end of an existing connection to another object", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "reconnect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"context\": {\n \"zone_id\": \"a1Bd21e9-accB-f09f-CA11-5d44878b07b9\",\n \"validate_only\": false,\n \"actor_id\": \"aAafec05-8ACE-Dd09-c64b-06b0F23EA91e\",\n \"base_revision_id\": \" _HiH4bnWEw\",\n \"request_id\": \"0sv2Gc\"\n },\n \"connection_object\": {\n \"zone_id\": \"a089Fffe-CC45-FdEf-a82A-FaF08aAdcFad\",\n \"object_id\": \"C1FB5675-28Ba-D527-f398-9daCBEDCCeBf\",\n \"frame_id\": \"FEbfd9e6-EC86-CbdD-DC3A-ACAEc1d3c0Bd\"\n },\n \"current_object\": {\n \"zone_id\": \"DBD4f95c-91C5-24BA-4f45-50c7f22Ef3Fd\",\n \"object_id\": \"37D1eb38-dFBe-7Dc2-b6D6-7251F0d765ef\",\n \"frame_id\": \"fdE4bF2A-4937-f2d3-1153-fAbECbB6Fc5b\"\n },\n \"new_object\": {\n \"zone_id\": \"BaaF0a32-ad50-422B-2a1a-8191FD3eEc3b\",\n \"object_id\": \"71C3f024-E8AE-6DFC-eDb6-f60Bb2dF2EBb\",\n \"frame_id\": \"e4dc0dd3-E7c0-E0af-9C69-89Eade02D3e3\"\n },\n \"payload\": {\n \"new_side\": \"EAST\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dfa20b0f-135c-40b4-a009-677ec9874e2e", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "reconnect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"context\": {\n \"zone_id\": \"a1Bd21e9-accB-f09f-CA11-5d44878b07b9\",\n \"validate_only\": false,\n \"actor_id\": \"aAafec05-8ACE-Dd09-c64b-06b0F23EA91e\",\n \"base_revision_id\": \" _HiH4bnWEw\",\n \"request_id\": \"0sv2Gc\"\n },\n \"connection_object\": {\n \"zone_id\": \"a089Fffe-CC45-FdEf-a82A-FaF08aAdcFad\",\n \"object_id\": \"C1FB5675-28Ba-D527-f398-9daCBEDCCeBf\",\n \"frame_id\": \"FEbfd9e6-EC86-CbdD-DC3A-ACAEc1d3c0Bd\"\n },\n \"current_object\": {\n \"zone_id\": \"DBD4f95c-91C5-24BA-4f45-50c7f22Ef3Fd\",\n \"object_id\": \"37D1eb38-dFBe-7Dc2-b6D6-7251F0d765ef\",\n \"frame_id\": \"fdE4bF2A-4937-f2d3-1153-fAbECbB6Fc5b\"\n },\n \"new_object\": {\n \"zone_id\": \"BaaF0a32-ad50-422B-2a1a-8191FD3eEc3b\",\n \"object_id\": \"71C3f024-E8AE-6DFC-eDb6-f60Bb2dF2EBb\",\n \"frame_id\": \"e4dc0dd3-E7c0-E0af-9C69-89Eade02D3e3\"\n },\n \"payload\": {\n \"new_side\": \"EAST\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11bdd167-7101-4405-94cf-494dfc6efee0", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "reconnect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"context\": {\n \"zone_id\": \"a1Bd21e9-accB-f09f-CA11-5d44878b07b9\",\n \"validate_only\": false,\n \"actor_id\": \"aAafec05-8ACE-Dd09-c64b-06b0F23EA91e\",\n \"base_revision_id\": \" _HiH4bnWEw\",\n \"request_id\": \"0sv2Gc\"\n },\n \"connection_object\": {\n \"zone_id\": \"a089Fffe-CC45-FdEf-a82A-FaF08aAdcFad\",\n \"object_id\": \"C1FB5675-28Ba-D527-f398-9daCBEDCCeBf\",\n \"frame_id\": \"FEbfd9e6-EC86-CbdD-DC3A-ACAEc1d3c0Bd\"\n },\n \"current_object\": {\n \"zone_id\": \"DBD4f95c-91C5-24BA-4f45-50c7f22Ef3Fd\",\n \"object_id\": \"37D1eb38-dFBe-7Dc2-b6D6-7251F0d765ef\",\n \"frame_id\": \"fdE4bF2A-4937-f2d3-1153-fAbECbB6Fc5b\"\n },\n \"new_object\": {\n \"zone_id\": \"BaaF0a32-ad50-422B-2a1a-8191FD3eEc3b\",\n \"object_id\": \"71C3f024-E8AE-6DFC-eDb6-f60Bb2dF2EBb\",\n \"frame_id\": \"e4dc0dd3-E7c0-E0af-9C69-89Eade02D3e3\"\n },\n \"payload\": {\n \"new_side\": \"EAST\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5602d01d-244f-48ac-8c7b-6cdc60950881", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "reconnect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"context\": {\n \"zone_id\": \"a1Bd21e9-accB-f09f-CA11-5d44878b07b9\",\n \"validate_only\": false,\n \"actor_id\": \"aAafec05-8ACE-Dd09-c64b-06b0F23EA91e\",\n \"base_revision_id\": \" _HiH4bnWEw\",\n \"request_id\": \"0sv2Gc\"\n },\n \"connection_object\": {\n \"zone_id\": \"a089Fffe-CC45-FdEf-a82A-FaF08aAdcFad\",\n \"object_id\": \"C1FB5675-28Ba-D527-f398-9daCBEDCCeBf\",\n \"frame_id\": \"FEbfd9e6-EC86-CbdD-DC3A-ACAEc1d3c0Bd\"\n },\n \"current_object\": {\n \"zone_id\": \"DBD4f95c-91C5-24BA-4f45-50c7f22Ef3Fd\",\n \"object_id\": \"37D1eb38-dFBe-7Dc2-b6D6-7251F0d765ef\",\n \"frame_id\": \"fdE4bF2A-4937-f2d3-1153-fAbECbB6Fc5b\"\n },\n \"new_object\": {\n \"zone_id\": \"BaaF0a32-ad50-422B-2a1a-8191FD3eEc3b\",\n \"object_id\": \"71C3f024-E8AE-6DFC-eDb6-f60Bb2dF2EBb\",\n \"frame_id\": \"e4dc0dd3-E7c0-E0af-9C69-89Eade02D3e3\"\n },\n \"payload\": {\n \"new_side\": \"EAST\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad8006c1-de60-41e9-9239-8e0abaf76f28", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "reconnect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"context\": {\n \"zone_id\": \"a1Bd21e9-accB-f09f-CA11-5d44878b07b9\",\n \"validate_only\": false,\n \"actor_id\": \"aAafec05-8ACE-Dd09-c64b-06b0F23EA91e\",\n \"base_revision_id\": \" _HiH4bnWEw\",\n \"request_id\": \"0sv2Gc\"\n },\n \"connection_object\": {\n \"zone_id\": \"a089Fffe-CC45-FdEf-a82A-FaF08aAdcFad\",\n \"object_id\": \"C1FB5675-28Ba-D527-f398-9daCBEDCCeBf\",\n \"frame_id\": \"FEbfd9e6-EC86-CbdD-DC3A-ACAEc1d3c0Bd\"\n },\n \"current_object\": {\n \"zone_id\": \"DBD4f95c-91C5-24BA-4f45-50c7f22Ef3Fd\",\n \"object_id\": \"37D1eb38-dFBe-7Dc2-b6D6-7251F0d765ef\",\n \"frame_id\": \"fdE4bF2A-4937-f2d3-1153-fAbECbB6Fc5b\"\n },\n \"new_object\": {\n \"zone_id\": \"BaaF0a32-ad50-422B-2a1a-8191FD3eEc3b\",\n \"object_id\": \"71C3f024-E8AE-6DFC-eDb6-f60Bb2dF2EBb\",\n \"frame_id\": \"e4dc0dd3-E7c0-E0af-9C69-89Eade02D3e3\"\n },\n \"payload\": {\n \"new_side\": \"EAST\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22788bf8-85d5-4c5c-9fba-c601a0a4e5f8", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "reconnect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"context\": {\n \"zone_id\": \"a1Bd21e9-accB-f09f-CA11-5d44878b07b9\",\n \"validate_only\": false,\n \"actor_id\": \"aAafec05-8ACE-Dd09-c64b-06b0F23EA91e\",\n \"base_revision_id\": \" _HiH4bnWEw\",\n \"request_id\": \"0sv2Gc\"\n },\n \"connection_object\": {\n \"zone_id\": \"a089Fffe-CC45-FdEf-a82A-FaF08aAdcFad\",\n \"object_id\": \"C1FB5675-28Ba-D527-f398-9daCBEDCCeBf\",\n \"frame_id\": \"FEbfd9e6-EC86-CbdD-DC3A-ACAEc1d3c0Bd\"\n },\n \"current_object\": {\n \"zone_id\": \"DBD4f95c-91C5-24BA-4f45-50c7f22Ef3Fd\",\n \"object_id\": \"37D1eb38-dFBe-7Dc2-b6D6-7251F0d765ef\",\n \"frame_id\": \"fdE4bF2A-4937-f2d3-1153-fAbECbB6Fc5b\"\n },\n \"new_object\": {\n \"zone_id\": \"BaaF0a32-ad50-422B-2a1a-8191FD3eEc3b\",\n \"object_id\": \"71C3f024-E8AE-6DFC-eDb6-f60Bb2dF2EBb\",\n \"frame_id\": \"e4dc0dd3-E7c0-E0af-9C69-89Eade02D3e3\"\n },\n \"payload\": {\n \"new_side\": \"EAST\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a1dcea5-7fc8-4cd8-b48d-541fb4d8bdc7", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "reconnect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"context\": {\n \"zone_id\": \"a1Bd21e9-accB-f09f-CA11-5d44878b07b9\",\n \"validate_only\": false,\n \"actor_id\": \"aAafec05-8ACE-Dd09-c64b-06b0F23EA91e\",\n \"base_revision_id\": \" _HiH4bnWEw\",\n \"request_id\": \"0sv2Gc\"\n },\n \"connection_object\": {\n \"zone_id\": \"a089Fffe-CC45-FdEf-a82A-FaF08aAdcFad\",\n \"object_id\": \"C1FB5675-28Ba-D527-f398-9daCBEDCCeBf\",\n \"frame_id\": \"FEbfd9e6-EC86-CbdD-DC3A-ACAEc1d3c0Bd\"\n },\n \"current_object\": {\n \"zone_id\": \"DBD4f95c-91C5-24BA-4f45-50c7f22Ef3Fd\",\n \"object_id\": \"37D1eb38-dFBe-7Dc2-b6D6-7251F0d765ef\",\n \"frame_id\": \"fdE4bF2A-4937-f2d3-1153-fAbECbB6Fc5b\"\n },\n \"new_object\": {\n \"zone_id\": \"BaaF0a32-ad50-422B-2a1a-8191FD3eEc3b\",\n \"object_id\": \"71C3f024-E8AE-6DFC-eDb6-f60Bb2dF2EBb\",\n \"frame_id\": \"e4dc0dd3-E7c0-E0af-9C69-89Eade02D3e3\"\n },\n \"payload\": {\n \"new_side\": \"EAST\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e6a4dc6d-8c2d-4aba-b6e9-048f4aa745c1", "name": "Check whether a connection between two objects is feasible", "request": { "name": "Check whether a connection between two objects is feasible", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "connection_query", "value": "string", "description": "(Required) `connection_query` — JSON-encoded GetConnectionFeasibility request: source_object, target_object, optional payload (connector_type, source_side, target_side). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "a561dd5f-a142-4080-993f-eea624c66432", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "connection_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dea66d58-b2ea-4974-9b21-4cd81348fa95", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "connection_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0244f940-720b-43b2-91d3-4f8c2cfc6f5e", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "connection_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f24647dd-682f-4c78-9e30-79a1676aa580", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "connection_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c90d011a-7cc9-4ca9-a4ef-379f41f577e6", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "connection_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a723fc6a-9af4-4c51-9b27-fd69dfac6f7c", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "connection_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88f559d8-8f20-44e3-af77-1da277fea523", "name": "Create a connection between two objects in a zone", "request": { "name": "Create a connection between two objects in a zone", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"context\": {\n \"zone_id\": \"3AAd14C9-9eb0-F5eD-Af14-ca933240BDD1\",\n \"validate_only\": true,\n \"actor_id\": \"7396\",\n \"base_revision_id\": \"Q\",\n \"request_id\": \"g_\"\n },\n \"source_object\": {\n \"zone_id\": \"60f0D111-6d3d-1C5a-6Cd8-8c1D9Ef5262B\",\n \"object_id\": \"f0DDaC18-7d51-eFA7-CcB6-76FAEAc1CAa9\",\n \"frame_id\": \"7aD9cFB6-45d7-c7F5-c59D-25FD0BB8aDAd\"\n },\n \"target_object\": {\n \"zone_id\": \"3fB1E6e6-4c5f-1139-dd6a-bbB0C4F9FfFf\",\n \"object_id\": \"8CbdaBEF-Fa57-ccB9-FdbF-BA3aa7a7f0AD\",\n \"frame_id\": \"3Ee108aA-A7ed-7BCF-E8dd-Aca853273d63\"\n },\n \"payload\": {\n \"connector_type\": \"LINE\",\n \"target_side\": \"EAST\",\n \"source_side\": \"SOUTH\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e5e71496-e471-4c30-a2fc-fcd7350643ab", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"context\": {\n \"zone_id\": \"3AAd14C9-9eb0-F5eD-Af14-ca933240BDD1\",\n \"validate_only\": true,\n \"actor_id\": \"7396\",\n \"base_revision_id\": \"Q\",\n \"request_id\": \"g_\"\n },\n \"source_object\": {\n \"zone_id\": \"60f0D111-6d3d-1C5a-6Cd8-8c1D9Ef5262B\",\n \"object_id\": \"f0DDaC18-7d51-eFA7-CcB6-76FAEAc1CAa9\",\n \"frame_id\": \"7aD9cFB6-45d7-c7F5-c59D-25FD0BB8aDAd\"\n },\n \"target_object\": {\n \"zone_id\": \"3fB1E6e6-4c5f-1139-dd6a-bbB0C4F9FfFf\",\n \"object_id\": \"8CbdaBEF-Fa57-ccB9-FdbF-BA3aa7a7f0AD\",\n \"frame_id\": \"3Ee108aA-A7ed-7BCF-E8dd-Aca853273d63\"\n },\n \"payload\": {\n \"connector_type\": \"LINE\",\n \"target_side\": \"EAST\",\n \"source_side\": \"SOUTH\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aca4f4b3-a1d4-434a-84be-50db768b9dea", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"context\": {\n \"zone_id\": \"3AAd14C9-9eb0-F5eD-Af14-ca933240BDD1\",\n \"validate_only\": true,\n \"actor_id\": \"7396\",\n \"base_revision_id\": \"Q\",\n \"request_id\": \"g_\"\n },\n \"source_object\": {\n \"zone_id\": \"60f0D111-6d3d-1C5a-6Cd8-8c1D9Ef5262B\",\n \"object_id\": \"f0DDaC18-7d51-eFA7-CcB6-76FAEAc1CAa9\",\n \"frame_id\": \"7aD9cFB6-45d7-c7F5-c59D-25FD0BB8aDAd\"\n },\n \"target_object\": {\n \"zone_id\": \"3fB1E6e6-4c5f-1139-dd6a-bbB0C4F9FfFf\",\n \"object_id\": \"8CbdaBEF-Fa57-ccB9-FdbF-BA3aa7a7f0AD\",\n \"frame_id\": \"3Ee108aA-A7ed-7BCF-E8dd-Aca853273d63\"\n },\n \"payload\": {\n \"connector_type\": \"LINE\",\n \"target_side\": \"EAST\",\n \"source_side\": \"SOUTH\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3134449-0518-4c07-a05b-f8fa37475c0f", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"context\": {\n \"zone_id\": \"3AAd14C9-9eb0-F5eD-Af14-ca933240BDD1\",\n \"validate_only\": true,\n \"actor_id\": \"7396\",\n \"base_revision_id\": \"Q\",\n \"request_id\": \"g_\"\n },\n \"source_object\": {\n \"zone_id\": \"60f0D111-6d3d-1C5a-6Cd8-8c1D9Ef5262B\",\n \"object_id\": \"f0DDaC18-7d51-eFA7-CcB6-76FAEAc1CAa9\",\n \"frame_id\": \"7aD9cFB6-45d7-c7F5-c59D-25FD0BB8aDAd\"\n },\n \"target_object\": {\n \"zone_id\": \"3fB1E6e6-4c5f-1139-dd6a-bbB0C4F9FfFf\",\n \"object_id\": \"8CbdaBEF-Fa57-ccB9-FdbF-BA3aa7a7f0AD\",\n \"frame_id\": \"3Ee108aA-A7ed-7BCF-E8dd-Aca853273d63\"\n },\n \"payload\": {\n \"connector_type\": \"LINE\",\n \"target_side\": \"EAST\",\n \"source_side\": \"SOUTH\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c21bd01b-dace-453b-9c27-44e57673b280", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"context\": {\n \"zone_id\": \"3AAd14C9-9eb0-F5eD-Af14-ca933240BDD1\",\n \"validate_only\": true,\n \"actor_id\": \"7396\",\n \"base_revision_id\": \"Q\",\n \"request_id\": \"g_\"\n },\n \"source_object\": {\n \"zone_id\": \"60f0D111-6d3d-1C5a-6Cd8-8c1D9Ef5262B\",\n \"object_id\": \"f0DDaC18-7d51-eFA7-CcB6-76FAEAc1CAa9\",\n \"frame_id\": \"7aD9cFB6-45d7-c7F5-c59D-25FD0BB8aDAd\"\n },\n \"target_object\": {\n \"zone_id\": \"3fB1E6e6-4c5f-1139-dd6a-bbB0C4F9FfFf\",\n \"object_id\": \"8CbdaBEF-Fa57-ccB9-FdbF-BA3aa7a7f0AD\",\n \"frame_id\": \"3Ee108aA-A7ed-7BCF-E8dd-Aca853273d63\"\n },\n \"payload\": {\n \"connector_type\": \"LINE\",\n \"target_side\": \"EAST\",\n \"source_side\": \"SOUTH\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84fb51dd-d369-4597-835b-9e5278aff8db", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"context\": {\n \"zone_id\": \"3AAd14C9-9eb0-F5eD-Af14-ca933240BDD1\",\n \"validate_only\": true,\n \"actor_id\": \"7396\",\n \"base_revision_id\": \"Q\",\n \"request_id\": \"g_\"\n },\n \"source_object\": {\n \"zone_id\": \"60f0D111-6d3d-1C5a-6Cd8-8c1D9Ef5262B\",\n \"object_id\": \"f0DDaC18-7d51-eFA7-CcB6-76FAEAc1CAa9\",\n \"frame_id\": \"7aD9cFB6-45d7-c7F5-c59D-25FD0BB8aDAd\"\n },\n \"target_object\": {\n \"zone_id\": \"3fB1E6e6-4c5f-1139-dd6a-bbB0C4F9FfFf\",\n \"object_id\": \"8CbdaBEF-Fa57-ccB9-FdbF-BA3aa7a7f0AD\",\n \"frame_id\": \"3Ee108aA-A7ed-7BCF-E8dd-Aca853273d63\"\n },\n \"payload\": {\n \"connector_type\": \"LINE\",\n \"target_side\": \"EAST\",\n \"source_side\": \"SOUTH\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba5aaf93-a5b3-48cc-a9b0-1db261da34d0", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "connections", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"context\": {\n \"zone_id\": \"3AAd14C9-9eb0-F5eD-Af14-ca933240BDD1\",\n \"validate_only\": true,\n \"actor_id\": \"7396\",\n \"base_revision_id\": \"Q\",\n \"request_id\": \"g_\"\n },\n \"source_object\": {\n \"zone_id\": \"60f0D111-6d3d-1C5a-6Cd8-8c1D9Ef5262B\",\n \"object_id\": \"f0DDaC18-7d51-eFA7-CcB6-76FAEAc1CAa9\",\n \"frame_id\": \"7aD9cFB6-45d7-c7F5-c59D-25FD0BB8aDAd\"\n },\n \"target_object\": {\n \"zone_id\": \"3fB1E6e6-4c5f-1139-dd6a-bbB0C4F9FfFf\",\n \"object_id\": \"8CbdaBEF-Fa57-ccB9-FdbF-BA3aa7a7f0AD\",\n \"frame_id\": \"3Ee108aA-A7ed-7BCF-E8dd-Aca853273d63\"\n },\n \"payload\": {\n \"connector_type\": \"LINE\",\n \"target_side\": \"EAST\",\n \"source_side\": \"SOUTH\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b06a12c9-4662-4555-9bf7-1183213015a1", "name": "Relationships", "description": { "content": "Resolve parents, children, ancestors, descendants, and connected objects.", "type": "text/plain" }, "item": [ { "id": "56c6534e-5c85-4725-b6b2-45c52d23127d", "name": "Find related objects using deterministic relation filters and optional semantic hint", "request": { "name": "Find related objects using deterministic relation filters and optional semantic hint", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "relationship_query", "value": "string", "description": "(Required) `relationship_query` — JSON-encoded FindRelatedObjects request: anchor, optional scope, relation_types, relation_context, relation_query, max_depth, max_results. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "8ab7ed51-14f8-4ad5-ad53-5846ce4a94f7", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae429aeb-8d89-487a-891c-eb5102b20196", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3770eb2-82ee-4af5-8570-a69cf64d08a8", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "246be4bd-3ad2-430f-a626-731e8d65a9e0", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b64d59e-c6ef-4bbe-b043-530e34aa0b50", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4df41705-bb38-43ef-b38d-886515186ce9", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee20fbdc-d96a-4574-aed2-cfc832dad06c", "name": "Get hierarchical descendants of a container via BFS traversal", "request": { "name": "Get hierarchical descendants of a container via BFS traversal", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "descendants" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "relationship_query", "value": "string", "description": "(Required) `relationship_query` — JSON-encoded GetObjectDescendants request: object, optional object_types, optional payload (max_depth, max_results, flat_selection | path_selection). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "39538668-ff99-4d35-af8b-e0d27d97df51", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "descendants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "294cac27-3dd6-48a7-9788-0bfbe62fa88e", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "descendants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5fb3d1e-194d-42e2-b6df-b2313b5d7136", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "descendants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cdd791b-bd61-4ed2-a7d0-608221459192", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "descendants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0606452-42f7-448d-bc40-5b9f34339910", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "descendants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4962cc21-156d-45b9-8cec-aa56b665be6e", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "descendants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7867d418-1843-4751-9cc2-7cd39da03e33", "name": "Get ancestor chain for an object in the zone hierarchy", "request": { "name": "Get ancestor chain for an object in the zone hierarchy", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "ancestors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "relationship_query", "value": "string", "description": "(Required) `relationship_query` — JSON-encoded GetObjectAncestors request: object, optional max_levels. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "48af0a2f-4d58-4b75-8736-9666888c11c3", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "ancestors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6642497a-7714-4385-aba8-4542ac1291ea", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "ancestors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8c84643-c2c5-45fc-945d-12ef4f287ab5", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "ancestors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "718071b8-a27e-4cf1-bdd2-95b26730c471", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "ancestors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55d8c59e-8411-4f9c-a80c-f5b8809869ea", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "ancestors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef8e803e-e3c4-4a8e-a570-c4ec7a67ac95", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "ancestors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc5f73cf-902e-458b-98d7-3f3f87ea06ae", "name": "List the immediate child objects of one container (frame, group or zone root), optionally filtered by object type and windowed by range or index set. One level only - use getRelationshipDescendants for the deeper subtree.", "request": { "name": "List the immediate child objects of one container (frame, group or zone root), optionally filtered by object type and windowed by range or index set. One level only - use getRelationshipDescendants for the deeper subtree.", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "relationship_query", "value": "string", "description": "(Required) `relationship_query` — JSON-encoded GetObjectChildren request: object, optional object_types, optional payload (all | range | index_set, max_results). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "e866b803-2c34-4ff6-9035-34482ea81fe7", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16dc71f6-59d0-44ec-8723-c4d37f10e294", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09066682-a8ce-4690-b324-0861b3673941", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "118bc146-0f22-4d9c-880f-8642195a9ee4", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32e8462f-d0e0-466c-9fe1-9c14d46435e5", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a50ed7e-d050-4347-92ce-d47a54ff7d71", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "children" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "72d1fae3-4c71-4135-839c-92907202662b", "name": "Get objects connected to anchor through connector graph traversal", "request": { "name": "Get objects connected to anchor through connector graph traversal", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "connected" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "relationship_query", "value": "string", "description": "(Required) `relationship_query` — JSON-encoded GetConnectedObjects request: anchor, optional scope (container root), optional payload (direction, max_depth, max_results). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "24ebf016-cb47-4137-a69d-2adb58b13541", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "connected" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8132a79c-fdc2-4850-b8d4-5bb49a185c2e", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "connected" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65c8c846-d557-4162-98b6-54caa17d79b1", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "connected" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14202d9d-7d97-4ed2-a527-4d106382c830", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "connected" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f8cc2e6-9ba2-4cf1-8776-6ff151d980f5", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "connected" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9fb168c-7376-447f-b41a-c66b2dbc8241", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "connected" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "22af892b-8c2c-421d-af2d-7b5a73c32506", "name": "Get direct parent of an object in the zone hierarchy", "request": { "name": "Get direct parent of an object in the zone hierarchy", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "parents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "relationship_query", "value": "string", "description": "(Required) `relationship_query` — JSON-encoded GetObjectParents request: object. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "daa5f373-6b9b-42c4-8baf-0a8d832590f0", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "parents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "830b6c98-6fc2-4427-a629-11c32d260bdb", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "parents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fecd6ec3-7b35-4259-8078-8b80f0456ae8", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "parents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e9d41f8-3f4a-4ad6-acac-76f72c7eef50", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "parents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3685bb21-f3e6-4917-81a1-44c0694f8c59", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "parents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bae6ed2-1d20-4ffc-896c-ad94cf318825", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "parents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cfeaa8cd-1455-4c98-acb3-d267fba93670", "name": "Get deterministic relation evidence between two objects", "request": { "name": "Get deterministic relation evidence between two objects", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "relationship_query", "value": "string", "description": "(Required) `relationship_query` — JSON-encoded GetRelationEvidence request: source_object, target_object, optional relation_types and relation_context. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "d9804a45-458e-450e-90dc-77d349b5fe22", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b94ca13-298b-4d97-a58b-1bfeac419cf6", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de9fd927-9fa1-4714-81be-5a7d638e26e4", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a80213c7-5f32-4078-9b73-fcf55ac81d7f", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "827fbdad-7c32-42e5-af40-8ccbc6ec2b18", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebd7f7e1-44e6-4044-be77-dcc135dd455a", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "relationships", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "relationship_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "970168b8-0030-4a33-af3d-11ca9e28f63b", "name": "Traversal", "description": { "content": "Walk the zone in index, sequence, and windowed order.", "type": "text/plain" }, "item": [ { "id": "f19446e4-3f4a-4b60-a042-ff26fa3c64f1", "name": "Get hierarchical index path of an object within the zone traversal order", "request": { "name": "Get hierarchical index path of an object within the zone traversal order", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "index" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "traversal_query", "value": "string", "description": "(Required) `traversal_query` — JSON-encoded GetTraversalIndex request: object, optional traversal_scope, optional payload (filter). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "63ca341b-5f34-4925-8c6b-2dc42e9a8df3", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "index" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad14e959-36e6-4f55-b1b0-d77e3b9344f0", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "index" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbffecb8-0ced-4403-a727-3e022bd47187", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "index" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03256934-3da2-451e-aeca-2d41b9172a29", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "index" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bb6a6c0-b92c-4b59-a6fe-73d1121eb68c", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "index" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da1aaa37-56fc-4757-aa11-873dd62f77d3", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "index" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "857489e3-8fa3-4011-b6c5-240d9b24d9b5", "name": "Get ordered traversal neighbors from an anchor point in the zone", "request": { "name": "Get ordered traversal neighbors from an anchor point in the zone", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "sequence" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "traversal_query", "value": "string", "description": "(Required) `traversal_query` — JSON-encoded GetTraversalSequence request: anchor, optional traversal_scope, optional payload (direction, filter, max_results, wrap). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "52e89ca2-a19f-44a5-ae96-0c10442405ff", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "sequence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fb15c64-7b07-4c2f-8fab-402376760f0b", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "sequence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30885685-a3bb-4d9c-8fe9-73f08d64162b", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "sequence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b67ff2f5-714d-4fd5-94cb-7bf431630fb7", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "sequence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9531306-44d1-408b-9f2b-1296392d012f", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "sequence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f6eb8ee-6270-4a7c-a387-de7cc540058c", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "sequence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4a8c6560-1f96-452a-bf6e-87b89d029f5a", "name": "Get before/after context window around an anchor object in the zone", "request": { "name": "Get before/after context window around an anchor object in the zone", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "window" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "traversal_query", "value": "string", "description": "(Required) `traversal_query` — JSON-encoded GetTraversalWindow request: anchor, optional traversal_scope, optional payload (filter, before_count, after_count, wrap). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "1cb44546-13c0-499a-9eca-c9b70893ddf8", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "window" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14778d36-489f-4995-8c0b-ae142bd41cde", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "window" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74b34683-9226-400f-a832-8d75d63ff5b1", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "window" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d6112f4-3e7d-433c-9758-3d0a57722d1b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "window" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b07e4f3-f08c-49eb-92c9-2e70d9ff40cc", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "window" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0b260f0-c741-4454-8670-6dbb431a42cd", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "traversal", "window" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "traversal_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9ea32151-4313-41cb-9d58-6d79bde1d2b0", "name": "Visual Navigation", "description": { "content": "Find adjacent elements, geometric distances, and visual ordering.", "type": "text/plain" }, "item": [ { "id": "1d47e66e-4120-4cd2-8257-cdf099c0f2b0", "name": "Get the elements adjacent to an anchor, with distance and direction", "request": { "name": "Get the elements adjacent to an anchor, with distance and direction", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "adjacent-elements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "nav_query", "value": "string", "description": "(Required) `nav_query` — JSON-encoded GetObjectsAround request: anchor, optional payload and scope. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "2649321d-965a-4738-bd82-ec6bbf1da579", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "adjacent-elements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8a2b980-d14f-40f4-b26b-b7be87d2aa8b", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "adjacent-elements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11271c73-1105-4dd0-87d2-ff58c0e46025", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "adjacent-elements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23c5e9eb-88d9-429a-9b69-787ab9bf609b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "adjacent-elements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "671857b5-ad42-4007-9ec7-cff99ad0664c", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "adjacent-elements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d786a8b7-a46f-4405-ae3a-8312952f6c50", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "adjacent-elements" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "399cfdf4-d9a0-4707-9483-6c479267ce4a", "name": "Get the geometric distance between two objects", "request": { "name": "Get the geometric distance between two objects", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "distance" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "nav_query", "value": "string", "description": "(Required) `nav_query` — JSON-encoded GetDistanceBetweenObjects request: source_object, target_object. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "b8ff3544-397a-4b47-be9f-75ed02c78cc3", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "distance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66890c62-5527-4112-9d3c-eb3d824ea94e", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "distance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e77f0d69-d4b5-4632-b983-4d6cb051bf23", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "distance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9aa3cfaf-e6e2-458c-8b6d-06827279d1c5", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "distance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4332b62d-18f7-4184-bf6a-99ead0c7610f", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "distance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dba1496-9efd-40a9-b1ca-7b2c6370c074", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "distance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "abae258a-3c03-4bb3-b413-096c786c6c9e", "name": "Get the visually ordered neighbours of an anchor object", "request": { "name": "Get the visually ordered neighbours of an anchor object", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "sequence" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "nav_query", "value": "string", "description": "(Required) `nav_query` — JSON-encoded GetVisualSequence request: anchor, payload (direction/filter/limits), optional scope. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "aff936a6-831e-4b53-a640-cd44679a059e", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "sequence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aef13f0c-b518-45e7-86cc-403349d6ea36", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "sequence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4912cb32-8aa3-4f37-a5c8-a6e5971f7b65", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "sequence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8027be1-ef6f-46d2-87fe-604880d30c7b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "sequence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01de9134-11f3-435f-bd0c-e1e2f4545354", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "sequence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a2d688a-dcbe-4e1a-8c7e-a0c24c0c3638", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "visual-navigation", "sequence" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "nav_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f42e11f3-058a-4d33-9358-cf95631549df", "name": "Tables", "description": { "content": "Insert and delete table rows and columns, merge cells, and read cell text.", "type": "text/plain" }, "item": [ { "id": "5ffac7da-e635-40c4-a674-806ac736d1b4", "name": "Get paragraph text for a table cell by paragraph index range", "request": { "name": "Get paragraph text for a table cell by paragraph index range", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "paragraphtext" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "table_query", "value": "string", "description": "(Required) `table_query` — JSON-encoded GetCellParagraphText request: table, cell, payload.text.range. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "4008b68f-1c56-418b-a75d-cafa46fd4604", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "paragraphtext" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ea7d2bc-c6ad-44b4-a012-501e778fd01c", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "paragraphtext" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "338a4fe6-43be-43ec-a495-c3c46e222e8b", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "paragraphtext" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b912c968-aaaf-4b1b-acb9-2de3cf176a83", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "paragraphtext" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f88914f-b65b-4203-b9a6-e50846bc4a40", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "paragraphtext" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0069eaa1-87c8-4738-b17f-46e99adacf29", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "paragraphtext" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "800c2e2a-087a-4290-87f3-babaaee7bf69", "name": "Report a table object's current dimensions as a row count and a column count. Call it first to bound row and column indexes before reading, editing, inserting or deleting.", "request": { "name": "Report a table object's current dimensions as a row count and a column count. Call it first to bound row and column indexes before reading, editing, inserting or deleting.", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "size" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "table_query", "value": "string", "description": "(Required) `table_query` — JSON-encoded GetTableSize request: table. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "b17d29e6-78a7-4f14-860e-d77fca9ebc8d", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "size" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "863ec8bc-94af-4330-b68a-d1c1f7b1cc0d", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "size" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35a345fc-e807-45b0-a93b-89a8152c69e4", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "size" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ccee255-1faa-4a18-901a-65f3c02e8037", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "size" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90977fbe-02fb-499c-ab32-2d65e59c205e", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "size" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b5788d2-82d0-4d8e-9ed1-683b1682b068", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "size" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ec7bc26-72dd-4632-8104-9c2987978a4b", "name": "Merge a rectangular block of table cells into a single cell, given start and end row and column indexes. Reverse it with unmergeTableCells.", "request": { "name": "Merge a rectangular block of table cells into a single cell, given start and end row and column indexes. Reverse it with unmergeTableCells.", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cells", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"e9eacB32-cB0d-Fb1c-6fAf-eeDdb7Dc61aF\",\n \"zone_id\": \"A42fFD7d-234D-545e-BFE1-03ABd46cb358\",\n \"frame_id\": \"98a3e499-51Aa-D77a-96Da-4DcB1630Bdee\"\n },\n \"payload\": {\n \"range\": {\n \"start_row_index\": {\n \"value\": \"\"\n },\n \"end_row_index\": {\n \"value\": \"\"\n },\n \"start_column_index\": {\n \"value\": \"\"\n },\n \"end_column_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a0f8802d-5f51-4915-9525-4c133edd2f7e", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cells", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"e9eacB32-cB0d-Fb1c-6fAf-eeDdb7Dc61aF\",\n \"zone_id\": \"A42fFD7d-234D-545e-BFE1-03ABd46cb358\",\n \"frame_id\": \"98a3e499-51Aa-D77a-96Da-4DcB1630Bdee\"\n },\n \"payload\": {\n \"range\": {\n \"start_row_index\": {\n \"value\": \"\"\n },\n \"end_row_index\": {\n \"value\": \"\"\n },\n \"start_column_index\": {\n \"value\": \"\"\n },\n \"end_column_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59342216-98a4-4031-a9a5-5a9c14b9a5b0", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cells", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"e9eacB32-cB0d-Fb1c-6fAf-eeDdb7Dc61aF\",\n \"zone_id\": \"A42fFD7d-234D-545e-BFE1-03ABd46cb358\",\n \"frame_id\": \"98a3e499-51Aa-D77a-96Da-4DcB1630Bdee\"\n },\n \"payload\": {\n \"range\": {\n \"start_row_index\": {\n \"value\": \"\"\n },\n \"end_row_index\": {\n \"value\": \"\"\n },\n \"start_column_index\": {\n \"value\": \"\"\n },\n \"end_column_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ebb6811-a38c-4c29-b77e-36a031d21180", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cells", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"e9eacB32-cB0d-Fb1c-6fAf-eeDdb7Dc61aF\",\n \"zone_id\": \"A42fFD7d-234D-545e-BFE1-03ABd46cb358\",\n \"frame_id\": \"98a3e499-51Aa-D77a-96Da-4DcB1630Bdee\"\n },\n \"payload\": {\n \"range\": {\n \"start_row_index\": {\n \"value\": \"\"\n },\n \"end_row_index\": {\n \"value\": \"\"\n },\n \"start_column_index\": {\n \"value\": \"\"\n },\n \"end_column_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c97c189-d3b1-4411-96d7-a4b3b740e09d", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cells", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"e9eacB32-cB0d-Fb1c-6fAf-eeDdb7Dc61aF\",\n \"zone_id\": \"A42fFD7d-234D-545e-BFE1-03ABd46cb358\",\n \"frame_id\": \"98a3e499-51Aa-D77a-96Da-4DcB1630Bdee\"\n },\n \"payload\": {\n \"range\": {\n \"start_row_index\": {\n \"value\": \"\"\n },\n \"end_row_index\": {\n \"value\": \"\"\n },\n \"start_column_index\": {\n \"value\": \"\"\n },\n \"end_column_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e831fabc-ca97-4c27-9d07-1e5c8ee512ed", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cells", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"e9eacB32-cB0d-Fb1c-6fAf-eeDdb7Dc61aF\",\n \"zone_id\": \"A42fFD7d-234D-545e-BFE1-03ABd46cb358\",\n \"frame_id\": \"98a3e499-51Aa-D77a-96Da-4DcB1630Bdee\"\n },\n \"payload\": {\n \"range\": {\n \"start_row_index\": {\n \"value\": \"\"\n },\n \"end_row_index\": {\n \"value\": \"\"\n },\n \"start_column_index\": {\n \"value\": \"\"\n },\n \"end_column_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1104f50-97c0-4246-847d-30b7661f02be", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cells", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"e9eacB32-cB0d-Fb1c-6fAf-eeDdb7Dc61aF\",\n \"zone_id\": \"A42fFD7d-234D-545e-BFE1-03ABd46cb358\",\n \"frame_id\": \"98a3e499-51Aa-D77a-96Da-4DcB1630Bdee\"\n },\n \"payload\": {\n \"range\": {\n \"start_row_index\": {\n \"value\": \"\"\n },\n \"end_row_index\": {\n \"value\": \"\"\n },\n \"start_column_index\": {\n \"value\": \"\"\n },\n \"end_column_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e65ac521-7126-4d9f-994c-292a13b80147", "name": "Insert rows before or after an anchor row index", "request": { "name": "Insert rows before or after an anchor row index", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "rows", "insert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"744bd807-Ffe4-3775-0f0F-b7Bbe74C1F5E\",\n \"zone_id\": \"a9f4bD9E-692F-3DAe-B983-E0037f4973e1\",\n \"frame_id\": \"D52DF719-0e38-E4dC-102D-41DD9C876fD5\"\n },\n \"payload\": {\n \"anchor_index\": 9024,\n \"count\": 9808,\n \"position\": \"AFTER\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a6a21f61-265d-4e3b-86cd-ed339ed3ee71", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "rows", "insert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"744bd807-Ffe4-3775-0f0F-b7Bbe74C1F5E\",\n \"zone_id\": \"a9f4bD9E-692F-3DAe-B983-E0037f4973e1\",\n \"frame_id\": \"D52DF719-0e38-E4dC-102D-41DD9C876fD5\"\n },\n \"payload\": {\n \"anchor_index\": 9024,\n \"count\": 9808,\n \"position\": \"AFTER\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22a0776d-9065-4013-b0b3-3ae72c1193ce", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "rows", "insert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"744bd807-Ffe4-3775-0f0F-b7Bbe74C1F5E\",\n \"zone_id\": \"a9f4bD9E-692F-3DAe-B983-E0037f4973e1\",\n \"frame_id\": \"D52DF719-0e38-E4dC-102D-41DD9C876fD5\"\n },\n \"payload\": {\n \"anchor_index\": 9024,\n \"count\": 9808,\n \"position\": \"AFTER\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6467a8d6-6d50-4f7d-b47a-522a80efa862", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "rows", "insert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"744bd807-Ffe4-3775-0f0F-b7Bbe74C1F5E\",\n \"zone_id\": \"a9f4bD9E-692F-3DAe-B983-E0037f4973e1\",\n \"frame_id\": \"D52DF719-0e38-E4dC-102D-41DD9C876fD5\"\n },\n \"payload\": {\n \"anchor_index\": 9024,\n \"count\": 9808,\n \"position\": \"AFTER\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "767d5a50-98c2-4d7d-bc7c-4d64503db3a8", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "rows", "insert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"744bd807-Ffe4-3775-0f0F-b7Bbe74C1F5E\",\n \"zone_id\": \"a9f4bD9E-692F-3DAe-B983-E0037f4973e1\",\n \"frame_id\": \"D52DF719-0e38-E4dC-102D-41DD9C876fD5\"\n },\n \"payload\": {\n \"anchor_index\": 9024,\n \"count\": 9808,\n \"position\": \"AFTER\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62bf3ff9-ea30-427a-97da-cb1fb62c4f6e", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "rows", "insert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"744bd807-Ffe4-3775-0f0F-b7Bbe74C1F5E\",\n \"zone_id\": \"a9f4bD9E-692F-3DAe-B983-E0037f4973e1\",\n \"frame_id\": \"D52DF719-0e38-E4dC-102D-41DD9C876fD5\"\n },\n \"payload\": {\n \"anchor_index\": 9024,\n \"count\": 9808,\n \"position\": \"AFTER\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07cb8c83-fe27-4d7d-a44a-76714de7568a", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "rows", "insert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"744bd807-Ffe4-3775-0f0F-b7Bbe74C1F5E\",\n \"zone_id\": \"a9f4bD9E-692F-3DAe-B983-E0037f4973e1\",\n \"frame_id\": \"D52DF719-0e38-E4dC-102D-41DD9C876fD5\"\n },\n \"payload\": {\n \"anchor_index\": 9024,\n \"count\": 9808,\n \"position\": \"AFTER\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2769f1b8-aff1-4eed-9fc3-a37fbe6d0c29", "name": "Report how many paragraphs one table cell's text contains. Use to bound a paragraph index before getTableCellParagraphText.", "request": { "name": "Report how many paragraphs one table cell's text contains. Use to bound a paragraph index before getTableCellParagraphText.", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "paragraphcount" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "table_query", "value": "string", "description": "(Required) `table_query` — JSON-encoded GetCellParagraphCount request: table, cell. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "ee12ca66-fadf-4b4d-a97a-785faaba6890", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "paragraphcount" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7df39001-3da9-4668-b088-bf950c969906", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "paragraphcount" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efa417ea-d26f-4fa1-933f-836db4745957", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "paragraphcount" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3b6f594-107c-4c54-9a3b-45b32ccae535", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "paragraphcount" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a3bbe3e-6bb8-4697-9543-cd48f828eb98", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "paragraphcount" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9ff855d-2999-403d-bf85-7abefda5b663", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "paragraphcount" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "975a45fa-48af-4465-94ae-c37aa1c538bc", "name": "Report the character count of one table cell's text without returning the text itself. Use to bound a character range before reading or mutating that cell.", "request": { "name": "Report the character count of one table cell's text without returning the text itself. Use to bound a character range before reading or mutating that cell.", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "textlength" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "table_query", "value": "string", "description": "(Required) `table_query` — JSON-encoded GetCellTextLength request: table, cell. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "d1495c40-4c6c-4ad6-ad34-6439f114f865", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "textlength" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5c2decf-451c-4ce1-a908-ce0c929f873f", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "textlength" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35cc0f14-e233-4ca1-88ec-d3f610c82b80", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "textlength" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43ec6f2d-7e46-4b3c-9fe9-3eb4eb0ea558", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "textlength" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e30672d-8372-4011-b5d9-9ea74b5f69ad", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "textlength" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98eb8725-f2f3-45f7-bb74-dd7149326e92", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "textlength" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "36aac0f0-51d1-4224-9c87-48bd6eb72616", "name": "Remove a contiguous band of table rows given a half-open row index range (start inclusive, end exclusive). Rows below shift up, so re-read the table size before the next index-based call.", "request": { "name": "Remove a contiguous band of table rows given a half-open row index range (start inclusive, end exclusive). Rows below shift up, so re-read the table size before the next index-based call.", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "rows", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"9fE7Cf55-28C4-AD2D-BC07-c7e1AaBDA0E1\",\n \"zone_id\": \"E6c8E2CD-ACAa-a72E-605c-985e8449DEc7\",\n \"frame_id\": \"d05A6a7A-CF9D-f289-F8f8-C1A3f39A6B20\"\n },\n \"payload\": {\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7420625f-5767-47fa-9ce9-0d48ad351af6", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "rows", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"9fE7Cf55-28C4-AD2D-BC07-c7e1AaBDA0E1\",\n \"zone_id\": \"E6c8E2CD-ACAa-a72E-605c-985e8449DEc7\",\n \"frame_id\": \"d05A6a7A-CF9D-f289-F8f8-C1A3f39A6B20\"\n },\n \"payload\": {\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbbb3321-15c6-45fe-91f1-e6c71b5bc1db", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "rows", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"9fE7Cf55-28C4-AD2D-BC07-c7e1AaBDA0E1\",\n \"zone_id\": \"E6c8E2CD-ACAa-a72E-605c-985e8449DEc7\",\n \"frame_id\": \"d05A6a7A-CF9D-f289-F8f8-C1A3f39A6B20\"\n },\n \"payload\": {\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcb488bf-d1f0-49ca-8476-330418631178", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "rows", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"9fE7Cf55-28C4-AD2D-BC07-c7e1AaBDA0E1\",\n \"zone_id\": \"E6c8E2CD-ACAa-a72E-605c-985e8449DEc7\",\n \"frame_id\": \"d05A6a7A-CF9D-f289-F8f8-C1A3f39A6B20\"\n },\n \"payload\": {\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "402129cd-9d09-4a01-85c4-1641053d24ee", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "rows", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"9fE7Cf55-28C4-AD2D-BC07-c7e1AaBDA0E1\",\n \"zone_id\": \"E6c8E2CD-ACAa-a72E-605c-985e8449DEc7\",\n \"frame_id\": \"d05A6a7A-CF9D-f289-F8f8-C1A3f39A6B20\"\n },\n \"payload\": {\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fd9785b-3680-4f5b-bb3b-f7f851eb4666", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "rows", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"9fE7Cf55-28C4-AD2D-BC07-c7e1AaBDA0E1\",\n \"zone_id\": \"E6c8E2CD-ACAa-a72E-605c-985e8449DEc7\",\n \"frame_id\": \"d05A6a7A-CF9D-f289-F8f8-C1A3f39A6B20\"\n },\n \"payload\": {\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a419fa5-4ecd-414c-9f67-bbe15f39a547", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "rows", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"9fE7Cf55-28C4-AD2D-BC07-c7e1AaBDA0E1\",\n \"zone_id\": \"E6c8E2CD-ACAa-a72E-605c-985e8449DEc7\",\n \"frame_id\": \"d05A6a7A-CF9D-f289-F8f8-C1A3f39A6B20\"\n },\n \"payload\": {\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "93515aab-5164-4e13-8843-d4e9d33440ce", "name": "Apply text mutation (range/cursor/all_text) to a table cell", "request": { "name": "Apply text mutation (range/cursor/all_text) to a table cell", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "edittext" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"CEec6b55-6e8e-e2bB-d08c-e27f915CeDD2\",\n \"zone_id\": \"dc20f72E-dD2b-6931-F3cc-3488e10dCe1C\",\n \"frame_id\": \"490b6c63-edaf-fF9b-DE99-bf0dC3ECbCeA\"\n },\n \"cell\": {\n \"row_index\": 8261,\n \"column_index\": 5241\n },\n \"payload\": {\n \"text\": {\n \"cursor\": {\n \"value\": \"\"\n },\n \"all_text\": {\n \"value\": \"\"\n },\n \"range\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9c928388-a862-4d55-9df0-2a292a11075b", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "edittext" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"CEec6b55-6e8e-e2bB-d08c-e27f915CeDD2\",\n \"zone_id\": \"dc20f72E-dD2b-6931-F3cc-3488e10dCe1C\",\n \"frame_id\": \"490b6c63-edaf-fF9b-DE99-bf0dC3ECbCeA\"\n },\n \"cell\": {\n \"row_index\": 8261,\n \"column_index\": 5241\n },\n \"payload\": {\n \"text\": {\n \"cursor\": {\n \"value\": \"\"\n },\n \"all_text\": {\n \"value\": \"\"\n },\n \"range\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "716137b9-b5ec-436e-821e-40aac924d999", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "edittext" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"CEec6b55-6e8e-e2bB-d08c-e27f915CeDD2\",\n \"zone_id\": \"dc20f72E-dD2b-6931-F3cc-3488e10dCe1C\",\n \"frame_id\": \"490b6c63-edaf-fF9b-DE99-bf0dC3ECbCeA\"\n },\n \"cell\": {\n \"row_index\": 8261,\n \"column_index\": 5241\n },\n \"payload\": {\n \"text\": {\n \"cursor\": {\n \"value\": \"\"\n },\n \"all_text\": {\n \"value\": \"\"\n },\n \"range\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dfe730a-0dc7-4afc-afbe-ee7c9bba7016", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "edittext" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"CEec6b55-6e8e-e2bB-d08c-e27f915CeDD2\",\n \"zone_id\": \"dc20f72E-dD2b-6931-F3cc-3488e10dCe1C\",\n \"frame_id\": \"490b6c63-edaf-fF9b-DE99-bf0dC3ECbCeA\"\n },\n \"cell\": {\n \"row_index\": 8261,\n \"column_index\": 5241\n },\n \"payload\": {\n \"text\": {\n \"cursor\": {\n \"value\": \"\"\n },\n \"all_text\": {\n \"value\": \"\"\n },\n \"range\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42fc1221-0fb7-4f99-9cde-bd5c8eeb500d", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "edittext" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"CEec6b55-6e8e-e2bB-d08c-e27f915CeDD2\",\n \"zone_id\": \"dc20f72E-dD2b-6931-F3cc-3488e10dCe1C\",\n \"frame_id\": \"490b6c63-edaf-fF9b-DE99-bf0dC3ECbCeA\"\n },\n \"cell\": {\n \"row_index\": 8261,\n \"column_index\": 5241\n },\n \"payload\": {\n \"text\": {\n \"cursor\": {\n \"value\": \"\"\n },\n \"all_text\": {\n \"value\": \"\"\n },\n \"range\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29927eef-a728-40ea-8362-d3e01a6bad3c", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "edittext" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"CEec6b55-6e8e-e2bB-d08c-e27f915CeDD2\",\n \"zone_id\": \"dc20f72E-dD2b-6931-F3cc-3488e10dCe1C\",\n \"frame_id\": \"490b6c63-edaf-fF9b-DE99-bf0dC3ECbCeA\"\n },\n \"cell\": {\n \"row_index\": 8261,\n \"column_index\": 5241\n },\n \"payload\": {\n \"text\": {\n \"cursor\": {\n \"value\": \"\"\n },\n \"all_text\": {\n \"value\": \"\"\n },\n \"range\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "183c41b0-a9ce-438d-bf83-fa7afb4e1008", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "edittext" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"CEec6b55-6e8e-e2bB-d08c-e27f915CeDD2\",\n \"zone_id\": \"dc20f72E-dD2b-6931-F3cc-3488e10dCe1C\",\n \"frame_id\": \"490b6c63-edaf-fF9b-DE99-bf0dC3ECbCeA\"\n },\n \"cell\": {\n \"row_index\": 8261,\n \"column_index\": 5241\n },\n \"payload\": {\n \"text\": {\n \"cursor\": {\n \"value\": \"\"\n },\n \"all_text\": {\n \"value\": \"\"\n },\n \"range\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2683327-454d-412a-a900-9c4ebbac829a", "name": "Read the plain text held in one table cell, addressed by row and column index, either whole or over a character range. Returns text with formatting flattened away.", "request": { "name": "Read the plain text held in one table cell, addressed by row and column index, either whole or over a character range. Returns text with formatting flattened away.", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "text" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "table_query", "value": "string", "description": "(Required) `table_query` — JSON-encoded GetCellText request: table, cell, optional payload.text (range or all_text). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "80e74a8e-b199-4b3e-bc72-7708629b78db", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "text" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "896318ab-b98d-4d37-aa7a-ca6c8b98b57c", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "text" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34f6ad1b-15b1-4f6b-ab43-098deea95249", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "text" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb890b1b-a4ce-4c24-9b85-c527645c72c9", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "text" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ccfe70a-8c70-49a3-a96a-7e3eaeb13775", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "text" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc7df080-4023-4acf-937d-cd5bd32aacec", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "text" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "table_query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f213e8e-ad08-4771-86e8-ef1803502748", "name": "Overwrite one table cell's entire text with a supplied string. Whole-cell replacement - use editTableCellText for a range, cursor or otherwise partial mutation.", "request": { "name": "Overwrite one table cell's entire text with a supplied string. Whole-cell replacement - use editTableCellText for a range, cursor or otherwise partial mutation.", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "text" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"cD6EE075-DdC5-4D90-59C2-F3EFEDBe678D\",\n \"zone_id\": \"2B4829cD-D7e9-35e6-8eFA-f7EF5f7DA635\",\n \"frame_id\": \"66fCc536-f9c4-CAd9-F55A-63b0C56E75FA\"\n },\n \"cell\": {\n \"row_index\": 6966,\n \"column_index\": 5163\n },\n \"payload\": {\n \"text\": \"籟\\udb3a膑첓埛\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f8274c4c-39b2-4844-b35a-f0bdf27299f1", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "text" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"cD6EE075-DdC5-4D90-59C2-F3EFEDBe678D\",\n \"zone_id\": \"2B4829cD-D7e9-35e6-8eFA-f7EF5f7DA635\",\n \"frame_id\": \"66fCc536-f9c4-CAd9-F55A-63b0C56E75FA\"\n },\n \"cell\": {\n \"row_index\": 6966,\n \"column_index\": 5163\n },\n \"payload\": {\n \"text\": \"籟\\udb3a膑첓埛\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25f3355e-f863-4d14-98d6-769d75a8a0d8", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "text" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"cD6EE075-DdC5-4D90-59C2-F3EFEDBe678D\",\n \"zone_id\": \"2B4829cD-D7e9-35e6-8eFA-f7EF5f7DA635\",\n \"frame_id\": \"66fCc536-f9c4-CAd9-F55A-63b0C56E75FA\"\n },\n \"cell\": {\n \"row_index\": 6966,\n \"column_index\": 5163\n },\n \"payload\": {\n \"text\": \"籟\\udb3a膑첓埛\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b14aee3-7da2-49e7-a6c1-b57a37d29856", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "text" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"cD6EE075-DdC5-4D90-59C2-F3EFEDBe678D\",\n \"zone_id\": \"2B4829cD-D7e9-35e6-8eFA-f7EF5f7DA635\",\n \"frame_id\": \"66fCc536-f9c4-CAd9-F55A-63b0C56E75FA\"\n },\n \"cell\": {\n \"row_index\": 6966,\n \"column_index\": 5163\n },\n \"payload\": {\n \"text\": \"籟\\udb3a膑첓埛\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc2ff4c5-22f5-4d9e-a07e-615b5cd8ce1d", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "text" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"cD6EE075-DdC5-4D90-59C2-F3EFEDBe678D\",\n \"zone_id\": \"2B4829cD-D7e9-35e6-8eFA-f7EF5f7DA635\",\n \"frame_id\": \"66fCc536-f9c4-CAd9-F55A-63b0C56E75FA\"\n },\n \"cell\": {\n \"row_index\": 6966,\n \"column_index\": 5163\n },\n \"payload\": {\n \"text\": \"籟\\udb3a膑첓埛\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e94178c3-8671-4f7f-b5df-77b2506c8733", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "text" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"cD6EE075-DdC5-4D90-59C2-F3EFEDBe678D\",\n \"zone_id\": \"2B4829cD-D7e9-35e6-8eFA-f7EF5f7DA635\",\n \"frame_id\": \"66fCc536-f9c4-CAd9-F55A-63b0C56E75FA\"\n },\n \"cell\": {\n \"row_index\": 6966,\n \"column_index\": 5163\n },\n \"payload\": {\n \"text\": \"籟\\udb3a膑첓埛\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7af2cdc5-5d67-4932-8bd2-c5c4e80ce842", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cell", "text" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"cD6EE075-DdC5-4D90-59C2-F3EFEDBe678D\",\n \"zone_id\": \"2B4829cD-D7e9-35e6-8eFA-f7EF5f7DA635\",\n \"frame_id\": \"66fCc536-f9c4-CAd9-F55A-63b0C56E75FA\"\n },\n \"cell\": {\n \"row_index\": 6966,\n \"column_index\": 5163\n },\n \"payload\": {\n \"text\": \"籟\\udb3a膑첓埛\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47385b78-2fa0-45e4-b2ad-7dface2fe08e", "name": "Insert columns before or after an anchor column index", "request": { "name": "Insert columns before or after an anchor column index", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "columns", "insert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"EEbdeeae-3a6E-FE6e-08b4-eFB9B2d24353\",\n \"zone_id\": \"cEECCAbB-da87-FfaE-dFCD-abad2E800b75\",\n \"frame_id\": \"Ca89Db56-23D2-22f7-b64c-c50Ac9fABA23\"\n },\n \"payload\": {\n \"anchor_index\": 2151,\n \"count\": 1591,\n \"position\": \"INSERT_POSITION_UNSPECIFIED\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a6f0da9b-642f-4120-8d8c-e7a9bd5286cd", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "columns", "insert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"EEbdeeae-3a6E-FE6e-08b4-eFB9B2d24353\",\n \"zone_id\": \"cEECCAbB-da87-FfaE-dFCD-abad2E800b75\",\n \"frame_id\": \"Ca89Db56-23D2-22f7-b64c-c50Ac9fABA23\"\n },\n \"payload\": {\n \"anchor_index\": 2151,\n \"count\": 1591,\n \"position\": \"INSERT_POSITION_UNSPECIFIED\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbd1069e-689d-4a73-acf8-1e39d422ffe5", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "columns", "insert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"EEbdeeae-3a6E-FE6e-08b4-eFB9B2d24353\",\n \"zone_id\": \"cEECCAbB-da87-FfaE-dFCD-abad2E800b75\",\n \"frame_id\": \"Ca89Db56-23D2-22f7-b64c-c50Ac9fABA23\"\n },\n \"payload\": {\n \"anchor_index\": 2151,\n \"count\": 1591,\n \"position\": \"INSERT_POSITION_UNSPECIFIED\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3db54219-c882-4494-996f-899df2984417", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "columns", "insert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"EEbdeeae-3a6E-FE6e-08b4-eFB9B2d24353\",\n \"zone_id\": \"cEECCAbB-da87-FfaE-dFCD-abad2E800b75\",\n \"frame_id\": \"Ca89Db56-23D2-22f7-b64c-c50Ac9fABA23\"\n },\n \"payload\": {\n \"anchor_index\": 2151,\n \"count\": 1591,\n \"position\": \"INSERT_POSITION_UNSPECIFIED\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09ab41ad-90af-45f4-b8ab-dc23a4bd10c9", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "columns", "insert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"EEbdeeae-3a6E-FE6e-08b4-eFB9B2d24353\",\n \"zone_id\": \"cEECCAbB-da87-FfaE-dFCD-abad2E800b75\",\n \"frame_id\": \"Ca89Db56-23D2-22f7-b64c-c50Ac9fABA23\"\n },\n \"payload\": {\n \"anchor_index\": 2151,\n \"count\": 1591,\n \"position\": \"INSERT_POSITION_UNSPECIFIED\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce6f34c8-09a7-44f0-ba80-5f11543ef72d", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "columns", "insert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"EEbdeeae-3a6E-FE6e-08b4-eFB9B2d24353\",\n \"zone_id\": \"cEECCAbB-da87-FfaE-dFCD-abad2E800b75\",\n \"frame_id\": \"Ca89Db56-23D2-22f7-b64c-c50Ac9fABA23\"\n },\n \"payload\": {\n \"anchor_index\": 2151,\n \"count\": 1591,\n \"position\": \"INSERT_POSITION_UNSPECIFIED\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55a5b69b-ef48-4608-8af3-4f3e2d591d32", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "columns", "insert" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"EEbdeeae-3a6E-FE6e-08b4-eFB9B2d24353\",\n \"zone_id\": \"cEECCAbB-da87-FfaE-dFCD-abad2E800b75\",\n \"frame_id\": \"Ca89Db56-23D2-22f7-b64c-c50Ac9fABA23\"\n },\n \"payload\": {\n \"anchor_index\": 2151,\n \"count\": 1591,\n \"position\": \"INSERT_POSITION_UNSPECIFIED\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ab5c5d7-b107-45d1-9658-31f167830ce5", "name": "Unmerge a merged region of table cells", "request": { "name": "Unmerge a merged region of table cells", "description": { "content": "Pass the table reference and `payload.cell` (`{row_index, column_index}`) identifying any cell inside the merged area. The payload takes a single `cell` reference, not a `range`.", "type": "text/plain" }, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cells", "unmerge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"3cCce252-aFca-CCc3-2298-58684AD4EFd0\",\n \"zone_id\": \"BA3283A9-ABfB-F4F6-d3aC-c4DfcBADB31a\",\n \"frame_id\": \"198765ea-E23A-1Cf7-7b37-54Ffcdde7Ec7\"\n },\n \"payload\": {\n \"cell\": {\n \"row_index\": {\n \"value\": \"\"\n },\n \"column_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bfac2cc2-41c9-4665-a6b4-8201da5221f8", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cells", "unmerge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"3cCce252-aFca-CCc3-2298-58684AD4EFd0\",\n \"zone_id\": \"BA3283A9-ABfB-F4F6-d3aC-c4DfcBADB31a\",\n \"frame_id\": \"198765ea-E23A-1Cf7-7b37-54Ffcdde7Ec7\"\n },\n \"payload\": {\n \"cell\": {\n \"row_index\": {\n \"value\": \"\"\n },\n \"column_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb92a4da-d942-40de-a137-13b636a22b73", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cells", "unmerge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"3cCce252-aFca-CCc3-2298-58684AD4EFd0\",\n \"zone_id\": \"BA3283A9-ABfB-F4F6-d3aC-c4DfcBADB31a\",\n \"frame_id\": \"198765ea-E23A-1Cf7-7b37-54Ffcdde7Ec7\"\n },\n \"payload\": {\n \"cell\": {\n \"row_index\": {\n \"value\": \"\"\n },\n \"column_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "402c4614-7d86-420e-856d-bda65007b248", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cells", "unmerge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"3cCce252-aFca-CCc3-2298-58684AD4EFd0\",\n \"zone_id\": \"BA3283A9-ABfB-F4F6-d3aC-c4DfcBADB31a\",\n \"frame_id\": \"198765ea-E23A-1Cf7-7b37-54Ffcdde7Ec7\"\n },\n \"payload\": {\n \"cell\": {\n \"row_index\": {\n \"value\": \"\"\n },\n \"column_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d171c59-f781-4ff0-b4c7-7fe4fe8a832c", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cells", "unmerge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"3cCce252-aFca-CCc3-2298-58684AD4EFd0\",\n \"zone_id\": \"BA3283A9-ABfB-F4F6-d3aC-c4DfcBADB31a\",\n \"frame_id\": \"198765ea-E23A-1Cf7-7b37-54Ffcdde7Ec7\"\n },\n \"payload\": {\n \"cell\": {\n \"row_index\": {\n \"value\": \"\"\n },\n \"column_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93f0d0f1-8006-4f1d-95a1-b690dbeca367", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cells", "unmerge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"3cCce252-aFca-CCc3-2298-58684AD4EFd0\",\n \"zone_id\": \"BA3283A9-ABfB-F4F6-d3aC-c4DfcBADB31a\",\n \"frame_id\": \"198765ea-E23A-1Cf7-7b37-54Ffcdde7Ec7\"\n },\n \"payload\": {\n \"cell\": {\n \"row_index\": {\n \"value\": \"\"\n },\n \"column_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "052d1356-7705-4233-a239-2261abb6635b", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "cells", "unmerge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"3cCce252-aFca-CCc3-2298-58684AD4EFd0\",\n \"zone_id\": \"BA3283A9-ABfB-F4F6-d3aC-c4DfcBADB31a\",\n \"frame_id\": \"198765ea-E23A-1Cf7-7b37-54Ffcdde7Ec7\"\n },\n \"payload\": {\n \"cell\": {\n \"row_index\": {\n \"value\": \"\"\n },\n \"column_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7eead5bc-ebc2-4344-b4be-f173bfd70af5", "name": "Delete columns in a specified column index range", "request": { "name": "Delete columns in a specified column index range", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "columns", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"0eBAc7Fd-1EBF-CbF7-Fe7d-b8f11b9D5C7C\",\n \"zone_id\": \"BeacAbb6-4CAA-77AA-BDEE-3F72834dcBDf\",\n \"frame_id\": \"DA36B4Af-a231-bca6-AeBa-67A01A3D62D7\"\n },\n \"payload\": {\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "11091355-6ece-4254-8302-22fb29958307", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "columns", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"0eBAc7Fd-1EBF-CbF7-Fe7d-b8f11b9D5C7C\",\n \"zone_id\": \"BeacAbb6-4CAA-77AA-BDEE-3F72834dcBDf\",\n \"frame_id\": \"DA36B4Af-a231-bca6-AeBa-67A01A3D62D7\"\n },\n \"payload\": {\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aadd2ab1-caf7-4f17-b7e9-030db582c1cf", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "columns", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"0eBAc7Fd-1EBF-CbF7-Fe7d-b8f11b9D5C7C\",\n \"zone_id\": \"BeacAbb6-4CAA-77AA-BDEE-3F72834dcBDf\",\n \"frame_id\": \"DA36B4Af-a231-bca6-AeBa-67A01A3D62D7\"\n },\n \"payload\": {\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86faebfe-65ce-489b-bf98-aacb2fcead28", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "columns", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"0eBAc7Fd-1EBF-CbF7-Fe7d-b8f11b9D5C7C\",\n \"zone_id\": \"BeacAbb6-4CAA-77AA-BDEE-3F72834dcBDf\",\n \"frame_id\": \"DA36B4Af-a231-bca6-AeBa-67A01A3D62D7\"\n },\n \"payload\": {\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d64cba3-ddc5-4cc2-b821-3471e9e8838e", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "columns", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"0eBAc7Fd-1EBF-CbF7-Fe7d-b8f11b9D5C7C\",\n \"zone_id\": \"BeacAbb6-4CAA-77AA-BDEE-3F72834dcBDf\",\n \"frame_id\": \"DA36B4Af-a231-bca6-AeBa-67A01A3D62D7\"\n },\n \"payload\": {\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a5401ad-4e39-43b4-94cc-a0717ec105eb", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "columns", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"0eBAc7Fd-1EBF-CbF7-Fe7d-b8f11b9D5C7C\",\n \"zone_id\": \"BeacAbb6-4CAA-77AA-BDEE-3F72834dcBDf\",\n \"frame_id\": \"DA36B4Af-a231-bca6-AeBa-67A01A3D62D7\"\n },\n \"payload\": {\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0015021-18ae-407b-9c3a-edf9e29577b8", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "table", "columns", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"0eBAc7Fd-1EBF-CbF7-Fe7d-b8f11b9D5C7C\",\n \"zone_id\": \"BeacAbb6-4CAA-77AA-BDEE-3F72834dcBDf\",\n \"frame_id\": \"DA36B4Af-a231-bca6-AeBa-67A01A3D62D7\"\n },\n \"payload\": {\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "80d46ddd-f7d4-47f1-a8e7-8161fd296ce9", "name": "Database Tables", "description": { "content": "Manage typed database_table columns, records, schema, and queries.", "type": "text/plain" }, "item": [ { "id": "a5f231aa-714f-48d4-8d5c-acb9cc31edac", "name": "Add a column (appended); applies its default to existing rows", "request": { "name": "Add a column (appended); applies its default to existing rows", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"B388dfbA-b465-0dA2-BE0A-8EBDEc5C3a3f\",\n \"zone_id\": \"731cf5e7-27Bf-BCfF-8a3B-c0b1233c8E6f\",\n \"frame_id\": \"2d8C9385-8E85-acfD-c4DD-6f4ab4CbA6C5\"\n },\n \"column\": {\n \"lookup\": {\n \"source_column_id\": {\n \"value\": \"\"\n },\n \"relation_column_id\": {\n \"value\": \"\"\n }\n },\n \"unique\": false,\n \"name\": \"袉됢柒ഇꃠ\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_value\": {\n \"value\": {\n \"value\": \"\"\n }\n },\n \"type\": \"PERSON\",\n \"required\": true,\n \"relation\": {\n \"reciprocal_column_id\": {\n \"value\": \"\"\n },\n \"allow_multiple\": {\n \"value\": \"\"\n },\n \"related_table_id\": {\n \"value\": \"\"\n }\n },\n \"rollup\": {\n \"source_column_id\": {\n \"value\": \"\"\n },\n \"relation_column_id\": {\n \"value\": \"\"\n },\n \"aggregate\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ac82569a-fb10-4a30-9f29-fba427a24cec", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"B388dfbA-b465-0dA2-BE0A-8EBDEc5C3a3f\",\n \"zone_id\": \"731cf5e7-27Bf-BCfF-8a3B-c0b1233c8E6f\",\n \"frame_id\": \"2d8C9385-8E85-acfD-c4DD-6f4ab4CbA6C5\"\n },\n \"column\": {\n \"lookup\": {\n \"source_column_id\": {\n \"value\": \"\"\n },\n \"relation_column_id\": {\n \"value\": \"\"\n }\n },\n \"unique\": false,\n \"name\": \"袉됢柒ഇꃠ\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_value\": {\n \"value\": {\n \"value\": \"\"\n }\n },\n \"type\": \"PERSON\",\n \"required\": true,\n \"relation\": {\n \"reciprocal_column_id\": {\n \"value\": \"\"\n },\n \"allow_multiple\": {\n \"value\": \"\"\n },\n \"related_table_id\": {\n \"value\": \"\"\n }\n },\n \"rollup\": {\n \"source_column_id\": {\n \"value\": \"\"\n },\n \"relation_column_id\": {\n \"value\": \"\"\n },\n \"aggregate\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42bc844e-6b46-404b-be82-801e9153dc51", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"B388dfbA-b465-0dA2-BE0A-8EBDEc5C3a3f\",\n \"zone_id\": \"731cf5e7-27Bf-BCfF-8a3B-c0b1233c8E6f\",\n \"frame_id\": \"2d8C9385-8E85-acfD-c4DD-6f4ab4CbA6C5\"\n },\n \"column\": {\n \"lookup\": {\n \"source_column_id\": {\n \"value\": \"\"\n },\n \"relation_column_id\": {\n \"value\": \"\"\n }\n },\n \"unique\": false,\n \"name\": \"袉됢柒ഇꃠ\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_value\": {\n \"value\": {\n \"value\": \"\"\n }\n },\n \"type\": \"PERSON\",\n \"required\": true,\n \"relation\": {\n \"reciprocal_column_id\": {\n \"value\": \"\"\n },\n \"allow_multiple\": {\n \"value\": \"\"\n },\n \"related_table_id\": {\n \"value\": \"\"\n }\n },\n \"rollup\": {\n \"source_column_id\": {\n \"value\": \"\"\n },\n \"relation_column_id\": {\n \"value\": \"\"\n },\n \"aggregate\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10f494a8-70c2-49b7-80cc-098e60b7bfcf", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"B388dfbA-b465-0dA2-BE0A-8EBDEc5C3a3f\",\n \"zone_id\": \"731cf5e7-27Bf-BCfF-8a3B-c0b1233c8E6f\",\n \"frame_id\": \"2d8C9385-8E85-acfD-c4DD-6f4ab4CbA6C5\"\n },\n \"column\": {\n \"lookup\": {\n \"source_column_id\": {\n \"value\": \"\"\n },\n \"relation_column_id\": {\n \"value\": \"\"\n }\n },\n \"unique\": false,\n \"name\": \"袉됢柒ഇꃠ\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_value\": {\n \"value\": {\n \"value\": \"\"\n }\n },\n \"type\": \"PERSON\",\n \"required\": true,\n \"relation\": {\n \"reciprocal_column_id\": {\n \"value\": \"\"\n },\n \"allow_multiple\": {\n \"value\": \"\"\n },\n \"related_table_id\": {\n \"value\": \"\"\n }\n },\n \"rollup\": {\n \"source_column_id\": {\n \"value\": \"\"\n },\n \"relation_column_id\": {\n \"value\": \"\"\n },\n \"aggregate\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "027259c4-4d1e-4e02-979d-b6d24ef49f10", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"B388dfbA-b465-0dA2-BE0A-8EBDEc5C3a3f\",\n \"zone_id\": \"731cf5e7-27Bf-BCfF-8a3B-c0b1233c8E6f\",\n \"frame_id\": \"2d8C9385-8E85-acfD-c4DD-6f4ab4CbA6C5\"\n },\n \"column\": {\n \"lookup\": {\n \"source_column_id\": {\n \"value\": \"\"\n },\n \"relation_column_id\": {\n \"value\": \"\"\n }\n },\n \"unique\": false,\n \"name\": \"袉됢柒ഇꃠ\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_value\": {\n \"value\": {\n \"value\": \"\"\n }\n },\n \"type\": \"PERSON\",\n \"required\": true,\n \"relation\": {\n \"reciprocal_column_id\": {\n \"value\": \"\"\n },\n \"allow_multiple\": {\n \"value\": \"\"\n },\n \"related_table_id\": {\n \"value\": \"\"\n }\n },\n \"rollup\": {\n \"source_column_id\": {\n \"value\": \"\"\n },\n \"relation_column_id\": {\n \"value\": \"\"\n },\n \"aggregate\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d85f80dc-7bb2-4b22-843a-a922c2c63b61", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"B388dfbA-b465-0dA2-BE0A-8EBDEc5C3a3f\",\n \"zone_id\": \"731cf5e7-27Bf-BCfF-8a3B-c0b1233c8E6f\",\n \"frame_id\": \"2d8C9385-8E85-acfD-c4DD-6f4ab4CbA6C5\"\n },\n \"column\": {\n \"lookup\": {\n \"source_column_id\": {\n \"value\": \"\"\n },\n \"relation_column_id\": {\n \"value\": \"\"\n }\n },\n \"unique\": false,\n \"name\": \"袉됢柒ഇꃠ\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_value\": {\n \"value\": {\n \"value\": \"\"\n }\n },\n \"type\": \"PERSON\",\n \"required\": true,\n \"relation\": {\n \"reciprocal_column_id\": {\n \"value\": \"\"\n },\n \"allow_multiple\": {\n \"value\": \"\"\n },\n \"related_table_id\": {\n \"value\": \"\"\n }\n },\n \"rollup\": {\n \"source_column_id\": {\n \"value\": \"\"\n },\n \"relation_column_id\": {\n \"value\": \"\"\n },\n \"aggregate\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24122ffe-1fc0-43d5-a972-7871ab9c42b4", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"B388dfbA-b465-0dA2-BE0A-8EBDEc5C3a3f\",\n \"zone_id\": \"731cf5e7-27Bf-BCfF-8a3B-c0b1233c8E6f\",\n \"frame_id\": \"2d8C9385-8E85-acfD-c4DD-6f4ab4CbA6C5\"\n },\n \"column\": {\n \"lookup\": {\n \"source_column_id\": {\n \"value\": \"\"\n },\n \"relation_column_id\": {\n \"value\": \"\"\n }\n },\n \"unique\": false,\n \"name\": \"袉됢柒ഇꃠ\",\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_value\": {\n \"value\": {\n \"value\": \"\"\n }\n },\n \"type\": \"PERSON\",\n \"required\": true,\n \"relation\": {\n \"reciprocal_column_id\": {\n \"value\": \"\"\n },\n \"allow_multiple\": {\n \"value\": \"\"\n },\n \"related_table_id\": {\n \"value\": \"\"\n }\n },\n \"rollup\": {\n \"source_column_id\": {\n \"value\": \"\"\n },\n \"relation_column_id\": {\n \"value\": \"\"\n },\n \"aggregate\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1928fb5a-1252-4309-a22a-d7b3f95ec233", "name": "Dry-run a column type change: feasibility and convertible/incompatible counts", "request": { "name": "Dry-run a column type change: feasibility and convertible/incompatible counts", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "type", "feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "object_id", "value": "jeep5LLz", "description": "(Required) Database table object id" }, { "disabled": false, "key": "column_id", "value": "yIOl1", "description": "(Required) Column id to test" }, { "disabled": false, "key": "target_type", "value": "I", "description": "(Required) Target ColumnType enum name (e.g. NUMBER)" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "f0ea4b2d-3a2d-4140-a5ac-df069f481ca1", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "type", "feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "object_id", "value": "jeep5LLz" }, { "key": "column_id", "value": "yIOl1" }, { "key": "target_type", "value": "I" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb6714af-d211-427a-aa4b-91583c12860f", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "type", "feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "object_id", "value": "jeep5LLz" }, { "key": "column_id", "value": "yIOl1" }, { "key": "target_type", "value": "I" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3169fe0f-8523-44b0-89c1-b5698fed6270", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "type", "feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "object_id", "value": "jeep5LLz" }, { "key": "column_id", "value": "yIOl1" }, { "key": "target_type", "value": "I" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e9be6cb-4b07-4f6b-9f5d-f69a1113c54a", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "type", "feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "object_id", "value": "jeep5LLz" }, { "key": "column_id", "value": "yIOl1" }, { "key": "target_type", "value": "I" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ff4e0e7-58c0-45fb-bde4-88ba488e649c", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "type", "feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "object_id", "value": "jeep5LLz" }, { "key": "column_id", "value": "yIOl1" }, { "key": "target_type", "value": "I" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5fa59a5-ba91-4b26-8976-7013f21bffcf", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "type", "feasibility" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "object_id", "value": "jeep5LLz" }, { "key": "column_id", "value": "yIOl1" }, { "key": "target_type", "value": "I" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ac7c654-c0e5-4dee-99f8-9f1d48a2bf26", "name": "Delete all records matching the (non-empty) filters", "request": { "name": "Delete all records matching the (non-empty) filters", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"1abB1D5e-5bAE-5F6c-cdC9-dfC944Bd17b7\",\n \"zone_id\": \"fD741ac1-B8Fb-aeed-f94E-74cdcea1B6fC\",\n \"frame_id\": \"Ba82D0C9-cFfE-bAef-B7A0-2E0cEf085AFA\"\n },\n \"filter\": {\n \"mode\": \"AND\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6a43c611-d04f-42d4-ab08-35f5d2b8c1a3", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"1abB1D5e-5bAE-5F6c-cdC9-dfC944Bd17b7\",\n \"zone_id\": \"fD741ac1-B8Fb-aeed-f94E-74cdcea1B6fC\",\n \"frame_id\": \"Ba82D0C9-cFfE-bAef-B7A0-2E0cEf085AFA\"\n },\n \"filter\": {\n \"mode\": \"AND\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "196b52ac-0ffd-4ae8-b6ba-8289c8c3ea5f", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"1abB1D5e-5bAE-5F6c-cdC9-dfC944Bd17b7\",\n \"zone_id\": \"fD741ac1-B8Fb-aeed-f94E-74cdcea1B6fC\",\n \"frame_id\": \"Ba82D0C9-cFfE-bAef-B7A0-2E0cEf085AFA\"\n },\n \"filter\": {\n \"mode\": \"AND\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3ca6557-03ed-4b5d-9b26-bcaf361524a9", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"1abB1D5e-5bAE-5F6c-cdC9-dfC944Bd17b7\",\n \"zone_id\": \"fD741ac1-B8Fb-aeed-f94E-74cdcea1B6fC\",\n \"frame_id\": \"Ba82D0C9-cFfE-bAef-B7A0-2E0cEf085AFA\"\n },\n \"filter\": {\n \"mode\": \"AND\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b876c9ca-3ad2-4fb7-9075-68a6fae75043", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"1abB1D5e-5bAE-5F6c-cdC9-dfC944Bd17b7\",\n \"zone_id\": \"fD741ac1-B8Fb-aeed-f94E-74cdcea1B6fC\",\n \"frame_id\": \"Ba82D0C9-cFfE-bAef-B7A0-2E0cEf085AFA\"\n },\n \"filter\": {\n \"mode\": \"AND\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a112e8a-0ef9-4de4-857e-a1737edbadda", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"1abB1D5e-5bAE-5F6c-cdC9-dfC944Bd17b7\",\n \"zone_id\": \"fD741ac1-B8Fb-aeed-f94E-74cdcea1B6fC\",\n \"frame_id\": \"Ba82D0C9-cFfE-bAef-B7A0-2E0cEf085AFA\"\n },\n \"filter\": {\n \"mode\": \"AND\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c1ae222-6476-44aa-8bab-a80953c10756", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"1abB1D5e-5bAE-5F6c-cdC9-dfC944Bd17b7\",\n \"zone_id\": \"fD741ac1-B8Fb-aeed-f94E-74cdcea1B6fC\",\n \"frame_id\": \"Ba82D0C9-cFfE-bAef-B7A0-2E0cEf085AFA\"\n },\n \"filter\": {\n \"mode\": \"AND\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "599a20c7-e4a2-4c5e-aba5-452973e2cadd", "name": "Sparse update of an existing record's cells (set or clear)", "request": { "name": "Sparse update of an existing record's cells (set or clear)", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"ADc39cba-6BcD-8FEb-29e8-Afa1efA20b50\",\n \"zone_id\": \"2E10FAD1-915c-6708-1Fd1-AbB7782cD07E\",\n \"frame_id\": \"ffdde837-a6B9-a77b-5Ae8-902aA3A11dbb\"\n },\n \"record\": {\n \"row_id\": \"ab9hYPx9GuDqdU8RfNaqCbwRhfZ4j4Z8YxUFPNmPi9g3qqEuyu2mPUXgTRVXLwH2HpI5l_V4XM5v0TzULC-wyywic2bO7uW2r5LOdG8evxuRrfvBvArkUOMtzDdxg6NflwHsqCc14X5suq1ool4zYIVAf-YkrC61Smo_Sn5BBiBxZJ__bnESY8az8c9MrVB-\"\n },\n \"cells\": [\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "16e48034-413c-4868-bca6-455ca24fe0f3", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"ADc39cba-6BcD-8FEb-29e8-Afa1efA20b50\",\n \"zone_id\": \"2E10FAD1-915c-6708-1Fd1-AbB7782cD07E\",\n \"frame_id\": \"ffdde837-a6B9-a77b-5Ae8-902aA3A11dbb\"\n },\n \"record\": {\n \"row_id\": \"ab9hYPx9GuDqdU8RfNaqCbwRhfZ4j4Z8YxUFPNmPi9g3qqEuyu2mPUXgTRVXLwH2HpI5l_V4XM5v0TzULC-wyywic2bO7uW2r5LOdG8evxuRrfvBvArkUOMtzDdxg6NflwHsqCc14X5suq1ool4zYIVAf-YkrC61Smo_Sn5BBiBxZJ__bnESY8az8c9MrVB-\"\n },\n \"cells\": [\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36dcb650-8cbb-4db9-b033-23b30cd88cb8", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"ADc39cba-6BcD-8FEb-29e8-Afa1efA20b50\",\n \"zone_id\": \"2E10FAD1-915c-6708-1Fd1-AbB7782cD07E\",\n \"frame_id\": \"ffdde837-a6B9-a77b-5Ae8-902aA3A11dbb\"\n },\n \"record\": {\n \"row_id\": \"ab9hYPx9GuDqdU8RfNaqCbwRhfZ4j4Z8YxUFPNmPi9g3qqEuyu2mPUXgTRVXLwH2HpI5l_V4XM5v0TzULC-wyywic2bO7uW2r5LOdG8evxuRrfvBvArkUOMtzDdxg6NflwHsqCc14X5suq1ool4zYIVAf-YkrC61Smo_Sn5BBiBxZJ__bnESY8az8c9MrVB-\"\n },\n \"cells\": [\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d0ade42-c9fa-4e1e-b977-8683e1d8ab77", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"ADc39cba-6BcD-8FEb-29e8-Afa1efA20b50\",\n \"zone_id\": \"2E10FAD1-915c-6708-1Fd1-AbB7782cD07E\",\n \"frame_id\": \"ffdde837-a6B9-a77b-5Ae8-902aA3A11dbb\"\n },\n \"record\": {\n \"row_id\": \"ab9hYPx9GuDqdU8RfNaqCbwRhfZ4j4Z8YxUFPNmPi9g3qqEuyu2mPUXgTRVXLwH2HpI5l_V4XM5v0TzULC-wyywic2bO7uW2r5LOdG8evxuRrfvBvArkUOMtzDdxg6NflwHsqCc14X5suq1ool4zYIVAf-YkrC61Smo_Sn5BBiBxZJ__bnESY8az8c9MrVB-\"\n },\n \"cells\": [\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dad4a3f-1f54-4ff0-8978-ff5cdc86dd0b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"ADc39cba-6BcD-8FEb-29e8-Afa1efA20b50\",\n \"zone_id\": \"2E10FAD1-915c-6708-1Fd1-AbB7782cD07E\",\n \"frame_id\": \"ffdde837-a6B9-a77b-5Ae8-902aA3A11dbb\"\n },\n \"record\": {\n \"row_id\": \"ab9hYPx9GuDqdU8RfNaqCbwRhfZ4j4Z8YxUFPNmPi9g3qqEuyu2mPUXgTRVXLwH2HpI5l_V4XM5v0TzULC-wyywic2bO7uW2r5LOdG8evxuRrfvBvArkUOMtzDdxg6NflwHsqCc14X5suq1ool4zYIVAf-YkrC61Smo_Sn5BBiBxZJ__bnESY8az8c9MrVB-\"\n },\n \"cells\": [\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f072230-dfec-4f39-8cbe-23beb39c44b0", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"ADc39cba-6BcD-8FEb-29e8-Afa1efA20b50\",\n \"zone_id\": \"2E10FAD1-915c-6708-1Fd1-AbB7782cD07E\",\n \"frame_id\": \"ffdde837-a6B9-a77b-5Ae8-902aA3A11dbb\"\n },\n \"record\": {\n \"row_id\": \"ab9hYPx9GuDqdU8RfNaqCbwRhfZ4j4Z8YxUFPNmPi9g3qqEuyu2mPUXgTRVXLwH2HpI5l_V4XM5v0TzULC-wyywic2bO7uW2r5LOdG8evxuRrfvBvArkUOMtzDdxg6NflwHsqCc14X5suq1ool4zYIVAf-YkrC61Smo_Sn5BBiBxZJ__bnESY8az8c9MrVB-\"\n },\n \"cells\": [\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a526601d-cb90-4a91-9e28-fb6a25ef39b7", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"ADc39cba-6BcD-8FEb-29e8-Afa1efA20b50\",\n \"zone_id\": \"2E10FAD1-915c-6708-1Fd1-AbB7782cD07E\",\n \"frame_id\": \"ffdde837-a6B9-a77b-5Ae8-902aA3A11dbb\"\n },\n \"record\": {\n \"row_id\": \"ab9hYPx9GuDqdU8RfNaqCbwRhfZ4j4Z8YxUFPNmPi9g3qqEuyu2mPUXgTRVXLwH2HpI5l_V4XM5v0TzULC-wyywic2bO7uW2r5LOdG8evxuRrfvBvArkUOMtzDdxg6NflwHsqCc14X5suq1ool4zYIVAf-YkrC61Smo_Sn5BBiBxZJ__bnESY8az8c9MrVB-\"\n },\n \"cells\": [\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2df96560-e484-4753-8e18-4949b50058c2", "name": "Reorder the table's columns to the given full order", "request": { "name": "Reorder the table's columns to the given full order", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "reorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"eCcCBAcD-FDbB-2c39-cdFA-C2F8cFf4BD86\",\n \"zone_id\": \"aeEdd312-8bdD-C749-f525-F93B7Bc6D754\",\n \"frame_id\": \"eCDf87A6-Ea7F-ee9A-A2a7-Ef4eA2A5D442\"\n },\n \"order\": [\n {\n \"column_id\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ccc0a451-ec18-4fc7-b5c9-09e759a9d7ae", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "reorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"eCcCBAcD-FDbB-2c39-cdFA-C2F8cFf4BD86\",\n \"zone_id\": \"aeEdd312-8bdD-C749-f525-F93B7Bc6D754\",\n \"frame_id\": \"eCDf87A6-Ea7F-ee9A-A2a7-Ef4eA2A5D442\"\n },\n \"order\": [\n {\n \"column_id\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9c03642-3a6b-4f47-a578-3f70bad69d9f", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "reorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"eCcCBAcD-FDbB-2c39-cdFA-C2F8cFf4BD86\",\n \"zone_id\": \"aeEdd312-8bdD-C749-f525-F93B7Bc6D754\",\n \"frame_id\": \"eCDf87A6-Ea7F-ee9A-A2a7-Ef4eA2A5D442\"\n },\n \"order\": [\n {\n \"column_id\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f1f2d2e-5bbc-4876-8739-7bd3e0b4f215", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "reorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"eCcCBAcD-FDbB-2c39-cdFA-C2F8cFf4BD86\",\n \"zone_id\": \"aeEdd312-8bdD-C749-f525-F93B7Bc6D754\",\n \"frame_id\": \"eCDf87A6-Ea7F-ee9A-A2a7-Ef4eA2A5D442\"\n },\n \"order\": [\n {\n \"column_id\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad1e84ca-5952-4d89-a24d-1923d9113efe", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "reorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"eCcCBAcD-FDbB-2c39-cdFA-C2F8cFf4BD86\",\n \"zone_id\": \"aeEdd312-8bdD-C749-f525-F93B7Bc6D754\",\n \"frame_id\": \"eCDf87A6-Ea7F-ee9A-A2a7-Ef4eA2A5D442\"\n },\n \"order\": [\n {\n \"column_id\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "336150e8-8cb0-4765-9dfe-6e73df75b4b6", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "reorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"eCcCBAcD-FDbB-2c39-cdFA-C2F8cFf4BD86\",\n \"zone_id\": \"aeEdd312-8bdD-C749-f525-F93B7Bc6D754\",\n \"frame_id\": \"eCDf87A6-Ea7F-ee9A-A2a7-Ef4eA2A5D442\"\n },\n \"order\": [\n {\n \"column_id\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e3794df-d090-4ca1-980c-ff78ea956405", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "reorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"eCcCBAcD-FDbB-2c39-cdFA-C2F8cFf4BD86\",\n \"zone_id\": \"aeEdd312-8bdD-C749-f525-F93B7Bc6D754\",\n \"frame_id\": \"eCDf87A6-Ea7F-ee9A-A2a7-Ef4eA2A5D442\"\n },\n \"order\": [\n {\n \"column_id\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "afc2289f-0588-4a78-99c5-f4747a0fa497", "name": "Apply one change to a column: rename, retype, set options, default, or constraints", "request": { "name": "Apply one change to a column: rename, retype, set options, default, or constraints", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"3215708D-ddAA-Cbab-2dCF-83Ca19a4Dbe8\",\n \"zone_id\": \"69883A25-E3A8-EBab-779F-f8A9e4B2Fa5B\",\n \"frame_id\": \"DbBc5F12-BBAd-6B0d-35b9-DD79A1E1Ec0E\"\n },\n \"column\": {\n \"column_id\": \"GnwgyuN6SQCt543OqIeEIh9X-JTGFmUFtAtnp9QSjfBnOES_KG6Qq4b17xEEmD-_gWN747RZhLyjpzaMVrwm4_tvl7cK9QswJCfoVJ5ryBUPp0hUtzSjjoobkNWunFfYaGWlgdwN\"\n },\n \"set_constraints\": {\n \"unique\": true,\n \"required\": true\n },\n \"retype\": {\n \"new_type\": \"MULTI_SELECT\"\n },\n \"rename\": \"ⁱ\",\n \"set_options\": {\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"set_default\": {\n \"value\": {\n \"date\": {\n \"value\": \"\"\n },\n \"select\": {\n \"value\": \"\"\n },\n \"rating\": {\n \"value\": \"\"\n },\n \"toggle\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"multi_select\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"person\": {\n \"value\": \"\"\n },\n \"checkbox\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "81730068-1a85-4a93-99f1-abc5aa7c89c9", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"3215708D-ddAA-Cbab-2dCF-83Ca19a4Dbe8\",\n \"zone_id\": \"69883A25-E3A8-EBab-779F-f8A9e4B2Fa5B\",\n \"frame_id\": \"DbBc5F12-BBAd-6B0d-35b9-DD79A1E1Ec0E\"\n },\n \"column\": {\n \"column_id\": \"GnwgyuN6SQCt543OqIeEIh9X-JTGFmUFtAtnp9QSjfBnOES_KG6Qq4b17xEEmD-_gWN747RZhLyjpzaMVrwm4_tvl7cK9QswJCfoVJ5ryBUPp0hUtzSjjoobkNWunFfYaGWlgdwN\"\n },\n \"set_constraints\": {\n \"unique\": true,\n \"required\": true\n },\n \"retype\": {\n \"new_type\": \"MULTI_SELECT\"\n },\n \"rename\": \"ⁱ\",\n \"set_options\": {\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"set_default\": {\n \"value\": {\n \"date\": {\n \"value\": \"\"\n },\n \"select\": {\n \"value\": \"\"\n },\n \"rating\": {\n \"value\": \"\"\n },\n \"toggle\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"multi_select\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"person\": {\n \"value\": \"\"\n },\n \"checkbox\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b69bac11-055c-4d12-b393-0afbc2e6956a", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"3215708D-ddAA-Cbab-2dCF-83Ca19a4Dbe8\",\n \"zone_id\": \"69883A25-E3A8-EBab-779F-f8A9e4B2Fa5B\",\n \"frame_id\": \"DbBc5F12-BBAd-6B0d-35b9-DD79A1E1Ec0E\"\n },\n \"column\": {\n \"column_id\": \"GnwgyuN6SQCt543OqIeEIh9X-JTGFmUFtAtnp9QSjfBnOES_KG6Qq4b17xEEmD-_gWN747RZhLyjpzaMVrwm4_tvl7cK9QswJCfoVJ5ryBUPp0hUtzSjjoobkNWunFfYaGWlgdwN\"\n },\n \"set_constraints\": {\n \"unique\": true,\n \"required\": true\n },\n \"retype\": {\n \"new_type\": \"MULTI_SELECT\"\n },\n \"rename\": \"ⁱ\",\n \"set_options\": {\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"set_default\": {\n \"value\": {\n \"date\": {\n \"value\": \"\"\n },\n \"select\": {\n \"value\": \"\"\n },\n \"rating\": {\n \"value\": \"\"\n },\n \"toggle\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"multi_select\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"person\": {\n \"value\": \"\"\n },\n \"checkbox\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c793e33c-060e-498d-aa96-d1bfea9d1877", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"3215708D-ddAA-Cbab-2dCF-83Ca19a4Dbe8\",\n \"zone_id\": \"69883A25-E3A8-EBab-779F-f8A9e4B2Fa5B\",\n \"frame_id\": \"DbBc5F12-BBAd-6B0d-35b9-DD79A1E1Ec0E\"\n },\n \"column\": {\n \"column_id\": \"GnwgyuN6SQCt543OqIeEIh9X-JTGFmUFtAtnp9QSjfBnOES_KG6Qq4b17xEEmD-_gWN747RZhLyjpzaMVrwm4_tvl7cK9QswJCfoVJ5ryBUPp0hUtzSjjoobkNWunFfYaGWlgdwN\"\n },\n \"set_constraints\": {\n \"unique\": true,\n \"required\": true\n },\n \"retype\": {\n \"new_type\": \"MULTI_SELECT\"\n },\n \"rename\": \"ⁱ\",\n \"set_options\": {\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"set_default\": {\n \"value\": {\n \"date\": {\n \"value\": \"\"\n },\n \"select\": {\n \"value\": \"\"\n },\n \"rating\": {\n \"value\": \"\"\n },\n \"toggle\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"multi_select\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"person\": {\n \"value\": \"\"\n },\n \"checkbox\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0cd1fb6-d84a-4080-9e96-4f4bfce9089f", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"3215708D-ddAA-Cbab-2dCF-83Ca19a4Dbe8\",\n \"zone_id\": \"69883A25-E3A8-EBab-779F-f8A9e4B2Fa5B\",\n \"frame_id\": \"DbBc5F12-BBAd-6B0d-35b9-DD79A1E1Ec0E\"\n },\n \"column\": {\n \"column_id\": \"GnwgyuN6SQCt543OqIeEIh9X-JTGFmUFtAtnp9QSjfBnOES_KG6Qq4b17xEEmD-_gWN747RZhLyjpzaMVrwm4_tvl7cK9QswJCfoVJ5ryBUPp0hUtzSjjoobkNWunFfYaGWlgdwN\"\n },\n \"set_constraints\": {\n \"unique\": true,\n \"required\": true\n },\n \"retype\": {\n \"new_type\": \"MULTI_SELECT\"\n },\n \"rename\": \"ⁱ\",\n \"set_options\": {\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"set_default\": {\n \"value\": {\n \"date\": {\n \"value\": \"\"\n },\n \"select\": {\n \"value\": \"\"\n },\n \"rating\": {\n \"value\": \"\"\n },\n \"toggle\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"multi_select\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"person\": {\n \"value\": \"\"\n },\n \"checkbox\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "454e5e2d-2b67-4d48-ab13-725052775ce3", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"3215708D-ddAA-Cbab-2dCF-83Ca19a4Dbe8\",\n \"zone_id\": \"69883A25-E3A8-EBab-779F-f8A9e4B2Fa5B\",\n \"frame_id\": \"DbBc5F12-BBAd-6B0d-35b9-DD79A1E1Ec0E\"\n },\n \"column\": {\n \"column_id\": \"GnwgyuN6SQCt543OqIeEIh9X-JTGFmUFtAtnp9QSjfBnOES_KG6Qq4b17xEEmD-_gWN747RZhLyjpzaMVrwm4_tvl7cK9QswJCfoVJ5ryBUPp0hUtzSjjoobkNWunFfYaGWlgdwN\"\n },\n \"set_constraints\": {\n \"unique\": true,\n \"required\": true\n },\n \"retype\": {\n \"new_type\": \"MULTI_SELECT\"\n },\n \"rename\": \"ⁱ\",\n \"set_options\": {\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"set_default\": {\n \"value\": {\n \"date\": {\n \"value\": \"\"\n },\n \"select\": {\n \"value\": \"\"\n },\n \"rating\": {\n \"value\": \"\"\n },\n \"toggle\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"multi_select\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"person\": {\n \"value\": \"\"\n },\n \"checkbox\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f610d5ff-97be-4bb6-8381-46275b8c6158", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"3215708D-ddAA-Cbab-2dCF-83Ca19a4Dbe8\",\n \"zone_id\": \"69883A25-E3A8-EBab-779F-f8A9e4B2Fa5B\",\n \"frame_id\": \"DbBc5F12-BBAd-6B0d-35b9-DD79A1E1Ec0E\"\n },\n \"column\": {\n \"column_id\": \"GnwgyuN6SQCt543OqIeEIh9X-JTGFmUFtAtnp9QSjfBnOES_KG6Qq4b17xEEmD-_gWN747RZhLyjpzaMVrwm4_tvl7cK9QswJCfoVJ5ryBUPp0hUtzSjjoobkNWunFfYaGWlgdwN\"\n },\n \"set_constraints\": {\n \"unique\": true,\n \"required\": true\n },\n \"retype\": {\n \"new_type\": \"MULTI_SELECT\"\n },\n \"rename\": \"ⁱ\",\n \"set_options\": {\n \"options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"set_default\": {\n \"value\": {\n \"date\": {\n \"value\": \"\"\n },\n \"select\": {\n \"value\": \"\"\n },\n \"rating\": {\n \"value\": \"\"\n },\n \"toggle\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"multi_select\": {\n \"value\": \"\"\n },\n \"phone\": {\n \"value\": \"\"\n },\n \"person\": {\n \"value\": \"\"\n },\n \"checkbox\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"category\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f0a0d9f-76f6-464b-b76c-cc67eaa0702a", "name": "Query database_table rows, or group and aggregate, in one call", "request": { "name": "Query database_table rows, or group and aggregate, in one call", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"76FABcFe-EAbA-dB31-98DA-Fd6A4Ec9F4Cb\",\n \"zone_id\": \"df6f89cf-Af5f-6E8B-3c26-E5B0BabaBBAF\",\n \"frame_id\": \"88fb249D-6611-c2Be-7E6D-D5Cfb2CEdC0b\"\n },\n \"query\": {\n \"filter\": {\n \"mode\": {\n \"value\": \"\"\n },\n \"conditions\": {\n \"value\": \"\"\n }\n },\n \"page\": {\n \"offset\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n }\n },\n \"rows\": {\n \"columns\": {\n \"value\": \"\"\n },\n \"sort\": {\n \"value\": \"\"\n }\n },\n \"aggregate\": {\n \"having\": {\n \"value\": \"\"\n },\n \"group_by\": {\n \"value\": \"\"\n },\n \"sort\": {\n \"value\": \"\"\n },\n \"aggregations\": {\n \"value\": \"\"\n },\n \"include_record_ids\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "30f42eba-b5d9-4ffb-a720-e760478f1224", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"76FABcFe-EAbA-dB31-98DA-Fd6A4Ec9F4Cb\",\n \"zone_id\": \"df6f89cf-Af5f-6E8B-3c26-E5B0BabaBBAF\",\n \"frame_id\": \"88fb249D-6611-c2Be-7E6D-D5Cfb2CEdC0b\"\n },\n \"query\": {\n \"filter\": {\n \"mode\": {\n \"value\": \"\"\n },\n \"conditions\": {\n \"value\": \"\"\n }\n },\n \"page\": {\n \"offset\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n }\n },\n \"rows\": {\n \"columns\": {\n \"value\": \"\"\n },\n \"sort\": {\n \"value\": \"\"\n }\n },\n \"aggregate\": {\n \"having\": {\n \"value\": \"\"\n },\n \"group_by\": {\n \"value\": \"\"\n },\n \"sort\": {\n \"value\": \"\"\n },\n \"aggregations\": {\n \"value\": \"\"\n },\n \"include_record_ids\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb320633-71ef-4ff1-80f3-6f6282fa23ac", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"76FABcFe-EAbA-dB31-98DA-Fd6A4Ec9F4Cb\",\n \"zone_id\": \"df6f89cf-Af5f-6E8B-3c26-E5B0BabaBBAF\",\n \"frame_id\": \"88fb249D-6611-c2Be-7E6D-D5Cfb2CEdC0b\"\n },\n \"query\": {\n \"filter\": {\n \"mode\": {\n \"value\": \"\"\n },\n \"conditions\": {\n \"value\": \"\"\n }\n },\n \"page\": {\n \"offset\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n }\n },\n \"rows\": {\n \"columns\": {\n \"value\": \"\"\n },\n \"sort\": {\n \"value\": \"\"\n }\n },\n \"aggregate\": {\n \"having\": {\n \"value\": \"\"\n },\n \"group_by\": {\n \"value\": \"\"\n },\n \"sort\": {\n \"value\": \"\"\n },\n \"aggregations\": {\n \"value\": \"\"\n },\n \"include_record_ids\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2cf72f1-eb01-4264-857d-7c26b50d0f59", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"76FABcFe-EAbA-dB31-98DA-Fd6A4Ec9F4Cb\",\n \"zone_id\": \"df6f89cf-Af5f-6E8B-3c26-E5B0BabaBBAF\",\n \"frame_id\": \"88fb249D-6611-c2Be-7E6D-D5Cfb2CEdC0b\"\n },\n \"query\": {\n \"filter\": {\n \"mode\": {\n \"value\": \"\"\n },\n \"conditions\": {\n \"value\": \"\"\n }\n },\n \"page\": {\n \"offset\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n }\n },\n \"rows\": {\n \"columns\": {\n \"value\": \"\"\n },\n \"sort\": {\n \"value\": \"\"\n }\n },\n \"aggregate\": {\n \"having\": {\n \"value\": \"\"\n },\n \"group_by\": {\n \"value\": \"\"\n },\n \"sort\": {\n \"value\": \"\"\n },\n \"aggregations\": {\n \"value\": \"\"\n },\n \"include_record_ids\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de6465a1-4d41-46bc-8e95-bb9c4e428fbb", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"76FABcFe-EAbA-dB31-98DA-Fd6A4Ec9F4Cb\",\n \"zone_id\": \"df6f89cf-Af5f-6E8B-3c26-E5B0BabaBBAF\",\n \"frame_id\": \"88fb249D-6611-c2Be-7E6D-D5Cfb2CEdC0b\"\n },\n \"query\": {\n \"filter\": {\n \"mode\": {\n \"value\": \"\"\n },\n \"conditions\": {\n \"value\": \"\"\n }\n },\n \"page\": {\n \"offset\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n }\n },\n \"rows\": {\n \"columns\": {\n \"value\": \"\"\n },\n \"sort\": {\n \"value\": \"\"\n }\n },\n \"aggregate\": {\n \"having\": {\n \"value\": \"\"\n },\n \"group_by\": {\n \"value\": \"\"\n },\n \"sort\": {\n \"value\": \"\"\n },\n \"aggregations\": {\n \"value\": \"\"\n },\n \"include_record_ids\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55432338-2141-405b-a3d6-faa3dcdb5173", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"76FABcFe-EAbA-dB31-98DA-Fd6A4Ec9F4Cb\",\n \"zone_id\": \"df6f89cf-Af5f-6E8B-3c26-E5B0BabaBBAF\",\n \"frame_id\": \"88fb249D-6611-c2Be-7E6D-D5Cfb2CEdC0b\"\n },\n \"query\": {\n \"filter\": {\n \"mode\": {\n \"value\": \"\"\n },\n \"conditions\": {\n \"value\": \"\"\n }\n },\n \"page\": {\n \"offset\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n }\n },\n \"rows\": {\n \"columns\": {\n \"value\": \"\"\n },\n \"sort\": {\n \"value\": \"\"\n }\n },\n \"aggregate\": {\n \"having\": {\n \"value\": \"\"\n },\n \"group_by\": {\n \"value\": \"\"\n },\n \"sort\": {\n \"value\": \"\"\n },\n \"aggregations\": {\n \"value\": \"\"\n },\n \"include_record_ids\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8b95837-68d5-4440-8281-2c2cfaa77917", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "query" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"76FABcFe-EAbA-dB31-98DA-Fd6A4Ec9F4Cb\",\n \"zone_id\": \"df6f89cf-Af5f-6E8B-3c26-E5B0BabaBBAF\",\n \"frame_id\": \"88fb249D-6611-c2Be-7E6D-D5Cfb2CEdC0b\"\n },\n \"query\": {\n \"filter\": {\n \"mode\": {\n \"value\": \"\"\n },\n \"conditions\": {\n \"value\": \"\"\n }\n },\n \"page\": {\n \"offset\": {\n \"value\": \"\"\n },\n \"limit\": {\n \"value\": \"\"\n }\n },\n \"rows\": {\n \"columns\": {\n \"value\": \"\"\n },\n \"sort\": {\n \"value\": \"\"\n }\n },\n \"aggregate\": {\n \"having\": {\n \"value\": \"\"\n },\n \"group_by\": {\n \"value\": \"\"\n },\n \"sort\": {\n \"value\": \"\"\n },\n \"aggregations\": {\n \"value\": \"\"\n },\n \"include_record_ids\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0c15566e-fc0b-4a61-b8eb-18a9322f8e48", "name": "Append a record from keyed cell assignments (partial allowed)", "request": { "name": "Append a record from keyed cell assignments (partial allowed)", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"43c5c4fA-b6E7-3A50-E49B-ff5e8Cf3916b\",\n \"zone_id\": \"4CbfDfC2-708D-C1fC-c8Af-Dfa09fAfdddf\",\n \"frame_id\": \"d9Ac3bAf-4CCF-BB95-11FD-565ED949E720\"\n },\n \"cells\": [\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4dd0c64f-7fd9-4f36-8694-889f1488f9e9", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"43c5c4fA-b6E7-3A50-E49B-ff5e8Cf3916b\",\n \"zone_id\": \"4CbfDfC2-708D-C1fC-c8Af-Dfa09fAfdddf\",\n \"frame_id\": \"d9Ac3bAf-4CCF-BB95-11FD-565ED949E720\"\n },\n \"cells\": [\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33dedd84-2107-4e31-a989-e43b678ed1ae", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"43c5c4fA-b6E7-3A50-E49B-ff5e8Cf3916b\",\n \"zone_id\": \"4CbfDfC2-708D-C1fC-c8Af-Dfa09fAfdddf\",\n \"frame_id\": \"d9Ac3bAf-4CCF-BB95-11FD-565ED949E720\"\n },\n \"cells\": [\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa525e48-7ccf-4324-8e8f-2fcc17575bee", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"43c5c4fA-b6E7-3A50-E49B-ff5e8Cf3916b\",\n \"zone_id\": \"4CbfDfC2-708D-C1fC-c8Af-Dfa09fAfdddf\",\n \"frame_id\": \"d9Ac3bAf-4CCF-BB95-11FD-565ED949E720\"\n },\n \"cells\": [\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d02ce6c5-5d3c-456b-b72c-dd10da2c7fca", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"43c5c4fA-b6E7-3A50-E49B-ff5e8Cf3916b\",\n \"zone_id\": \"4CbfDfC2-708D-C1fC-c8Af-Dfa09fAfdddf\",\n \"frame_id\": \"d9Ac3bAf-4CCF-BB95-11FD-565ED949E720\"\n },\n \"cells\": [\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5c89245-8811-40fc-a309-f5587856e179", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"43c5c4fA-b6E7-3A50-E49B-ff5e8Cf3916b\",\n \"zone_id\": \"4CbfDfC2-708D-C1fC-c8Af-Dfa09fAfdddf\",\n \"frame_id\": \"d9Ac3bAf-4CCF-BB95-11FD-565ED949E720\"\n },\n \"cells\": [\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f45c5551-e9e6-4b12-93c8-ad410237f8dd", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"43c5c4fA-b6E7-3A50-E49B-ff5e8Cf3916b\",\n \"zone_id\": \"4CbfDfC2-708D-C1fC-c8Af-Dfa09fAfdddf\",\n \"frame_id\": \"d9Ac3bAf-4CCF-BB95-11FD-565ED949E720\"\n },\n \"cells\": [\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n },\n {\n \"column_id\": {\n \"value\": \"\"\n },\n \"column\": {\n \"value\": \"\"\n },\n \"clear\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eddeb8a3-e989-4a0c-b31a-c490dbcf70b5", "name": "Delete a column (and its cells across all rows)", "request": { "name": "Delete a column (and its cells across all rows)", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"DeF67E2F-DfaE-Cd2E-14d0-E9AC030fbdcD\",\n \"zone_id\": \"f2c98Fa4-4ECD-8Cd6-3Ecf-44aa4e09f5E3\",\n \"frame_id\": \"3ffeb9Ac-FBc5-17d8-aBaA-Ce6453fB06FD\"\n },\n \"column\": {\n \"column_id\": \"Axko1ssn7qE1UZvrxIMP\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "da452b3f-c0a6-407a-a099-8f7484b58c06", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"DeF67E2F-DfaE-Cd2E-14d0-E9AC030fbdcD\",\n \"zone_id\": \"f2c98Fa4-4ECD-8Cd6-3Ecf-44aa4e09f5E3\",\n \"frame_id\": \"3ffeb9Ac-FBc5-17d8-aBaA-Ce6453fB06FD\"\n },\n \"column\": {\n \"column_id\": \"Axko1ssn7qE1UZvrxIMP\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f94fed81-f0d6-41f8-b8fb-8fa762dff140", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"DeF67E2F-DfaE-Cd2E-14d0-E9AC030fbdcD\",\n \"zone_id\": \"f2c98Fa4-4ECD-8Cd6-3Ecf-44aa4e09f5E3\",\n \"frame_id\": \"3ffeb9Ac-FBc5-17d8-aBaA-Ce6453fB06FD\"\n },\n \"column\": {\n \"column_id\": \"Axko1ssn7qE1UZvrxIMP\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3c1e64b-be95-4652-b6d6-bca09497cdf5", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"DeF67E2F-DfaE-Cd2E-14d0-E9AC030fbdcD\",\n \"zone_id\": \"f2c98Fa4-4ECD-8Cd6-3Ecf-44aa4e09f5E3\",\n \"frame_id\": \"3ffeb9Ac-FBc5-17d8-aBaA-Ce6453fB06FD\"\n },\n \"column\": {\n \"column_id\": \"Axko1ssn7qE1UZvrxIMP\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "603ce23b-196b-41fd-a081-1663c84ad551", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"DeF67E2F-DfaE-Cd2E-14d0-E9AC030fbdcD\",\n \"zone_id\": \"f2c98Fa4-4ECD-8Cd6-3Ecf-44aa4e09f5E3\",\n \"frame_id\": \"3ffeb9Ac-FBc5-17d8-aBaA-Ce6453fB06FD\"\n },\n \"column\": {\n \"column_id\": \"Axko1ssn7qE1UZvrxIMP\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4af4b440-4d2e-40b9-b3aa-2431df6b019f", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"DeF67E2F-DfaE-Cd2E-14d0-E9AC030fbdcD\",\n \"zone_id\": \"f2c98Fa4-4ECD-8Cd6-3Ecf-44aa4e09f5E3\",\n \"frame_id\": \"3ffeb9Ac-FBc5-17d8-aBaA-Ce6453fB06FD\"\n },\n \"column\": {\n \"column_id\": \"Axko1ssn7qE1UZvrxIMP\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0acd176-2436-4047-8840-e44eace7000f", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "columns", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"table\": {\n \"object_id\": \"DeF67E2F-DfaE-Cd2E-14d0-E9AC030fbdcD\",\n \"zone_id\": \"f2c98Fa4-4ECD-8Cd6-3Ecf-44aa4e09f5E3\",\n \"frame_id\": \"3ffeb9Ac-FBc5-17d8-aBaA-Ce6453fB06FD\"\n },\n \"column\": {\n \"column_id\": \"Axko1ssn7qE1UZvrxIMP\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d991700-3d8f-46b0-bade-96ce5906e082", "name": "Read database_table column schema (id, type, name, option lists) and row count", "request": { "name": "Read database_table column schema (id, type, name, option lists) and row count", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "schema" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "object_id", "value": "jeep5LLz", "description": "(Required) Database table object id (mint-time UUID)" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "42036ef1-a9a2-4a62-903d-19cbef19c4ba", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "schema" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "object_id", "value": "jeep5LLz" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80b48f68-0c1b-4669-a8bc-efaf73757cc8", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "schema" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "object_id", "value": "jeep5LLz" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab22f5ee-5351-439c-a270-f0d364e6d7f3", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "schema" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "object_id", "value": "jeep5LLz" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd12e3ff-cf57-4404-9a9a-2e0c662883db", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "schema" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "object_id", "value": "jeep5LLz" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cf41f1c-f376-4869-946f-6f3924d10333", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "schema" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "object_id", "value": "jeep5LLz" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ece79be-d0e4-435a-9c16-abbba9dff24f", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "database-table", "schema" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "object_id", "value": "jeep5LLz" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "60e4bad4-189f-4bd4-bd8b-1f0aac05c626", "name": "Text", "description": { "content": "Mutate and style text on any text-bearing object.", "type": "text/plain" }, "item": [ { "id": "e217a52a-96d1-4b26-889d-e0a148236ad9", "name": "Canonical text mutation API for replace/insert/delete/split/merge operations", "request": { "name": "Canonical text mutation API for replace/insert/delete/split/merge operations", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "edit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"object\": {\n \"zone_id\": \"DBDBccf3-1b3b-E9bC-d586-F7e4eBFef6a0\",\n \"object_id\": \"7ae4F89a-0e9e-Bda5-9ac5-88F57Aa9E0CA\",\n \"frame_id\": \"a5B79cE0-Bd0c-e5F0-D68b-E436C7Fc148F\"\n },\n \"payload\": {\n \"cursor\": {\n \"cursor_index\": {\n \"value\": \"\"\n },\n \"operation\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n }\n },\n \"all_text\": {\n \"operation\": {\n \"value\": \"\"\n },\n \"replacement_text\": {\n \"value\": \"\"\n }\n },\n \"range\": {\n \"range\": {\n \"value\": \"\"\n },\n \"operation\": {\n \"value\": \"\"\n },\n \"replacement_text\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "17707347-9a8b-40b6-b36a-a620c0dc82fa", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "edit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"object\": {\n \"zone_id\": \"DBDBccf3-1b3b-E9bC-d586-F7e4eBFef6a0\",\n \"object_id\": \"7ae4F89a-0e9e-Bda5-9ac5-88F57Aa9E0CA\",\n \"frame_id\": \"a5B79cE0-Bd0c-e5F0-D68b-E436C7Fc148F\"\n },\n \"payload\": {\n \"cursor\": {\n \"cursor_index\": {\n \"value\": \"\"\n },\n \"operation\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n }\n },\n \"all_text\": {\n \"operation\": {\n \"value\": \"\"\n },\n \"replacement_text\": {\n \"value\": \"\"\n }\n },\n \"range\": {\n \"range\": {\n \"value\": \"\"\n },\n \"operation\": {\n \"value\": \"\"\n },\n \"replacement_text\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d35763a-0855-443d-8a26-7fb79afd20d7", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "edit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"object\": {\n \"zone_id\": \"DBDBccf3-1b3b-E9bC-d586-F7e4eBFef6a0\",\n \"object_id\": \"7ae4F89a-0e9e-Bda5-9ac5-88F57Aa9E0CA\",\n \"frame_id\": \"a5B79cE0-Bd0c-e5F0-D68b-E436C7Fc148F\"\n },\n \"payload\": {\n \"cursor\": {\n \"cursor_index\": {\n \"value\": \"\"\n },\n \"operation\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n }\n },\n \"all_text\": {\n \"operation\": {\n \"value\": \"\"\n },\n \"replacement_text\": {\n \"value\": \"\"\n }\n },\n \"range\": {\n \"range\": {\n \"value\": \"\"\n },\n \"operation\": {\n \"value\": \"\"\n },\n \"replacement_text\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04da36d5-75d3-4b66-9886-88e217475cb5", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "edit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"object\": {\n \"zone_id\": \"DBDBccf3-1b3b-E9bC-d586-F7e4eBFef6a0\",\n \"object_id\": \"7ae4F89a-0e9e-Bda5-9ac5-88F57Aa9E0CA\",\n \"frame_id\": \"a5B79cE0-Bd0c-e5F0-D68b-E436C7Fc148F\"\n },\n \"payload\": {\n \"cursor\": {\n \"cursor_index\": {\n \"value\": \"\"\n },\n \"operation\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n }\n },\n \"all_text\": {\n \"operation\": {\n \"value\": \"\"\n },\n \"replacement_text\": {\n \"value\": \"\"\n }\n },\n \"range\": {\n \"range\": {\n \"value\": \"\"\n },\n \"operation\": {\n \"value\": \"\"\n },\n \"replacement_text\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d898580d-3861-46e9-9319-888531214972", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "edit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"object\": {\n \"zone_id\": \"DBDBccf3-1b3b-E9bC-d586-F7e4eBFef6a0\",\n \"object_id\": \"7ae4F89a-0e9e-Bda5-9ac5-88F57Aa9E0CA\",\n \"frame_id\": \"a5B79cE0-Bd0c-e5F0-D68b-E436C7Fc148F\"\n },\n \"payload\": {\n \"cursor\": {\n \"cursor_index\": {\n \"value\": \"\"\n },\n \"operation\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n }\n },\n \"all_text\": {\n \"operation\": {\n \"value\": \"\"\n },\n \"replacement_text\": {\n \"value\": \"\"\n }\n },\n \"range\": {\n \"range\": {\n \"value\": \"\"\n },\n \"operation\": {\n \"value\": \"\"\n },\n \"replacement_text\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "251988d8-88ec-49c1-b606-425db52fad84", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "edit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"object\": {\n \"zone_id\": \"DBDBccf3-1b3b-E9bC-d586-F7e4eBFef6a0\",\n \"object_id\": \"7ae4F89a-0e9e-Bda5-9ac5-88F57Aa9E0CA\",\n \"frame_id\": \"a5B79cE0-Bd0c-e5F0-D68b-E436C7Fc148F\"\n },\n \"payload\": {\n \"cursor\": {\n \"cursor_index\": {\n \"value\": \"\"\n },\n \"operation\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n }\n },\n \"all_text\": {\n \"operation\": {\n \"value\": \"\"\n },\n \"replacement_text\": {\n \"value\": \"\"\n }\n },\n \"range\": {\n \"range\": {\n \"value\": \"\"\n },\n \"operation\": {\n \"value\": \"\"\n },\n \"replacement_text\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c4686bf-36b4-4313-ab56-1d04aabaa2a4", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "edit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"object\": {\n \"zone_id\": \"DBDBccf3-1b3b-E9bC-d586-F7e4eBFef6a0\",\n \"object_id\": \"7ae4F89a-0e9e-Bda5-9ac5-88F57Aa9E0CA\",\n \"frame_id\": \"a5B79cE0-Bd0c-e5F0-D68b-E436C7Fc148F\"\n },\n \"payload\": {\n \"cursor\": {\n \"cursor_index\": {\n \"value\": \"\"\n },\n \"operation\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n }\n },\n \"all_text\": {\n \"operation\": {\n \"value\": \"\"\n },\n \"replacement_text\": {\n \"value\": \"\"\n }\n },\n \"range\": {\n \"range\": {\n \"value\": \"\"\n },\n \"operation\": {\n \"value\": \"\"\n },\n \"replacement_text\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6b7a553-ea60-40f8-be6c-57912d8d36da", "name": "Apply portion and or paragraph style to selected text scope", "request": { "name": "Apply portion and or paragraph style to selected text scope", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "style" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"object\": {\n \"zone_id\": \"2f0b6D2a-Db38-eE9c-F9B8-B7C69D916B60\",\n \"object_id\": \"d4Fc148F-622C-35AA-aFD2-c1beEBf15Aff\",\n \"frame_id\": \"6dc0973b-6005-78fE-1b44-d8dA4a42e63F\"\n },\n \"payload\": {\n \"all_text\": false,\n \"portion_style\": {\n \"fontweight\": {\n \"value\": \"\"\n },\n \"size\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"underline\": {\n \"value\": \"\"\n },\n \"strike\": {\n \"value\": \"\"\n },\n \"italic\": {\n \"value\": \"\"\n },\n \"font_name\": {\n \"value\": \"\"\n }\n },\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n },\n \"paragraph_style\": {\n \"spacing\": {\n \"value\": \"\"\n },\n \"level\": {\n \"value\": \"\"\n },\n \"halign\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5b6ebea5-b253-4b8e-b6fc-e32a33c9d0e9", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "style" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"object\": {\n \"zone_id\": \"2f0b6D2a-Db38-eE9c-F9B8-B7C69D916B60\",\n \"object_id\": \"d4Fc148F-622C-35AA-aFD2-c1beEBf15Aff\",\n \"frame_id\": \"6dc0973b-6005-78fE-1b44-d8dA4a42e63F\"\n },\n \"payload\": {\n \"all_text\": false,\n \"portion_style\": {\n \"fontweight\": {\n \"value\": \"\"\n },\n \"size\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"underline\": {\n \"value\": \"\"\n },\n \"strike\": {\n \"value\": \"\"\n },\n \"italic\": {\n \"value\": \"\"\n },\n \"font_name\": {\n \"value\": \"\"\n }\n },\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n },\n \"paragraph_style\": {\n \"spacing\": {\n \"value\": \"\"\n },\n \"level\": {\n \"value\": \"\"\n },\n \"halign\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1544ed7-55c3-48c7-8229-f5807b65e82b", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "style" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"object\": {\n \"zone_id\": \"2f0b6D2a-Db38-eE9c-F9B8-B7C69D916B60\",\n \"object_id\": \"d4Fc148F-622C-35AA-aFD2-c1beEBf15Aff\",\n \"frame_id\": \"6dc0973b-6005-78fE-1b44-d8dA4a42e63F\"\n },\n \"payload\": {\n \"all_text\": false,\n \"portion_style\": {\n \"fontweight\": {\n \"value\": \"\"\n },\n \"size\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"underline\": {\n \"value\": \"\"\n },\n \"strike\": {\n \"value\": \"\"\n },\n \"italic\": {\n \"value\": \"\"\n },\n \"font_name\": {\n \"value\": \"\"\n }\n },\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n },\n \"paragraph_style\": {\n \"spacing\": {\n \"value\": \"\"\n },\n \"level\": {\n \"value\": \"\"\n },\n \"halign\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ada7766c-4ffe-4fbc-9223-aba5b2b09cc9", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "style" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"object\": {\n \"zone_id\": \"2f0b6D2a-Db38-eE9c-F9B8-B7C69D916B60\",\n \"object_id\": \"d4Fc148F-622C-35AA-aFD2-c1beEBf15Aff\",\n \"frame_id\": \"6dc0973b-6005-78fE-1b44-d8dA4a42e63F\"\n },\n \"payload\": {\n \"all_text\": false,\n \"portion_style\": {\n \"fontweight\": {\n \"value\": \"\"\n },\n \"size\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"underline\": {\n \"value\": \"\"\n },\n \"strike\": {\n \"value\": \"\"\n },\n \"italic\": {\n \"value\": \"\"\n },\n \"font_name\": {\n \"value\": \"\"\n }\n },\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n },\n \"paragraph_style\": {\n \"spacing\": {\n \"value\": \"\"\n },\n \"level\": {\n \"value\": \"\"\n },\n \"halign\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59d91740-3344-4677-b2b7-da95c83111ed", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "style" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"object\": {\n \"zone_id\": \"2f0b6D2a-Db38-eE9c-F9B8-B7C69D916B60\",\n \"object_id\": \"d4Fc148F-622C-35AA-aFD2-c1beEBf15Aff\",\n \"frame_id\": \"6dc0973b-6005-78fE-1b44-d8dA4a42e63F\"\n },\n \"payload\": {\n \"all_text\": false,\n \"portion_style\": {\n \"fontweight\": {\n \"value\": \"\"\n },\n \"size\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"underline\": {\n \"value\": \"\"\n },\n \"strike\": {\n \"value\": \"\"\n },\n \"italic\": {\n \"value\": \"\"\n },\n \"font_name\": {\n \"value\": \"\"\n }\n },\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n },\n \"paragraph_style\": {\n \"spacing\": {\n \"value\": \"\"\n },\n \"level\": {\n \"value\": \"\"\n },\n \"halign\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "020740f4-526e-497a-a404-54748d17064b", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "style" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"object\": {\n \"zone_id\": \"2f0b6D2a-Db38-eE9c-F9B8-B7C69D916B60\",\n \"object_id\": \"d4Fc148F-622C-35AA-aFD2-c1beEBf15Aff\",\n \"frame_id\": \"6dc0973b-6005-78fE-1b44-d8dA4a42e63F\"\n },\n \"payload\": {\n \"all_text\": false,\n \"portion_style\": {\n \"fontweight\": {\n \"value\": \"\"\n },\n \"size\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"underline\": {\n \"value\": \"\"\n },\n \"strike\": {\n \"value\": \"\"\n },\n \"italic\": {\n \"value\": \"\"\n },\n \"font_name\": {\n \"value\": \"\"\n }\n },\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n },\n \"paragraph_style\": {\n \"spacing\": {\n \"value\": \"\"\n },\n \"level\": {\n \"value\": \"\"\n },\n \"halign\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58af806a-4470-43f8-8dfc-2c46d749adfb", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "zones", ":zone_id", "text", "style" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "disabled": false, "type": "any", "value": "string", "key": "zone_id", "description": "(Required) The unique identifier of the zone" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"object\": {\n \"zone_id\": \"2f0b6D2a-Db38-eE9c-F9B8-B7C69D916B60\",\n \"object_id\": \"d4Fc148F-622C-35AA-aFD2-c1beEBf15Aff\",\n \"frame_id\": \"6dc0973b-6005-78fE-1b44-d8dA4a42e63F\"\n },\n \"payload\": {\n \"all_text\": false,\n \"portion_style\": {\n \"fontweight\": {\n \"value\": \"\"\n },\n \"size\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"underline\": {\n \"value\": \"\"\n },\n \"strike\": {\n \"value\": \"\"\n },\n \"italic\": {\n \"value\": \"\"\n },\n \"font_name\": {\n \"value\": \"\"\n }\n },\n \"range\": {\n \"start_index\": {\n \"value\": \"\"\n },\n \"end_index\": {\n \"value\": \"\"\n }\n },\n \"paragraph_style\": {\n \"spacing\": {\n \"value\": \"\"\n },\n \"level\": {\n \"value\": \"\"\n },\n \"halign\": {\n \"value\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "09732ca3-c776-4b87-a121-9ee7d8ff933f", "name": "Data", "description": { "content": "Batch get, list, and update zones, frames, zone-slots, and objects.", "type": "text/plain" }, "item": [ { "id": "9202e456-ff5f-4772-b11b-f7caa8c0fd3b", "name": "List zones, frames, zone-slots or objects", "request": { "name": "List zones, frames, zone-slots or objects", "description": { "content": "Lists data entities with optional pagination. Accepts either a single `operation` or an `operations` array for a batch request.", "type": "text/plain" }, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "revision_id", "value": "-453830745", "description": "Optional: specific revision to fetch; latest if empty" }, { "disabled": false, "key": "operation", "value": "string", "description": "JSON-encoded single ListOperation document: {operation_id?, list_zones:{start_index?, max_results?, page_token?} | list_frames:{zone_id, start_index?, max_results?, page_token?} | list_zone_slots:{zone_id, start_index?, max_results?, page_token?} | list_objects:{container:{zone:{zone_id} | frame:{zone_id, frame_id}}, start_index?, max_results?, page_token?}}. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." }, { "disabled": false, "key": "operations", "value": "string", "description": "`operations` — JSON-encoded array of ListOperation documents for a batch request. Each element follows the same structure as the single operation param. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "96abd0bb-afbf-4a77-9fb3-3bb7dddf33ed", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "revision_id", "value": "-453830745" }, { "key": "operation", "value": "string" }, { "key": "operations", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0228a30-0c2f-42ed-93e2-37a668787f25", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "revision_id", "value": "-453830745" }, { "key": "operation", "value": "string" }, { "key": "operations", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "453a4dbe-78c7-44f8-88da-4c5c95bd38c7", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "revision_id", "value": "-453830745" }, { "key": "operation", "value": "string" }, { "key": "operations", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46577ff2-83d2-45d7-9240-72cf7a272ee0", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "revision_id", "value": "-453830745" }, { "key": "operation", "value": "string" }, { "key": "operations", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b20270f-6070-4e1f-abf8-a4ac6cff722a", "name": "Rate limit exceeded - this operation allows 120 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "revision_id", "value": "-453830745" }, { "key": "operation", "value": "string" }, { "key": "operations", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b32bbd1-dc9a-48d5-bb26-9af4df7fc065", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "revision_id", "value": "-453830745" }, { "key": "operation", "value": "string" }, { "key": "operations", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b18e3e3-7210-42e6-a20d-411bd7385e3d", "name": "Apply a single deterministic mutation operation to a Space", "request": { "name": "Apply a single deterministic mutation operation to a Space", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"operation\": \"string\",\n \"base_revision_id\": \"string\",\n \"space_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "df6f2c43-1099-4fae-a244-efb28e10fef6", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operation\": \"string\",\n \"base_revision_id\": \"string\",\n \"space_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1260fbb-8ed2-4fd0-b38c-6dd6d496861e", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operation\": \"string\",\n \"base_revision_id\": \"string\",\n \"space_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ef6c070-600c-4f43-8894-1407716f9082", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operation\": \"string\",\n \"base_revision_id\": \"string\",\n \"space_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09e8da0f-e31b-4d1e-9c8c-95d28d8bd8ae", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operation\": \"string\",\n \"base_revision_id\": \"string\",\n \"space_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bf1fbbd-d669-4659-8135-dc806a2be6de", "name": "Rate limit exceeded - this operation allows 60 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operation\": \"string\",\n \"base_revision_id\": \"string\",\n \"space_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0770c0ae-223e-4778-86be-3f8749cc2351", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operation\": \"string\",\n \"base_revision_id\": \"string\",\n \"space_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b5503378-3390-48e6-aebe-fd4fa659c318", "name": "Get zones, frames, objects, facets or zone-slots", "request": { "name": "Get zones, frames, objects, facets or zone-slots", "description": { "content": "Reads one or more data entities \\u2014 zone, frame, object, object facet, space or zone-slot \\u2014 through a structured operation. Accepts either a single `operation` or an `operations` array for a batch request.", "type": "text/plain" }, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "revision_id", "value": "-453830745", "description": "Optional: specific revision to fetch; latest if empty" }, { "disabled": false, "key": "operation", "value": "string", "description": "JSON-encoded single GetOperation document: {operation_id?, get_space:{} | get_zone:{zone_id} | get_frame:{zone_id, frame_id} | get_zone_slot:{zone_slot:{zone_id, index}} | get_object:{object:{zone_object:{zone_id, object_id} | frame_object:{zone_id, frame_id, object_id}}} | get_object_facet:{object:{...}, facet_type}}. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." }, { "disabled": false, "key": "operations", "value": "string", "description": "`operations` — JSON-encoded array of GetOperation documents for a batch request. Each element follows the same structure as the single operation param. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "0a4ccd79-66f3-4b32-9011-897342b5c624", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "revision_id", "value": "-453830745" }, { "key": "operation", "value": "string" }, { "key": "operations", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"request_uri\": {\n \"value\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c9ad3fe-2f4d-496a-ae07-53872aa56f48", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "revision_id", "value": "-453830745" }, { "key": "operation", "value": "string" }, { "key": "operations", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5759aa22-7645-4f81-abb7-a9fff348f63c", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "revision_id", "value": "-453830745" }, { "key": "operation", "value": "string" }, { "key": "operations", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8fd2bc1-38f0-4464-9bae-c68c605a724b", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "revision_id", "value": "-453830745" }, { "key": "operation", "value": "string" }, { "key": "operations", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "354056de-459d-4f90-a9ad-60e17cdbb4fe", "name": "Rate limit exceeded - this operation allows 120 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "revision_id", "value": "-453830745" }, { "key": "operation", "value": "string" }, { "key": "operations", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d735a4b-5b4c-4fdd-9aba-bd986676b8d1", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "revision_id", "value": "-453830745" }, { "key": "operation", "value": "string" }, { "key": "operations", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0875031d-a5ed-4e26-af47-8d2c05ad843e", "name": "Apply multiple deterministic mutation operations to a Space in order", "request": { "name": "Apply multiple deterministic mutation operations to a Space in order", "description": {}, "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "batchUpdate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "Vani.teams.UPDATE Vani.spaces.UPDATE Vani.spaces.DELETE Vani.zones.READ Vani.editions.UPDATE Vani.spaces.CREATE Vani.teams.CREATE Vani.spaces.READ Vani.editions.CREATE Vani.zones.CREATE Vani.teams.READ Vani.editions.READ Vani.teams.DELETE" }, { "key": "accessTokenUrl", "value": "https://accounts.zoho.com/oauth/v2/token" }, { "key": "authUrl", "value": "https://accounts.zoho.com/oauth/v2/auth" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"operations\": [\n \"string\"\n ],\n \"apply_mode\": \"BEST_EFFORT\",\n \"base_revision_id\": \"string\",\n \"space_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "95bf6bdb-a663-4fb3-bf00-21bae6464dbd", "name": "Successful response", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "batchUpdate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operations\": [\n \"string\"\n ],\n \"apply_mode\": \"BEST_EFFORT\",\n \"base_revision_id\": \"string\",\n \"space_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"string\",\n \"data\": {},\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f23338a-4250-47f8-915e-2c1360865187", "name": "Invalid request - validation failed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "batchUpdate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operations\": [\n \"string\"\n ],\n \"apply_mode\": \"BEST_EFFORT\",\n \"base_revision_id\": \"string\",\n \"space_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fff4194f-3043-4732-8aa5-273142d61edb", "name": "Unauthorized - missing or invalid access token", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "batchUpdate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operations\": [\n \"string\"\n ],\n \"apply_mode\": \"BEST_EFFORT\",\n \"base_revision_id\": \"string\",\n \"space_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "199d42b2-1cd5-454b-8c00-ded0d2dbeff7", "name": "Not found - a resource named in the path does not exist, or is not visible to the caller", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "batchUpdate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operations\": [\n \"string\"\n ],\n \"apply_mode\": \"BEST_EFFORT\",\n \"base_revision_id\": \"string\",\n \"space_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f79cb39-28c3-4cb5-b99a-318667fbb39c", "name": "Rate limit exceeded - this operation allows 30 requests per minute per user", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "batchUpdate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operations\": [\n \"string\"\n ],\n \"apply_mode\": \"BEST_EFFORT\",\n \"base_revision_id\": \"string\",\n \"space_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5260f2c3-5bfa-4e3d-bbfa-34f7a1388c11", "name": "Internal server error - the request was well-formed but could not be completed", "originalRequest": { "url": { "path": [ "sdk", "v1", "editions", ":edition_id", "spaces", ":space_id", "data", "batchUpdate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "edition_id", "description": "(Required) The unique identifier of the edition" }, { "disabled": false, "type": "any", "value": "string", "key": "space_id", "description": "(Required) The unique identifier of the space" }, { "description": "Data-centre TLD for your edition. (This can only be one of com,in,eu,ca,com.au,sa,ae)", "type": "any", "value": "{{dc}}", "key": "dc" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"operations\": [\n \"string\"\n ],\n \"apply_mode\": \"BEST_EFFORT\",\n \"base_revision_id\": \"string\",\n \"space_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"details\": {\n \"sdk_error_code\": {\n \"value\": \"\"\n },\n \"error_code\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.app.vanihq.{{dc}}", "description": "API host. Change {{dc}} to your edition's data-centre TLD." }, { "key": "dc", "value": "com", "description": "Data-centre TLD for your edition. One of: com, in, eu, ca, com.au, sa, ae." } ], "info": { "_postman_id": "196143a0-31a6-4c95-9827-e0cb52aaa22b", "name": "Vani API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Edition-level resources: the edition itself, its subscription, join requests, and templates." } }