{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Indices API", "version": "1.0" }, "items": [ { "info": { "name": "Indices", "type": "folder" }, "items": [ { "info": { "name": "VTex Get indices", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/dataentities/:dataEntityName/indices", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "dataEntityName", "value": "", "type": "path", "description": "Name of the data entity." } ] }, "docs": "Returns the list of [indices](https://developers.vtex.com/docs/guides/master-data-components#index) by data entity. \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` e" }, { "info": { "name": "VTex Create index", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/dataentities/:dataEntityName/indices", "params": [ { "name": "dataEntityName", "value": "", "type": "path", "description": "Name of the data entity." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an [index](https://developers.vtex.com/docs/guides/master-data-components#index). \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 applic" }, { "info": { "name": "VTex Get index by name", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/dataentities/:dataEntityName/indices/:index_name", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "dataEntityName", "value": "", "type": "path", "description": "Name of the data entity." }, { "name": "index_name", "value": "", "type": "path", "description": "Name of the index." } ] }, "docs": "Retrieves an [index](https://developers.vtex.com/docs/guides/master-data-components#index). \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 appl" }, { "info": { "name": "VTex Delete index by name", "type": "http" }, "http": { "method": "DELETE", "url": "https://{providerApiEndpoint}/api/dataentities/:dataEntityName/indices/:index_name", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "dataEntityName", "value": "", "type": "path", "description": "Name of the data entity." }, { "name": "index_name", "value": "", "type": "path", "description": "Name of the index." } ] }, "docs": "Deletes an [index](https://developers.vtex.com/docs/guides/master-data-components#index). \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 applic" } ] } ], "bundled": true }