{ "item": [ { "id": "ab7ac8a8-6324-4faf-8433-7b4f62f6abb7", "name": "Relationships", "description": { "content": "Resolve parents, children, ancestors, descendants, and connected objects.", "type": "text/plain" }, "item": [ { "id": "0a2a5589-ce3b-4f14-ba69-017e86cf7abf", "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": "09ef0902-b5da-401f-bc44-ac25948240e3", "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": "84ab1fa4-b8d1-49e1-afda-a769f49c97c5", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9e1d847-64db-452d-8d4c-db6d17d3e844", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9700d3fe-2b55-4fc2-90e5-c3735d57c229", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6725882-20b5-4df4-99f5-d18db5dc4157", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad7c298e-fd4d-445f-83b4-2e4ed24a161f", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8347228d-f90e-4db2-913c-3599791e5424", "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": "7035152e-e04a-4e3b-9353-3d0f591354bd", "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": "4c44ba65-1b72-4d30-88f5-edf90b4c0be8", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12157c0f-213b-4b5d-b829-b05334bc313b", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61ad9436-1588-4463-acf2-5346009a57d3", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c15388a6-5924-4f22-abe5-44041c026a25", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11480ac9-cf62-410e-a555-b8404300b19d", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f23ae68a-c839-421d-b553-274a6a9c5dcc", "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": "8cbacb9f-43de-44bb-a7df-e94a17efb37d", "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": "15a317ab-cf7c-4250-825c-7f0f763362b0", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df561d0c-0e46-4491-8f2c-740df830e562", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef845fec-a99c-4a13-9671-a8900547ff0c", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08b0ea1e-0ac1-4835-ad63-84437dc8334c", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67ce893d-7aa6-4efe-a629-913c2f84c07d", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "daf4c2e6-67fc-41a8-8328-0dee4f5538e4", "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": "e32063b8-76af-4f8d-ab99-a7de0a954d89", "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": "69a44d9c-c217-4e71-806c-f3921623e011", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ad3dcf8-997a-4bbc-8f05-7066f6dc97e7", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b92b980-185a-42d9-8bef-ca142d1b8a9c", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75f62024-5f83-404b-a216-fa36c0aa5786", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b585e990-bcb7-4a2e-9b26-97fe6678d539", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b76d88b9-0cb2-4909-ae88-039ebb6c753e", "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": "0f695dc9-d66f-4a07-9957-7e87c16fc7ff", "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": "d75058b7-bacf-4cfe-9eb6-125e72552697", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de4b9959-be13-48ab-9c32-6ad0411ae078", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b9551c6-f8e2-4dbf-a47f-04a8a2c61d34", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9793130-13e9-47f1-bbd9-c9ff9eb7f65a", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64a272a0-bf79-4976-9711-f6b668674ef9", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c534a51-d687-4355-9c49-d4471d5370fd", "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": "2e4c75ab-69cc-45f2-8e74-9a12921d37f1", "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": "fc12d187-29b7-4fbf-bf84-82288a87a31a", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83844d23-d7cd-4fee-a5ac-05b376f440c1", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93527c2f-2e89-43e3-921a-125243119316", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d912e8de-a127-4a0c-8f65-f33771041d5d", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a22ab8b0-8bae-4764-9385-26144c5e9820", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3370c42-3e8e-447c-ba62-9555a9e9e1b0", "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": "d94ea55f-f1e6-4298-83ef-33a99d744def", "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": "0d0227f9-2d43-417b-becf-3040f9906488", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6fb3551-580a-492e-9c5a-a037bbaccb51", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7842f08-9e16-4d7a-b244-97a6849e5c59", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4da58503-60ea-4434-96d8-99a28401bb1f", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ac4a97e-c2b7-4b47-bdee-166cfcacb219", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3859ecf2-a7bb-42db-aabd-ab6ae211245e", "name": "Traversal", "description": { "content": "Walk the zone in index, sequence, and windowed order.", "type": "text/plain" }, "item": [ { "id": "1550c31f-872f-472f-8197-843addd546bd", "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": "3cd789e3-26b9-45cc-9df5-276d0b58f212", "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\": \"string\",\n \"data\": {\n \"result\": {\n \"index_path\": [\n \"string\",\n \"string\"\n ]\n },\n \"error\": {\n \"code\": \"ZONE_NOT_FOUND\",\n \"message\": \"string\"\n },\n \"effective_scope\": {\n \"scope_type\": \"ZONE_ROOT\"\n }\n },\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab771690-eab8-4d65-b36a-a79091024105", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de3a0939-1312-4016-b93a-e2bc37d48f95", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2edfc0cf-1fcf-4dfb-b6d2-527aeb6ebdd7", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c7cefe4-8d23-4af1-b4a1-aacae8aa5d37", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1480797-0d0f-4032-8210-a0920ff64752", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e986a15b-a515-4302-b7dd-0507bed26aa5", "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": "84b6025f-a20a-4637-be5f-2343e43c5dec", "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\": \"string\",\n \"data\": {\n \"result\": {\n \"objects\": [\n {\n \"zone_id\": \"string\",\n \"object_id\": \"string\",\n \"frame_id\": \"string\"\n },\n {\n \"zone_id\": \"string\",\n \"object_id\": \"string\",\n \"frame_id\": \"string\"\n }\n ]\n },\n \"error\": {\n \"code\": \"OBJECT_NOT_FOUND\",\n \"message\": \"string\"\n }\n },\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36196916-d1d8-47ae-8236-d7dac31d26c1", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f227c090-72af-4696-88a3-90d138c11baf", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f087b4e-14a7-457c-9aba-c166395f8701", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35a9e2f5-e889-48cf-9e73-415a72308f6f", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e24a7428-e3eb-4c83-a4ad-fc87fe9fd02e", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd13badb-0078-4c51-b183-73557929819c", "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": "dc40ca7d-babe-4d23-b478-2bed75b8620f", "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\": \"string\",\n \"data\": {\n \"result\": {\n \"before_objects\": [\n {\n \"zone_id\": \"string\",\n \"object_id\": \"string\",\n \"frame_id\": \"string\"\n },\n {\n \"zone_id\": \"string\",\n \"object_id\": \"string\",\n \"frame_id\": \"string\"\n }\n ],\n \"after_objects\": [\n {\n \"zone_id\": \"string\",\n \"object_id\": \"string\",\n \"frame_id\": \"string\"\n },\n {\n \"zone_id\": \"string\",\n \"object_id\": \"string\",\n \"frame_id\": \"string\"\n }\n ],\n \"meta\": {\n \"anchor_index_path\": [\n \"string\",\n \"string\"\n ]\n }\n },\n \"error\": {\n \"code\": \"NO_EMPTY_REGION\",\n \"message\": \"string\"\n },\n \"effective_scope\": {\n \"scope_type\": \"GROUP_ROOT\"\n }\n },\n \"message\": \"string\",\n \"request_uri\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c053513-696c-499f-b800-5a6491f0d092", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ce4bb5d-d093-4bb3-be5c-bce8c89b9368", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3bcaa6a-dfdc-4af7-b70a-90fca92e74c2", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8eef605-4ea5-4899-99e5-439ea451d7ed", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1cfcd23-641d-4ea4-86ce-113cc2650a5f", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3b083a4d-66d5-4bb2-8128-5c31b4a8bdc8", "name": "Visual Navigation", "description": { "content": "Find adjacent elements, geometric distances, and visual ordering.", "type": "text/plain" }, "item": [ { "id": "0e94e018-fa5e-4dac-b26f-624543a23044", "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": "63b03843-6b98-4d22-841a-c5737cf70b6a", "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": "e567f300-1406-486a-841e-5f09ff3c9d8a", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "959b3d24-c5f8-4c5c-8341-94779d02bf08", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed595d34-2a59-4799-8a0f-cba4e8a0e410", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d836ccf-39d7-4675-bdc1-a385ba110d89", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a44c5d0-0d63-418a-8596-69ff4e113b69", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34354300-26fd-4aec-b204-8f23ca1d4faf", "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": "c7dc82a1-c2df-4f49-ad5f-9ac8952d40ba", "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": "45f6b228-545e-4eaa-b7b6-af5b7ac22abd", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5794e137-c821-4c1e-83af-00ac936761a8", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "780ff3dc-dd8e-4d07-95c2-86bcf52f8bdf", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25dfb90f-7a11-4c80-bc85-2e8c97c286a0", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4180395a-1bad-4523-8bd3-542259f94353", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ec4a0d5-25b3-4890-a1f9-0296c23dc31c", "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": "d1a5c5f4-5c85-4969-81c1-4aa1664f54dc", "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": "ceb0b7da-479f-459a-a810-38e2dfefa199", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b0d7699-e2e4-42af-a7ac-da467553de87", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac9b4ef5-74ad-416f-8c36-e2291b94e9b8", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c151c85-69d9-4353-b35f-7b153a2594b8", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n },\n \"request_uri\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fb931f3-3e57-48a3-b673-9fbb5c6af9ff", "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\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\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": "e0b60d94-b0fc-47cf-9296-81b89bb9c7c3", "name": "Navigation & Relationships", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Traverse the zone hierarchy, resolve relationships, and navigate visually between objects." } }