{ "opencollection": "1.0.0", "info": { "name": "Vijil Console API (Combined) agent-configurations demographics API", "version": "0.1.0" }, "items": [ { "info": { "name": "demographics", "type": "folder" }, "items": [ { "info": { "name": "List Dimensions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/demographics/", "params": [ { "name": "protected_class_only", "value": "", "type": "query", "description": "Filter to only protected class dimensions" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results" }, { "name": "offset", "value": "", "type": "query", "description": "Number of results to skip" } ] }, "docs": "List demographic dimensions.\n\nRequires agent:read permission (dimensions are global reference data)." }, { "info": { "name": "Create Dimension", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/demographics/", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new demographic dimension.\n\nRequires super admin permission (dimensions are global)." }, { "info": { "name": "Get Dimension", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/demographics/:dimension_id", "params": [ { "name": "dimension_id", "value": "", "type": "path" } ] }, "docs": "Get a dimension by ID, including its values." }, { "info": { "name": "Update Dimension", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/demographics/:dimension_id", "params": [ { "name": "dimension_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a demographic dimension.\n\nRequires super admin permission." }, { "info": { "name": "Delete Dimension", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/demographics/:dimension_id", "params": [ { "name": "dimension_id", "value": "", "type": "path" } ] }, "docs": "Delete a demographic dimension and all its values.\n\nRequires super admin permission." }, { "info": { "name": "Get Dimension By Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/demographics/by-name/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get a dimension by name, including its values." }, { "info": { "name": "List Values", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/demographics/:dimension_id/values", "params": [ { "name": "dimension_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results" }, { "name": "offset", "value": "", "type": "query", "description": "Number of results to skip" } ] }, "docs": "List values for a dimension." }, { "info": { "name": "Add Value", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/demographics/:dimension_id/values", "params": [ { "name": "dimension_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a value to a dimension.\n\nRequires super admin permission." }, { "info": { "name": "Bulk Add Values", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/demographics/:dimension_id/values/bulk", "params": [ { "name": "dimension_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk add values to a dimension.\n\nRequires super admin permission." }, { "info": { "name": "Update Value", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/demographics/values/:value_id", "params": [ { "name": "value_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a value.\n\nRequires super admin permission." }, { "info": { "name": "Delete Value", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/demographics/values/:value_id", "params": [ { "name": "value_id", "value": "", "type": "path" } ] }, "docs": "Delete a value.\n\nRequires super admin permission." }, { "info": { "name": "List Dimensions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/dimensions/", "params": [ { "name": "protected_class_only", "value": "", "type": "query", "description": "Filter to only protected class dimensions" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results" }, { "name": "offset", "value": "", "type": "query", "description": "Number of results to skip" } ] }, "docs": "List demographic dimensions.\n\nRequires agent:read permission (dimensions are global reference data)." }, { "info": { "name": "Create Dimension", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dimensions/", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new demographic dimension.\n\nRequires super admin permission (dimensions are global)." }, { "info": { "name": "Get Dimension", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/dimensions/:dimension_id", "params": [ { "name": "dimension_id", "value": "", "type": "path" } ] }, "docs": "Get a dimension by ID, including its values." }, { "info": { "name": "Update Dimension", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/dimensions/:dimension_id", "params": [ { "name": "dimension_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a demographic dimension.\n\nRequires super admin permission." }, { "info": { "name": "Delete Dimension", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/dimensions/:dimension_id", "params": [ { "name": "dimension_id", "value": "", "type": "path" } ] }, "docs": "Delete a demographic dimension and all its values.\n\nRequires super admin permission." }, { "info": { "name": "Get Dimension By Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/dimensions/by-name/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get a dimension by name, including its values." }, { "info": { "name": "List Values", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/dimensions/:dimension_id/values", "params": [ { "name": "dimension_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results" }, { "name": "offset", "value": "", "type": "query", "description": "Number of results to skip" } ] }, "docs": "List values for a dimension." }, { "info": { "name": "Add Value", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dimensions/:dimension_id/values", "params": [ { "name": "dimension_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a value to a dimension.\n\nRequires super admin permission." }, { "info": { "name": "Bulk Add Values", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dimensions/:dimension_id/values/bulk", "params": [ { "name": "dimension_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk add values to a dimension.\n\nRequires super admin permission." }, { "info": { "name": "Update Value", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/dimensions/values/:value_id", "params": [ { "name": "value_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a value.\n\nRequires super admin permission." }, { "info": { "name": "Delete Value", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/dimensions/values/:value_id", "params": [ { "name": "value_id", "value": "", "type": "path" } ] }, "docs": "Delete a value.\n\nRequires super admin permission." } ] } ], "bundled": true }