{ "opencollection": "1.0.0", "info": { "name": "Opply Activity Feed Ingredients API", "version": "0.0.0" }, "items": [ { "info": { "name": "Ingredients", "type": "folder" }, "items": [ { "info": { "name": "List of all inquiries for a brand", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/inquiries/ingredients/", "params": [ { "name": "name", "value": "", "type": "query", "description": "Supports searching using a string/substring of product_name" }, { "name": "ordering", "value": "", "type": "query", "description": "Supports sorting by name created. Use - to filter backwards" }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "product_uuid", "value": "", "type": "query", "description": "Supports searching by product to which ingredient is assigned" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "List of all inquiries for a brand" }, { "info": { "name": "Ingredient creation endpoint.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/inquiries/ingredients/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Ingredient creation endpoint." }, { "info": { "name": "api_v1_inquiries_ingredients_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/inquiries/ingredients/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "api_v1_inquiries_ingredients_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/inquiries/ingredients/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "api_v1_inquiries_ingredients_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/inquiries/ingredients/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "api_v1_inquiries_ingredients_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/inquiries/ingredients/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "api_v1_inquiries_ingredients_delete_documents_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/inquiries/ingredients/:uuid/delete-documents/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "api_v1_inquiries_ingredients_documents_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/inquiries/ingredients/:uuid/documents/", "params": [ { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "Retrieve assigned (copy) ingredients", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/inquiries/ingredients/:uuid/retrieve-assigned-ingredient/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve assigned (copy) ingredients" }, { "info": { "name": "api_v1_inquiries_ingredients_upload_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/inquiries/ingredients/:uuid/upload/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "Import ingredients from a CSV file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/inquiries/ingredients/process-csv/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Import ingredients from a CSV file.\n\nThe UUID is the UUID of an uploaded CompanyDocument.\nThe response UUID is a UUID that can be used to check the status of the task." }, { "info": { "name": "Get the status of an ingredients CSV import task", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/inquiries/ingredients/process-csv/status/:task_id/", "params": [ { "name": "task_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Poll the status of a previously triggered CSV import task." } ] } ], "bundled": true }