{ "opencollection": "1.0.0", "info": { "name": "IO.Common Accounts Operations API", "version": "1.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Operations", "type": "folder" }, "items": [ { "info": { "name": "Get list of possible generic operation types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Operations/types", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get list of possible generic operation types" }, { "info": { "name": "Get all the available operations for an account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Operations", "params": [ { "name": "Filter", "value": "", "type": "query" }, { "name": "Page", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "SortColumn", "value": "", "type": "query" }, { "name": "SortOrder", "value": "", "type": "query" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all the available operations for an account" }, { "info": { "name": "Create base operation - usable and visible to all the accounts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Operations", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create base operation - usable and visible to all the accounts" }, { "info": { "name": "Get operation details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Operations/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get operation details" }, { "info": { "name": "Update operation details", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Operations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Opeartion Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update operation details" }, { "info": { "name": "Delete operation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/Operations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Opeartion Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete operation" }, { "info": { "name": "Get the list of all the properties added to operations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Operations/properties", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the list of all the properties added to operations" }, { "info": { "name": "Get the defined properties for operations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Operations/definedProperties", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the defined properties for operations" }, { "info": { "name": "Create new operation property with parameters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Operations/definedProperties", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create new operation property with parameters" }, { "info": { "name": "Update existing operation property with parameters", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Operations/definedProperties/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Property parameter Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update existing operation property with parameters" }, { "info": { "name": "Delete existing operation property with parameters", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/Operations/definedProperties/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Property parameter Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete existing operation property with parameters" }, { "info": { "name": "Bulk upsert/delete operation properties with parameters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Operations/definedProperties/bulk", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Bulk upsert/delete operation properties with parameters" }, { "info": { "name": "Create account specific extended operation from base operation.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Operations/extend", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create account specific extended operation from base operation." }, { "info": { "name": "Update the Issue / Receive unique-item status assignments for an operation.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Operations/:operationId/unique-item-statuses", "params": [ { "name": "operationId", "value": "", "type": "path", "description": "Operation Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update the Issue / Receive unique-item status assignments for an operation." }, { "info": { "name": "Bulk-replace the per-operation flag configuration. PUT semantics: the body\r\nlists every desired `(FlagTypeId, FlagActionType)` tuple; missing rows\r\nare deleted, new rows are added, intersections are kept untouched. Rejects\r\nany payload that declares both `Raise` and `Clear` for the same\r\n`FlagTypeId`. Feature-gated on `\"UNIQUE_ITEMS\"`.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Operations/:operationId/operation-flags", "params": [ { "name": "operationId", "value": "", "type": "path" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Bulk-replace the per-operation flag configuration. PUT semantics: the body\r\nlists every desired `(FlagTypeId, FlagActionType)` tuple; missing rows\r\nare deleted, new rows are added, intersections are kept untouched. Rejects\r\nany payload that declares both `Raise` and `Clear` for the same\r\n`FlagTypeId`. Feature-gated on `\"UNIQUE_ITEMS\"`." }, { "info": { "name": "Get operation dimensions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Operations/:opId/dimensions", "params": [ { "name": "opId", "value": "", "type": "path" }, { "name": "Filter", "value": "", "type": "query" }, { "name": "Page", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "SortColumn", "value": "", "type": "query" }, { "name": "SortOrder", "value": "", "type": "query" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get operation dimensions" }, { "info": { "name": "Add operation dimension", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Operations/:opId/dimensions", "params": [ { "name": "opId", "value": "", "type": "path", "description": "Operation id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Add operation dimension" }, { "info": { "name": "Bulk update operation dimensions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Operations/:opId/dimensions", "params": [ { "name": "opId", "value": "", "type": "path", "description": "Operation Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Bulk update operation dimensions" }, { "info": { "name": "Get the list of all the properties added to operations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Operations/dimensions/properties", "params": [ { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the list of all the properties added to operations" }, { "info": { "name": "Update operation dimension", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Operations/:opId/dimensions/:id", "params": [ { "name": "opId", "value": "", "type": "path", "description": "Operation Id" }, { "name": "id", "value": "", "type": "path", "description": "Operation dimension Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update operation dimension" }, { "info": { "name": "Remove operation dimension", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/Operations/:opId/dimensions/:id", "params": [ { "name": "opId", "value": "", "type": "path", "description": "OperationId" }, { "name": "id", "value": "", "type": "path", "description": "Operation dimension Id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Remove operation dimension" }, { "info": { "name": "Get operation questons", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Operations/:id/questions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Operation id" }, { "name": "Filter", "value": "", "type": "query" }, { "name": "Page", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "SortColumn", "value": "", "type": "query" }, { "name": "SortOrder", "value": "", "type": "query" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get operation questons" }, { "info": { "name": "Add operation question", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/Operations/:id/questions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Operation id" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Add operation question" }, { "info": { "name": "Bulk update operation questions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Operations/:id/questions", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Bulk update operation questions" }, { "info": { "name": "Update selected question", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Operations/:id/questions/:questionId", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "questionId", "value": "", "type": "path" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update selected question" }, { "info": { "name": "Delete question", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/Operations/:id/questions/:questionId", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "questionId", "value": "", "type": "path" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete question" }, { "info": { "name": "Get operation scan card layout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Operations/:operationId/card", "params": [ { "name": "operationId", "value": "", "type": "path" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get operation scan card layout" }, { "info": { "name": "Update operation scan card layout", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Operations/:operationId/card", "params": [ { "name": "operationId", "value": "", "type": "path" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update operation scan card layout" }, { "info": { "name": "Get operation scan line layout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Operations/:operationId/line", "params": [ { "name": "operationId", "value": "", "type": "path" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get operation scan line layout" }, { "info": { "name": "Update operation scan line layout", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/Operations/:operationId/line", "params": [ { "name": "operationId", "value": "", "type": "path" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update operation scan line layout" }, { "info": { "name": "Get the user groups and locations where operation is set", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/Operations/:operationId/usergrouplocations", "params": [ { "name": "operationId", "value": "", "type": "path" }, { "name": "Account", "value": "", "type": "query", "description": "Account" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://identity.scanbro.com/connect/authorize", "accessTokenUrl": "https://identity.scanbro.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the user groups and locations where operation is set" } ] } ], "bundled": true }