{ "opencollection": "1.0.0", "info": { "name": "Benchling AA Sequences Mixtures API", "version": "2.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/api/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Mixtures", "type": "folder" }, "items": [ { "info": { "name": "List mixtures", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/mixtures", "params": [ { "name": "nextToken", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "createdAt", "value": "", "type": "query", "description": "Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those created in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND = and <= operators (but not < or >). If any schemaField filters are present, the schemaId param must also be present. Note that all operators must be separated from any values by a single space.\n" }, { "name": "archiveReason", "value": "", "type": "query", "description": "Archive reason. Restricts items to those with the specified archive reason. Use \"NOT_ARCHIVED\" to filter for unarchived mixtures. Use \"ANY_ARCHIVED\" to filter for archived mixtures regardless of reason. Use \"ANY_ARCHIVED_OR_NOT_ARCHIVED\" to return items for both archived and unarchived.\n" }, { "name": "mentions", "value": "", "type": "query", "description": "Comma-separated list of resource IDs. Restricts results to those that mention the given items in the description.\n" }, { "name": "ids", "value": "", "type": "query", "description": "Comma-separated list of ids. Matches all of the provided IDs, or returns a 400 error that includes a list of which IDs are invalid.\n" }, { "name": "names.anyOf", "value": "", "type": "query", "description": "Comma-separated list of names. Maximum of 100. Restricts results to those that match any of the specified names, aliases, or entity registry IDs, case insensitive. Warning - this filter can be non-performant due to case insensitivity.\n" }, { "name": "names.anyOf.caseSensitive", "value": "", "type": "query", "description": "Comma-separated list of names. Maximum of 100. Restricts results to those that match any of the specified names, aliases, or entity registry IDs, case sensitive.\n" }, { "name": "entityRegistryIds.anyOf", "value": "", "type": "query", "description": "Comma-separated list of entity registry IDs. Maximum of 100. Restricts results to those that match any of the specified registry IDs.\n" }, { "name": "ingredientComponentEntityIds", "value": "", "type": "query", "description": "Comma-separated list of ingredient component entity ids. Matches all mixtures that contain ingredients whose component entities match all of the provided IDs, or returns a 400 error that includes a list of which IDs are invalid.\n" }, { "name": "ingredientComponentEntityIds.anyOf", "value": "", "type": "query", "description": "Comma-separated list of ingredient component entity ids. Maximum of 100. Matches all mixtures that contain ingredients whose component entities match any of the provided IDs, or returns a 400 error that includes a list of which IDs are invalid.\n" }, { "name": "authorIds.anyOf", "value": "", "type": "query", "description": "Comma separated list of user or app IDs. Maximum of 100." } ] }, "docs": "List mixtures" }, { "info": { "name": "Create a mixture", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/mixtures", "body": { "type": "json", "data": "{}" } }, "docs": "Create a mixture.\nTo create a new child mixture (eg. a prep) from a parent mixture (eg. a recipe), set the parent mixture field and specify the desired final state for your ingredients.\nBenchling will recognize that any ingredients you specify that match ingredients on the parent mixture (based on component entity) are inherited. This can be seen on the returned `ingredients[i].hasParent` attribute.\n" }, { "info": { "name": "Get a mixture", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/mixtures/:mixture_id", "params": [ { "name": "mixture_id", "value": "", "type": "path" } ] }, "docs": "Get a mixture" }, { "info": { "name": "Update a mixture", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/mixtures/:mixture_id", "params": [ { "name": "mixture_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a mixture.\nTo change the parent mixture, set the parent mixture field and specify the desired final state for your ingredients.\nBenchling will recognize that any ingredients you specify that match ingredients on the parent mixture (based on component entity) are inherited. This can be seen on the returned `ingredients[i].hasParent` attribute.\n" }, { "info": { "name": "Archive mixtures", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/mixtures:archive", "body": { "type": "json", "data": "{}" } }, "docs": "Archive mixtures" }, { "info": { "name": "Bulk Create mixtures", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/mixtures:bulk-create", "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple mixtures. Limit of 1000 mixtures per request.\nTo create new child mixtures (eg. a prep) from parent mixtures (eg. a recipe), set the parent mixture field and specify the desired final state for your ingredients.\nBenchling will recognize that any ingredients you specify that match ingredients on the parent mixtures (based on component entity) are inherited. This can be seen on the returned `ingredients[i].hasParent` attribute.\n" }, { "info": { "name": "Bulk Update mixtures", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/mixtures:bulk-update", "body": { "type": "json", "data": "{}" } }, "docs": "Update multiple mixtures.\nTo change the parent mixture on your specified mixtures, set the parent mixture field and specify the desired final state for your ingredients.\nBenchling will recognize that any ingredients you specify that match ingredients on the parent mixtures (based on component entity) are inherited. This can be seen on the returned `ingredients[i].hasParent` attribute.\n" }, { "info": { "name": "Unarchive mixtures", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/mixtures:unarchive", "body": { "type": "json", "data": "{}" } }, "docs": "Unarchive mixtures" } ] } ], "bundled": true }