From 6c8c57d8b948fdf9aa123fae7a0fa8d91bad2b59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BAlia=20Rabello?= <77292838+julia-rabello@users.noreply.github.com> Date: Thu, 19 Sep 2024 11:57:26 -0300 Subject: [PATCH 1/4] add links to pagination guide - mdv1 --- VTEX - MasterData API - v10.2.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/VTEX - MasterData API - v10.2.json b/VTEX - MasterData API - v10.2.json index 82450fcba..bbbe186c8 100644 --- a/VTEX - MasterData API - v10.2.json +++ b/VTEX - MasterData API - v10.2.json @@ -977,7 +977,7 @@ "Scroll" ], "summary": "Scroll documents", - "description": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\n### First request example:\r\n```\r\n/dataentities/CL/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nAfter the first request, retrieve the token in the header `X-VTEX-MD-TOKEN` and make the next requests.\r\n\r\n### Example of subsequent requests:\r\n```\r\n/dataentities/CL/scroll?_token={tokenValue}\r\n```\r\n\r\n> To inform the number of documents per request, use the query string parameter `_size`, which has the maximum value of 1000.\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `\/dataentities\/CL\/search?email=my@email.com` |\r\n| **Complex filter** | `\/dataentities\/CL\/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `\/dataentities\/CL\/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `\/dataentities\/CL\/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `\/dataentities\/CL\/search?firstName=*Maria*` |\r\n| **Null values** | `\/dataentities\/CL\/search?_where=firstName is null` |\r\n| **Non-null values** | `\/dataentities\/CL\/search?_where=firstName is not null` |\r\n| **Difference** | `\/dataentities\/CL\/search?_where=firstName<>maria` |\r\n| **Greater than** | `\/dataentities\/CL\/search?_where=number>5` |\r\n| **Less than** | `\/dataentities\/CL\/search?_where=date<2001-01-01` |\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens, you will receive an error with status code `429`.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "description": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\n### First request example:\r\n```\r\n/dataentities/CL/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nTo inform the number of documents per request, use the query string parameter `_size`, which has the maximum value of 1000.\r\n\r\nAfter the first request, retrieve the token in the header `X-VTEX-MD-TOKEN` and make the next requests.\r\n\r\n### Example of subsequent requests:\r\n```\r\n/dataentities/CL/scroll?_token={tokenValue}\r\n```\n\r\n\rLearn more about pagination at [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `\/dataentities\/CL\/search?email=my@email.com` |\r\n| **Complex filter** | `\/dataentities\/CL\/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `\/dataentities\/CL\/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `\/dataentities\/CL\/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `\/dataentities\/CL\/search?firstName=*Maria*` |\r\n| **Null values** | `\/dataentities\/CL\/search?_where=firstName is null` |\r\n| **Non-null values** | `\/dataentities\/CL\/search?_where=firstName is not null` |\r\n| **Difference** | `\/dataentities\/CL\/search?_where=firstName<>maria` |\r\n| **Greater than** | `\/dataentities\/CL\/search?_where=number>5` |\r\n| **Less than** | `\/dataentities\/CL\/search?_where=date<2001-01-01` |\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens, you will receive an error with status code `429`.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "Scrolldocuments", "parameters": [ { @@ -1145,7 +1145,7 @@ "Search" ], "summary": "Search documents", - "description": "Retrieves Master Data v1 documents' information, while choosing which fields will be returned and filtering documents by specific fields.\r\n\r\n> Learn more about [Master Data v1 search queries](https://developers.vtex.com/vtex-rest-api/docs/how-the-queries-in-master-data-v1-work).\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `\/dataentities\/CL\/search?email=my@email.com` |\r\n| **Complex filter** | `\/dataentities\/CL\/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `\/dataentities\/CL\/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `\/dataentities\/CL\/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `\/dataentities\/CL\/search?firstName=*Maria*` |\r\n| **Null values** | `\/dataentities\/CL\/search?_where=firstName is null` |\r\n| **Non-null values** | `\/dataentities\/CL\/search?_where=firstName is not null` |\r\n| **Difference** | `\/dataentities\/CL\/search?_where=firstName<>maria` |\r\n| **Greater than** | `\/dataentities\/CL\/search?_where=number>5` |\r\n| **Less than** | `\/dataentities\/CL\/search?_where=date<2001-01-01` |\n\r\n\r>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `503`. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "description": "Retrieves Master Data v1 documents' information, while choosing which fields will be returned and filtering documents by specific fields.\r\n\r\n>ℹ️ Learn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api) and [Querying documents in Master Data v1](https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1).\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `\/dataentities\/CL\/search?email=my@email.com` |\r\n| **Complex filter** | `\/dataentities\/CL\/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `\/dataentities\/CL\/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `\/dataentities\/CL\/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `\/dataentities\/CL\/search?firstName=*Maria*` |\r\n| **Null values** | `\/dataentities\/CL\/search?_where=firstName is null` |\r\n| **Non-null values** | `\/dataentities\/CL\/search?_where=firstName is not null` |\r\n| **Difference** | `\/dataentities\/CL\/search?_where=firstName<>maria` |\r\n| **Greater than** | `\/dataentities\/CL\/search?_where=number>5` |\r\n| **Less than** | `\/dataentities\/CL\/search?_where=date<2001-01-01` |\n\r\n\r>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `503`. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "Searchdocuments", "parameters": [ { From f64f23400b31f90c111a7500a6c146ad16dc1b3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BAlia=20Rabello?= <77292838+julia-rabello@users.noreply.github.com> Date: Thu, 19 Sep 2024 11:57:30 -0300 Subject: [PATCH 2/4] add links to pagination guide - mdv2 --- VTEX - Master Data API - v2.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/VTEX - Master Data API - v2.json b/VTEX - Master Data API - v2.json index c22d069ac..e7d6de7cb 100644 --- a/VTEX - Master Data API - v2.json +++ b/VTEX - Master Data API - v2.json @@ -366,7 +366,7 @@ "Search" ], "summary": "Search documents", - "description": "Retrieves Master Data v2 documents' information, while choosing which fields will be returned and filtering documents by specific fields.\r\n\r\n> The response header `REST-Content-Range` indicates the total amount of results for that specific search. For example, it may return `resources 0-100/136108`, which indicates it has returned the first 100 results out of a total of 136108.\r\n\r\nBelow you can see some query examples and learn more about each query parameter.\n\r\n\r>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `503`.\r\n\r\n## Query examples\r\n\r\n| **Query Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `\/dataentities\/Newsletter\/search?email=my@email.com` |\r\n| **Complex filter** | `\/dataentities\/Newsletter\/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `\/dataentities\/Newsletter\/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Range numeric fields** | `\/dataentities\/Newsletter\/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `\/dataentities\/Newsletter\/search?firstName=*Maria*` |\r\n| **Filter for null values** | `\/dataentities\/Newsletter\/search?_where=firstName is null` |\r\n| **Filter for non-null values** | `\/dataentities\/Newsletter\/search?_where=firstName is not null` |\r\n| **Filter for difference** | `\/dataentities\/Newsletter\/search?_where=firstName<>maria` |\r\n| **Filter greater than** | `\/dataentities\/Newsletter\/search?_where=number>5` |\r\n| **Filter less than** | `\/dataentities\/Newsletter\/search?_where=date<2001-01-01` |\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "description": "Retrieves Master Data v2 documents' information, while choosing which fields will be returned and filtering documents by specific fields.\r\n\r\n> The response header `REST-Content-Range` indicates the total amount of results for that specific search. For example, it may return `resources 0-100/136108`, which indicates it has returned the first 100 results out of a total of 136108.\r\n\r\nBelow you can see some query examples and learn more about each query parameter.\n\r\n\rLearn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `503`.\r\n\r\n## Query examples\r\n\r\n| **Query Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `\/dataentities\/Newsletter\/search?email=my@email.com` |\r\n| **Complex filter** | `\/dataentities\/Newsletter\/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `\/dataentities\/Newsletter\/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Range numeric fields** | `\/dataentities\/Newsletter\/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `\/dataentities\/Newsletter\/search?firstName=*Maria*` |\r\n| **Filter for null values** | `\/dataentities\/Newsletter\/search?_where=firstName is null` |\r\n| **Filter for non-null values** | `\/dataentities\/Newsletter\/search?_where=firstName is not null` |\r\n| **Filter for difference** | `\/dataentities\/Newsletter\/search?_where=firstName<>maria` |\r\n| **Filter greater than** | `\/dataentities\/Newsletter\/search?_where=number>5` |\r\n| **Filter less than** | `\/dataentities\/Newsletter\/search?_where=date<2001-01-01` |\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "Searchdocuments", "parameters": [ { @@ -479,7 +479,7 @@ "Scroll" ], "summary": "Scroll documents", - "description": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\nFirst request:\r\n```\r\n/dataentities/Newsletter/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nRetrieve the token in the header `X-VTEX-MD-TOKEN` from the first request's response and use it to make the following requests.\r\n\r\nSubsequent requests:\r\n```\r\n/dataentities/Newsletter/scroll?_token={tokenValue}\r\n```\n\r\n\r>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or using the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `429`.\r\n\r\n## Query examples\r\n\r\n| **Query Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `\/dataentities\/Newsletter\/search?email=my@email.com` |\r\n| **Complex filter** | `\/dataentities\/Newsletter\/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `\/dataentities\/Newsletter\/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Range numeric fields** | `\/dataentities\/Newsletter\/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `\/dataentities\/Newsletter\/search?firstName=*Maria*` |\r\n| **Filter for null values** | `\/dataentities\/Newsletter\/search?_where=firstName is null` |\r\n| **Filter for non-null values** | `\/dataentities\/Newsletter\/search?_where=firstName is not null` |\r\n| **Filter for difference** | `\/dataentities\/Newsletter\/search?_where=firstName<>maria` |\r\n| **Filter greater than** | `\/dataentities\/Newsletter\/search?_where=number>5` |\r\n| **Filter less than** | `\/dataentities\/Newsletter\/search?_where=date<2001-01-01` |\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "description": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\nFirst request:\r\n```\r\n/dataentities/Newsletter/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nRetrieve the token in the header `X-VTEX-MD-TOKEN` from the first request's response and use it to make the following requests.\r\n\r\nSubsequent requests:\r\n```\r\n/dataentities/Newsletter/scroll?_token={tokenValue}\r\n```\n\r\n\rLearn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or using the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `429`.\r\n\r\n## Query examples\r\n\r\n| **Query Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `\/dataentities\/Newsletter\/search?email=my@email.com` |\r\n| **Complex filter** | `\/dataentities\/Newsletter\/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `\/dataentities\/Newsletter\/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Range numeric fields** | `\/dataentities\/Newsletter\/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `\/dataentities\/Newsletter\/search?firstName=*Maria*` |\r\n| **Filter for null values** | `\/dataentities\/Newsletter\/search?_where=firstName is null` |\r\n| **Filter for non-null values** | `\/dataentities\/Newsletter\/search?_where=firstName is not null` |\r\n| **Filter for difference** | `\/dataentities\/Newsletter\/search?_where=firstName<>maria` |\r\n| **Filter greater than** | `\/dataentities\/Newsletter\/search?_where=number>5` |\r\n| **Filter less than** | `\/dataentities\/Newsletter\/search?_where=date<2001-01-01` |\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "Scrolldocuments", "parameters": [ { From 9c3b0525036f851ab1debff3e5e949f029ded656 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BAlia=20Rabello?= <77292838+julia-rabello@users.noreply.github.com> Date: Thu, 19 Sep 2024 11:58:45 -0300 Subject: [PATCH 3/4] edit description - mdv1 --- VTEX - MasterData API - v10.2.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - MasterData API - v10.2.json b/VTEX - MasterData API - v10.2.json index bbbe186c8..8b7db70dc 100644 --- a/VTEX - MasterData API - v10.2.json +++ b/VTEX - MasterData API - v10.2.json @@ -977,7 +977,7 @@ "Scroll" ], "summary": "Scroll documents", - "description": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\n### First request example:\r\n```\r\n/dataentities/CL/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nTo inform the number of documents per request, use the query string parameter `_size`, which has the maximum value of 1000.\r\n\r\nAfter the first request, retrieve the token in the header `X-VTEX-MD-TOKEN` and make the next requests.\r\n\r\n### Example of subsequent requests:\r\n```\r\n/dataentities/CL/scroll?_token={tokenValue}\r\n```\n\r\n\rLearn more about pagination at [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `\/dataentities\/CL\/search?email=my@email.com` |\r\n| **Complex filter** | `\/dataentities\/CL\/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `\/dataentities\/CL\/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `\/dataentities\/CL\/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `\/dataentities\/CL\/search?firstName=*Maria*` |\r\n| **Null values** | `\/dataentities\/CL\/search?_where=firstName is null` |\r\n| **Non-null values** | `\/dataentities\/CL\/search?_where=firstName is not null` |\r\n| **Difference** | `\/dataentities\/CL\/search?_where=firstName<>maria` |\r\n| **Greater than** | `\/dataentities\/CL\/search?_where=number>5` |\r\n| **Less than** | `\/dataentities\/CL\/search?_where=date<2001-01-01` |\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens, you will receive an error with status code `429`.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "description": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\n### First request example:\r\n```\r\n/dataentities/CL/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nTo inform the number of documents per request, use the query string parameter `_size`, which has the maximum value of 1000.\r\n\r\nAfter the first request, retrieve the token in the header `X-VTEX-MD-TOKEN` and make the next requests.\r\n\r\n### Example of subsequent requests:\r\n```\r\n/dataentities/CL/scroll?_token={tokenValue}\r\n```\r\n\r\n>ℹ️ Learn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `\/dataentities\/CL\/search?email=my@email.com` |\r\n| **Complex filter** | `\/dataentities\/CL\/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `\/dataentities\/CL\/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `\/dataentities\/CL\/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `\/dataentities\/CL\/search?firstName=*Maria*` |\r\n| **Null values** | `\/dataentities\/CL\/search?_where=firstName is null` |\r\n| **Non-null values** | `\/dataentities\/CL\/search?_where=firstName is not null` |\r\n| **Difference** | `\/dataentities\/CL\/search?_where=firstName<>maria` |\r\n| **Greater than** | `\/dataentities\/CL\/search?_where=number>5` |\r\n| **Less than** | `\/dataentities\/CL\/search?_where=date<2001-01-01` |\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens, you will receive an error with status code `429`.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "Scrolldocuments", "parameters": [ { From ee5b77e40faef4a9157c53abcf40167a51452129 Mon Sep 17 00:00:00 2001 From: julia-rabello <> Date: Thu, 19 Sep 2024 15:01:13 +0000 Subject: [PATCH 4/4] Update generated files by portman --- .../VTEX - Master Data API - v2.json | 166 +++++++-------- .../VTEX - MasterData API - v10.2.json | 198 +++++++++--------- 2 files changed, 182 insertions(+), 182 deletions(-) diff --git a/PostmanCollections/VTEX - Master Data API - v2.json b/PostmanCollections/VTEX - Master Data API - v2.json index f56915573..d98a00dc9 100644 --- a/PostmanCollections/VTEX - Master Data API - v2.json +++ b/PostmanCollections/VTEX - Master Data API - v2.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "c5ee440c-a526-405c-97da-16b0cfc6fe19" + "postman_id": "09424348-10e2-463c-9020-f339396ea78f" }, "item": [ { - "id": "39ff7993-2e17-40a3-ad72-5db2c030e1b7", + "id": "034c3695-395c-4eb5-89d9-77bc5db04de0", "name": "Documents", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "5e1ddc3a-ae64-4d1f-86f2-9147e7343b5d", + "id": "682a47b5-c14f-453e-811e-d01a314a8be6", "name": "Create new document", "request": { "name": "Create new document", @@ -99,7 +99,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "291bc739-d4e0-45ce-9ba6-a73d7221270a", + "id": "7894c971-b73e-4ff4-be2c-c1a900a0b306", "name": "OK", "originalRequest": { "url": { @@ -189,7 +189,7 @@ { "listen": "test", "script": { - "id": "dd5aff12-cc1e-4adb-9aea-fd8f2d6bdaf2", + "id": "18687b33-8933-429b-8e52-e1d5550ff0e6", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/dataentities/:dataEntityName/documents - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -205,7 +205,7 @@ } }, { - "id": "ae4e1b7a-66a3-404b-8b96-ad084ad01b21", + "id": "a98949d0-fc2c-4001-9a50-d86dc2b080dd", "name": "Create partial document", "request": { "name": "Create partial document", @@ -292,7 +292,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3e27e44b-5a0d-4013-971d-7cbd5d2c0c5c", + "id": "1cc5b7e7-a6b6-4a7b-bf95-c49d5f68811b", "name": "OK", "originalRequest": { "url": { @@ -382,7 +382,7 @@ { "listen": "test", "script": { - "id": "1367e005-3112-4407-b332-96f8367b8c00", + "id": "f340c616-7135-471b-a525-c6be9a9de439", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/dataentities/:dataEntityName/documents - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -398,7 +398,7 @@ } }, { - "id": "9073d5b2-298c-4ce7-8ac4-1f4ac2beb0d8", + "id": "9d6c37ed-fa5c-4963-b8f1-a2d7f0f47186", "name": "Get document", "request": { "name": "Get document", @@ -492,7 +492,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "544f84b4-c51a-464c-a9e5-aeb365d21a74", + "id": "9d3af8e8-605c-463a-9c78-b295c7d5c0d4", "name": "OK", "originalRequest": { "url": { @@ -579,7 +579,7 @@ { "listen": "test", "script": { - "id": "74a244ce-c88c-4e45-b7cc-9645d4bc7710", + "id": "40dab239-e487-4d34-b76b-00691fe01f5e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -595,7 +595,7 @@ } }, { - "id": "1a0facfc-ad74-443e-b48f-f3e6c494137e", + "id": "7917e1f5-048b-446a-b096-210d0eb967d7", "name": "Create document with custom ID or update entire document", "request": { "name": "Create document with custom ID or update entire document", @@ -693,7 +693,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "10de5527-cb0e-43d0-8b02-b8300afc1484", + "id": "c14f396d-91cd-49a1-930a-363b923f385e", "name": "OK. Document changed successfully.", "originalRequest": { "url": { @@ -783,7 +783,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "1176bc6f-27ec-4a5b-be18-f5f880710d0b", + "id": "4f0ef9a2-87f7-440b-aa88-4232404c7c13", "name": "Created. Document created successfully.", "originalRequest": { "url": { @@ -863,7 +863,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "19c1b9ff-e3b0-4dcc-934d-416fe0aa90b3", + "id": "da027511-ba7e-43f9-b438-18a50bd25cf5", "name": "Not Modified. There were no changes to the document.", "originalRequest": { "url": { @@ -943,7 +943,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "0d7973c0-18ac-4761-bbed-b25f04a01999", + "id": "318218c8-f9a5-470f-b7b4-9d1fb35de295", "name": "Bad Request. Invalid information in JSON.", "originalRequest": { "url": { @@ -1023,7 +1023,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "199b50df-8bb7-4b70-8e9f-4718d9be1615", + "id": "03b20124-0ae9-48b1-858d-ac08a6504444", "name": "Forbidden. Unauthorized access.", "originalRequest": { "url": { @@ -1104,7 +1104,7 @@ { "listen": "test", "script": { - "id": "ab23c01f-e74c-4055-a1d5-992ef87fcf79", + "id": "09926103-5d3c-4cdb-9172-ba225309f800", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:dataEntityName/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1120,7 +1120,7 @@ } }, { - "id": "a4cdb442-ca1b-4daa-b978-5cf1e32d8f4a", + "id": "5206949e-5e0b-425a-a6f2-a082adc36824", "name": "Update partial document", "request": { "name": "Update partial document", @@ -1218,7 +1218,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "efd6a463-d1dc-430b-9d22-4e2a21d6a8d9", + "id": "bd0f8a6a-e834-48aa-9406-1180e503579e", "name": "OK", "originalRequest": { "url": { @@ -1309,7 +1309,7 @@ { "listen": "test", "script": { - "id": "ed9afe65-54fc-4b89-84b3-00c3baa8cf8b", + "id": "7c5ce5b7-ac3a-4106-b946-7499a6fa1716", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/dataentities/:dataEntityName/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1325,7 +1325,7 @@ } }, { - "id": "37da6a06-06d2-494e-afee-ae4138b0998b", + "id": "e43a8443-7d09-4561-bd38-d3fcc575e5bd", "name": "Delete document", "request": { "name": "Delete document", @@ -1396,7 +1396,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "10c633ad-3907-42de-b338-2e7d2794f453", + "id": "e2a7a3f3-a88f-4883-9742-29f3c85c969e", "name": "OK", "originalRequest": { "url": { @@ -1454,7 +1454,7 @@ { "listen": "test", "script": { - "id": "1c811a8e-2197-47ad-b134-186f568190d6", + "id": "dec703ee-f84f-4a80-b6fc-b13cb817a63c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/dataentities/:dataEntityName/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1470,7 +1470,7 @@ "event": [] }, { - "id": "5dd39eed-1d54-4f81-b20c-336c0a3f0828", + "id": "cc507f76-468a-489a-a0b2-3b0b15558d73", "name": "Search", "description": { "content": "", @@ -1478,12 +1478,12 @@ }, "item": [ { - "id": "ae07f707-3f62-4130-9a18-5b8c311ce826", + "id": "64a41106-7b26-4112-ba6e-bb6d6371750d", "name": "Search documents", "request": { "name": "Search documents", "description": { - "content": "Retrieves Master Data v2 documents' information, while choosing which fields will be returned and filtering documents by specific fields.\r\n\r\n> The response header `REST-Content-Range` indicates the total amount of results for that specific search. For example, it may return `resources 0-100/136108`, which indicates it has returned the first 100 results out of a total of 136108.\r\n\r\nBelow you can see some query examples and learn more about each query parameter.\n\r\n\r>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `503`.\r\n\r\n## Query examples\r\n\r\n| **Query Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/Newsletter/search?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/Newsletter/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/Newsletter/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Range numeric fields** | `/dataentities/Newsletter/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/Newsletter/search?firstName=*Maria*` |\r\n| **Filter for null values** | `/dataentities/Newsletter/search?_where=firstName is null` |\r\n| **Filter for non-null values** | `/dataentities/Newsletter/search?_where=firstName is not null` |\r\n| **Filter for difference** | `/dataentities/Newsletter/search?_where=firstName<>maria` |\r\n| **Filter greater than** | `/dataentities/Newsletter/search?_where=number>5` |\r\n| **Filter less than** | `/dataentities/Newsletter/search?_where=date<2001-01-01` |\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "content": "Retrieves Master Data v2 documents' information, while choosing which fields will be returned and filtering documents by specific fields.\r\n\r\n> The response header `REST-Content-Range` indicates the total amount of results for that specific search. For example, it may return `resources 0-100/136108`, which indicates it has returned the first 100 results out of a total of 136108.\r\n\r\nBelow you can see some query examples and learn more about each query parameter.\n\r\n\rLearn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `503`.\r\n\r\n## Query examples\r\n\r\n| **Query Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/Newsletter/search?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/Newsletter/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/Newsletter/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Range numeric fields** | `/dataentities/Newsletter/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/Newsletter/search?firstName=*Maria*` |\r\n| **Filter for null values** | `/dataentities/Newsletter/search?_where=firstName is null` |\r\n| **Filter for non-null values** | `/dataentities/Newsletter/search?_where=firstName is not null` |\r\n| **Filter for difference** | `/dataentities/Newsletter/search?_where=firstName<>maria` |\r\n| **Filter greater than** | `/dataentities/Newsletter/search?_where=number>5` |\r\n| **Filter less than** | `/dataentities/Newsletter/search?_where=date<2001-01-01` |\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -1588,7 +1588,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "79a3a0dd-5b4c-4b11-9d74-7e079ac48a1b", + "id": "c988b5ef-5152-4de6-9312-143a156a1d8f", "name": "OK", "originalRequest": { "url": { @@ -1709,7 +1709,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "affb6e57-d554-4547-b9ba-2469573e6e96", + "id": "696d9851-0b08-4239-bcde-27d9172a2a52", "name": "Bad Request", "originalRequest": { "url": { @@ -1821,7 +1821,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ead652c5-52ad-46e5-9fe2-da4a32b88fb6", + "id": "e8ddce18-960a-4fde-87f7-6c8b846624ec", "name": "Forbidden", "originalRequest": { "url": { @@ -1933,7 +1933,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "0bb3beac-9d26-4975-8ad8-87c86d9bab6a", + "id": "216606f7-8ccc-4ff2-a51f-2e7b9c947c31", "name": "Service Unavailable. Wildcard queries temporarily blocked due to excessive usage. Consider adjusting your code to remove them or reduce the rate of search requests with wildcards (*). This temporary block may also be due to excessive use of requests with the parameter `keyword`.", "originalRequest": { "url": { @@ -2036,7 +2036,7 @@ { "listen": "test", "script": { - "id": "b36e69d2-45d6-4bb9-86b4-a616a23d17cc", + "id": "132db4de-c25c-4787-a473-b69959353f79", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2055,7 +2055,7 @@ "event": [] }, { - "id": "23896b6f-5e80-4108-9129-c83c82500fe7", + "id": "2ff13c35-63c2-4c39-bc06-8f2a85f6a0ca", "name": "Scroll", "description": { "content": "", @@ -2063,12 +2063,12 @@ }, "item": [ { - "id": "8eb62089-9ccc-4466-8749-d7236db4ce8e", + "id": "26318c7e-b2ca-4e09-901d-836b5a1a335f", "name": "Scroll documents", "request": { "name": "Scroll documents", "description": { - "content": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\nFirst request:\r\n```\r\n/dataentities/Newsletter/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nRetrieve the token in the header `X-VTEX-MD-TOKEN` from the first request's response and use it to make the following requests.\r\n\r\nSubsequent requests:\r\n```\r\n/dataentities/Newsletter/scroll?_token={tokenValue}\r\n```\n\r\n\r>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or using the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `429`.\r\n\r\n## Query examples\r\n\r\n| **Query Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/Newsletter/search?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/Newsletter/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/Newsletter/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Range numeric fields** | `/dataentities/Newsletter/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/Newsletter/search?firstName=*Maria*` |\r\n| **Filter for null values** | `/dataentities/Newsletter/search?_where=firstName is null` |\r\n| **Filter for non-null values** | `/dataentities/Newsletter/search?_where=firstName is not null` |\r\n| **Filter for difference** | `/dataentities/Newsletter/search?_where=firstName<>maria` |\r\n| **Filter greater than** | `/dataentities/Newsletter/search?_where=number>5` |\r\n| **Filter less than** | `/dataentities/Newsletter/search?_where=date<2001-01-01` |\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "content": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\nFirst request:\r\n```\r\n/dataentities/Newsletter/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nRetrieve the token in the header `X-VTEX-MD-TOKEN` from the first request's response and use it to make the following requests.\r\n\r\nSubsequent requests:\r\n```\r\n/dataentities/Newsletter/scroll?_token={tokenValue}\r\n```\n\r\n\rLearn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or using the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `429`.\r\n\r\n## Query examples\r\n\r\n| **Query Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/Newsletter/search?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/Newsletter/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/Newsletter/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Range numeric fields** | `/dataentities/Newsletter/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/Newsletter/search?firstName=*Maria*` |\r\n| **Filter for null values** | `/dataentities/Newsletter/search?_where=firstName is null` |\r\n| **Filter for non-null values** | `/dataentities/Newsletter/search?_where=firstName is not null` |\r\n| **Filter for difference** | `/dataentities/Newsletter/search?_where=firstName<>maria` |\r\n| **Filter greater than** | `/dataentities/Newsletter/search?_where=number>5` |\r\n| **Filter less than** | `/dataentities/Newsletter/search?_where=date<2001-01-01` |\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -2191,7 +2191,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "06103422-0d71-430e-b3b0-c71bc6aabd6f", + "id": "29217db9-1810-4f85-be0a-0d3692216669", "name": "OK", "originalRequest": { "url": { @@ -2320,7 +2320,7 @@ "type": "text/plain" }, "key": "X-VTEX-MD-TOKEN", - "value": "adipisicing id consequat" + "value": "esse dolo" }, { "disabled": true, @@ -2329,7 +2329,7 @@ "type": "text/plain" }, "key": "REST-Content-Total", - "value": "anim elit dolor deserunt" + "value": "dolore anim dolor" } ], "body": "[\n {\n \"id\": \"b818cbda-e489-11e6-94f4-0ac138d2d42e\",\n \"accountId\": \"14af940d-9300-4279-9355-61d44c2ff879\",\n \"accountName\": \"apiexamples\",\n \"dataEntityId\": \"Newsletter\"\n }\n]", @@ -2339,7 +2339,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4d4baeac-9cc8-4480-864f-392fa65e27d9", + "id": "4b9da702-2038-4e56-8774-27cfe31b9660", "name": "Bad Request", "originalRequest": { "url": { @@ -2469,7 +2469,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "b8772ed0-96e7-43e4-b7df-d025cee17421", + "id": "0e47c177-28c6-45e2-8ea7-f97bcd91e33f", "name": "Too Many Requests. Wildcard queries temporarily blocked due to excessive usage. Consider adjusting your code to remove them or reduce the rate of search requests with wildcards (*). This temporary block may also be due to excessive use of requests with the parameter `keyword`.", "originalRequest": { "url": { @@ -2590,7 +2590,7 @@ { "listen": "test", "script": { - "id": "3fe200a8-5e96-4a64-bf3c-fcc5f659bd11", + "id": "fa7bc069-2606-4204-9d76-69e0eb2d7615", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/scroll - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2609,7 +2609,7 @@ "event": [] }, { - "id": "949e9468-b209-4370-bbb4-069a46a5f6d2", + "id": "3eaf9a7f-016a-4d56-8f27-04b11a392ebb", "name": "Schemas", "description": { "content": "", @@ -2617,7 +2617,7 @@ }, "item": [ { - "id": "8ec2f16e-bb82-4809-b864-abb3c05c010a", + "id": "340b65d6-0e97-4fa7-83e1-3f3ebe536bfa", "name": "Get schemas", "request": { "name": "Get schemas", @@ -2672,7 +2672,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "30b1f328-910b-4762-affb-0b046b47a012", + "id": "35de989b-6dba-4caa-8236-737b20a4088d", "name": "OK", "originalRequest": { "url": { @@ -2730,7 +2730,7 @@ { "listen": "test", "script": { - "id": "6d34d6b1-bc06-40b4-981e-9ae5ea6822fa", + "id": "3dcca71f-df3a-4033-a781-63102fb01724", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/schemas - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2746,7 +2746,7 @@ } }, { - "id": "0f197cc6-e07d-420e-982b-c9f3afe4db57", + "id": "b0b15195-1621-4e9c-b203-bd6601778f89", "name": "Get schema by name", "request": { "name": "Get schema by name", @@ -2812,7 +2812,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "007b6a36-9721-4226-ba82-67121ae98961", + "id": "3c69aee9-abaa-47aa-a57a-528536bf3631", "name": "OK", "originalRequest": { "url": { @@ -2871,7 +2871,7 @@ { "listen": "test", "script": { - "id": "e5d544c7-1482-4bcb-b630-e0b4a3e05b1f", + "id": "4f8ebdf5-40c7-4a91-a29e-fd16875f4bc8", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/schemas/:schemaName - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2887,7 +2887,7 @@ } }, { - "id": "b72d7e60-8233-4004-a222-fc980c835cba", + "id": "526ec273-65f3-4e3a-80d3-c8c4780479c7", "name": "Save schema by name", "request": { "name": "Save schema by name", @@ -2957,7 +2957,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "870f4e17-d4f8-4411-bfcb-4f6231243874", + "id": "8ebf794b-4ee4-4106-bd66-fba0e35bc6ec", "name": "OK", "originalRequest": { "url": { @@ -3020,7 +3020,7 @@ { "listen": "test", "script": { - "id": "dad27c7e-1765-4102-a982-76183ad46b6b", + "id": "93859074-80aa-48d9-b060-1647bdb7be3a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:dataEntityName/schemas/:schemaName - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3036,7 +3036,7 @@ } }, { - "id": "4730cca5-1ec8-4d47-bb59-2f3e33268d7d", + "id": "fed76ec4-83fa-46ee-9187-c37c6637c932", "name": "Delete schema by name", "request": { "name": "Delete schema by name", @@ -3098,7 +3098,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "6f0330b6-767b-479d-beab-6ea505a64d70", + "id": "f4f1b366-0fd1-425b-a5c6-1c229e600672", "name": "No Content", "originalRequest": { "url": { @@ -3147,7 +3147,7 @@ { "listen": "test", "script": { - "id": "053958d1-9530-40ce-b829-86b8b81e2527", + "id": "d3aa6644-c77e-452f-920d-60872de7c7f9", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/dataentities/:dataEntityName/schemas/:schemaName - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3164,7 +3164,7 @@ "event": [] }, { - "id": "6f54f726-fe1d-41ab-b640-8073b79a3083", + "id": "d0817205-b633-4815-b402-18c19c24771d", "name": "Indices", "description": { "content": "", @@ -3172,7 +3172,7 @@ }, "item": [ { - "id": "289edbee-2329-40d1-b44c-2472fd15f11c", + "id": "3eb35633-73b8-4940-826f-263bcb6e8e43", "name": "Get indices", "request": { "name": "Get indices", @@ -3227,7 +3227,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ce25ae7f-2f1b-4fac-acf2-5a626f30371c", + "id": "09d524ac-7274-4de7-94ce-957bbd3887ac", "name": "OK", "originalRequest": { "url": { @@ -3285,7 +3285,7 @@ { "listen": "test", "script": { - "id": "a3b2981d-81b3-4dc8-bad6-619358dd6c6b", + "id": "6b102ab2-e6a5-4895-a7e1-52d811690a89", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/indices - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3301,7 +3301,7 @@ } }, { - "id": "a211bb1a-897c-4388-8449-05e029fd4b66", + "id": "29e47984-b9df-410b-b8a7-7337e5118d62", "name": "Create index", "request": { "name": "Create index", @@ -3356,7 +3356,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "9b8c95c7-f20b-4b34-b43d-8100da7f8ef4", + "id": "d7b735e2-18fb-4a7a-b4aa-79bb8481235a", "name": "OK", "originalRequest": { "url": { @@ -3408,7 +3408,7 @@ { "listen": "test", "script": { - "id": "87283972-aab6-4ff7-b15e-584080e60bbb", + "id": "af763a95-5b6d-41c5-a8fa-014eaa405889", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:dataEntityName/indices - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -3421,7 +3421,7 @@ } }, { - "id": "8de7ea5d-f9af-467e-973d-6fada57b37c1", + "id": "dfec5fb3-d61f-4ad8-9acf-8e507c1e100e", "name": "Get index by name", "request": { "name": "Get index by name", @@ -3487,7 +3487,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4188d1fa-112d-49c3-b854-79866c240aaa", + "id": "294804b6-29a9-433b-a0b1-cf8a6dcec303", "name": "OK", "originalRequest": { "url": { @@ -3546,7 +3546,7 @@ { "listen": "test", "script": { - "id": "2006ce5b-8236-48b3-a74f-596d3f272e58", + "id": "bd6cc9dc-8f53-46e5-a06f-e72f15804a3e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/indices/:index_name - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3562,7 +3562,7 @@ } }, { - "id": "357328c7-5b5c-4446-8f12-630d7a3caec4", + "id": "10a70a54-bf28-44fc-b42c-1dd43e18b0a4", "name": "Delete index by name", "request": { "name": "Delete index by name", @@ -3624,7 +3624,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "c3165627-ab3b-4584-bc52-ae2381bae94c", + "id": "9591fb12-0ee0-4ff7-afa7-50c7c931a38f", "name": "No Content", "originalRequest": { "url": { @@ -3673,7 +3673,7 @@ { "listen": "test", "script": { - "id": "3d5e16da-9999-40e9-bee8-e2fe16689910", + "id": "c61bc917-8ee5-4f48-be3c-b46f5c2c4826", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/dataentities/:dataEntityName/indices/:index_name - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3690,7 +3690,7 @@ "event": [] }, { - "id": "35be85a8-2b93-4852-939e-57725fd127f2", + "id": "a4bce0c3-6835-4e52-b306-95f144c72a96", "name": "Clusters", "description": { "content": "", @@ -3698,7 +3698,7 @@ }, "item": [ { - "id": "418769ba-1145-4630-a8ce-323541d74671", + "id": "f339f920-0cd9-4921-a296-f93553c99f76", "name": "Validate document by clusters", "request": { "name": "Validate document by clusters", @@ -3778,7 +3778,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "fc15f0f8-11fc-4cf1-9bb5-d8c272921a14", + "id": "c9300d9d-f4ca-4678-9420-52e6fec7dc44", "name": "OK", "originalRequest": { "url": { @@ -3851,7 +3851,7 @@ { "listen": "test", "script": { - "id": "2f531b26-6c46-4595-8bd8-4a1467f93093", + "id": "1c6bc96c-9f4b-4259-916c-1dab1bed5c9d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/dataentities/:dataEntityName/documents/:id/clusters - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3870,7 +3870,7 @@ "event": [] }, { - "id": "eff6437f-9aaf-47ef-b7c6-5fb43b61b527", + "id": "42935904-b6a9-4bbd-b89f-387bc6f38d25", "name": "Versions", "description": { "content": "", @@ -3878,7 +3878,7 @@ }, "item": [ { - "id": "75b2f961-862b-4ac6-9d8d-53c1ae7093a1", + "id": "e9d7ae9e-66ea-40a2-b107-5e83354ef2b7", "name": "List versions", "request": { "name": "List versions", @@ -3973,7 +3973,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "936f3646-5381-4dda-a22c-4c5529c5df0c", + "id": "a2d44694-5c51-4e7f-bd96-b25f18fb74ea", "name": "OK", "originalRequest": { "url": { @@ -4061,7 +4061,7 @@ { "listen": "test", "script": { - "id": "5cbe0457-a5d9-4f2b-b4b1-84679bc8ee08", + "id": "1635d500-7340-4f08-b319-b9f14324d247", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/documents/:id/versions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4077,7 +4077,7 @@ } }, { - "id": "c866d02c-8202-4409-ad5d-92528d2f12d2", + "id": "258baa55-d27c-45ee-8e62-df8674631f4f", "name": "Get version", "request": { "name": "Get version", @@ -4164,7 +4164,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "68e9c61a-2d35-45d6-8b8b-5ef652d11d44", + "id": "a0e509e1-f062-4f19-97de-2b971f04570d", "name": "OK", "originalRequest": { "url": { @@ -4234,7 +4234,7 @@ { "listen": "test", "script": { - "id": "b12c7679-6854-4bba-9494-b70743a4f7b3", + "id": "351c9ffa-8264-4b87-a6e5-18d89fabc3be", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/documents/:id/versions/:versionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4250,7 +4250,7 @@ } }, { - "id": "e0ee2af3-87ae-4906-8566-ffd61177a174", + "id": "78803f20-ce04-4d0b-af6f-d935ad8b8c51", "name": "Update version", "request": { "name": "Update version", @@ -4337,7 +4337,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "fca0ea2e-ab98-4cfe-b667-8a794a76775a", + "id": "9932b6de-992b-46bf-a02b-458d8a157ec5", "name": "OK", "originalRequest": { "url": { @@ -4406,7 +4406,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "453df84d-872e-4639-bdaa-056461d890bf", + "id": "ceaad177-52f8-4ec2-b711-8374a3b75a26", "name": "Not Modified", "originalRequest": { "url": { @@ -4466,7 +4466,7 @@ { "listen": "test", "script": { - "id": "475475c4-fc57-4275-8e50-914527d13698", + "id": "de29b0dc-3842-41d6-bec4-5b6583d68ffc", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:dataEntityName/documents/:id/versions/:versionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4524,7 +4524,7 @@ } ], "info": { - "_postman_id": "c5ee440c-a526-405c-97da-16b0cfc6fe19", + "_postman_id": "09424348-10e2-463c-9020-f339396ea78f", "name": "Master Data API - v2", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { diff --git a/PostmanCollections/VTEX - MasterData API - v10.2.json b/PostmanCollections/VTEX - MasterData API - v10.2.json index ca71d0ec7..95b35c604 100644 --- a/PostmanCollections/VTEX - MasterData API - v10.2.json +++ b/PostmanCollections/VTEX - MasterData API - v10.2.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "2b832c77-819b-4d7a-86e4-7f0dcde9d8a6" + "postman_id": "d25941b8-055a-4e9d-b67e-27f7d64f1fcc" }, "item": [ { - "id": "74944ec6-441e-4202-baa0-53d646bbeb06", + "id": "1fcc42f9-bc76-459f-aeec-9ee6b66c7a78", "name": "Data Entities", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "17163f2e-76cf-4cdf-a5f2-0663683876f3", + "id": "9bb9d1b0-281a-447b-9b4b-169ec3da8fb9", "name": "List data entities", "request": { "name": "List data entities", @@ -63,7 +63,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9ab70bee-bc8d-471b-b4af-881c86d3ad07", + "id": "90ce3153-29b4-41b8-b8b6-2b86e3761e73", "name": "OK", "originalRequest": { "url": { @@ -127,7 +127,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "6fe09959-14d1-4ca0-97ee-a506977d5a9f", + "id": "a71a1edc-e09a-412b-a623-f27e5c436ecc", "name": "Forbidden", "originalRequest": { "url": { @@ -192,7 +192,7 @@ { "listen": "test", "script": { - "id": "1078c77f-74ba-42eb-abfa-754766b158dd", + "id": "98ad2192-5c87-4e88-a25c-127222d40e78", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -208,7 +208,7 @@ } }, { - "id": "f72e73a5-ec19-4033-8cd1-0de9c8fec453", + "id": "3076e74d-8322-4ec2-89ea-4a681d638f00", "name": "Get data entity structure", "request": { "name": "Get data entity structure", @@ -271,7 +271,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "93d51c12-bfc7-4d94-86a3-5536b6d0d622", + "id": "4537222a-a988-42f9-8963-0851c190c2d9", "name": "OK", "originalRequest": { "url": { @@ -336,7 +336,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "29005dd8-a915-42f6-b759-3662782ae1d3", + "id": "207a494d-e82d-4778-bc2e-ed4ac8cf3fb4", "name": "Forbidden", "originalRequest": { "url": { @@ -402,7 +402,7 @@ { "listen": "test", "script": { - "id": "f500785f-7103-44cf-928a-a9eac5283866", + "id": "2e8839a2-0b6a-4f68-9a61-0be012715bb8", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:acronym - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -421,7 +421,7 @@ "event": [] }, { - "id": "bedd00be-658b-40b4-b3be-02b1068d93ab", + "id": "546041db-36b4-4272-b2db-43a0e7a3abb7", "name": "Documents", "description": { "content": "", @@ -429,7 +429,7 @@ }, "item": [ { - "id": "5267634b-165e-4be2-8717-b65030417973", + "id": "11e9e13d-032d-41e4-aba0-48434dc89334", "name": "Create new document", "request": { "name": "Create new document", @@ -506,7 +506,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "72c06aa9-8a5f-46c3-b4be-82dab800054b", + "id": "d295b30e-86ec-45b2-92e0-d5c61a2699fb", "name": "Created", "originalRequest": { "url": { @@ -586,7 +586,7 @@ { "listen": "test", "script": { - "id": "68542302-7a7e-4e43-8adb-5bf07442df74", + "id": "50259b35-a07e-4fbc-978a-6801e5cd639c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/dataentities/:acronym/documents - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -602,7 +602,7 @@ } }, { - "id": "e68aad93-d678-493e-9d91-0153a1aa311d", + "id": "10bada96-53e0-400f-8622-7b0e54c7e2c2", "name": "Create partial document", "request": { "name": "Create partial document", @@ -679,7 +679,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a38426d8-8fad-407d-b92d-60c0c38621ae", + "id": "3c153bb4-7c93-4987-8c17-943e464bf997", "name": "Created", "originalRequest": { "url": { @@ -759,7 +759,7 @@ { "listen": "test", "script": { - "id": "39d1adae-2503-4695-8192-99230ee46e78", + "id": "1f36fb8d-857f-4422-9986-01af7d32f77d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/dataentities/:acronym/documents - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -775,7 +775,7 @@ } }, { - "id": "3f560bf7-a494-4156-81f8-42332d24c6b2", + "id": "d2d7f300-2a04-4009-9f62-e33a64b4c0e1", "name": "Get document", "request": { "name": "Get document", @@ -860,7 +860,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1cf2f93c-459e-4170-bf75-38c820a94542", + "id": "f3224231-03e6-4b91-b3b7-390f4b588646", "name": "OK", "originalRequest": { "url": { @@ -937,7 +937,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7f8aedfa-9682-4ef6-81ac-45ce33fd5235", + "id": "db50ec23-35d9-4b06-9907-aca64a15ab57", "name": "Forbidden", "originalRequest": { "url": { @@ -1015,7 +1015,7 @@ { "listen": "test", "script": { - "id": "643e4043-6089-479d-bc29-6555766e7f3b", + "id": "2e63b95b-f353-415a-afe1-1080cd53d9eb", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:acronym/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1031,7 +1031,7 @@ } }, { - "id": "3a67e6d6-be04-414e-a4ab-810ba6083aed", + "id": "8b03a387-bc0c-4a93-bc21-0624f124ce0c", "name": "Create document with custom ID or update entire document", "request": { "name": "Create document with custom ID or update entire document", @@ -1115,7 +1115,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "5188042a-83d4-419f-a825-f6355c1bf878", + "id": "bbed9855-68e5-404b-8f97-771119cd7114", "name": "No Content", "originalRequest": { "url": { @@ -1186,7 +1186,7 @@ { "listen": "test", "script": { - "id": "1c46b17e-1aa0-4a42-8c6d-9388214bf67c", + "id": "d72997aa-2fbc-43dd-b66e-0a4b5907be27", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:acronym/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1200,7 +1200,7 @@ } }, { - "id": "4fe9ae86-f51a-45c4-b3c6-2690034f7f67", + "id": "5c7e8aa8-864c-4e4e-ba2e-e29ff4051ac5", "name": "Update partial document", "request": { "name": "Update partial document", @@ -1284,7 +1284,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "b5e9a1ff-87ee-492e-827d-b13bcbeee550", + "id": "27e04e31-edcf-4ce7-abfb-a374fa1d90ae", "name": "No Content", "originalRequest": { "url": { @@ -1355,7 +1355,7 @@ { "listen": "test", "script": { - "id": "aefe13bf-0d32-4402-8e3f-7a72cfac7119", + "id": "8949452b-1b5f-48e4-a46a-aeb790a73fb3", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/dataentities/:acronym/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1369,7 +1369,7 @@ } }, { - "id": "9d8c4e10-c431-4549-a748-1a51a2c47a7e", + "id": "f66ebde0-7066-4a74-97b2-02ac352bc335", "name": "Delete document", "request": { "name": "Delete document", @@ -1440,7 +1440,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "f802affb-9440-43b3-aed5-b3830aaabe02", + "id": "39855bd6-ea33-4da6-b76b-c7967da516c6", "name": "No Content", "originalRequest": { "url": { @@ -1498,7 +1498,7 @@ { "listen": "test", "script": { - "id": "5b0be576-a12f-432f-9d36-714159b261c6", + "id": "019d314d-53d4-405e-a73d-ce307b3557d2", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/dataentities/:acronym/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1515,7 +1515,7 @@ "event": [] }, { - "id": "ff51a888-e783-4337-860d-718f3c690d2e", + "id": "8c8ef754-4cc6-417d-9edb-711a9da3acca", "name": "Customer profiles", "description": { "content": "", @@ -1523,7 +1523,7 @@ }, "item": [ { - "id": "d03b896f-7a58-4b66-99e1-22955907c3c4", + "id": "1c78568b-34d4-4a1e-baa2-7e77705b6185", "name": "Create new customer profile", "request": { "name": "Create new customer profile", @@ -1599,7 +1599,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "0814d9cb-25cf-45d6-9458-41760a689714", + "id": "fc814588-0f6c-43f3-bfb2-1bafce610a7f", "name": "OK", "originalRequest": { "url": { @@ -1689,7 +1689,7 @@ { "listen": "test", "script": { - "id": "4cab2f25-445e-44f3-b69d-dd22e5428fa1", + "id": "5e511635-5fd2-4031-bdbc-03978a95ca6c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/dataentities/CL/documents - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1705,7 +1705,7 @@ } }, { - "id": "3d80ab70-541e-4994-adb7-eebcb7d278a3", + "id": "c096e5ac-5a1c-4c5a-928a-71d7a0e75246", "name": "Update customer profile", "request": { "name": "Update customer profile", @@ -1793,7 +1793,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "00e12f71-e69a-47f2-8e26-0e4bde8bc5bd", + "id": "3420e2f8-96fe-4794-8662-0d63a0c041fa", "name": "OK", "originalRequest": { "url": { @@ -1884,7 +1884,7 @@ { "listen": "test", "script": { - "id": "d3e209b5-fcfb-40fc-a8fd-def36a0c74c4", + "id": "0d8c8d0f-2a65-4d84-8c0c-4aedd8bec86e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/dataentities/CL/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1900,7 +1900,7 @@ } }, { - "id": "43b46f26-c67f-411b-b206-eab6643c3736", + "id": "cbdda61e-dcc4-41d8-82bd-e874dda60a6a", "name": "Delete customer profile", "request": { "name": "Delete customer profile", @@ -1961,7 +1961,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "4dbd48a4-679e-4af0-91c4-71bf659416dc", + "id": "83542bd8-12dc-4bf5-b9d3-66b1bfbe3be3", "name": "No Content", "originalRequest": { "url": { @@ -2019,7 +2019,7 @@ { "listen": "test", "script": { - "id": "6c587359-a969-448d-ac1b-d542e9bb344d", + "id": "b4b17331-3f00-4ccc-8a8d-167a9a35478f", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/dataentities/CL/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2036,7 +2036,7 @@ "event": [] }, { - "id": "b040c63c-bf3b-434f-867b-0162b62a8d89", + "id": "4a8d2bf9-a585-4c2c-a337-c18dba2bb0de", "name": "Addresses", "description": { "content": "", @@ -2044,7 +2044,7 @@ }, "item": [ { - "id": "6d3c2a46-01d3-46eb-be8f-9ec31c3e9b8b", + "id": "3381dc2c-9f05-4e83-86ef-8883b8773b43", "name": "Create new customer address", "request": { "name": "Create new customer address", @@ -2120,7 +2120,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1483d933-b386-4e7b-88b4-3a5298e9fe54", + "id": "666f6b4f-5917-4c68-a6aa-1480112c6293", "name": "OK", "originalRequest": { "url": { @@ -2210,7 +2210,7 @@ { "listen": "test", "script": { - "id": "e1d2cb7c-903f-4519-a8ff-d9755d59fcf3", + "id": "5fdfe8d8-24b7-4fa9-bb0d-24b7d35dc9da", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/dataentities/AD/documents - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2226,7 +2226,7 @@ } }, { - "id": "77a65891-dd7c-4249-8ead-329d527bb8bc", + "id": "1da011ce-1693-4e60-8d5a-0a1ee5d57fb9", "name": "Update customer address", "request": { "name": "Update customer address", @@ -2314,7 +2314,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c53afe35-1576-44bd-bb83-a12ecb121925", + "id": "de199385-c292-4762-816b-80860d2cdfb0", "name": "OK", "originalRequest": { "url": { @@ -2405,7 +2405,7 @@ { "listen": "test", "script": { - "id": "25120e1a-c492-4820-af81-f4fba3239838", + "id": "887e112d-95e4-4e75-9bbe-22e3008133e4", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/dataentities/AD/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2421,7 +2421,7 @@ } }, { - "id": "8e9dfed6-a6c7-41db-8848-30b5ea5dbad3", + "id": "9eef762c-9bc3-4e23-a0c5-d7b44b11d9cc", "name": "Delete customer address", "request": { "name": "Delete customer address", @@ -2482,7 +2482,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "a2390193-c565-4ff2-be34-fcdc56850bdb", + "id": "03090b01-c675-48e4-b352-a657311e3fab", "name": "No Content", "originalRequest": { "url": { @@ -2540,7 +2540,7 @@ { "listen": "test", "script": { - "id": "cc5300f6-dbc8-4482-b335-30e59763b41f", + "id": "70c7de8f-4266-41a6-8448-8807dbc8307c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/dataentities/AD/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2557,7 +2557,7 @@ "event": [] }, { - "id": "bc9dcce8-9a58-4a42-bac8-c6a49670ecec", + "id": "cb9952c0-990a-4629-8b91-cd318d3b2298", "name": "Versions", "description": { "content": "", @@ -2565,7 +2565,7 @@ }, "item": [ { - "id": "4662bf83-cccc-4fd1-9693-d1b7d7945d67", + "id": "922c6adf-70f1-4f9b-8c5b-ba103227b30e", "name": "List versions", "request": { "name": "List versions", @@ -2641,7 +2641,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "498ce315-005d-4656-9edc-a4797ed5ec18", + "id": "a3427759-0929-43eb-9ca3-43f0fb9efbe5", "name": "OK", "originalRequest": { "url": { @@ -2710,7 +2710,7 @@ { "listen": "test", "script": { - "id": "a748116b-28c7-42fa-be14-a7cd5cb15e9a", + "id": "6d7337ca-3d56-4cb3-9326-37fa37fccd9f", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:acronym/documents/:id/versions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2726,7 +2726,7 @@ } }, { - "id": "a2bd3ad6-5749-46f9-9a8e-72095f0a2655", + "id": "38f72c95-208f-4892-a33e-aea2d6dca3f0", "name": "Get version", "request": { "name": "Get version", @@ -2813,7 +2813,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "16338b9e-bbab-4b77-9458-a99d0443dfe6", + "id": "fb039119-f00d-4662-947a-482f17ec33be", "name": "OK", "originalRequest": { "url": { @@ -2883,7 +2883,7 @@ { "listen": "test", "script": { - "id": "bbfa2df0-3863-49ca-8bae-e4780f91a4e2", + "id": "ed046a9a-8fcc-416a-9d72-972de05fdabd", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:acronym/documents/:id/versions/:versionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2899,7 +2899,7 @@ } }, { - "id": "1e3f34e3-2a3b-43be-b898-fc2b9467cf0d", + "id": "fe5a607c-dc32-4a17-b67e-b8740730c4a9", "name": "Update version", "request": { "name": "Update version", @@ -2986,7 +2986,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "fcac87a2-9434-4b4c-8117-05bc48b6494f", + "id": "2e77ae4f-b6c9-4e18-8dcb-e0fbaa4daae7", "name": "OK", "originalRequest": { "url": { @@ -3055,7 +3055,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "3b37e52c-4f70-4cef-a4e3-3fd37edead06", + "id": "28d6eff0-a0f3-4c74-8779-1499fbd1237d", "name": "Not modified. This response happens when the `versionId` informed in the path already corresponds to the current version of the document.", "originalRequest": { "url": { @@ -3115,7 +3115,7 @@ { "listen": "test", "script": { - "id": "4afbc025-f8a1-4d03-9dc3-1e9b1f72ee67", + "id": "2cff82a4-c343-4176-874f-6b48a764a3ad", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:acronym/documents/:id/versions/:versionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3134,7 +3134,7 @@ "event": [] }, { - "id": "31529e45-f395-48ea-bb67-c7249c3c09ce", + "id": "bdfb7674-a199-464c-9657-0d48aef9f632", "name": "Scroll", "description": { "content": "", @@ -3142,12 +3142,12 @@ }, "item": [ { - "id": "cc2bd675-2992-4db9-9dba-2ec029eba89c", + "id": "9e369821-96a1-41e6-82df-53957125f4be", "name": "Scroll documents", "request": { "name": "Scroll documents", "description": { - "content": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\n### First request example:\r\n```\r\n/dataentities/CL/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nAfter the first request, retrieve the token in the header `X-VTEX-MD-TOKEN` and make the next requests.\r\n\r\n### Example of subsequent requests:\r\n```\r\n/dataentities/CL/scroll?_token={tokenValue}\r\n```\r\n\r\n> To inform the number of documents per request, use the query string parameter `_size`, which has the maximum value of 1000.\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/CL/search?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/CL/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/CL/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `/dataentities/CL/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/CL/search?firstName=*Maria*` |\r\n| **Null values** | `/dataentities/CL/search?_where=firstName is null` |\r\n| **Non-null values** | `/dataentities/CL/search?_where=firstName is not null` |\r\n| **Difference** | `/dataentities/CL/search?_where=firstName<>maria` |\r\n| **Greater than** | `/dataentities/CL/search?_where=number>5` |\r\n| **Less than** | `/dataentities/CL/search?_where=date<2001-01-01` |\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens, you will receive an error with status code `429`.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "content": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\n### First request example:\r\n```\r\n/dataentities/CL/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nTo inform the number of documents per request, use the query string parameter `_size`, which has the maximum value of 1000.\r\n\r\nAfter the first request, retrieve the token in the header `X-VTEX-MD-TOKEN` and make the next requests.\r\n\r\n### Example of subsequent requests:\r\n```\r\n/dataentities/CL/scroll?_token={tokenValue}\r\n```\r\n\r\n>ℹ️ Learn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/CL/search?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/CL/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/CL/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `/dataentities/CL/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/CL/search?firstName=*Maria*` |\r\n| **Null values** | `/dataentities/CL/search?_where=firstName is null` |\r\n| **Non-null values** | `/dataentities/CL/search?_where=firstName is not null` |\r\n| **Difference** | `/dataentities/CL/search?_where=firstName<>maria` |\r\n| **Greater than** | `/dataentities/CL/search?_where=number>5` |\r\n| **Less than** | `/dataentities/CL/search?_where=date<2001-01-01` |\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens, you will receive an error with status code `429`.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -3261,7 +3261,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "af275960-e2d3-4b76-999d-f1ad10f7bfda", + "id": "b4de8c36-59ba-42ac-a434-5769c2cab22d", "name": "OK", "originalRequest": { "url": { @@ -3381,7 +3381,7 @@ "type": "text/plain" }, "key": "X-VTEX-MD-TOKEN", - "value": "n" + "value": "incididunt sunt Exc" }, { "disabled": true, @@ -3390,7 +3390,7 @@ "type": "text/plain" }, "key": "REST-Content-Total", - "value": "labore sit do" + "value": "sed " } ], "body": "[\n {\n \"id\": \"2f5dde81-1613-11ea-82ee-12f868feb457\",\n \"accountId\": \"a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2\",\n \"accountName\": \"apiexamples\",\n \"dataEntityId\": \"AS\"\n },\n {\n \"id\": \"3b3a3fc9-164b-11ea-82ee-121449f60ecb\",\n \"accountId\": \"a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2\",\n \"accountName\": \"apiexamples\",\n \"dataEntityId\": \"AS\"\n }\n]", @@ -3400,7 +3400,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "23504600-3770-4f62-bb7c-4b06a1d3a85e", + "id": "7885ae6e-5b90-4dab-bb0d-ad1d93e12234", "name": "Bad Request", "originalRequest": { "url": { @@ -3521,7 +3521,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "17d190af-0eeb-4924-aeea-42cfc834105c", + "id": "f25a4634-0a79-4412-9492-84200f0ce804", "name": "Too Many Requests. Wildcard queries temporarily blocked due to excessive usage. Consider adjusting your code to remove them or reduce the rate of search requests with wildcards (*). This temporary block may also be due to excessive use of requests with the parameter `keyword`.", "originalRequest": { "url": { @@ -3633,7 +3633,7 @@ { "listen": "test", "script": { - "id": "65b24efa-363b-466d-8f2f-1631489dd464", + "id": "a66f0411-8929-4d02-ad0a-9233438d9895", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:acronym/scroll - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3652,7 +3652,7 @@ "event": [] }, { - "id": "6c10bbd6-9ecb-4ade-a0e0-58f4d98f2817", + "id": "e0b6cae1-0520-460a-bba2-44cde07fb8f2", "name": "Search", "description": { "content": "", @@ -3660,12 +3660,12 @@ }, "item": [ { - "id": "788244ff-7d4f-476f-8405-87039ccc049d", + "id": "4c602c51-0167-471b-9695-5873fcd8abeb", "name": "Search documents", "request": { "name": "Search documents", "description": { - "content": "Retrieves Master Data v1 documents' information, while choosing which fields will be returned and filtering documents by specific fields.\r\n\r\n> Learn more about [Master Data v1 search queries](https://developers.vtex.com/vtex-rest-api/docs/how-the-queries-in-master-data-v1-work).\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/CL/search?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/CL/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/CL/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `/dataentities/CL/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/CL/search?firstName=*Maria*` |\r\n| **Null values** | `/dataentities/CL/search?_where=firstName is null` |\r\n| **Non-null values** | `/dataentities/CL/search?_where=firstName is not null` |\r\n| **Difference** | `/dataentities/CL/search?_where=firstName<>maria` |\r\n| **Greater than** | `/dataentities/CL/search?_where=number>5` |\r\n| **Less than** | `/dataentities/CL/search?_where=date<2001-01-01` |\n\r\n\r>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `503`. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "content": "Retrieves Master Data v1 documents' information, while choosing which fields will be returned and filtering documents by specific fields.\r\n\r\n>ℹ️ Learn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api) and [Querying documents in Master Data v1](https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1).\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/CL/search?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/CL/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/CL/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `/dataentities/CL/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/CL/search?firstName=*Maria*` |\r\n| **Null values** | `/dataentities/CL/search?_where=firstName is null` |\r\n| **Non-null values** | `/dataentities/CL/search?_where=firstName is not null` |\r\n| **Difference** | `/dataentities/CL/search?_where=firstName<>maria` |\r\n| **Greater than** | `/dataentities/CL/search?_where=number>5` |\r\n| **Less than** | `/dataentities/CL/search?_where=date<2001-01-01` |\n\r\n\r>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `503`. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -3761,7 +3761,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e52cfb3b-786b-43f2-b12d-dc6ead8d6751", + "id": "ae28e0bc-c3f0-4e66-8d48-a8f487efd6d4", "name": "OK", "originalRequest": { "url": { @@ -3873,7 +3873,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "2a9acff1-bcdb-435e-9de9-2e5cdbd0e22b", + "id": "34e00371-65ab-4e24-8f0b-009566d3daa3", "name": "Service Unavailable. Wildcard queries temporarily blocked due to excessive usage. Consider adjusting your code to remove them or reduce the rate of search requests with wildcards (*). This temporary block may also be due to excessive use of requests with the parameter `keyword`.", "originalRequest": { "url": { @@ -3967,7 +3967,7 @@ { "listen": "test", "script": { - "id": "68c2b5f6-7b1a-4dff-8397-ed65c4cae0eb", + "id": "c70c2fe1-0795-494a-a8e8-74122e2c6d12", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:acronym/search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3986,7 +3986,7 @@ "event": [] }, { - "id": "becd5e5d-4f3b-4c4d-b16b-c14b0ffa1489", + "id": "ce824cf5-8af7-4669-99ac-679759fb653e", "name": "Attachments", "description": { "content": "", @@ -3994,7 +3994,7 @@ }, "item": [ { - "id": "43732afd-35ad-4a51-a8c7-2dd1f58d7e3f", + "id": "3ee33734-1f7d-489d-9835-7d9f7b5b5992", "name": "Retrieve attachment", "request": { "name": "Retrieve attachment", @@ -4092,7 +4092,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "a608136e-991e-4a49-8e31-af8abbd6020d", + "id": "284d03e8-2c2f-47a6-8e73-9be9472f5415", "name": "OK", "originalRequest": { "url": { @@ -4155,7 +4155,7 @@ "value": "image/jpg" } ], - "body": "enim", + "body": "nulla incididunt deserunt id", "cookie": [] } ], @@ -4163,7 +4163,7 @@ { "listen": "test", "script": { - "id": "bfedad2e-6594-460c-b2ee-241216c2f7b7", + "id": "ceb5d327-f752-429f-8dc4-2d2f63c39f7a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:acronym/documents/:id/:field/attachments/:file-name - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4177,7 +4177,7 @@ } }, { - "id": "1e6c58f7-a674-4b15-9983-03a70acff6cd", + "id": "658b6ce3-2792-45ab-962c-48367a0fd663", "name": "Save attachment", "request": { "name": "Save attachment", @@ -4277,7 +4277,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "64a59fab-29a6-4541-81a4-3703a37bb425", + "id": "079c7965-4047-4575-ab7b-135f75daeee4", "name": "No Content", "originalRequest": { "url": { @@ -4354,7 +4354,7 @@ { "listen": "test", "script": { - "id": "9bd4ab6b-2aed-4d5f-8e56-05f0d39a27ac", + "id": "898a4ff1-e075-49b4-8da6-25f8cca48c51", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/dataentities/:acronym/documents/:id/:field/attachments - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4371,7 +4371,7 @@ "event": [] }, { - "id": "4249118e-b211-4ab1-bf6e-751c27eb7941", + "id": "e10308da-428a-488f-b3a1-7a54e563c15b", "name": "Clusters", "description": { "content": "", @@ -4379,7 +4379,7 @@ }, "item": [ { - "id": "9c533eb6-f115-4555-91c0-2ebd9592b639", + "id": "31f02821-eae1-4dfa-9929-9c1a63a72fa5", "name": "Validate document by clusters", "request": { "name": "Validate document by clusters", @@ -4464,7 +4464,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "62e0e478-25a3-4c53-a501-8cec9db82eff", + "id": "a7e0e65d-c06b-41d2-85c8-17278efa0395", "name": "OK", "originalRequest": { "url": { @@ -4536,7 +4536,7 @@ { "listen": "test", "script": { - "id": "94a9d152-5bad-4c10-ad6a-02eb9b0c80ef", + "id": "025a839b-a907-4870-91bb-52abf7fe0ec4", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/dataentities/:acronym/documents/:id/clusters - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -4552,7 +4552,7 @@ "event": [] }, { - "id": "c6d687f5-bd75-4477-a687-7fecf8b3f8c6", + "id": "5a4c07b1-f7e0-4291-8021-17b5c093e3fc", "name": "Score", "description": { "content": "", @@ -4560,7 +4560,7 @@ }, "item": [ { - "id": "f74ff33a-dde2-4098-924c-0bac10ea2613", + "id": "ffc35a76-63f6-49be-b994-ca79eab92c97", "name": "Update scores", "request": { "name": "Update scores", @@ -4645,7 +4645,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "8d6148e8-3d12-4761-af6a-7913ee0d142e", + "id": "345c9d97-d2b1-44fb-a216-1958c59bac48", "name": "No Content", "originalRequest": { "url": { @@ -4717,7 +4717,7 @@ { "listen": "test", "script": { - "id": "b6a08629-fa33-4015-8bf3-7a1d59d80aa6", + "id": "3d37bc10-ced6-488a-96fe-2f026eb0456a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:acronym/documents/:id/score - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4731,7 +4731,7 @@ } }, { - "id": "441eb0ca-87a5-4031-aa2b-9b7e48573b0a", + "id": "999d2f6d-9ac4-475d-9ec1-e3b3cd0b1710", "name": "Update score by field", "request": { "name": "Update score by field", @@ -4827,7 +4827,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "acf8a434-f550-44d9-b82f-6e01148c9f09", + "id": "63af720e-b94a-4b31-ab6f-d5ed9318b290", "name": "No Content", "originalRequest": { "url": { @@ -4900,7 +4900,7 @@ { "listen": "test", "script": { - "id": "41174163-67eb-4b1c-bde2-3b4aacbf3f29", + "id": "2318e4f3-2b1a-4c74-8261-cd8313b98efa", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:acronym/documents/:id/score/:field-name - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4914,7 +4914,7 @@ } }, { - "id": "8919cd6d-899a-4aa1-bb66-79d52c121ef9", + "id": "a873647a-3b64-4c5e-a292-dcd202a057d8", "name": "Delete score by field", "request": { "name": "Delete score by field", @@ -5010,7 +5010,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "458b12c2-cd04-49c5-b165-fbb282c3d603", + "id": "c286f18d-b652-49d0-b70e-dda51fccff28", "name": "No Content", "originalRequest": { "url": { @@ -5083,7 +5083,7 @@ { "listen": "test", "script": { - "id": "7c062023-36ee-4056-ab1a-bd7e64af0c15", + "id": "c92c3331-4497-49a8-8a78-492185fd5082", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/dataentities/:acronym/documents/:id/score/:field-name - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -5139,7 +5139,7 @@ } ], "info": { - "_postman_id": "2b832c77-819b-4d7a-86e4-7f0dcde9d8a6", + "_postman_id": "d25941b8-055a-4e9d-b67e-27f7d64f1fcc", "name": "Master Data API - v1", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": {