Welcome to the Labii API! This powerful tool is designed to streamline your workflow and enhance your applications with robust data integration capabilities. Whether you're a developer looking to leverage our features or a business seeking to optimize your processes, the Labii API provides a comprehensive solution tailored to your needs.
\nThe Labii API is a RESTful API that provides programmatic access to the Labii platform, enabling developers to automate tasks and integrate Labii with other tools. The API supports all standard HTTP methods: GET, POST, PUT, and DELETE, offering flexibility and compatibility with various programming languages and tools.
\nThe Labii API is designed for ease of use and provides extensive documentation on each endpoint. Each endpoint includes information on:
\nHTTP Method: The HTTP verb to use (GET, POST, PUT, DELETE).
\nEndpoint URL: The unique path to the resource.
\nParameters: Required and optional parameters for requests.
\nResponses: Expected response format and data.
\nResource-Based Architecture: Each endpoint in the Labii API represents a specific resource within the Labii platform, such as a project, experiment, or row.
\nAuthentication & Authorization: The Labii API uses OAuth 2.0 for secure authentication and authorization, ensuring that only authorized users can access data.
\nPagination & Filtering: Built-in support for pagination and filtering lets users retrieve specific data subsets based on various criteria, improving data retrieval efficiency.
\nThe Labii API uses two primary types of URLs for resource access:
\nList and Detail Views
\nList View (for retrieving lists of objects): {{base_url}}/{app}/{model}/list/{level}/{sid}/{serializer}/
Detail View (for retrieving details of a single object): {{base_url}}/{app}/{model}/detail/{sid}/
The base_url is typically set to https://www.labii.dev/ but can be customized for organizations with dedicated Labii servers: https://[your-subdomain].labii.dev/
• app: The name of the application.
• model: The name of the data model (e.g., projects, experiments).
• level: Determines the scope of records to retrieve (see the Levels section in the Labii documentation for details).
• sid: A static, encrypted identifier for the object. It must align with the specified level (e.g., if level=organization, the sid must match the organization SID).
• serializer: Controls the detail level of returned data with three options:
• name: Returns only the SID and name of the object (fastest).
• list: Returns selected fields (fast).
• detail: Returns all fields (slowest).
The Labii API includes multiple objects representing different entities within the Labii platform. Each object belongs to a specific app and model, with a corresponding set of methods available for interaction.
\nThe Labii API supports the following HTTP methods:
\n• GET: Retrieve one or more objects.
• POST: Create a new object.
• PUT: Update an existing object.
• PATCH: Partially update an existing object.
• DELETE: Delete an object.
User access is role-based. Permissions vary based on organizational and project-level roles.
\n• Admin: Full access to organization resources.
• Member: Access as a standard organization member.
• Alumni: Limited access for former members.
• User: External users without organizational access.
• Anonymous: Unauthorized users.
• Project Manager: Full project access.
• Project Edit: Edit permissions within the project.
• Project View: View-only access within the project.
The serializer defines the level of detail for returned data, each serving different use cases:
\n• name: Returns only the SID and name.
• list: Provides basic fields relevant to each table.
• detail: Returns a comprehensive set of fields, offering the full record structure.
By providing these serializers, Labii allows developers to optimize data retrieval according to their needs, balancing speed and detail.
\nTo begin using the Labii API, you'll need to sign up for an account and obtain your API key. The following steps will guide you through the setup process:
\nSign Up: Create an account on the Labii platform.
\nObtain API Key: After registration, navigate to your dashboard to generate your unique API key.
\nDocumentation: Review our detailed API documentation, which covers endpoints, request methods, and response formats.
\nTest the API: Use our sandbox environment to experiment with API calls before going live.
\nIf you encounter any issues while using the Labii API, we’re here to help! To report a problem, please follow these steps:
\nCheck the Documentation: Ensure that the issue isn't addressed in our documentation.
\nSubmit a Support Ticket: Use our support portal to submit a ticket with detailed information about the issue, including error messages and steps to reproduce the problem.
\nMonitor Updates: Keep an eye on our status page for any ongoing incidents or maintenance updates that may affect API performance.
\nWe provide several resources to assist you:
\nAPI Documentation: Comprehensive guides and examples to help you integrate and utilize the API effectively.
\nCommunity Forum: Join our community forum to discuss with other users, share tips, and find solutions to common problems.
\nSupport Team: Reach out to our dedicated support team via email or the contact form on our website for personalized assistance.
\nWe’re excited to see what you build with the Labii API! If you have any questions or need further assistance, don't hesitate to reach out. Happy coding!
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"38730820","collectionId":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","publishedId":"2sAY4xB29e","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"01579b"},"publishDate":"2024-11-03T05:50:08.000Z"},"item":[{"name":"Authentication","item":[{"name":"Get Access Token","event":[{"listen":"test","script":{"id":"6e92b1aa-ca7d-4d62-90f9-74238b0bbf2b","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Response has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," const requiredFields = [\"sid\", \"first_name\", \"last_name\", \"email\", \"phone\", \"timezone\", \"language\", \"token\", \"secret\"];"," requiredFields.forEach(field => {"," pm.expect(responseData).to.have.property(field);"," });","});","","","pm.test(\"Email is in a valid format\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.email).to.be.a('string').and.to.match(/^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$/, \"Email is not in a valid format\");","});","","","pm.test(\"Phone is in a valid format\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.phone).to.match(/^\\+\\d{1,3}-\\d{3}-\\d{3}-\\d{4}$/);","});",""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"4801925e-8f01-4fa5-84a1-d1974fc76dc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"{{email}}\",\n \"password\": \"{{password}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.labii.dev/accounts/auth/","description":"This endpoint allows the user to authenticate their account by providing their username (email) and password.
\nusername (string): The username or email of the user.
password (string): The password for the user's account.
The response will be a JSON object with the following fields:
\nsid (string): The session ID.
first_name (string): The first name of the user.
last_name (string): The last name of the user.
full_name (string): The full name of the user.
email (string): The email address of the user.
phone (string): The phone number of the user.
timezone (string): The timezone of the user.
language (string): The language preference of the user.
token (string): The authentication token.
secret (string): A secret associated with the user's account.
{\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"first_name\": {\"type\": \"string\"},\n \"last_name\": {\"type\": \"string\"},\n \"full_name\": {\"type\": \"string\"},\n \"email\": {\"type\": \"string\"},\n \"phone\": {\"type\": \"string\"},\n \"timezone\": {\"type\": \"string\"},\n \"language\": {\"type\": \"string\"},\n \"token\": {\"type\": \"string\"},\n \"secret\": {\"type\": \"string\"}\n }\n}\n\nThis endpoint allows you to create a new API key for the specified organization.
\nname (string, required): The name of the API key.
\nexpiry_date (string, required): The expiry date of the API key.
\nThe response will be a JSON object with the following properties:
\nsid (string): The unique identifier of the API key.
\nname (string): The name of the API key.
\nkey (string): The API key value.
\nuser (string): The user associated with the API key.
\ncreated (string): The creation date of the API key.
\nexpiry_date (string): The expiry date of the API key.
\nhelp_text (object): Additional information about the API key, including name, revoked status, expiry date, and unique identifier (sid).
\nchange_permission (boolean): Indicates whether the user has permission to change the API key.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"key\": {\"type\": \"string\"},\n \"user\": {\"type\": \"string\"},\n \"created\": {\"type\": \"string\"},\n \"expiry_date\": {\"type\": \"string\"},\n \"help_text\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\"type\": \"string\"},\n \"revoked\": {\"type\": \"string\"},\n \"expiry_date\": {\"type\": \"string\"},\n \"sid\": {\"type\": \"string\"}\n }\n },\n \"change_permission\": {\"type\": \"boolean\"}\n }\n}\n\nThis endpoint is used to log out the user from their account.
\nNo request body is required for this endpoint.
\nThe response for this request is a JSON object with the following schema:
\n{\n \"message\": \"string\"\n}\n\nmessage: A string indicating the status of the logout operation.Labii Authentication provides a secure and flexible framework for accessing our APIs, supporting both token authentication and API key authentication methods. Token authentication ensures that users can securely access resources by verifying their identity through dynamically generated tokens, while API key authentication allows for straightforward access using unique keys assigned to each user or application. This dual approach offers developers the flexibility to choose the authentication method that best suits their needs, ensuring robust security and seamless integration with Labii's powerful API services.
\n","_postman_id":"32fb0dfd-6b34-4960-a814-078112558ce2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Organization","item":[{"name":"Get Organization List","event":[{"listen":"test","script":{"id":"44007761-2fb3-49be-8d7d-b6a7cad81d2f","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is within an acceptable range\", function () {"," pm.expect(pm.response.responseTime).to.be.below(500);","});","","","pm.test(\"Response has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData).to.have.property('page_size');"," pm.expect(responseData).to.have.property('page_number');"," pm.expect(responseData).to.have.property('page_count');"," pm.expect(responseData).to.have.property('count');"," pm.expect(responseData).to.have.property('next');"," pm.expect(responseData).to.have.property('previous');"," pm.expect(responseData).to.have.property('add_permission');"," pm.expect(responseData).to.have.property('results');","});","","","pm.test(\"Validate the results array\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array');"," responseData.results.forEach(function(result) {"," pm.expect(result).to.be.an('object');"," pm.expect(result.sid).to.be.a('string');"," pm.expect(result.name).to.be.a('string');"," pm.expect(result.username).to.be.a('string');"," pm.expect(result.description).to.be.a('string');"," pm.expect(result.logo_icon).to.exist; // Can be null"," pm.expect(result.logo_wordmark).to.exist; // Can be null"," pm.expect(result.is_academic).to.be.a('boolean');"," pm.expect(result.plan).to.be.a('string');"," pm.expect(result.change_permission).to.be.a('boolean');"," });","});","","","pm.test(\"Verify response attributes\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," "," responseData.results.forEach(function(result) {"," pm.expect(result.sid).to.be.a('string').and.to.have.lengthOf.at.least(1, \"sid should be a non-empty string\");"," pm.expect(result.name).to.be.a('string').and.to.have.lengthOf.at.least(1, \"name should be a non-empty string\");"," pm.expect(result.username).to.be.a('string').and.to.have.lengthOf.at.least(1, \"username should be a non-empty string\");"," pm.expect(result.is_academic).to.be.a('boolean', \"is_academic should be a boolean\");"," pm.expect(result.change_permission).to.be.a('boolean', \"change_permission should be a boolean\");"," });","});",""],"type":"text/javascript"}}],"id":"6b6618f7-cf93-4bd5-a37c-de020bc524a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/organizations/organization/list/user/{{user_sid}}/list/","description":"This endpoint retrieves a list of organizations associated with the specified user.
\nAll active organization members are authorized to make API calls.
\nlevel: Specifies the scope of records to retrieve. Only the user level is allowed in this case.
sid: The static, encrypted ID associated with a Labii object. Here, it should refer specifically to the user's SID.
serializer: Defines the extent of fields included in the returned data, with three available options:
name: Returns only the SID and name of the object, optimized for speed.
list: Provides selected fields from the object, offering a quick response.
detail: Retrieves all fields from the object, which is slower.
This request does not require a request body.
\nThe response will be a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"page_size\": {\"type\": \"integer\"},\n \"page_number\": {\"type\": \"integer\"},\n \"page_count\": {\"type\": \"integer\"},\n \"count\": {\"type\": \"integer\"},\n \"next\": {\"type\": [\"string\", \"null\"]},\n \"previous\": {\"type\": [\"string\", \"null\"]},\n \"add_permission\": {\"type\": \"boolean\"},\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"username\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"logo_icon\": {\"type\": [\"string\", \"null\"]},\n \"logo_wordmark\": {\"type\": [\"string\", \"null\"]},\n \"is_academic\": {\"type\": \"boolean\"},\n \"plan\": {\"type\": \"string\"},\n \"change_permission\": {\"type\": \"boolean\"}\n }\n }\n }\n }\n}\n\nThis endpoint retrieves the detailed information about a specific organization.
\nAll active organization members are authorized to make API calls.
\nNo request body is required for this request.
\norganization_sid_test_edit (path parameter) - The unique identifier for the organization.The response for this request is a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"username\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"language\": { \"type\": \"string\" },\n \"logo_icon\": { \"type\": [\"string\", \"null\"] },\n \"logo_wordmark\": { \"type\": [\"string\", \"null\"] },\n \"navbar_background_color\": { \"type\": [\"string\", \"null\"] },\n \"navbar_text_color\": { \"type\": [\"string\", \"null\"] },\n \"print_header\": { \"type\": \"string\" },\n \"permission_structure\": { \"type\": \"string\" },\n \"plan\": { \"type\": \"string\" },\n \"enable_antivirus_scan\": { \"type\": \"boolean\" },\n \"enable_password_expiration\": { \"type\": \"boolean\" },\n \"password_expiration_days\": { \"type\": \"integer\" },\n \"backup_frequency\": { \"type\": \"string\" },\n \"backup_rate\": { \"type\": \"integer\" },\n \"metadata\": { \"type\": \"array\" },\n \"credits\": { \"type\": \"string\" },\n \"user_quota\": { \"type\": \"integer\" },\n \"project_quota\": { \"type\": \"integer\" },\n \"table_quota\": { \"type\": \"integer\" },\n \"is_academic\": { \"type\": \"boolean\" },\n \"close_account\": { \"type\": \"string\" },\n \"update_reference\": { \"type\": \"string\" },\n \"updated_by\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" }\n }\n },\n \"date_updated\": { \"type\": \"string\" },\n \"date_created\": { \"type\": \"string\" },\n \"personnel\": {\n \"type\": \"object\",\n \"properties\": {\n \"count\": { \"type\": \"integer\" },\n \"sid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" }\n }\n },\n \"is_archived\": { \"type\": \"boolean\" },\n \"help_text\": {\n \"type\": \"object\",\n \"properties\": {\n // Properties omitted for brevity\n }\n },\n \"change_permission\": { \"type\": \"boolean\" }\n }\n}\n\nThis endpoint allows the user to update specific fields of the resource.
\nOnly the Administrators can edit organization details.
\nname: (text) The name of the resource.
description: (text) The description of the resource.
language: (text) The language of the resource.
logo_icon: (text) The URL or path of the icon for the resource's logo.
logo_wordmark: (text) The URL or path of the wordmark for the resource's logo.
navbar_background_color: (text) The background color of the navigation bar.
navbar_text_color: (text) The text color of the navigation bar.
print_header: (text) The header for printing.
enable_antivirus_scan: (boolean) Indicates whether antivirus scan is enabled or not.
enable_password_expiration: (boolean) Indicates whether password expiration is enabled or not.
password_expiration_days: (number) The number of days after which the password will expire.
metadata: (array) Additional metadata for the resource.
status: (string) The status of the update operation.
message: (string) A message indicating the result of the update operation.
The Labii Organization API allows users to manage and interact with organizations within the Labii platform programmatically. With this API, users can retrieve a list of all organizations they belong to, which is useful for quick access to their affiliated groups and associated resources. Additionally, users can obtain detailed information about a specific organization by providing the organization’s identifier, enabling them to access metadata and settings specific to that organization. However, the API does not allow users to create new organizations, ensuring that organization creation remains restricted to specific administrative channels. This design prioritizes controlled access while enabling efficient organization management for existing users.
\n","_postman_id":"ff291f74-2640-4b6c-af4c-e6d1c1f170b0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"People","item":[{"name":"Get People List","event":[{"listen":"test","script":{"id":"013ef499-962a-4caa-bbe8-efab7be7e1e5","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is within an acceptable range\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Response has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData).to.have.property('page_size');"," pm.expect(responseData).to.have.property('page_number');"," pm.expect(responseData).to.have.property('page_count');"," pm.expect(responseData).to.have.property('count');"," pm.expect(responseData).to.have.property('next');"," pm.expect(responseData).to.have.property('previous');"," pm.expect(responseData).to.have.property('add_permission');"," pm.expect(responseData).to.have.property('results');","});","","","pm.test(\"Validate the results array and its elements\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array');"," responseData.results.forEach(function(result) {"," pm.expect(result).to.be.an('object');"," pm.expect(result.sid).to.be.a('string');"," pm.expect(result.name).to.be.a('string');"," pm.expect(result.email).to.be.a('string');"," pm.expect(result.title).to.be.a('string');"," pm.expect(result.is_administrator).to.be.a('boolean');"," pm.expect(result.date_start).to.be.a('string');"," pm.expect(result.date_end).to.be.a('string').or.to.be.null;"," pm.expect(result.is_archived).to.be.a('boolean');"," pm.expect(result.change_permission).to.be.a('boolean');"," });","});","","","pm.test(\"Verify presence and data types of specific fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," "," responseData.results.forEach(function(result) {"," pm.expect(result.sid).to.be.a('string');"," pm.expect(result.name).to.be.a('string');"," pm.expect(result.email).to.be.a('string');"," pm.expect(result.title).to.be.a('string');"," pm.expect(result.date_start).to.be.a('string');"," pm.expect(result.is_archived).to.be.a('boolean');"," });","});",""],"type":"text/javascript"}}],"id":"ec886f88-f1f1-4fb0-86c3-364e67313d3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/organizations/personnel/list/organization/{{organization_sid_test_administrator}}/list/","description":"This endpoint makes an HTTP GET request to retrieve the data. The request does not include a request body.
\nAll active organization members are authorized to make API calls.
\nThe response body will contain the data requested by the client in the following JSON schema:
\n{\n \"page_size\": 0,\n \"page_number\": 0,\n \"page_count\": 0,\n \"count\": 0,\n \"next\": null,\n \"previous\": null,\n \"add_permission\": true,\n \"results\": [\n {\n \"sid\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"title\": \"\",\n \"is_administrator\": true,\n \"date_start\": \"\",\n \"date_end\": null,\n \"is_archived\": true,\n \"change_permission\": true\n }\n ]\n}\n\nOnly the Administrators can edit organization details.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["organizations","personnel","list","organization","{{organization_sid_test_administrator}}","list",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[{"id":"f0eec1fb-bed4-4008-9048-eac3406c836b","name":"Get People List","originalRequest":{"method":"GET","header":[],"url":"https://www.labii.dev/organizations/personnel/list/organization/{{organization_sid_test_administrator}}/list/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 03 Nov 2024 07:58:42 GMT","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Allow","value":"GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS","type":"text"},{"key":"Expires","value":"0","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate","type":"text"},{"key":"Pragma","value":"no-cache","type":"text"},{"key":"Server","value":"Labii","type":"text"},{"key":"Access-Control-Allow-Origin","value":"*","type":"text"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin","type":"text"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp","type":"text"},{"key":"Content-Security-Policy","value":"style-src 'self' *.amazonaws.com 'unsafe-inline'; frame-src 'none'; script-src 'self' *.amazonaws.com; img-src 'self' *.amazonaws.com; font-src 'self' data: *.amazonaws.com; default-src 'self' 'unsafe-inline' 'unsafe-eval' https://www.labii.com http://localhost:3000","type":"text"},{"key":"Vary","value":"Accept-Language, Cookie, Origin","type":"text"},{"key":"Content-Language","value":"en","type":"text"},{"key":"X-Frame-Options","value":"DENY","type":"text"},{"key":"Content-Length","value":"1173","type":"text"},{"key":"X-Content-Type-Options","value":"nosniff","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","type":"text"},{"key":"Referrer-Policy","value":"same-origin","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"page_size\": 10,\n \"page_number\": 1,\n \"page_count\": 1,\n \"count\": 5,\n \"next\": null,\n \"previous\": null,\n \"add_permission\": true,\n \"results\": [\n {\n \"sid\": \"GJMP0a40x31c3INSX38ch\",\n \"name\": \"Test Labii\",\n \"email\": \"test@labii.com\",\n \"title\": \"Administrator\",\n \"is_administrator\": true,\n \"date_start\": \"2024-11-02\",\n \"date_end\": null,\n \"is_archived\": false,\n \"change_permission\": true\n },\n {\n \"sid\": \"JMPS0a40x31c6LQV16afk\",\n \"name\": \"Developer Labii\",\n \"email\": \"developer@labii.com\",\n \"title\": null,\n \"is_administrator\": false,\n \"date_start\": \"2024-11-02\",\n \"date_end\": null,\n \"is_archived\": false,\n \"change_permission\": true\n },\n {\n \"sid\": \"KNQT0a40x31c7MRW27bgl\",\n \"name\": \"Inactive Labii\",\n \"email\": \"inactive@labii.com\",\n \"title\": null,\n \"is_administrator\": false,\n \"date_start\": \"2024-11-02\",\n \"date_end\": null,\n \"is_archived\": false,\n \"change_permission\": true\n },\n {\n \"sid\": \"LORU0a40x31c8NSX38chm\",\n \"name\": \"Business Labii\",\n \"email\": \"test_business@labii.com\",\n \"title\": null,\n \"is_administrator\": false,\n \"date_start\": \"2024-11-02\",\n \"date_end\": null,\n \"is_archived\": false,\n \"change_permission\": true\n }\n ]\n}"}],"_postman_id":"ec886f88-f1f1-4fb0-86c3-364e67313d3f"},{"name":"Create People","event":[{"listen":"prerequest","script":{"id":"b967b83f-b305-42ec-a496-e3e31444e51c","exec":["// update currentDate","const currentDate = js.getCurrentDate();","pm.environment.set(\"currentDate\", currentDate);"],"type":"text/javascript"}},{"listen":"test","script":{"id":"652f7fe5-589b-430d-b920-4057a55c513b","exec":["// Set the variable","var jsonData = pm.response.json();","pm.environment.set(\"people_sid\", jsonData.sid);","","pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Validate the schema for the response JSON\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData).to.have.property('sid');"," pm.expect(responseData).to.have.property('user__sid');"," pm.expect(responseData).to.have.property('name');"," pm.expect(responseData).to.have.property('email');"," pm.expect(responseData).to.have.property('first_name');"," pm.expect(responseData).to.have.property('last_name');"," pm.expect(responseData).to.have.property('title');"," pm.expect(responseData).to.have.property('date_start');"," pm.expect(responseData).to.have.property('date_end');"," pm.expect(responseData).to.have.property('is_administrator');"," pm.expect(responseData).to.have.property('should_receive_mention_notification');"," pm.expect(responseData).to.have.property('should_receive_notification_email');"," pm.expect(responseData).to.have.property('metadata');"," pm.expect(responseData).to.have.property('calendar');"," pm.expect(responseData).to.have.property('teams');"," pm.expect(responseData).to.have.property('permissions');"," pm.expect(responseData).to.have.property('certifications');"," pm.expect(responseData).to.have.property('status');"," pm.expect(responseData).to.have.property('is_archived');"," pm.expect(responseData).to.have.property('updated_by');"," pm.expect(responseData).to.have.property('date_updated');"," pm.expect(responseData).to.have.property('change_permission');"," pm.expect(responseData).to.have.property('help_text');","});","","","pm.test(\"All required fields are present in the response\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.user__sid).to.exist;"," pm.expect(responseData.email).to.exist;"," pm.expect(responseData.first_name).to.exist;"," pm.expect(responseData.last_name).to.exist;"," pm.expect(responseData.title).to.exist;"," pm.expect(responseData.date_start).to.exist;"," pm.expect(responseData.is_administrator).to.exist;"," pm.expect(responseData.should_receive_mention_notification).to.exist;"," pm.expect(responseData.should_receive_notification_email).to.exist;"," pm.expect(responseData.teams).to.exist;"," pm.expect(responseData.permissions).to.exist;"," pm.expect(responseData.certifications).to.exist;"," pm.expect(responseData.status).to.exist;"," pm.expect(responseData.is_archived).to.exist;"," pm.expect(responseData.updated_by).to.exist;"," pm.expect(responseData.date_updated).to.exist;"," pm.expect(responseData.change_permission).to.exist;"," pm.expect(responseData.help_text).to.exist;","});","","","pm.test(\"Date start and date end should be in valid format\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.date_start).to.match(/^\\d{4}-\\d{2}-\\d{2}$/);"," pm.expect(responseData.date_end).to.be.oneOf([null, null, /^\\d{4}-\\d{2}-\\d{2}$/]);","});",""],"type":"text/javascript"}}],"id":"fc9b5150-bfc1-4946-b60a-57262e8c97d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"new@labii.com\",\n \"first_name\": \"New\",\n \"last_name\": \"Labii\",\n \"title\": \"Tester\",\n \"date_start\": \"{{currentDate}}\",\n \"is_administrator\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://www.labii.dev/organizations/personnel/list/organization/{{organization_sid_test_administrator}}/list/","description":"This endpoint allows the creation of a new personnel entry within the specified organization.
\nOnly the Administrators can edit organization details.
\nemail (string): The email address of the personnel.
first_name (string): The first name of the personnel.
last_name (string): The last name of the personnel.
title (string): The job title of the personnel.
date_start (string): The start date of the personnel's employment.
is_administrator (boolean): Indicates if the personnel is an administrator.
The response will be a JSON object with the following schema:
\n{\n \"sid\": \"\",\n \"user__sid\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"title\": \"\",\n \"date_start\": \"\",\n \"date_end\": null,\n \"is_administrator\": true,\n \"should_receive_mention_notification\": true,\n \"should_receive_notification_email\": true,\n \"metadata\": [],\n \"calendar\": null,\n \"teams\": [\n {\n \"sid\": \"\",\n \"name\": \"\"\n }\n ],\n \"permissions\": [\"\"],\n \"certifications\": [],\n \"status\": \"\",\n \"is_archived\": true,\n \"updated_by\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"date_updated\": \"\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"\",\n \"title\": \"\",\n \"date_start\": \"\",\n \"date_end\": \"\",\n \"calendar\": \"\",\n \"is_administrator\": \"\",\n \"should_receive_mention_notification\": \"\",\n \"should_receive_notification_email\": \"\",\n \"metadata\": \"\",\n \"is_archived\": \"\"\n }\n}\n\nThis endpoint retrieves detailed information about a specific personnel in the organization.
\nAll active organization members are authorized to make API calls.
\nNo request body parameters are required for this request.
\nThe response will be a JSON object with the following properties:
\nsid (string): The unique identifier for the personnel.
user__sid (string): The unique identifier for the user associated with the personnel.
name (string): The name of the personnel.
email (string): The email address of the personnel.
first_name (string): The first name of the personnel.
last_name (string): The last name of the personnel.
title (string): The job title of the personnel.
date_start (string): The start date of the personnel's employment.
date_end (string): The end date of the personnel's employment, if applicable.
is_administrator (boolean): Indicates if the personnel is an administrator.
should_receive_mention_notification (boolean): Indicates if the personnel should receive mention notifications.
should_receive_notification_email (boolean): Indicates if the personnel should receive notification emails.
metadata (array): Additional metadata associated with the personnel.
calendar (object): The calendar details for the personnel.
teams (array): An array of teams the personnel is associated with, each containing sid (string) and name (string) properties.
permissions (array): An array of permissions granted to the personnel.
certifications (array): An array of certifications held by the personnel.
status (string): The status of the personnel.
is_archived (boolean): Indicates if the personnel is archived.
updated_by (object): Details of the user who last updated the personnel, containing sid (string) and name (string) properties.
date_updated (string): The date when the personnel information was last updated.
change_permission (boolean): Indicates if the personnel has permission to make changes.
help_text (object): Additional help text details, containing various properties related to the personnel.
Example response:
\n{\n \"sid\": \"\",\n \"user__sid\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"title\": \"\",\n \"date_start\": \"\",\n \"date_end\": null,\n \"is_administrator\": true,\n \"should_receive_mention_notification\": true,\n \"should_receive_notification_email\": true,\n \"metadata\": [],\n \"calendar\": null,\n \"teams\": [{\"sid\": \"\", \"name\": \"\"}],\n \"permissions\": [\"\"],\n \"certifications\": [],\n \"status\": \"\",\n \"is_archived\": true,\n \"updated_by\": {\"sid\": \"\", \"name\": \"\"},\n \"date_updated\": \"\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"\",\n \"title\": \"\",\n \"date_start\": \"\",\n \"date_end\": \"\",\n \"calendar\": \"\",\n \"is_administrator\": \"\",\n \"should_receive_mention_notification\": \"\",\n \"should_receive_notification_email\": \"\",\n \"metadata\": \"\",\n \"is_archived\": \"\"\n }\n}\n\nThis endpoint is used to update the details of a personnel in the organization.
\nOnly the Administrators can edit organization details.
\nfirst_name (string, required): The first name of the personnel.
\nlast_name (string, required): The last name of the personnel.
\ntitle (string, required): The title or designation of the personnel.
\ndate_start (string, required): The start date of the personnel's role.
\ndate_end (string, optional): The end date of the personnel's role.
\nis_administrator (boolean, required): Indicates if the personnel is an administrator.
\nshould_receive_mention_notification (boolean, required): Specifies whether the personnel should receive mention notifications.
\nshould_receive_notification_email (boolean, required): Specifies whether the personnel should receive notification emails.
\nmetadata (array, required): Additional metadata associated with the personnel.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"user__sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"email\": {\"type\": \"string\"},\n \"first_name\": {\"type\": \"string\"},\n \"last_name\": {\"type\": \"string\"},\n \"title\": {\"type\": \"string\"},\n \"date_start\": {\"type\": \"string\"},\n \"date_end\": {\"type\": [\"string\", \"null\"]},\n \"is_administrator\": {\"type\": \"boolean\"},\n \"should_receive_mention_notification\": {\"type\": \"boolean\"},\n \"should_receive_notification_email\": {\"type\": \"boolean\"},\n \"metadata\": {\"type\": \"array\"},\n \"calendar\": {\"type\": [\"object\", \"null\"]},\n \"teams\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"}\n }\n }\n },\n \"permissions\": {\n \"type\": \"array\",\n \"items\": {\"type\": \"string\"}\n },\n \"certifications\": {\"type\": \"array\"},\n \"status\": {\"type\": \"string\"},\n \"is_archived\": {\"type\": \"boolean\"},\n \"updated_by\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"}\n }\n },\n \"date_updated\": {\"type\": \"string\"},\n \"change_permission\": {\"type\": \"boolean\"},\n \"help_text\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"title\": {\"type\": \"string\"},\n \"date_start\": {\"type\": \"string\"},\n \"date_end\": {\"type\": \"string\"},\n \"calendar\": {\"type\": [\"string\", \"null\"]},\n \"is_administrator\": {\"type\": \"string\"},\n \"should_receive_mention_notification\": {\"type\": \"string\"},\n \"should_receive_notification_email\": {\"type\": \"string\"},\n \"metadata\": {\"type\": \"string\"},\n \"is_archived\": {\"type\": \"string\"}\n }\n }\n }\n}\n\nThe Labii People API provides functionality to manage and interact with user accounts within an organization. Through this API, users can retrieve a list of all members, add new users to the organization, access detailed information about specific users, and edit user details as needed. This API enables streamlined user management, making it easier to keep team information up-to-date and ensure that all necessary personnel have access to relevant organizational resources on the Labii platform.
\n","_postman_id":"4af31c7b-ed54-479c-9199-06bfe072f7e9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Team","item":[{"name":"Get Team List","event":[{"listen":"test","script":{"id":"b9ea32e0-375b-45fa-aa6e-63e2943210c7","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Response has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.page_size).to.exist;"," pm.expect(responseData.page_number).to.exist;"," pm.expect(responseData.page_count).to.exist;"," pm.expect(responseData.count).to.exist;"," pm.expect(responseData.next).to.exist;"," pm.expect(responseData.previous).to.exist;"," pm.expect(responseData.add_permission).to.exist;","});","","","pm.test(\"Validate the results array\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.results).to.be.an('array');"," responseData.results.forEach(function(result) {"," pm.expect(result).to.be.an('object');"," pm.expect(result.sid).to.be.a('string');"," pm.expect(result.name).to.be.a('string');"," pm.expect(result.description).to.be.a('string');"," pm.expect(result.is_archived).to.be.a('boolean');"," pm.expect(result.change_permission).to.be.a('boolean');"," });","});","","","pm.test(\"Verify the properties of results\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array');"," "," responseData.results.forEach(function(result) {"," pm.expect(result.sid).to.be.a('string').and.to.have.lengthOf.at.least(1, \"sid should be a non-empty string\");"," pm.expect(result.name).to.be.a('string').and.to.have.lengthOf.at.least(1, \"name should be a non-empty string\");"," pm.expect(result.description).to.be.a('string').and.to.have.lengthOf.at.least(1, \"description should be a non-empty string\");"," pm.expect(result.is_archived).to.be.a('boolean', \"is_archived should be a boolean\");"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"c96ba3cf-e1d2-490c-9fe0-2dd5dbdf17a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/organizations/team/list/organization/{{organization_sid_test_administrator}}/list/","description":"This endpoint retrieves a list of teams within the specified organization.
\nOnly the Administrators can make this api call.
\nNo request body parameters are required for this endpoint.
\nThe response will be a JSON object with the following schema:
\n{\n \"page_size\": integer,\n \"page_number\": integer,\n \"page_count\": integer,\n \"count\": integer,\n \"next\": string or null,\n \"previous\": string or null,\n \"add_permission\": boolean,\n \"results\": [\n {\n \"sid\": string,\n \"name\": string,\n \"description\": string,\n \"is_archived\": boolean,\n \"change_permission\": boolean\n }\n ]\n}\n\npage_size: The number of items per page.
page_number: The current page number.
page_count: The total number of pages.
count: The total count of teams.
next: The URL for the next page of results, or null if there are no more pages.
previous: The URL for the previous page of results, or null if this is the first page.
add_permission: Indicates whether the user has permission to add teams.
results: An array of team objects containing their unique ID, name, description, archived status, and change permission.
This endpoint is used to create a new team within a specific organization.
\nOnly the Administrators can make this api call.
\nname (string, required): The name of the team. It should be unique within the organization.
\ndescription (string, optional): A brief description of the team.
\nmembers (array, required): An array of objects containing details of the team members.
\nsid (string, required): The unique identifier of the member.
\nname (string, required): The name of the member.
\nExample:
\n{\n \"name\": \"Test Team {{currentDate}}\",\n \"description\": \"Test team created by postman\",\n \"members\": [\n {\n \"sid\": \"{{people_sid_test_administrato ...\",\n \"name\": \"Test Labii\"\n }\n ]\n}\n#### Response\nThe response for this request will be a JSON object with the following schema:\n```json\n{\n \"sid\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"members\": [\n {\n \"sid\": \"\",\n \"name\": \"\"\n }\n ],\n \"is_archived\": true,\n \"updated_by\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"date_updated\": \"\",\n \"date_created\": \"\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"\",\n \"is_archived\": \"\",\n \"members\": \"\"\n }\n}\n\nThis endpoint retrieves the details of a specific team within the organization.
\nOnly the Administrators can make this api call.
\nThis request does not require a request body.
\nsid (string): The unique identifier of the team.
name (string): The name of the team.
description (string): The description of the team.
members (array): An array of objects containing the details of team members, including their unique identifier and name.
sid (string): The unique identifier of the team member.
name (string): The name of the team member.
is_archived (boolean): Indicates whether the team is archived.
updated_by (object): An object containing the details of the user who last updated the team.
sid (string): The unique identifier of the user.
name (string): The name of the user.
date_updated (string): The date when the team was last updated.
date_created (string): The date when the team was created.
change_permission (boolean): Indicates whether the user has permission to make changes to the team.
help_text (object): An object containing additional help text related to the team.
sid (string): The unique identifier of the help text.
is_archived (string): Indicates whether the help text is archived.
members (string): Additional information about team members provided in the help text.
This endpoint is used to update the details of a specific team within an organization.
\nOnly the Administrators can make this api call.
\nname (string, required): The updated name of the team.
\ndescription (string, required): The updated description of the team.
\nThe response for this request can be represented as a JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"members\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"}\n }\n }\n },\n \"is_archived\": {\"type\": \"boolean\"},\n \"updated_by\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"}\n }\n },\n \"date_updated\": {\"type\": \"string\"},\n \"date_created\": {\"type\": \"string\"},\n \"change_permission\": {\"type\": \"boolean\"},\n \"help_text\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"is_archived\": {\"type\": \"string\"},\n \"members\": {\"type\": \"string\"}\n }\n }\n }\n}\n\nThis endpoint sends an HTTP DELETE request to delete the details of a specific team within an organization.
\nOnly the Administrators can make this api call.
\nThe response of this request is a JSON schema representing the data structure of the response. The schema will outline the properties and their data types that will be returned upon successful deletion of the team details.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["organizations","team","detail","{{team_sid}}",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[],"_postman_id":"a7895277-c492-4317-84df-782cc24176ff"}],"id":"0279b64f-ed55-48c4-bf9c-d91e7630c0c7","description":"The Labii Team API provides a comprehensive set of features for managing teams, allowing users to effortlessly retrieve a list of teams, create new teams, access detailed information about specific teams, edit existing teams, and delete teams as needed. This ultimate toolkit simplifies team management and collaboration, enabling users to delve into the organizational structure with ease and efficiency.
\n","_postman_id":"0279b64f-ed55-48c4-bf9c-d91e7630c0c7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Backup","item":[{"name":"Get Backup List","event":[{"listen":"test","script":{"id":"2370bb97-b374-48d8-befc-9ab1ae09f0f9","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Validate the response schema for the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.results).to.be.an('array');",""," responseData.results.forEach(function(result) {"," pm.expect(result.sid).to.be.a('string');"," pm.expect(result.name).to.be.a('string');"," pm.expect(result.status).to.exist;"," pm.expect(result.number_of_versions).to.be.a('number');"," pm.expect(result.number_of_files).to.be.a('number');"," pm.expect(result.file_size).to.exist;"," pm.expect(result.date_created).to.exist;"," pm.expect(result.date_expired).to.be.null;"," pm.expect(result.change_permission).to.be.true;"," });","});","","","pm.test(\"Date created is in a valid date format\", function () {"," const responseData = pm.response.json();"," "," responseData.results.forEach(function(result) {"," pm.expect(result.date_created).to.match(/^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$/, \"Date created should be in valid date format\");"," });","});","","","pm.test(\"File size is a non-empty string\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array');"," "," responseData.results.forEach(function(result) {"," pm.expect(result.file_size).to.be.a('string').and.to.have.lengthOf.at.least(1, \"File size should not be empty\");"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"a1b909fd-d926-4bc3-98e7-995d601a98ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/organizations/backup/list/organization/{{organization_sid_test_administrator}}/list/","description":"This endpoint retrieves the list of backups for a specific organization.
\nOnly the Administrators can make this api call.
\nThis request does not require a request body.
\npage_size (number): The number of items per page.
page_number (number): The current page number.
page_count (number): The total number of pages.
count (number): The total count of backups.
next (string): The URL for the next page of backups.
previous (string): The URL for the previous page of backups.
add_permission (boolean): Indicates if the user has permission to add backups.
results (array): An array of backup objects with the following properties:
sid (string): The backup ID.
name (string): The name of the backup.
status (string): The status of the backup.
number_of_versions (number): The number of versions for the backup.
number_of_files (number): The number of files in the backup.
file_size (string): The total size of the backup files.
date_created (string): The date when the backup was created.
date_expired (string): The date when the backup will expire, if applicable.
change_permission (boolean): Indicates if the user has permission to change the backup.
This endpoint allows you to create a backup for a specific organization.
\nOnly the Administrators can make this api call.
\nname (string): The name of the backup.
description (string): A description for the backup.
date_expired (string): The expiration date for the backup.
Example:
\n{\n \"name\": \"Test Backup {{currentDate}}\",\n \"description\": \"Test backup created by postman\",\n \"date_expired\": \"{{nextWeekDate}}\"\n}\n\nsid (string): The ID of the backup.
name (string): The name of the backup.
description (string): A description for the backup.
status (string): The status of the backup.
number_of_versions (integer): The number of versions of the backup.
number_of_files (integer): The number of files in the backup.
price (string): The price of the backup.
file_size (string): The size of the backup files.
download (string): The download link for the backup.
date_expired (string): The expiration date for the backup.
date_created (string): The date when the backup was created.
help_text (object): Additional information about the backup.
sid (string): The ID of the help text.
status (string): The status of the help text.
number_of_versions (string): The number of versions in the help text.
number_of_files (string): The number of files in the help text.
file_size (string): The size of the files in the help text.
price (string): The price of the help text.
date_expired (string): The expiration date for the help text.
download (string): The download link for the help text.
change_permission (boolean): Indicates whether permission to change the backup is allowed.
Example:
\n{\n \"sid\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"number_of_versions\": 0,\n \"number_of_files\": 0,\n \"price\": \"\",\n \"file_size\": \"\",\n \"download\": \"\",\n \"date_expired\": \"\",\n \"date_created\": \"\",\n \"help_text\": {\n \"sid\": \"\",\n \"status\": \"\",\n \"number_of_versions\": \"\",\n \"number_of_files\": \"\",\n \"file_size\": \"\",\n \"price\": \"\",\n \"date_expired\": \"\",\n \"download\": \"\"\n },\n \"change_permission\": true\n}\n\nThis endpoint retrieves detailed information about a specific backup within an organization.
\nOnly the Administrators can make this api call.
\nNo request body is required for this endpoint.
\nbackup_sid (path parameter) : The unique identifier of the backup for which details are to be retrieved.The response will be a JSON object with the following properties:
\nsid : The unique identifier of the backup.
name : The name of the backup.
description : Description of the backup.
status : Current status of the backup.
number_of_versions : The number of versions available for the backup.
number_of_files : The total number of files in the backup.
price : The price of the backup.
file_size : The size of the backup files.
download : URL for downloading the backup.
date_expired : Expiry date of the backup.
date_created : Date when the backup was created.
help_text : Additional help text with the following properties:
sid : The unique identifier of the help text.
status : Status of the help text.
number_of_versions : Number of versions in the help text.
number_of_files : Number of files in the help text.
file_size : Size of the files in the help text.
price : Price of the help text.
date_expired : Expiry date of the help text.
download : URL for downloading the help text.
change_permission : Indicates whether the permission to change the backup is allowed (true/false).
{\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"status\": {\"type\": \"string\"},\n \"number_of_versions\": {\"type\": \"integer\"},\n \"number_of_files\": {\"type\": \"integer\"},\n \"price\": {\"type\": \"string\"},\n \"file_size\": {\"type\": \"string\"},\n \"download\": {\"type\": \"string\"},\n \"date_expired\": {\"type\": \"string\"},\n \"date_created\": {\"type\": \"string\"},\n \"help_text\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"status\": {\"type\": \"string\"},\n \"number_of_versions\": {\"type\": \"string\"},\n \"number_of_files\": {\"type\": \"string\"},\n \"file_size\": {\"type\": \"string\"},\n \"price\": {\"type\": \"string\"},\n \"date_expired\": {\"type\": \"string\"},\n \"download\": {\"type\": \"string\"}\n }\n },\n \"change_permission\": {\"type\": \"boolean\"}\n }\n}\n\nThis endpoint is used to update the details of a specific backup in an organization.
\nOnly the Administrators can make this api call.
\nname (string, required): The updated name of the backup.
\ndescription (string, required): The updated description of the backup.
\ndate_expired (string, required): The updated expiration date of the backup.
\nThe response for this request will be a JSON object with the following properties:
\nsid (string): The unique identifier of the backup.
\nname (string): The name of the backup.
\ndescription (string): The description of the backup.
\nstatus (string): The status of the backup.
\nnumber_of_versions (integer): The number of versions of the backup.
\nnumber_of_files (integer): The number of files in the backup.
\nprice (string): The price of the backup.
\nfile_size (string): The size of the backup files.
\ndownload (string): The download link for the backup.
\ndate_expired (string): The expiration date of the backup.
\ndate_created (string): The creation date of the backup.
\nhelp_text (object): Additional help text related to the backup, with properties sid, status, number_of_versions, number_of_files, file_size, price, date_expired, and download.
\nchange_permission (boolean): Indicates whether the permission to change the backup is granted.
\n{\n \"sid\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"number_of_versions\": 0,\n \"number_of_files\": 0,\n \"price\": \"\",\n \"file_size\": \"\",\n \"download\": \"\",\n \"date_expired\": \"\",\n \"date_created\": \"\",\n \"help_text\": {\n \"sid\": \"\",\n \"status\": \"\",\n \"number_of_versions\": \"\",\n \"number_of_files\": \"\",\n \"file_size\": \"\",\n \"price\": \"\",\n \"date_expired\": \"\",\n \"download\": \"\"\n },\n \"change_permission\": true\n}\n\nThe HTTP DELETE request is used to delete a specific backup detail belonging to an organization. The backup_sid path parameter in the URL specifies the unique identifier of the backup detail to be deleted.
Only the Administrators can make this api call.
\nThe response of this request is a JSON schema representing the structure of the response data. The schema will outline the properties and their data types that can be expected in the response upon successful deletion of the backup detail.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["organizations","backup","detail","{{backup_sid}}",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[],"_postman_id":"5b644102-2e05-4baf-b52c-a3f30088bb95"}],"id":"f8d9bc56-fb60-47a1-bea9-1faa5e8c16d6","description":"The Labii Backup API offers robust functionality for managing data backups, allowing users to create backups of their data, retrieve a list of existing backups, edit backup configurations, and delete backups as required. This API ensures that users can maintain data integrity and security with ease, providing a seamless way to safeguard important information and streamline backup management processes.
\n","_postman_id":"f8d9bc56-fb60-47a1-bea9-1faa5e8c16d6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Certification","item":[{"name":"Get Certification List","event":[{"listen":"test","script":{"id":"65dcb2cc-08e7-4f3a-bd69-52a677d17779","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is in an acceptable range\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Validate the response schema for the fields\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.page_size).to.exist.and.to.be.a('number');"," pm.expect(responseData.page_number).to.exist.and.to.be.a('number');"," pm.expect(responseData.page_count).to.exist.and.to.be.a('number');"," pm.expect(responseData.count).to.exist.and.to.be.a('number');"," pm.expect(responseData.next).to.exist.and.to.satisfy((value) => value === null || typeof value === 'string');"," pm.expect(responseData.previous).to.exist.and.to.satisfy((value) => value === null || typeof value === 'string');"," pm.expect(responseData.add_permission).to.exist.and.to.be.a('boolean');"," pm.expect(responseData.results).to.exist.and.to.be.an('array');","});","","","pm.test(\"Results array is present and contains the expected number of elements\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.have.property('results').that.is.an('array').and.to.have.lengthOf(responseData.count);","});","","","pm.test(\"Each 'results' object has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array');"," responseData.results.forEach(function(result) {"," pm.expect(result).to.have.property('sid').that.is.a('string');"," pm.expect(result).to.have.property('name').that.is.a('string');"," pm.expect(result).to.have.property('people').that.is.an('object');"," pm.expect(result).to.have.property('date_initiated').that.is.a('string');"," pm.expect(result).to.have.property('date_expired').that.is.a('string');"," pm.expect(result).to.have.property('is_archived').that.is.a('boolean');"," pm.expect(result).to.have.property('change_permission').that.is.a('boolean');"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"89aeffcf-6921-47a3-b5e5-8189fca75cda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/organizations/certification/list/organization/{{organization_sid_test_administrator}}/list/","description":"This endpoint retrieves a list of certifications for a specific organization.
\nOnly the Administrators can make this api call.
\nMethod: GET
\nURL: https://www.labii.dev/organizations/certification/list/organization/{{organization_sid_test_administrator}}/list/
The response will contain the following fields:
\npage_size (number): The number of items per page
page_number (number): The current page number
page_count (number): The total number of pages
count (number): The total count of certifications
next (string): Link to the next page of certifications
previous (string): Link to the previous page of certifications
add_permission (boolean): Indicates if the user has permission to add certifications
results (array): An array of certification objects, each containing the following fields:
sid (string): The certification ID
name (string): The name of the certification
people (object): Details of the people associated with the certification
sid (string): The person's ID
name (string): The person's name
date_initiated (string): The date when the certification was initiated
date_expired (string): The expiration date of the certification
is_archived (boolean): Indicates if the certification is archived
change_permission (boolean): Indicates if the user has permission to change the certification
This endpoint allows the creation of a new certification within the specified organization.
\nOnly the Administrators can make this api call.
\nname (string): The name of the test certification.
description (string): Description of the test certification.
people (object):
sid (string): The unique identifier of the person associated with the certification.
name (string): The name of the person associated with the certification.
date_expired (string): The expiration date of the certification.
The response will be in JSON format and will include the following fields:
\nsid (string): The unique identifier of the certification.
name (string): The name of the certification.
description (string): Description of the certification.
people (object):
sid (string): The unique identifier of the person associated with the certification.
name (string): The name of the person associated with the certification.
date_initiated (string): The date when the certification was initiated.
date_expired (string): The expiration date of the certification.
is_archived (boolean): Indicates whether the certification is archived.
change_permission (boolean): Indicates the permission to change the certification.
updated_by (object):
sid (string): The unique identifier of the user who updated the certification.
name (string): The name of the user who updated the certification.
date_updated (string): The date when the certification was last updated.
date_created (string): The date when the certification was created.
help_text (object):
sid (string): The unique identifier of the help text associated with the certification.
name (string): The name of the help text associated with the certification.
date_initiated (string): The date when the help text was initiated.
date_expired (string): The expiration date of the help text.
is_archived (string): Indicates whether the help text is archived.
{\n \"sid\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"people\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"date_initiated\": \"\",\n \"date_expired\": \"\",\n \"is_archived\": true,\n \"change_permission\": true,\n \"updated_by\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"date_updated\": \"\",\n \"date_created\": \"\",\n \"help_text\": {\n \"sid\": \"\",\n \"name\": \"\",\n \"date_initiated\": \"\",\n \"date_expired\": \"\",\n \"is_archived\": \"\"\n }\n}\n\nThis endpoint retrieves the details of a specific certification within an organization.
\nOnly the Administrators can make this api call.
\nMethod: GET
\nURL: https://www.labii.dev/organizations/certification/detail/{{certification_sid}}/
The response will include the following fields:
\nsid (string): The unique identifier of the certification.
name (string): The name of the certification.
description (string): The description of the certification.
people (object): Details of the people associated with the certification, including their unique identifier and name.
date_initiated (string): The date when the certification was initiated.
date_expired (string): The expiration date of the certification.
is_archived (boolean): Indicates if the certification is archived.
change_permission (boolean): Indicates whether permission to change the certification is granted.
updated_by (object): Details of the user who last updated the certification, including their unique identifier and name.
date_updated (string): The date when the certification was last updated.
date_created (string): The date when the certification was created.
help_text (object): Additional help text related to the certification, including its unique identifier, name, initiation date, expiration date, and archived status.
This endpoint allows the user to update the details of a specific certification within an organization.
\nOnly the Administrators can make this api call.
\nname (string): The updated name of the certification.
description (string): The updated description of the certification.
date_expired (string): The updated expiration date of the certification.
Example:
\n{\n \"name\": \"Test Certification Updated\",\n \"description\": \"Test certification edited by user\",\n \"date_expired\": \"2023-12-31\"\n}\n\nsid (string): The unique identifier of the certification.
name (string): The name of the certification.
description (string): The description of the certification.
people (object): Details of the people associated with the certification.
date_initiated (string): The date when the certification was initiated.
date_expired (string): The expiration date of the certification.
is_archived (boolean): Indicates if the certification is archived.
change_permission (boolean): Indicates the permission to change the certification.
updated_by (object): Details of the user who updated the certification.
date_updated (string): The date when the certification was last updated.
date_created (string): The date when the certification was created.
help_text (object): Additional help text for the certification.
Example:
\n{\n \"sid\": \"abc123\",\n \"name\": \"Test Certification Updated\",\n \"description\": \"Updated description\",\n \"people\": {\n \"sid\": \"xyz789\",\n \"name\": \"John Doe\"\n },\n \"date_initiated\": \"2022-01-01\",\n \"date_expired\": \"2023-12-31\",\n \"is_archived\": false,\n \"change_permission\": true,\n \"updated_by\": {\n \"sid\": \"user123\",\n \"name\": \"Jane Smith\"\n },\n \"date_updated\": \"2022-09-15\",\n \"date_created\": \"2021-01-01\",\n \"help_text\": {\n \"sid\": \"def456\",\n \"name\": \"Certification Help\",\n \"date_initiated\": \"2021-01-01\",\n \"date_expired\": \"2023-12-31\",\n \"is_archived\": false\n }\n}\n\nThe Labii Certification API is designed to empower organizations by enabling them to manage certifications effectively. Users can retrieve a list of available certifications, create new certifications, access detailed information about specific certifications, and edit existing ones. This API is crucial for companies that need to ensure that only trained users have access to certain tables or applications, enhancing security and compliance while streamlining the certification management process.
\n","_postman_id":"2405c0c0-2c9d-44e2-8021-26dc099124e7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Project","item":[{"name":"Get Project List","event":[{"listen":"test","script":{"id":"545f3ee7-7ab8-472a-a797-a1762cb8650c","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 500ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(500);","});","","","pm.test(\"Validate the response schema for fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.page_size).to.exist.and.to.be.a('number');"," pm.expect(responseData.page_number).to.exist.and.to.be.a('number');"," pm.expect(responseData.page_count).to.exist.and.to.be.a('number');"," pm.expect(responseData.count).to.exist.and.to.be.a('number');"," pm.expect(responseData.next).to.exist;"," pm.expect(responseData.previous).to.exist;"," pm.expect(responseData.add_permission).to.exist.and.to.be.a('boolean');"," pm.expect(responseData.results).to.exist.and.to.be.an('array');","});","","","pm.test(\"Results array is present and contains the expected number of elements\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.results).to.be.an('array');"," pm.expect(responseData.results).to.have.lengthOf(responseData.count);","});","","","pm.test(\"Validate properties in results\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array').that.is.not.empty;"," "," responseData.results.forEach(function(result) {"," pm.expect(result.sid).to.be.a('string').and.to.have.lengthOf.at.least(1, \"sid should be a non-empty string\");"," pm.expect(result.name).to.be.a('string').and.to.have.lengthOf.at.least(1, \"name should be a non-empty string\");"," pm.expect(result.order).to.be.a('number').and.to.satisfy((val) => val >= 0, \"order should be a non-negative integer\");"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"4efdd1a7-026b-4e3d-8973-b29daf52d3af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/projects/project/list/organization/{{organization_sid_test_administrator}}/list/","description":"This endpoint retrieves a list of projects within the specified organization.
\nOnly the Administrators can make this api call.
\nNo request body is required for this endpoint.
\norganization_sid_test_administrator (path parameter) - The unique identifier of the organization.The response will be a JSON object with the following properties:
\npage_size (number) - The number of results per page.
page_number (number) - The current page number.
page_count (number) - The total number of pages.
count (number) - The total count of projects.
next (string) - The URL for the next page of results, if available.
previous (string) - The URL for the previous page of results, if available.
add_permission (boolean) - Indicates if the user has permission to add projects.
results (array) - An array of project objects with the following properties:
sid (string) - The unique identifier of the project.
name (string) - The name of the project.
parent (string) - The parent project, if applicable.
description (string) - The description of the project.
date_start (string) - The start date of the project.
date_end (string) - The end date of the project, if applicable.
order (number) - The order of the project.
color (string) - The color code associated with the project.
is_archived (boolean) - Indicates if the project is archived.
change_permission (boolean) - Indicates if the user has permission to change the project.
{\n \"type\": \"object\",\n \"properties\": {\n \"page_size\": { \"type\": \"number\" },\n \"page_number\": { \"type\": \"number\" },\n \"page_count\": { \"type\": \"number\" },\n \"count\": { \"type\": \"number\" },\n \"next\": { \"type\": [\"string\", \"null\"] },\n \"previous\": { \"type\": [\"string\", \"null\"] },\n \"add_permission\": { \"type\": \"boolean\" },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"parent\": { \"type\": [\"string\", \"null\"] },\n \"description\": { \"type\": \"string\" },\n \"date_start\": { \"type\": \"string\" },\n \"date_end\": { \"type\": [\"string\", \"null\"] },\n \"order\": { \"type\": \"number\" },\n \"color\": { \"type\": [\"string\", \"null\"] },\n \"is_archived\": { \"type\": \"boolean\" },\n \"change_permission\": { \"type\": \"boolean\" }\n }\n }\n }\n }\n}\n\nThis endpoint allows the user to create a new project within the specified organization.
\nOnly the Administrators can make this api call.
\nname (string, required): The name of the project.
\ndescription (string, required): A brief description of the project.
\ndate_start (string, required): The start date of the project.
\ndate_end (string, required): The end date of the project.
\ncolor (string, required): The color code associated with the project.
\nExample:
\n{\n \"name\": \"Test Project {{currentDate}}\",\n \"description\": \"Test project created by postman\",\n \"date_start\": \"{{currentDate}}\",\n \"date_end\": \"{{nextWeekDate}}\",\n \"color\": \"#000000\"\n}\n\nThe response for this request is a JSON object with the following properties:
\nsid (string): The unique identifier for the project.
\nname (string): The name of the project.
\nparent (string): The parent project, if any.
\ndescription (string): A brief description of the project.
\ndate_start (string): The start date of the project.
\ndate_end (string): The end date of the project.
\norder (integer): The order of the project.
\ncolor (string): The color code associated with the project.
\nopen_to_organization (boolean): Indicates if the project is open to the organization.
\nopen_to_public (boolean): Indicates if the project is open to the public.
\nmetadata (array): Additional metadata associated with the project.
\nis_archived (boolean): Indicates if the project is archived.
\nupdated_by (object): Details of the user who last updated the project.
\ndate_updated (string): The date when the project was last updated.
\ndate_created (string): The date when the project was created.
\nchange_permission (boolean): Indicates the change permission for the project.
\nhelp_text (object): Additional help text for the project.
\nExample:
\n{\n \"sid\": \"\",\n \"name\": \"\",\n \"parent\": null,\n \"description\": \"\",\n \"date_start\": \"\",\n \"date_end\": \"\",\n \"order\": 0,\n \"color\": \"\",\n \"open_to_organization\": true,\n \"open_to_public\": true,\n \"metadata\": [],\n \"is_archived\": true,\n \"updated_by\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"date_updated\": \"\",\n \"date_created\": \"\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"\",\n \"parent\": \"\",\n \"order\": \"\",\n \"color\": \"\",\n \"metadata\": \"\",\n \"open_to_organization\": \"\",\n \"open_to_public\": \"\",\n \"is_archived\": \"\"\n }\n}\n\nThe endpoint retrieves the details of a specific project identified by the project_sid parameter.
\nOnly the Administrators can make this api call.
\nThe response will be a JSON object with the following properties:
\nsid (string): The unique identifier of the project.
name (string): The name of the project.
parent (object): The parent project, if any.
description (string): The description of the project.
date_start (string): The start date of the project.
date_end (string): The end date of the project.
order (number): The order of the project.
color (string): The color associated with the project.
open_to_organization (boolean): Indicates if the project is open to the organization.
open_to_public (boolean): Indicates if the project is open to the public.
metadata (array): Additional metadata associated with the project.
is_archived (boolean): Indicates if the project is archived.
updated_by (object): Details of the user who last updated the project.
date_updated (string): The date when the project was last updated.
date_created (string): The date when the project was created.
change_permission (boolean): Indicates if the user has permission to change the project.
help_text (object): Additional help text related to the project.
The response of this request can be documented as a JSON schema.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["projects","project","detail","{{project_sid}}",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[{"id":"f3f87230-48ac-4721-86c3-9e8aafe83c96","name":"Get Project Detail","originalRequest":{"method":"GET","header":[],"url":"https://www.labii.dev/projects/project/detail/{{project_sid}}/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 03 Nov 2024 20:58:56 GMT","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Allow","value":"GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS","type":"text"},{"key":"Expires","value":"0","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate","type":"text"},{"key":"Pragma","value":"no-cache","type":"text"},{"key":"Server","value":"Labii","type":"text"},{"key":"Access-Control-Allow-Origin","value":"*","type":"text"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin","type":"text"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp","type":"text"},{"key":"Content-Security-Policy","value":"style-src 'self' *.amazonaws.com 'unsafe-inline'; frame-src 'none'; script-src 'self' *.amazonaws.com; img-src 'self' *.amazonaws.com; font-src 'self' data: *.amazonaws.com; default-src 'self' 'unsafe-inline' 'unsafe-eval' https://www.labii.com http://localhost:3000","type":"text"},{"key":"Vary","value":"Accept-Language, Cookie, Origin","type":"text"},{"key":"Content-Language","value":"en","type":"text"},{"key":"X-Frame-Options","value":"DENY","type":"text"},{"key":"Content-Length","value":"1790","type":"text"},{"key":"X-Content-Type-Options","value":"nosniff","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","type":"text"},{"key":"Referrer-Policy","value":"same-origin","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"sid\": \"nqtw0a40x2cd8puzEJOTY\",\n \"name\": \"Test Project 2024-11-03\",\n \"parent\": null,\n \"description\": \"Test project created by postman.\",\n \"date_start\": \"2024-11-03\",\n \"date_end\": \"2024-11-10\",\n \"order\": 3,\n \"color\": \"#000000\",\n \"open_to_organization\": false,\n \"open_to_public\": false,\n \"metadata\": [],\n \"is_archived\": false,\n \"updated_by\": {\n \"sid\": \"knqt0a40xffmrwBGLQV\",\n \"name\": \"Test Labii\"\n },\n \"date_updated\": \"2024-11-03T20:58:01.319544Z\",\n \"date_created\": \"2024-11-03T20:58:01.319555Z\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"Static encrypted identifier. \",\n \"parent\": \"Choose a parent project. Users at the parent project have access to all records at the child projects. In cases where parent and child projects have different permissions, the higher permission will be used.\",\n \"order\": \"The order to display this project. Integer only. Drag the project to a preferred position at the list view to update the order. \",\n \"color\": \"Color of folder icon\",\n \"metadata\": \"Use metadata to store additional values.\",\n \"open_to_organization\": \"If checked, your organization's members can view/use it. Check this box if you want the whole organization to see this project. To keep this project private, set value to false. The default value is False. \",\n \"open_to_public\": \"If checked, anyone with a labii account can access it. Ensure that this option is checked if you are a vendor or reagent supplier and you want your customers to be able to copy the record for their own records. The default value is False. \",\n \"is_archived\": \"The project will be archived if the checkbox is checked. In accordance with GLP and FDA CFR 21 Part 11, data deletion is highly restricted. You cannot delete a project, but you can archive it to hide it. The default value is False.This endpoint is used to update the details of a specific project.
\nname (string): The updated name of the project.
description (string): The updated description of the project.
date_start (string): The updated start date of the project.
date_end (string): The updated end date of the project.
color (string): The updated color code for the project.
is_archived (boolean): Indicates whether the project is archived or not.
The response for this request can be represented as a JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"parent\": {\"type\": [\"object\", \"null\"]},\n \"description\": {\"type\": \"string\"},\n \"date_start\": {\"type\": \"string\"},\n \"date_end\": {\"type\": \"string\"},\n \"order\": {\"type\": \"integer\"},\n \"color\": {\"type\": \"string\"},\n \"open_to_organization\": {\"type\": \"boolean\"},\n \"open_to_public\": {\"type\": \"boolean\"},\n \"metadata\": {\"type\": \"array\"},\n \"is_archived\": {\"type\": \"boolean\"},\n \"updated_by\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"}\n }\n },\n \"date_updated\": {\"type\": \"string\"},\n \"date_created\": {\"type\": \"string\"},\n \"change_permission\": {\"type\": \"boolean\"},\n \"help_text\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"parent\": {\"type\": \"string\"},\n \"order\": {\"type\": \"string\"},\n \"color\": {\"type\": \"string\"},\n \"metadata\": {\"type\": \"string\"},\n \"open_to_organization\": {\"type\": \"string\"},\n \"open_to_public\": {\"type\": \"string\"},\n \"is_archived\": {\"type\": \"string\"}\n }\n }\n }\n}\n\nThe Labii Project API serves as a foundational tool for managing project-based permissions, allowing users to efficiently handle their projects. With this API, users can retrieve a comprehensive list of projects, create new ones, access detailed information about specific projects, and make edits as needed. By facilitating streamlined project management, it ensures that permission control is effectively maintained, enhancing both organization and security within workflows.
\n","_postman_id":"faff6ac5-3256-406f-a378-232420d5a1f4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Project Member","item":[{"name":"Get Member List","event":[{"listen":"test","script":{"id":"646de684-a0d5-439e-9a50-a9277795250b","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Response has the required fields\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData).to.include.all.keys('page_size', 'page_number', 'page_count', 'count', 'next', 'previous', 'add_permission');","});","","","pm.test(\"Validate the results array and its elements\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.results).to.be.an('array');",""," responseData.results.forEach(function(result) {"," pm.expect(result).to.have.property('sid').that.is.a('string');"," pm.expect(result).to.have.property('name').that.is.a('string');"," pm.expect(result).to.have.property('team').that.is.null;"," pm.expect(result).to.have.property('personnel').that.is.an('object');"," pm.expect(result.personnel).to.have.property('sid').that.is.a('string');"," pm.expect(result.personnel).to.have.property('name').that.is.a('string');"," pm.expect(result).to.have.property('project').that.is.an('object');"," pm.expect(result.project).to.have.property('sid').that.is.a('string');"," pm.expect(result.project).to.have.property('name').that.is.a('string');"," pm.expect(result).to.have.property('permission').that.is.a('string');"," pm.expect(result).to.have.property('is_archived').that.is.a('boolean');"," pm.expect(result).to.have.property('change_permission').that.is.a('boolean');"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"6097102d-5e32-4b5a-ae94-ef87e90e9f63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/projects/member/list/organization/{{organization_sid_test_administrator}}/list/?project__sid={{project_sid_test_administrator}}","description":"This endpoint retrieves the list of members associated with a specific project within the organization.
\nMethod: GET
\nURL: https://www.labii.dev/projects/member/list/organization/{{organization_sid_test_administrator}}/list/?project__sid={{project_sid_test_administrator}}
The response will include the following fields:
\npage_size (number): The number of results per page
page_number (number): The current page number
page_count (number): The total number of pages
count (number): The total count of members
next (string): URL for the next page
previous (string): URL for the previous page
add_permission (boolean): Indicates if the user has permission to add members
results (array): An array of member objects, each containing the following fields:
sid (string): The unique identifier of the member
name (string): The name of the member
team (object): The team details
personnel (object): The personnel details
sid (string): The unique identifier of the personnel
name (string): The name of the personnel
project (object): The project details
sid (string): The unique identifier of the project
name (string): The name of the project
permission (string): The permission level of the member
is_archived (boolean): Indicates if the member is archived
change_permission (boolean): Indicates if the user has permission to change the member's details
The endpoint makes an HTTP POST request to retrieve a list of members for a specific project within an organization. The request includes a payload in raw JSON format, containing the member's name, team, personnel details, and permission level.
\nname (string): The name of the member.
team (null): The team to which the member belongs.
personnel (object): Details of the personnel, including their unique identifier (sid) and name.
permission (string): The permission level for the member.
The response is a JSON object with the following schema:
\n{\n \"sid\": \"\",\n \"name\": \"\",\n \"team\": null,\n \"personnel\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"project\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"permission\": \"\",\n \"is_archived\": true,\n \"updated_by\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"date_updated\": \"\",\n \"date_created\": \"\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"\",\n \"permission\": \"\",\n \"is_archived\": \"\"\n }\n}\n\nThe response object includes fields such as member's unique identifier (sid), name, team, personnel details, project details, permission level, archived status, updated by details, creation and update dates, change permission status, and help text details.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["projects","member","list","organization","{{organization_sid_test_administrator}}","list",""],"host":["https://www.labii.dev"],"query":[{"key":"project__sid","value":"{{project_sid_test_administrator}}"}],"variable":[]}},"response":[{"id":"14105177-50e7-4d18-863b-3ee438bc5ca0","name":"Create Member","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Test member for Test Labii\",\n \"team\": null,\n \"personnel\": {\n \"sid\": \"{{people_sid_test_administrator}}\",\n \"name\": \"Test Labii\"\n },\n \"permission\": \"Edit\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://www.labii.dev/projects/member/list/organization/{{organization_sid_test_administrator}}/list/?project__sid={{project_sid_test_administrator}}","host":["https://www.labii.dev"],"path":["projects","member","list","organization","{{organization_sid_test_administrator}}","list",""],"query":[{"key":"project__sid","value":"{{project_sid_test_administrator}}","sortOrder":0}]}},"status":"Created","code":201,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 03 Nov 2024 21:14:14 GMT","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Allow","value":"GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS","type":"text"},{"key":"Pragma","value":"no-cache","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate","type":"text"},{"key":"Expires","value":"0","type":"text"},{"key":"Server","value":"Labii","type":"text"},{"key":"Access-Control-Allow-Origin","value":"*","type":"text"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin","type":"text"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp","type":"text"},{"key":"Content-Security-Policy","value":"style-src 'self' *.amazonaws.com 'unsafe-inline'; frame-src 'none'; script-src 'self' *.amazonaws.com; img-src 'self' *.amazonaws.com; font-src 'self' data: *.amazonaws.com; default-src 'self' 'unsafe-inline' 'unsafe-eval' https://www.labii.com http://localhost:3000","type":"text"},{"key":"Vary","value":"Accept-Language, Cookie, Origin","type":"text"},{"key":"Content-Language","value":"en","type":"text"},{"key":"X-Frame-Options","value":"DENY","type":"text"},{"key":"Content-Length","value":"765","type":"text"},{"key":"X-Content-Type-Options","value":"nosniff","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","type":"text"},{"key":"Referrer-Policy","value":"same-origin","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"sid\": \"258a0a40x376a49dinsxC\",\n \"name\": \"Edit permission for Test Labii\",\n \"team\": null,\n \"personnel\": {\n \"sid\": \"GJMP0a40x31c3INSX38ch\",\n \"name\": \"Test Labii\"\n },\n \"project\": {\n \"sid\": \"hknq0a40x2cd2jotyDINS\",\n \"name\": \"Sample Project\"\n },\n \"permission\": \"Edit\",\n \"is_archived\": false,\n \"updated_by\": {\n \"sid\": \"knqt0a40xffmrwBGLQV\",\n \"name\": \"Test Labii\"\n },\n \"date_updated\": \"2024-11-03T21:14:12.740063Z\",\n \"date_created\": \"2024-11-03T21:14:12.740076Z\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"Static encrypted identifier. \",\n \"permission\": \"Manager, managers of the project.This endpoint retrieves the details of a specific member within a project. It makes an HTTP GET request to the specified URL with the member's unique identifier in the path parameter.
\nNo request body is required for this endpoint.
\nsid (string): The unique identifier of the member.
name (string): The name of the member.
team (object): Details of the team to which the member belongs.
personnel (object): Details of the personnel associated with the member.
project (object): Details of the project to which the member is assigned.
permission (string): The permission level of the member.
is_archived (boolean): Indicates whether the member is archived.
updated_by (object): Details of the user who last updated the member.
date_updated (string): The date when the member was last updated.
date_created (string): The date when the member was created.
change_permission (boolean): Indicates whether the member has permission to change settings.
help_text (object): Additional help text related to the member.
This endpoint is used to update the details of a specific member within a project.
\nname (string, required): The updated name for the member's permission.
\nteam (string): The updated team for the member.
\npersonnel (object, required): The updated personnel details including sid and name.
\nsid (string, required): The SID of the personnel.
\nname (string, required): The name of the personnel.
\npermission (string, required): The updated permission for the member.
\nThe response for this request is a JSON object with the following schema:
\n{\n \"sid\": \"\",\n \"name\": \"\",\n \"team\": null,\n \"personnel\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"project\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"permission\": \"\",\n \"is_archived\": true,\n \"updated_by\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"date_updated\": \"\",\n \"date_created\": \"\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"\",\n \"permission\": \"\",\n \"is_archived\": \"\"\n }\n}\n\nThe response includes the updated details of the member within the project.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["projects","member","detail","{{member_sid}}",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[{"id":"2dfb4a4b-064b-442f-b804-9f0236fad3f1","name":"Edit Member","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Manager permission for Test Labii\",\n \"team\": null,\n \"personnel\": {\n \"sid\": \"{{people_sid_test_administrator}}\",\n \"name\": \"Test Labii\"\n },\n \"permission\": \"Manager\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.labii.dev/projects/member/detail/{{member_sid}}/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 03 Nov 2024 21:17:22 GMT","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Allow","value":"GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS","type":"text"},{"key":"Pragma","value":"no-cache","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate","type":"text"},{"key":"Expires","value":"0","type":"text"},{"key":"Server","value":"Labii","type":"text"},{"key":"Access-Control-Allow-Origin","value":"*","type":"text"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin","type":"text"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp","type":"text"},{"key":"Content-Security-Policy","value":"style-src 'self' *.amazonaws.com 'unsafe-inline'; frame-src 'none'; script-src 'self' *.amazonaws.com; img-src 'self' *.amazonaws.com; font-src 'self' data: *.amazonaws.com; default-src 'self' 'unsafe-inline' 'unsafe-eval' https://www.labii.com http://localhost:3000","type":"text"},{"key":"Vary","value":"Accept-Language, Cookie, Origin","type":"text"},{"key":"Content-Language","value":"en","type":"text"},{"key":"X-Frame-Options","value":"DENY","type":"text"},{"key":"Content-Length","value":"771","type":"text"},{"key":"X-Content-Type-Options","value":"nosniff","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","type":"text"},{"key":"Referrer-Policy","value":"same-origin","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"sid\": \"258a0a40x376a49dinsxC\",\n \"name\": \"Manager permission for Test Labii\",\n \"team\": null,\n \"personnel\": {\n \"sid\": \"GJMP0a40x31c3INSX38ch\",\n \"name\": \"Test Labii\"\n },\n \"project\": {\n \"sid\": \"hknq0a40x2cd2jotyDINS\",\n \"name\": \"Sample Project\"\n },\n \"permission\": \"Manager\",\n \"is_archived\": false,\n \"updated_by\": {\n \"sid\": \"knqt0a40xffmrwBGLQV\",\n \"name\": \"Test Labii\"\n },\n \"date_updated\": \"2024-11-03T21:14:12.740063Z\",\n \"date_created\": \"2024-11-03T21:14:12.740076Z\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"Static encrypted identifier. \",\n \"permission\": \"Manager, managers of the project.This endpoint is used to delete the details of a specific member within a project.
\nThis endpoint does not require a request body.
\nUpon successful deletion, the response will not contain any content, and the status code will indicate a successful deletion (2xx). If the deletion is unsuccessful, an error response will be returned.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["projects","member","detail","{{member_sid}}",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[],"_postman_id":"25acee7c-f523-46df-94f5-ded86b59dad3"}],"id":"30d1fc36-6f85-4a38-a779-ea8f3bb947a9","description":"The Labii Project Member API is essential for managing user permissions within projects, allowing administrators and project managers to efficiently oversee project membership. This API enables users to retrieve a list of project members, create new members, access detailed information about specific members, and edit or delete member entries as necessary. By providing these capabilities, the API streamlines the process of granting and managing permissions, ensuring that the right users have appropriate access to project resources.
\n","_postman_id":"30d1fc36-6f85-4a38-a779-ea8f3bb947a9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Widget","item":[{"name":"Get Widget List","event":[{"listen":"test","script":{"id":"90458102-94f8-42ba-b2de-ab64c36434d4","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Validate the response schema for the required fields\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.page_size).to.exist.and.to.be.a('number');"," pm.expect(responseData.page_number).to.exist.and.to.be.a('number');"," pm.expect(responseData.count).to.exist.and.to.be.a('number');"," pm.expect(responseData.results).to.exist.and.to.be.an('array');","});","","","pm.test(\"Results array is present and contains expected number of elements\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.results).to.exist.and.to.be.an('array');"," pm.expect(responseData.results).to.have.lengthOf(1); // Replace 1 with the expected number of elements","});","","","pm.test(\"Validate the 'status' object within the 'results' array for the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array');"," responseData.results.forEach(function(result) {"," pm.expect(result.status.sid).to.be.a('string');"," pm.expect(result.status.is_archived).to.be.a('boolean');"," pm.expect(result.status.change_permission).to.be.a('boolean');"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"267ff4d2-7096-474c-904b-9f3c409d483e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/widgets/widget/list/organization/{{organization_sid_test_administrator}}/list/","description":"This endpoint retrieves a list of widgets associated with the specified organization.
\nNo request body is required for this endpoint.
\norganization_sid_test_administrator (path parameter) - The unique identifier of the organization.The response will be a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"page_size\": { \"type\": \"integer\" },\n \"page_number\": { \"type\": \"integer\" },\n \"page_count\": { \"type\": \"integer\" },\n \"count\": { \"type\": \"integer\" },\n \"next\": { \"type\": \"string\" },\n \"previous\": { \"type\": [\"string\", \"null\"] },\n \"add_permission\": { \"type\": \"boolean\" },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"icon\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"type\": { \"type\": \"string\" },\n \"category\": { \"type\": \"string\" },\n \"sub_category\": { \"type\": \"string\" },\n \"company\": { \"type\": \"string\" },\n \"version\": { \"type\": \"string\" },\n \"release_date\": { \"type\": \"string\" },\n \"subscription_price\": { \"type\": \"string\" },\n \"PPU_price\": { \"type\": \"string\" },\n \"notes\": { \"type\": \"string\" },\n \"related_to\": { \"type\": \"string\" },\n \"allow_multiple\": { \"type\": \"boolean\" },\n \"is_readonly\": { \"type\": \"boolean\" },\n \"is_public\": { \"type\": \"boolean\" },\n \"status\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"is_archived\": { \"type\": \"boolean\" },\n \"change_permission\": { \"type\": \"boolean\" }\n }\n },\n \"documentation_url\": { \"type\": \"string\" },\n \"screenshot_url\": { \"type\": \"string\" },\n \"change_permission\": { \"type\": \"boolean\" }\n }\n }\n }\n }\n}\n\nThis endpoint retrieves the details of a specific widget identified by the widget_sid.
Method: GET
\nEndpoint: https://www.labii.dev/widgets/widget/detail/{{widget_sid}}/
The response for this request is an empty array [].
This request does not require a request body.
\nThe response for this request does not contain any data.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["widgets","widget","detail","{{widget_sid}}",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[{"id":"16e6223a-820c-44d1-be8a-c3eaae05112a","name":"Get Widget Detail","originalRequest":{"method":"GET","header":[],"url":"https://www.labii.dev/widgets/widget/detail/{{widget_sid}}/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Sun, 03 Nov 2024 21:35:40 GMT","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Allow","value":"GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS","type":"text"},{"key":"Pragma","value":"no-cache","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate","type":"text"},{"key":"Expires","value":"0","type":"text"},{"key":"Server","value":"Labii","type":"text"},{"key":"Access-Control-Allow-Origin","value":"*","type":"text"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin","type":"text"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp","type":"text"},{"key":"Content-Security-Policy","value":"style-src 'self' *.amazonaws.com 'unsafe-inline'; frame-src 'none'; script-src 'self' *.amazonaws.com; img-src 'self' *.amazonaws.com; font-src 'self' data: *.amazonaws.com; default-src 'self' 'unsafe-inline' 'unsafe-eval' https://www.labii.com http://localhost:3000","type":"text"},{"key":"Vary","value":"Accept-Language, Cookie, Origin","type":"text"},{"key":"Content-Language","value":"en","type":"text"},{"key":"X-Frame-Options","value":"DENY","type":"text"},{"key":"Content-Length","value":"2555","type":"text"},{"key":"X-Content-Type-Options","value":"nosniff","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","type":"text"},{"key":"Referrer-Policy","value":"same-origin","type":"text"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"889e33e1-1305-428f-a4f0-aca7cbf23b58"},{"name":"Install Widget","event":[{"listen":"test","script":{"id":"97fd6982-32b4-4c78-9d31-d5ddd50c050f","exec":["// Set the variable","var jsonData = pm.response.json();","pm.environment.set(\"organizationwidget_sid\", jsonData.sid);","","","pm.test(\"Response status code is 201\", function () {"," pm.response.to.have.status(201);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Validate the sid field in the response\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.have.property('sid');","});","","","pm.test(\"Widget object contains sid and name fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.widget).to.exist.and.to.be.an('object');"," pm.expect(responseData.widget.sid).to.exist.and.to.be.a('string');"," pm.expect(responseData.widget.name).to.exist.and.to.be.a('string');","});","","","pm.test(\"Verify the 'updated_by' object contains 'sid' and 'name' fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.updated_by).to.exist;"," pm.expect(responseData.updated_by.sid).to.exist;"," pm.expect(responseData.updated_by.name).to.exist;","});","",""],"type":"text/javascript","packages":{}}}],"id":"b50b6683-5407-48b0-ab6d-c4a0138a88bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"widget\": {\n \"sid\": \"EHKN0a40x1bGLQV16af\", \n \"name\": \"Text\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://www.labii.dev/organizations/organizationwidget/list/organization/{{organization_sid_test_administrator}}/list/","description":"This endpoint allows you to create a new widget for a specific organization.
\nwidget.sid (string): The unique identifier for the widget.
widget.name (string): The name of the widget.
Example:
\n{\n \"widget\": {\n \"sid\": \"EHKN0a40x1bGLQV16af\",\n \"name\": \"Text\"\n }\n}\n\nsid (string): The unique identifier for the organization widget.
widget.sid (string): The unique identifier for the widget.
widget.name (string): The name of the widget.
is_archived (boolean): Indicates if the widget is archived.
updated_by.sid (string): The unique identifier of the user who updated the widget.
updated_by.name (string): The name of the user who updated the widget.
date_updated (string): The date when the widget was last updated.
date_created (string): The date when the widget was created.
change_permission (boolean): Indicates if the user has permission to change the widget.
Example:
\n{\n \"sid\": \"\",\n \"widget\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"is_archived\": true,\n \"updated_by\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"date_updated\": \"\",\n \"date_created\": \"\",\n \"change_permission\": true\n}\n\nThis endpoint allows you to update the details of a specific organization widget using an HTTP PATCH request. The request should be sent to https://www.labii.dev/organizations/organizationwidget/detail/{{organizationwidget_sid}}/.
\nThe request should include a raw JSON payload with the following parameter:
\nis_archived (boolean): Indicates whether the organization widget is archived or not.The response will include the updated details of the organization widget, including the following parameters:
\nsid (string): The ID of the organization widget.
widget (object): Details of the widget.
sid (string): The ID of the widget.
name (string): The name of the widget.
is_archived (boolean): Indicates whether the organization widget is archived or not.
updated_by (object): Details of the user who updated the organization widget.
sid (string): The ID of the user.
name (string): The name of the user.
date_updated (string): The date when the organization widget was updated.
date_created (string): The date when the organization widget was created.
change_permission (boolean): Indicates whether the user has permission to change the organization widget.
This HTTP PATCH request is used to update the details of a specific organization widget. The request should be made to https://www.labii.dev/organizations/organizationwidget/detail/{{organizationwidget_sid}}/.
\nThe request should include a raw JSON payload with the following parameter:
\nis_archived: A boolean value indicating whether the organization widget is archived or not.The response will include the updated details of the organization widget, including the following parameters:
\nsid: The ID of the organization widget.
widget: Details of the widget.
is_archived: A boolean value indicating whether the organization widget is archived or not.
updated_by: Details of the user who updated the organization widget.
date_updated: The date when the organization widget was updated.
date_created: The date when the organization widget was created.
change_permission: A boolean value indicating whether the user has permission to change the organization widget.
The Labii Widget API offers users a powerful tool for managing widgets within their applications. With this API, users can easily retrieve a list of available widgets or access detailed information about specific widgets. Additionally, it allows for seamless installation, activation, or inactivation of widgets, providing flexibility and control over the widget functionality within their projects. This API enhances user experience by enabling efficient widget management tailored to individual needs.
\n","_postman_id":"8d08a2ed-45a6-455b-aa21-f93f3a139f85","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Workflow","item":[{"name":"Get Workflow List","event":[{"listen":"test","script":{"id":"139f84fc-4da0-4167-b6b7-83a2689f7bfe","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Response has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.page_size).to.exist;"," pm.expect(responseData.page_number).to.exist;"," pm.expect(responseData.page_count).to.exist;"," pm.expect(responseData.count).to.exist;"," pm.expect(responseData.next).to.exist;"," pm.expect(responseData.previous).to.exist;"," pm.expect(responseData.add_permission).to.exist;","});","","","pm.test(\"Results array is present and contains the expected number of elements\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.results).to.exist.and.to.be.an('array');"," pm.expect(responseData.results).to.have.lengthOf(responseData.count);","});","","","pm.test(\"Validate response attributes\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," "," responseData.results.forEach(function(result) {"," pm.expect(result.sid).to.be.a('string').and.to.have.lengthOf.at.least(1, \"sid should be a non-empty string\");"," pm.expect(result.name).to.be.a('string').and.to.have.lengthOf.at.least(1, \"name should be a non-empty string\");"," pm.expect(result.description).to.be.a('string').and.to.have.lengthOf.at.least(1, \"description should be a non-empty string\");"," pm.expect(result.order).to.be.a('number').and.to.be.at.least(0, \"order should be a non-negative integer\");"," pm.expect(result.is_archived).to.be.a('boolean', \"is_archived should be a boolean\");"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"3bbaaa97-7e92-40eb-9d3d-24047eb83453","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/workflows/workflow/list/organization/{{organization_sid_test_administrator}}/list/","description":"This endpoint retrieves a list of workflows for a specific organization.
\nThis request does not require a request body.
\npage_size (integer): The number of items per page.
page_number (integer): The current page number.
page_count (integer): The total number of pages.
count (integer): The total count of workflows.
next (string): The URL for the next page of workflows.
previous (string): The URL for the previous page of workflows.
add_permission (boolean): Indicates if the user has permission to add workflows.
results (array): An array of workflow objects containing the following fields:
sid (string): The unique identifier for the workflow.
name (string): The name of the workflow.
description (string): The description of the workflow.
order (integer): The order of the workflow.
is_archived (boolean): Indicates if the workflow is archived.
change_permission (boolean): Indicates if the user has permission to change the workflow.
This endpoint allows the user to create a new workflow list for the specified organization.
\nname (string): The name of the workflow.
description (string): Description of the workflow.
trigger (object): Object containing trigger details.
events (string): Type of trigger events.
interval_value (number): Value for the interval trigger.
interval_unit (string): Unit for the interval trigger.
actions (array of objects): Array containing action details.
name (string): Name of the action.
body (string): Body of the action.
The response will be a JSON object with the following schema:
\n{\n \"sid\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"trigger\": {\n \"events\": \"\",\n \"interval_value\": 0,\n \"interval_unit\": \"\"\n },\n \"actions\": [\n {\n \"name\": \"\",\n \"body\": \"\"\n }\n ],\n \"order\": 0,\n \"execution_log\": {\n \"name_plural\": \"\",\n \"query\": \"\",\n \"is_readonly\": true\n },\n \"is_archived\": true,\n \"updated_by\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"date_updated\": \"\",\n \"date_created\": \"\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"trigger\": \"\",\n \"actions\": \"\",\n \"is_archived\": \"\"\n }\n}\n\nThis endpoint retrieves the details of a specific workflow identified by its workflow_sid.
Method: GET
\nURL: https://www.labii.dev/workflows/workflow/detail/{{workflow_sid}}/
The response will include the following fields:
\nsid (string): The unique identifier of the workflow.
name (string): The name of the workflow.
description (string): The description of the workflow.
trigger (object): An object containing trigger details including events (string), interval_unit (string), and interval_value (number).
actions (array): An array of objects containing body (string) and name (string) for each action.
order (number): The order of the workflow.
execution_log (object): An object containing name_plural (string), query (string), and is_readonly (boolean) fields.
is_archived (boolean): Indicates if the workflow is archived.
updated_by (object): An object containing sid (string) and name (string) of the user who last updated the workflow.
date_updated (string): The date when the workflow was last updated.
date_created (string): The date when the workflow was created.
change_permission (boolean): Indicates if the user has permission to change the workflow.
help_text (object): An object containing sid (string), name (string), description (string), order (string), trigger (string), actions (string), and is_archived (string) fields.
This endpoint allows the user to update the details of a specific workflow.
\nThe request should be sent as an HTTP PATCH to https://www.labii.dev/workflows/workflow/detail/{{workflow_sid}}/ with the following JSON payload in the raw request body:
{\n \"name\": \"Test Workflow {{currentDate}}\",\n \"description\": \"Test workflow edit by postman.\",\n \"trigger\": {\n \"events\": \"interval\",\n \"interval_value\": 1,\n \"interval_unit\": \"days\"\n },\n \"actions\": [\n {\n \"name\": \"Test\",\n \"body\": \"Test\"\n }\n ]\n}\n\nThe response will be a JSON object with the updated workflow details. Here is an example response schema:
\n{\n \"sid\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"trigger\": {\n \"events\": \"\",\n \"interval_value\": 0,\n \"interval_unit\": \"\"\n },\n \"actions\": [\n {\n \"name\": \"\",\n \"body\": \"\"\n }\n ],\n \"order\": 0,\n \"execution_log\": {\n \"name_plural\": \"\",\n \"query\": \"\",\n \"is_readonly\": true\n },\n \"is_archived\": true,\n \"updated_by\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"date_updated\": \"\",\n \"date_created\": \"\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"trigger\": \"\",\n \"actions\": \"\",\n \"is_archived\": \"\"\n }\n}\n\nThis endpoint allows the user to update the details of a specific workflow, identified by the workflow_sid, and trigger it using the row__sid.
The response will be a JSON object with the following schema:
\n{\n \"sid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"trigger\": {\n \"events\": \"string\",\n \"interval_value\": 0,\n \"interval_unit\": \"string\"\n },\n \"actions\": [\n {\n \"name\": \"string\",\n \"body\": \"string\"\n }\n ],\n \"order\": 0,\n \"execution_log\": {\n \"name_plural\": \"string\",\n \"query\": \"string\",\n \"is_readonly\": true\n },\n \"is_archived\": true,\n \"updated_by\": {\n \"sid\": \"string\",\n \"name\": \"string\"\n },\n \"date_updated\": \"string\",\n \"date_created\": \"string\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"order\": \"string\",\n \"trigger\": \"string\",\n \"actions\": \"string\",\n \"is_archived\": \"string\"\n }\n}\n\nThis endpoint is used to delete a specific workflow detail identified by its unique identifier (workflow_sid).
\nMethod: DELETE
URL: https://www.labii.dev/workflows/workflow/detail/{{workflow_sid}}/
The response for this request follows the JSON schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n }\n }\n}\n\nThe Labii Workflow Widget API is designed to facilitate the management of workflows, which represent orchestrated and repeatable patterns of activity that transform resources into processes. This API empowers administrators to efficiently oversee their workflows by providing capabilities to retrieve a comprehensive list of workflows, create new workflows, access detailed information about specific workflows, edit existing ones, trigger workflows, and delete workflows as needed. By streamlining workflow management, this API enhances operational efficiency and supports the systematic organization of resources for various activities.
\n","_postman_id":"d3fa3d16-0812-459a-b875-9a406b6ddc34","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Workflow ExecutionLog","item":[{"name":"Get ExecutionLog List","event":[{"listen":"test","script":{"id":"0777fcfe-dbf2-4675-981b-7685a2483e32","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Validate the schema of the response body\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData).to.have.property('execution_logs').that.is.an('array');"," responseData.execution_logs.forEach(function(log) {"," pm.expect(log).to.have.property('timestamp').that.is.a('string');"," pm.expect(log).to.have.property('status').that.is.a('string');"," pm.expect(log).to.have.property('details').that.is.an('object');"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"1a1dac56-d8fc-4c17-aec1-bb09a7ffbe81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/workflows/executionlog/list/organization/{{organization_sid_test_administrator}}/list/?workflow__sid={{workflow_sid}}","description":"This endpoint retrieves the execution logs for a specific workflow within the organization.
\nGET https://www.labii.dev/workflows/executionlog/list/organization/{{organization_sid_test_administrator}}/list/?workflow__sid={{workflow_sid}}\n\nThis GET request fetches the execution logs for a specific workflow within the organization.
\nThe response for this request is a JSON object conforming to the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"log_id\": {\n \"type\": \"string\"\n },\n \"timestamp\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"string\"\n }\n }\n}\n\nThis endpoint makes an HTTP GET request to retrieve the detailed execution log for a specific workflow. The request should include the execution log's unique identifier in the URL.
\nThis request does not require a request body.
\nThe response will contain detailed information about the execution log, including timestamps, status, and any relevant data associated with the workflow execution.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["workflows","executionlog","detail","{{executionlog_sid}}",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[],"_postman_id":"292d5492-3395-4ac2-96bc-ebf6c233e74f"}],"id":"b60e74ee-2a1c-4c8e-b54c-ab1a3a89b392","description":"The Labii Workflow Execution Log API is a valuable tool for monitoring and analyzing the performance of workflows by providing detailed logs of each execution. This API enables users to display a comprehensive list of workflows and access detailed information about specific workflow executions. By offering insights into workflow performance, this API aids in troubleshooting, optimization, and ensuring that processes are running smoothly and efficiently.
\n","_postman_id":"b60e74ee-2a1c-4c8e-b54c-ab1a3a89b392","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Application","item":[{"name":"Get Application List","event":[{"listen":"test","script":{"id":"90df2b45-a88d-4b16-8728-25242da44c92","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is acceptable\", function () {"," pm.expect(pm.response.responseTime).to.be.below(300);","});","","","pm.test(\"Validate the response schema for page_size, page_number, page_count, count, next, previous, add_permission, and results array\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.page_size).to.be.a('number');"," pm.expect(responseData.page_number).to.be.a('number');"," pm.expect(responseData.page_count).to.be.a('number');"," pm.expect(responseData.count).to.be.a('number');"," pm.expect(responseData.next).to.be.a('string');"," pm.expect(responseData.previous).to.satisfy((value) => typeof value === 'string' || value === null);"," pm.expect(responseData.add_permission).to.be.a('boolean');"," pm.expect(responseData.results).to.be.an('array');","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","pm.test(\"Response is a valid JSON object\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');","});","","pm.test(\"Each table object in 'results' array contains required properties\", function () {"," const responseData = pm.response.json();"," "," responseData.results.forEach(function(table) {"," pm.expect(table).to.have.property('icon');"," pm.expect(table).to.have.property('name_singular');"," pm.expect(table).to.have.property('name_plural');"," pm.expect(table).to.have.property('sid');"," pm.expect(table).to.have.property('tables');"," pm.expect(table).to.have.property('teams');"," pm.expect(table).to.have.property('order');"," pm.expect(table).to.have.property('is_archived');"," });","});","","","pm.test(\"Results array is not empty\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array').that.is.not.empty;","});",""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"814654b1-0aba-4d63-b575-a11902dbd807","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/applications/application/list/organization/{{organization_sid_test_administrator}}/list/","description":"This endpoint retrieves a list of applications for a specific organization.
\nNo request body is required for this endpoint.
\nThe response will be a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"page_size\": {\"type\": \"integer\"},\n \"page_number\": {\"type\": \"integer\"},\n \"page_count\": {\"type\": \"integer\"},\n \"count\": {\"type\": \"integer\"},\n \"next\": {\"type\": \"string\"},\n \"previous\": {\"type\": [\"string\", \"null\"]},\n \"add_permission\": {\"type\": \"boolean\"},\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"icon\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"tables\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"}\n }\n }\n },\n \"teams\": {\n \"type\": \"array\",\n \"items\": {\"type\": \"string\"}\n },\n \"order\": {\"type\": \"integer\"},\n \"is_archived\": {\"type\": \"boolean\"},\n \"change_permission\": {\"type\": \"boolean\"}\n }\n }\n }\n }\n}\n\nThe response will contain the list of applications with their details such as name, icon, permissions, and associated tables.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["applications","application","list","organization","{{organization_sid_test_administrator}}","list",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[{"id":"9ad1908e-e46b-4c57-b642-9216279e3996","name":"Get Application List","originalRequest":{"method":"GET","header":[],"url":"https://www.labii.dev/applications/application/list/organization/{{organization_sid_test_administrator}}/list/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Thu, 28 Nov 2024 21:41:28 GMT","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Allow","value":"GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS","type":"text"},{"key":"Expires","value":"0","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate","type":"text"},{"key":"Pragma","value":"no-cache","type":"text"},{"key":"Server","value":"Labii","type":"text"},{"key":"Access-Control-Allow-Origin","value":"*","type":"text"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin","type":"text"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp","type":"text"},{"key":"Content-Security-Policy","value":"font-src 'self' data: *.amazonaws.com; img-src 'self' *.amazonaws.com; frame-src 'none'; default-src 'self' 'unsafe-inline' 'unsafe-eval' https://www.labii.com http://localhost:3000; script-src 'self' *.amazonaws.com; style-src 'self' *.amazonaws.com 'unsafe-inline'","type":"text"},{"key":"Vary","value":"Accept-Language, Cookie, Origin","type":"text"},{"key":"Content-Language","value":"en","type":"text"},{"key":"X-Frame-Options","value":"DENY","type":"text"},{"key":"Content-Length","value":"4780","type":"text"},{"key":"X-Content-Type-Options","value":"nosniff","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","type":"text"},{"key":"Referrer-Policy","value":"same-origin","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"page_size\": 10,\n \"page_number\": 1,\n \"page_count\": 2,\n \"count\": 19,\n \"next\": \"http://127.0.0.1:8000/applications/application/list/organization/HKNQ0a40x2988JOTY49di/list/?page=2\",\n \"previous\": null,\n \"add_permission\": true,\n \"results\": [\n {\n \"sid\": \"369b0a40x54950ejotyD\",\n \"icon\": \"article\",\n \"name\": \"ELN\",\n \"tables\": [\n {\n \"sid\": \"ADGJ0a40x124a7CHMRW27b\",\n \"name\": \"protocols\"\n },\n {\n \"sid\": \"BEHK0a40x124a8DINSX38c\",\n \"name\": \"experiments\"\n },\n {\n \"sid\": \"CFIL0a40x124a9EJOTY49d\",\n \"name\": \"ELISA\"\n },\n {\n \"sid\": \"DGJM0a40x124aaFKPUZ50e\",\n \"name\": \"DRC\"\n }\n ],\n \"teams\": [\n \"Available to All\"\n ],\n \"order\": 1,\n \"is_archived\": false,\n \"change_permission\": true\n },\n {\n \"sid\": \"470c0a40x54a6afkpuzE\",\n \"icon\": \"lab_panel\",\n \"name\": \"Sample Management\",\n \"tables\": [\n {\n \"sid\": \"EHKN0a40x124abGLQV16af\",\n \"name\": \"sample receiving\"\n },\n {\n \"sid\": \"FILO0a40x124acHMRW27bg\",\n \"name\": \"samples\"\n },\n {\n \"sid\": \"GJMP0a40x124adINSX38ch\",\n \"name\": \"aliquots\"\n },\n {\n \"sid\": \"HKNQ0a40x124aeJOTY49di\",\n \"name\": \"consumptions\"\n },\n {\n \"sid\": \"ILOR0a40x124afKPUZ50ej\",\n \"name\": \"storages\"\n }\n ],\n \"teams\": [\n \"Available to All\"\n ],\n \"order\": 2,\n \"is_archived\": false,\n \"change_permission\": true\n },\n {\n \"sid\": \"58ad0a40x54b7bglqvAF\",\n \"icon\": \"precision_manufacturing\",\n \"name\": \"Equipment Management\",\n \"tables\": [\n {\n \"sid\": \"ILOR0a40x124afKPUZ50ej\",\n \"name\": \"storages\"\n },\n {\n \"sid\": \"JMPS0a40x124b0LQV16afk\",\n \"name\": \"equipment\"\n },\n {\n \"sid\": \"KNQT0a40x124b1MRW27bgl\",\n \"name\": \"equipment usage\"\n },\n {\n \"sid\": \"LORU0a40x124b2NSX38chm\",\n \"name\": \"equipment maintenance\"\n }\n ],\n \"teams\": [\n \"Available to All\"\n ],\n \"order\": 3,\n \"is_archived\": false,\n \"change_permission\": true\n },\n {\n \"sid\": \"69be0a40x54c8chmrwBG\",\n \"icon\": \"inventory_2\",\n \"name\": \"Inventory Management\",\n \"tables\": [\n {\n \"sid\": \"EHKN0a40x124abGLQV16af\",\n \"name\": \"sample receiving\"\n },\n {\n \"sid\": \"HKNQ0a40x124aeJOTY49di\",\n \"name\": \"consumptions\"\n },\n {\n \"sid\": \"ILOR0a40x124afKPUZ50ej\",\n \"name\": \"storages\"\n },\n {\n \"sid\": \"MPSV0a40x124b3OTY49din\",\n \"name\": \"reagents\"\n },\n {\n \"sid\": \"NQTW0a40x124b4PUZ50ejo\",\n \"name\": \"stock\"\n },\n {\n \"sid\": \"ORUX0a40x124b5QV16afkp\",\n \"name\": \"checkin\"\n },\n {\n \"sid\": \"PSVY0a40x124b6RW27bglq\",\n \"name\": \"checkout\"\n },\n {\n \"sid\": \"QTWZ0a40x124b7SX38chmr\",\n \"name\": \"vendors\"\n }\n ],\n \"teams\": [\n \"Available to All\"\n ],\n \"order\": 4,\n \"is_archived\": false,\n \"change_permission\": true\n },\n {\n \"sid\": \"70cf0a40x54d9dinsxCH\",\n \"icon\": \"science\",\n \"name\": \"LIMS for Sample Testing\",\n \"tables\": [\n {\n \"sid\": \"EHKN0a40x124abGLQV16af\",\n \"name\": \"sample receiving\"\n },\n {\n \"sid\": \"FILO0a40x124acHMRW27bg\",\n \"name\": \"samples\"\n },\n {\n \"sid\": \"RUX10a40x124b8TY49dins\",\n \"name\": \"testings\"\n },\n {\n \"sid\": \"SVY20a40x124b9UZ50ejot\",\n \"name\": \"reports\"\n },\n {\n \"sid\": \"TWZ30a40x124baV16afkpu\",\n \"name\": \"quality control\"\n }\n ],\n \"teams\": [\n \"Available to All\"\n ],\n \"order\": 5,\n \"is_archived\": false,\n \"change_permission\": true\n },\n {\n \"sid\": \"8adg0a40x54e0ejotyDI\",\n \"icon\": \"animation\",\n \"name\": \"LIMS for Molecular Cloning\",\n \"tables\": [\n {\n \"sid\": \"HKNQ0a40x124aeJOTY49di\",\n \"name\": \"consumptions\"\n },\n {\n \"sid\": \"NQTW0a40x124b4PUZ50ejo\",\n \"name\": \"stock\"\n },\n {\n \"sid\": \"ORUX0a40x124b5QV16afkp\",\n \"name\": \"checkin\"\n },\n {\n \"sid\": \"PSVY0a40x124b6RW27bglq\",\n \"name\": \"checkout\"\n },\n {\n \"sid\": \"UX140a40x124bbW27bglqv\",\n \"name\": \"clonings\"\n },\n {\n \"sid\": \"VY250a40x124bcX38chmrw\",\n \"name\": \"plasmids\"\n },\n {\n \"sid\": \"WZ360a40x124bdY49dinsx\",\n \"name\": \"vectors\"\n },\n {\n \"sid\": \"X1470a40x124beZ50ejoty\",\n \"name\": \"sequences\"\n },\n {\n \"sid\": \"Y2580a40x124bf16afkpuz\",\n \"name\": \"cells\"\n }\n ],\n \"teams\": [\n \"Available to All\"\n ],\n \"order\": 6,\n \"is_archived\": false,\n \"change_permission\": true\n },\n {\n \"sid\": \"9beh0a40x54fafkpuzEJ\",\n \"icon\": \"genetics\",\n \"name\": \"LIMS for NGS\",\n \"tables\": [\n {\n \"sid\": \"ADGJ0a40x124a7CHMRW27b\",\n \"name\": \"protocols\"\n },\n {\n \"sid\": \"HKNQ0a40x124aeJOTY49di\",\n \"name\": \"consumptions\"\n },\n {\n \"sid\": \"ILOR0a40x124afKPUZ50ej\",\n \"name\": \"storages\"\n },\n {\n \"sid\": \"Z3690a40x124c027bglqvA\",\n \"name\": \"NGS experiments\"\n },\n {\n \"sid\": \"14700a40x124c138chmrwB\",\n \"name\": \"hosts\"\n },\n {\n \"sid\": \"258a0a40x124c249dinsxC\",\n \"name\": \"NGS Materials\"\n }\n ],\n \"teams\": [\n \"Available to All\"\n ],\n \"order\": 7,\n \"is_archived\": false,\n \"change_permission\": true\n },\n {\n \"sid\": \"0cfi0a40x550bglqvAFK\",\n \"icon\": \"content_cut\",\n \"name\": \"LIMS for CRISPR\",\n \"tables\": [\n {\n \"sid\": \"369b0a40x124c350ejotyD\",\n \"name\": \"CRISPR\"\n },\n {\n \"sid\": \"470c0a40x124c46afkpuzE\",\n \"name\": \"sgRNAs\"\n }\n ],\n \"teams\": [\n \"Available to All\"\n ],\n \"order\": 8,\n \"is_archived\": false,\n \"change_permission\": true\n },\n {\n \"sid\": \"adgj0a40x551chmrwBGL\",\n \"icon\": \"coronavirus\",\n \"name\": \"Diagnostic Testing\",\n \"tables\": [\n {\n \"sid\": \"58ad0a40x124c57bglqvAF\",\n \"name\": \"qPCR CT Ranges\"\n },\n {\n \"sid\": \"69be0a40x124c68chmrwBG\",\n \"name\": \"qPCR Cq\"\n },\n {\n \"sid\": \"70cf0a40x124c79dinsxCH\",\n \"name\": \"qPCR Reports\"\n }\n ],\n \"teams\": [\n \"Available to All\"\n ],\n \"order\": 9,\n \"is_archived\": false,\n \"change_permission\": true\n },\n {\n \"sid\": \"behk0a40x552dinsxCHM\",\n \"icon\": \"gesture\",\n \"name\": \"LIMS for Protein Expression\",\n \"tables\": [\n {\n \"sid\": \"HKNQ0a40x124aeJOTY49di\",\n \"name\": \"consumptions\"\n },\n {\n \"sid\": \"ILOR0a40x124afKPUZ50ej\",\n \"name\": \"storages\"\n },\n {\n \"sid\": \"NQTW0a40x124b4PUZ50ejo\",\n \"name\": \"stock\"\n },\n {\n \"sid\": \"ORUX0a40x124b5QV16afkp\",\n \"name\": \"checkin\"\n },\n {\n \"sid\": \"PSVY0a40x124b6RW27bglq\",\n \"name\": \"checkout\"\n },\n {\n \"sid\": \"QTWZ0a40x124b7SX38chmr\",\n \"name\": \"vendors\"\n },\n {\n \"sid\": \"8adg0a40x124c80ejotyDI\",\n \"name\": \"protein\"\n },\n {\n \"sid\": \"9beh0a40x124c9afkpuzEJ\",\n \"name\": \"antibodies\"\n }\n ],\n \"teams\": [\n \"Available to All\"\n ],\n \"order\": 10,\n \"is_archived\": false,\n \"change_permission\": true\n }\n ]\n}"}],"_postman_id":"814654b1-0aba-4d63-b575-a11902dbd807"},{"name":"Create Application","event":[{"listen":"prerequest","script":{"id":"85ee6d87-96d1-4e44-9b93-19804b7e5d4b","exec":["// update currentDate","const currentDate = js.getCurrentDate();","pm.environment.set(\"currentDate\", currentDate);"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"49424aab-a741-4835-8987-b903a1cb5d52","exec":["// Set the variable","var jsonData = pm.response.json();","pm.environment.set(\"application_sid\", jsonData.sid);","","","pm.test(\"Response status code is 201\", function () {"," pm.response.to.have.status(201);","});","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Validate the response schema for the required fields\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.sid).to.be.a('string');"," pm.expect(responseData.name).to.be.a('string');"," pm.expect(responseData.icon).to.be.a('string');"," pm.expect(responseData.order).to.be.a('number');"," pm.expect(responseData.tables).to.be.an('array');"," pm.expect(responseData.teams).to.be.an('array');"," pm.expect(responseData.updated_by).to.be.an('object');"," pm.expect(responseData.date_updated).to.exist;"," pm.expect(responseData.date_created).to.exist;"," pm.expect(responseData.change_permission).to.be.a('boolean');"," pm.expect(responseData.help_text).to.be.an('object');","});","",""],"type":"text/javascript","packages":{}}}],"id":"325f560b-dc50-4ff2-a757-b7f7c296c8f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"icon\": \"star\",\n \"name\": \"Test Application {{currentDate}}\",\n \"tables\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://www.labii.dev/applications/application/list/organization/{{organization_sid_test_administrator}}/list/","description":"This endpoint makes an HTTP POST request to create a new application within the specified organization. The request payload includes parameters such as icon, name, and tables.
\nicon (string): The icon for the application.
\nname (string): The name of the application.
\ntables (array): An array of tables for the application.
\n{\n \"sid\": \"string\",\n \"name\": \"string\",\n \"icon\": \"string\",\n \"order\": 0,\n \"tables\": [],\n \"teams\": [],\n \"updated_by\": {\n \"sid\": \"string\",\n \"name\": \"string\"\n },\n \"date_updated\": \"string\",\n \"date_created\": \"string\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"icon\": \"string\",\n \"order\": \"string\",\n \"is_archived\": \"string\",\n \"tables\": \"string\",\n \"teams\": \"string\"\n }\n}\n\nThe response includes various details about the created application, such as the application's SID, icon, names, order, tables, teams, update details, date created, change permission, and help text.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["applications","application","list","organization","{{organization_sid_test_administrator}}","list",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[{"id":"93e84490-15d1-427f-81ed-3e801f600c2f","name":"Create Application","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"icon\": \"star\",\n \"name\": \"Test Application {{currentDate}}\",\n \"tables\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://www.labii.dev/applications/application/list/organization/{{organization_sid_test_administrator}}/list/"},"status":"Created","code":201,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Fri, 29 Nov 2024 02:43:09 GMT","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Allow","value":"GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS","type":"text"},{"key":"Pragma","value":"no-cache","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate","type":"text"},{"key":"Expires","value":"0","type":"text"},{"key":"Server","value":"Labii","type":"text"},{"key":"Access-Control-Allow-Origin","value":"*","type":"text"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin","type":"text"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp","type":"text"},{"key":"Content-Security-Policy","value":"style-src 'self' *.amazonaws.com 'unsafe-inline'; frame-src 'none'; default-src 'self' 'unsafe-inline' 'unsafe-eval' https://www.labii.com http://localhost:3000; font-src 'self' data: *.amazonaws.com; script-src 'self' *.amazonaws.com; img-src 'self' *.amazonaws.com","type":"text"},{"key":"Vary","value":"Accept-Language, Cookie, Origin","type":"text"},{"key":"Content-Language","value":"en","type":"text"},{"key":"X-Frame-Options","value":"DENY","type":"text"},{"key":"Content-Length","value":"955","type":"text"},{"key":"X-Content-Type-Options","value":"nosniff","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","type":"text"},{"key":"Referrer-Policy","value":"same-origin","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"sid\": \"loru0a40x59ansxCHMRW\",\n \"name\": \"Test Application 2024-11-28\",\n \"icon\": \"star\",\n \"order\": 20,\n \"tables\": [],\n \"teams\": [],\n \"updated_by\": {\n \"sid\": \"knqt0a40xffmrwBGLQV\",\n \"name\": \"Test Labii\"\n },\n \"date_updated\": \"2024-11-29T02:43:09.532073Z\",\n \"date_created\": \"2024-11-29T02:43:09.532078Z\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"Static encrypted identifier. \",\n \"name\": \"Name of the application\",\n \"description\": \"What is this application about?\",\n \"icon\": \"Icon of the application. Choose one at https://material.io/icons/. Replace blanks with '_'. For example: 'account_circle'\",\n \"order\": \"The order to display the application. \",\n \"is_archived\": \"If checked, the application is not available to use.\",\n \"tables\": \"Choose one or more tables to be grouped into this application.\",\n \"teams\": \"Choose one or more teams to have access to this application. If you don't choose any team, all teams will have access to this application.\"\n }\n}"}],"_postman_id":"325f560b-dc50-4ff2-a757-b7f7c296c8f8"},{"name":"Get Application Detail","event":[{"listen":"test","script":{"id":"10b3e430-7d84-4e3c-be95-eceb2a97c24c","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response time is within acceptable range\", function () {"," pm.expect(pm.response.responseTime).to.be.below(300);","});","","","pm.test(\"Validate the presence of required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData).to.have.property('sid').that.is.a('string');"," pm.expect(responseData).to.have.property('icon').that.is.a('string');"," pm.expect(responseData).to.have.property('name').that.is.a('string');"," pm.expect(responseData).to.have.property('name_singular').that.is.a('string');"," pm.expect(responseData).to.have.property('name_plural').that.is.a('string');"," pm.expect(responseData).to.have.property('name_system').that.is.a('string').or.to.be.a('null');"," pm.expect(responseData).to.have.property('type').that.is.a('string');"," pm.expect(responseData).to.have.property('description').that.is.a('string');"," pm.expect(responseData).to.have.property('unique_code').that.is.a('string');","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","pm.test(\"Validate the data types of the fields according to the provided JSON schema\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.sid).to.be.a('string');"," pm.expect(responseData.icon).to.be.a('string');"," pm.expect(responseData.name).to.be.a('string');"," pm.expect(responseData.name_singular).to.be.a('string');"," pm.expect(responseData.name_plural).to.be.a('string');"," pm.expect(responseData.name_system).to.satisfy((value) => typeof value === 'string' || value === null);"," pm.expect(responseData.type).to.be.a('string');"," pm.expect(responseData.description).to.be.a('string');"," pm.expect(responseData.unique_code).to.satisfy((value) => typeof value === 'string');","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","pm.test(\"Check that the 'tables' and 'teams' arrays are present in the response\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.tables).to.be.an('array').and.to.not.be.empty;"," pm.expect(responseData.teams).to.be.an('array').and.to.not.be.empty;","});","",""],"type":"text/javascript","packages":{}}}],"id":"a9dbc830-a2b1-412e-88f2-eb9dfaefd13c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/applications/application/detail/{{application_sid}}/","description":"This endpoint makes an HTTP GET request to retrieve details of a specific application. The endpoint URL should include the application_sid path parameter, which represents the unique identifier of the application.
The response for this request is a JSON object representing the details of the specified application. Below is a JSON schema representing the structure of the response:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"icon\": { \"type\": \"string\" },\n \"order\": { \"type\": \"integer\" },\n \"tables\": { \"type\": \"array\" },\n \"teams\": { \"type\": \"array\" },\n \"updated_by\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" }\n }\n },\n \"date_updated\": { \"type\": \"string\" },\n \"date_created\": { \"type\": \"string\" },\n \"change_permission\": { \"type\": \"boolean\" },\n \"help_text\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"icon\": { \"type\": \"string\" },\n \"order\": { \"type\": \"string\" },\n \"is_archived\": { \"type\": \"string\" },\n \"tables\": { \"type\": \"string\" },\n \"teams\": { \"type\": \"string\" }\n }\n }\n }\n}\n\nThis endpoint is used to delete a specific table filter detail.
\nMethod: DELETE
\nURL: https://www.labii.dev/tables/filter/detail/{{filter_sid}}/
This request does not require a request body.
\nThe response for this request is a JSON schema, which will include the details of the deletion operation. The schema will outline the structure of the response body, including the properties and their data types.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["applications","application","detail","{{application_sid}}",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf49c3e8-e880-4771-a2d8-3cdb2401c251"}],"id":"9ccd1bae-aed9-4a97-932e-b8ca5c11dd32","description":"Labii applications are domain-specific data management solutions built by combining configurable tables to address specialized needs. Each application is tailored to organize, track, and analyze professional data, whether for scientific research, business operations, or other purposes. For example, Labii can serve as an Electronic Lab Notebook (ELN) to manage experiment entries and document research activities or function as a Laboratory Information Management System (LIMS) to streamline workflows and sample tracking. This modular approach enables Labii to replace single-function platforms with versatile, integrated applications.
\n","_postman_id":"9ccd1bae-aed9-4a97-932e-b8ca5c11dd32","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Table","item":[{"name":"Get Table List","event":[{"listen":"test","script":{"id":"4358b675-4f04-4d96-a602-df58bcac1136","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Validate the top-level fields\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData).to.have.property('page_size');"," pm.expect(responseData).to.have.property('page_number');"," pm.expect(responseData).to.have.property('page_count');"," pm.expect(responseData).to.have.property('count');"," pm.expect(responseData).to.have.property('next');"," pm.expect(responseData).to.have.property('previous');"," pm.expect(responseData).to.have.property('add_permission');","});","","","pm.test(\"Results array is present and contains expected number of elements\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.have.property('results').that.is.an('array').with.lengthOf(1);","});","","","pm.test(\"Validate the 'results' array elements have the required fields\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData.results).to.be.an('array');"," responseData.results.forEach(function(result) {"," pm.expect(result).to.have.property('icon').that.is.a('string');"," pm.expect(result).to.have.property('name_singular').that.is.a('string');"," pm.expect(result).to.have.property('name_plural').that.is.a('string');"," pm.expect(result).to.have.property('sid').that.is.a('string');"," pm.expect(result).to.have.property('unique_code').that.is.a('string');"," pm.expect(result).to.have.property('order').that.is.a('number');"," pm.expect(result).to.have.property('is_archived');"," pm.expect(result).to.have.property('change_permission');"," pm.expect(result).to.have.property('readonly_fields').that.is.an('array');"," pm.expect(result).to.have.property('clickable_field').that.is.a('string');"," pm.expect(result).to.have.property('hidden_fields').that.is.an('array');"," pm.expect(result).to.have.property('hidden_fields_detail').that.is.an('array');"," pm.expect(result).to.have.property('groups').that.is.an('array');"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"af0d9015-33af-4bfb-b169-beff76db1333","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/tables/table/list/organization/{{organization_sid_test_administrator}}/list/","description":"This endpoint retrieves a list of tables for a specific organization.
\nNo request body is required for this endpoint.
\nThe response will be a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"page_size\": {\"type\": \"integer\"},\n \"page_number\": {\"type\": \"integer\"},\n \"page_count\": {\"type\": \"integer\"},\n \"count\": {\"type\": \"integer\"},\n \"next\": {\"type\": \"string\"},\n \"previous\": {\"type\": [\"string\", \"null\"]},\n \"add_permission\": {\"type\": \"boolean\"},\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"icon\": {\"type\": \"string\"},\n \"name_singular\": {\"type\": \"string\"},\n \"name_plural\": {\"type\": \"string\"},\n \"sid\": {\"type\": \"string\"},\n \"unique_code\": {\"type\": \"string\"},\n \"order\": {\"type\": \"integer\"},\n \"is_archived\": {\"type\": \"boolean\"},\n \"change_permission\": {\"type\": \"boolean\"},\n \"readonly_fields\": {\n \"type\": \"array\",\n \"items\": {\"type\": \"string\"}\n },\n \"clickable_field\": {\"type\": \"string\"},\n \"hidden_fields\": {\n \"type\": \"array\",\n \"items\": {\"type\": \"string\"}\n },\n \"hidden_fields_detail\": {\n \"type\": \"array\",\n \"items\": {\"type\": \"string\"}\n },\n \"groups\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\"type\": \"string\"},\n \"fields\": {\n \"type\": \"array\",\n \"items\": {\"type\": \"string\"}\n }\n }\n }\n }\n }\n }\n }\n }\n}\n\nThe response will contain the list of tables with their details such as name, icon, permissions, and fields.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["tables","table","list","organization","{{organization_sid_test_administrator}}","list",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[{"id":"7296987c-dfbd-4909-96f5-0a962c3eba2f","name":"Get Table List","originalRequest":{"method":"GET","header":[],"url":"https://www.labii.dev/tables/table/list/organization/{{organization_sid_test_administrator}}/list/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Mon, 04 Nov 2024 00:26:58 GMT","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Allow","value":"GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS","type":"text"},{"key":"Expires","value":"0","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate","type":"text"},{"key":"Pragma","value":"no-cache","type":"text"},{"key":"Server","value":"Labii","type":"text"},{"key":"Access-Control-Allow-Origin","value":"*","type":"text"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin","type":"text"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp","type":"text"},{"key":"Content-Security-Policy","value":"style-src 'self' *.amazonaws.com 'unsafe-inline'; frame-src 'none'; script-src 'self' *.amazonaws.com; img-src 'self' *.amazonaws.com; font-src 'self' data: *.amazonaws.com; default-src 'self' 'unsafe-inline' 'unsafe-eval' https://www.labii.com http://localhost:3000","type":"text"},{"key":"Vary","value":"Accept-Language, Cookie, Origin","type":"text"},{"key":"Content-Language","value":"en","type":"text"},{"key":"X-Frame-Options","value":"DENY","type":"text"},{"key":"Content-Length","value":"14909","type":"text"},{"key":"X-Content-Type-Options","value":"nosniff","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","type":"text"},{"key":"Referrer-Policy","value":"same-origin","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"page_size\": 10,\n \"page_number\": 1,\n \"page_count\": 6,\n \"count\": 57,\n \"next\": \"http://127.0.0.1:8000/tables/table/list/organization/HKNQ0a40x2988JOTY49di/list/?page=2\",\n \"previous\": null,\n \"add_permission\": true,\n \"results\": [\n {\n \"icon\": \"sticky_note_2\",\n \"name_singular\": \"entry\",\n \"name_plural\": \"entries\",\n \"sid\": \"zCFI0a40x124a6BGLQV16a\",\n \"unique_code\": \"ET\",\n \"order\": 2,\n \"is_archived\": false,\n \"change_permission\": true,\n \"readonly_fields\": [\n \"sid\",\n \"uid\",\n \"version\",\n \"table\",\n \"owner\",\n \"date_created\",\n \"date_updated\",\n \"updated_by\",\n \"is_locked\"\n ],\n \"clickable_field\": \"name\",\n \"hidden_fields\": [\n \"sid\",\n \"is_locked\",\n \"section_set\",\n \"uid\",\n \"change_permission\",\n \"data\",\n \"help_text\"\n ],\n \"hidden_fields_detail\": [\n \"is_locked\",\n \"column_set\",\n \"section_set\",\n \"change_permission\",\n \"data\",\n \"help_text\"\n ],\n \"groups\": [\n {\n \"name\": \"Overview\",\n \"fields\": [\n \"sid\",\n \"uid\",\n \"version\",\n \"table\",\n \"projects\",\n \"owner\",\n \"updated_by\",\n \"date_updated\",\n \"date_created\"\n ]\n },\n {\n \"name\": \"Columns\",\n \"description\": \"These are custom columns in this table that are not grouped. Group the columns using the column widget of the Subtitle.\",\n \"fields\": [\n \"JMPS0a40x55c9aLQV16afk\"\n ],\n \"is_column\": true\n },\n {\n \"name\": \"Use this entry as a template\",\n \"fields\": [\n \"is_template\"\n ]\n },\n {\n \"name\": \"Metadata\",\n \"fields\": [\n \"metadata\"\n ]\n },\n {\n \"name\": \"Archive this entry\",\n \"description\": \"It is not possible to delete a record, but you can archive it or rename it.\",\n \"color\": \"red lighten-5 red-text\",\n \"fields\": [\n \"is_archived\"\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"af0d9015-33af-4bfb-b169-beff76db1333"},{"name":"Create Table","event":[{"listen":"test","script":{"id":"f0323b74-f7a7-4749-be55-54724922e939","exec":["// Set the variable","var jsonData = pm.response.json();","pm.environment.set(\"table_sid\", jsonData.sid);","","","pm.test(\"Response status code is 201\", function () {"," pm.response.to.have.status(201);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Response body schema is correct\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.sid).to.be.a('string');"," pm.expect(responseData.icon).to.be.a('string');"," pm.expect(responseData.name).to.be.a('string');"," pm.expect(responseData.name_singular).to.be.a('string');"," pm.expect(responseData.name_plural).to.be.a('string');"," pm.expect(responseData.name_system).to.be.a('null');"," pm.expect(responseData.type).to.be.a('string');"," pm.expect(responseData.description).to.be.a('string');"," pm.expect(responseData.unique_code).to.be.a('string');"," pm.expect(responseData.uid_format).to.be.a('null');"," pm.expect(responseData.should_support_custom_uid).to.be.a('boolean');"," pm.expect(responseData.default_list_view).to.be.a('string');"," pm.expect(responseData.default_filters).to.be.an('array');"," pm.expect(responseData.default_detail_view).to.be.a('string');"," pm.expect(responseData.default_add_query).to.be.a('string');"," pm.expect(responseData.should_display_workflow).to.be.a('boolean');"," pm.expect(responseData.should_limit_edit_to_owner).to.be.a('boolean');"," pm.expect(responseData.fields_to_display).to.be.an('array');"," pm.expect(responseData.fields_to_display_for_detail).to.be.an('array');"," pm.expect(responseData.should_enable_section_complete_action).to.be.a('boolean');"," pm.expect(responseData.ordering).to.be.a('string');"," pm.expect(responseData.minimum_number_of_signers).to.be.a('number');"," pm.expect(responseData.columns).to.be.an('array');"," pm.expect(responseData.order).to.be.a('number');"," pm.expect(responseData.number_of_records).to.be.a('number');"," pm.expect(responseData.print_header).to.be.a('string');"," pm.expect(responseData.metadata).to.be.an('array');"," pm.expect(responseData.required_certifications).to.be.a('null');"," pm.expect(responseData.application).to.be.an('object');"," pm.expect(responseData.is_archived).to.be.a('boolean');"," pm.expect(responseData.updated_by).to.be.an('object');"," pm.expect(responseData.date_updated).to.be.a('string');"," pm.expect(responseData.date_created).to.be.a('string');"," pm.expect(responseData.change_permission).to.be.a('boolean');"," pm.expect(responseData.readonly_fields).to.be.an('array');"," pm.expect(responseData.clickable_field).to.be.a('string');"," pm.expect(responseData.hidden_fields).to.be.an('array');"," pm.expect(responseData.hidden_fields_detail).to.be.an('array');"," pm.expect(responseData.groups).to.be.an('array');"," pm.expect(responseData.help_text).to.be.an('object');","});","","","pm.test(\"Verify that the 'table_sid' variable is set in the environment\", function () {"," pm.expect(pm.environment.get(\"table_sid\")).to.exist;","});","",""],"type":"text/javascript","packages":{}}}],"id":"5fa91e4f-5784-465b-ad9a-67ad91bdaea5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"icon\": \"star\",\n \"name_singular\": \"postman\",\n \"name_plural\": \"postmans\",\n \"description\": \"Test table created by postman.\",\n \"unique_code\": \"POST\",\n \"uid_format\": null,\n \"should_support_custom_uid\": false,\n \"default_list_view\": \"records\",\n \"default_filters\": [\n \"all\",\n \"active\",\n \"archived\",\n \"my\",\n \"my_unsigned\",\n \"templates\"\n ],\n \"default_detail_view\": \"workflow_toc\",\n \"default_add_query\": \"\",\n \"should_display_workflow\": false,\n \"should_limit_edit_to_owner\": false,\n \"fields_to_display\": [\n \"projects\",\n \"owner\"\n ],\n \"fields_to_display_for_detail\": [],\n \"should_enable_section_complete_action\": true,\n \"ordering\": \"-date_updated\",\n \"minimum_number_of_signers\": 0,\n \"print_header\": \"\",\n \"metadata\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://www.labii.dev/tables/table/list/organization/{{organization_sid_test_administrator}}/list/","description":"This endpoint makes an HTTP POST request to create a new table within the specified organization. The request payload includes parameters such as icon, name_singular, name_plural, description, unique_code, default_list_view, default_filters, default_detail_view, should_display_workflow, should_limit_edit_to_owner, fields_to_display, should_enable_section_complete_action, ordering, minimum_number_of_signers, and metadata.
\nicon (string): The icon for the table.
\nname_singular (string): The singular name for the table.
\nname_plural (string): The plural name for the table.
\ndescription (string): Description of the table.
\nunique_code (string): Unique code for the table.
\ndefault_list_view (string): Default view for the table list.
\ndefault_filters (array of strings): Default filters for the table.
\ndefault_detail_view (string): Default view for table details.
\nshould_display_workflow (boolean): Indicates if the workflow should be displayed.
\nshould_limit_edit_to_owner (boolean): Indicates if editing is limited to the owner.
\nfields_to_display (array of strings): Fields to be displayed in the table.
\nshould_enable_section_complete_action (boolean): Indicates if section complete action is enabled.
\nordering (string): Ordering of the table records.
\nminimum_number_of_signers (number): Minimum number of signers required.
\nmetadata (array): Additional metadata for the table.
\nThe response includes various details about the created table, such as the table's SID, icon, names, type, description, default views, fields to display, ordering, minimum number of signers, and metadata. Additionally, it provides information about the application, update details, permissions, and group fields.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["tables","table","list","organization","{{organization_sid_test_administrator}}","list",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[{"id":"2ae96f57-0f6c-4c9f-80c2-e365c96f826a","name":"Create Table","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"icon\": \"star\",\n \"name_singular\": \"postman\",\n \"name_plural\": \"postmans\",\n \"description\": \"Test table created by postman.\",\n \"unique_code\": \"POST\",\n \"uid_format\": null,\n \"should_support_custom_uid\": false,\n \"default_list_view\": \"records\",\n \"default_filters\": [\n \"all\",\n \"active\",\n \"archived\",\n \"my\",\n \"my_unsigned\",\n \"templates\"\n ],\n \"default_detail_view\": \"workflow_toc\",\n \"default_add_query\": \"\",\n \"should_display_workflow\": false,\n \"should_limit_edit_to_owner\": false,\n \"fields_to_display\": [\n \"projects\",\n \"owner\"\n ],\n \"fields_to_display_for_detail\": [],\n \"should_enable_section_complete_action\": true,\n \"ordering\": \"-date_updated\",\n \"minimum_number_of_signers\": 0,\n \"print_header\": \"\",\n \"metadata\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://www.labii.dev/tables/table/list/organization/{{organization_sid_test_administrator}}/list/"},"status":"Created","code":201,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Mon, 04 Nov 2024 00:55:22 GMT","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Allow","value":"GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS","type":"text"},{"key":"Pragma","value":"no-cache","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate","type":"text"},{"key":"Expires","value":"0","type":"text"},{"key":"Server","value":"Labii","type":"text"},{"key":"Access-Control-Allow-Origin","value":"*","type":"text"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin","type":"text"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp","type":"text"},{"key":"Content-Security-Policy","value":"style-src 'self' *.amazonaws.com 'unsafe-inline'; frame-src 'none'; script-src 'self' *.amazonaws.com; img-src 'self' *.amazonaws.com; font-src 'self' data: *.amazonaws.com; default-src 'self' 'unsafe-inline' 'unsafe-eval' https://www.labii.com http://localhost:3000","type":"text"},{"key":"Vary","value":"Accept-Language, Cookie, Origin","type":"text"},{"key":"Content-Language","value":"en","type":"text"},{"key":"X-Frame-Options","value":"DENY","type":"text"},{"key":"Content-Length","value":"6792","type":"text"},{"key":"X-Content-Type-Options","value":"nosniff","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","type":"text"},{"key":"Referrer-Policy","value":"same-origin","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"sid\": \"jmps0a40x12550lqvAFKPU\",\n \"icon\": \"star\",\n \"name\": \"postmans\",\n \"name_singular\": \"postman\",\n \"name_plural\": \"postmans\",\n \"name_system\": null,\n \"type\": \"blank\",\n \"description\": \"Test table created by postman.\",\n \"unique_code\": \"POST\",\n \"uid_format\": null,\n \"should_support_custom_uid\": false,\n \"default_list_view\": \"records\",\n \"default_filters\": [\n \"all\",\n \"active\",\n \"archived\",\n \"my\",\n \"my_unsigned\",\n \"templates\"\n ],\n \"default_detail_view\": \"workflow_toc\",\n \"default_add_query\": \"\",\n \"should_display_workflow\": false,\n \"should_limit_edit_to_owner\": false,\n \"fields_to_display\": [\n \"projects\",\n \"owner\"\n ],\n \"fields_to_display_for_detail\": [],\n \"should_enable_section_complete_action\": true,\n \"ordering\": \"-date_updated\",\n \"minimum_number_of_signers\": 0,\n \"columns\": [],\n \"order\": 58,\n \"number_of_records\": 0,\n \"print_header\": \"\",\n \"metadata\": [],\n \"required_certifications\": null,\n \"application\": {\n \"sid\": \"Other Tables\",\n \"name\": \"Other Tables\"\n },\n \"is_archived\": false,\n \"updated_by\": {\n \"sid\": \"knqt0a40xffmrwBGLQV\",\n \"name\": \"Test Labii\"\n },\n \"date_updated\": \"2024-11-04T00:55:22.652322Z\",\n \"date_created\": \"2024-11-04T00:55:22.652332Z\",\n \"change_permission\": true,\n \"readonly_fields\": [\n \"sid\",\n \"uid\",\n \"version\",\n \"table\",\n \"owner\",\n \"date_created\",\n \"date_updated\",\n \"updated_by\",\n \"is_locked\"\n ],\n \"clickable_field\": \"name\",\n \"hidden_fields\": [\n \"sid\",\n \"is_locked\",\n \"section_set\",\n \"uid\",\n \"change_permission\",\n \"data\",\n \"help_text\"\n ],\n \"hidden_fields_detail\": [\n \"is_locked\",\n \"column_set\",\n \"section_set\",\n \"change_permission\",\n \"data\",\n \"help_text\"\n ],\n \"groups\": [\n {\n \"name\": \"Overview\",\n \"fields\": [\n \"sid\",\n \"uid\",\n \"version\",\n \"table\",\n \"projects\",\n \"owner\",\n \"updated_by\",\n \"date_updated\",\n \"date_created\"\n ]\n },\n {\n \"name\": \"Use this postman as a template\",\n \"fields\": [\n \"is_template\"\n ]\n },\n {\n \"name\": \"Metadata\",\n \"fields\": [\n \"metadata\"\n ]\n },\n {\n \"name\": \"Archive this postman\",\n \"description\": \"It is not possible to delete a record, but you can archive it or rename it.\",\n \"color\": \"red lighten-5 red-text\",\n \"fields\": [\n \"is_archived\"\n ]\n }\n ],\n \"help_text\": {\n \"sid\": \"Static encrypted identifier. \",\n \"type\": \"Choose a table template. After the table is created, it will also create the columns, sections, and filters associated with it. These parameters can be updated at a later time.\",\n \"name_singular\": \"Table name, in singular format. Letters and Numbers only.\",\n \"name_plural\": \"Table name, in plural format. Letters and Numbers only.\",\n \"name_system\": \"The name for system to identify a particular table. \",\n \"description\": \"Description of the table. Provide enough information for other users in your organization to understand. Table descriptions will be displayed in table list views.\",\n \"icon\": \"Icon of the table. Choose one at https://fonts.google.com/icons. In order to use an icon, simply copy its lowercase name and replace blank spaces with '_'. For example: 'account_circle'\",\n \"order\": \"The order to display this table. Integer only. Drag the table to a preferred position at the list view to update the order. \",\n \"unique_code\": \"The abbreviation term of table name. The code must be at least 2 characters long and contain only uppercase letters. The unique code will be used to reference an object. Changes to the unique code will update the unique identifier of all records associated with the table.\",\n \"uid_format\": \"You have the option to personalize the UID by specifying your preferred UID format, which by default consists of '{Unique Code}{RID}'.\",\n \"should_support_custom_uid\": \"If true, users must supply their unique identifier (UID) for each record. This works well for reagents where you prefer to utilize the vendor's barcode as the UID.This endpoint makes an HTTP GET request to retrieve details of a specific table. The response for this request is a JSON object containing various properties such as table ID, name, type, description, default views, fields to display, application details, and more.
\nNo request body parameters are required for this request. The endpoint URL should include the table_sid path parameter, which represents the unique identifier of the table.
The response for this request is a JSON object representing the details of the specified table. Below is a JSON schema representing the structure of the response:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"icon\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"name_singular\": { \"type\": \"string\" },\n \"name_plural\": { \"type\": \"string\" },\n \"name_system\": { \"type\": [\"string\", \"null\"] },\n \"type\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"unique_code\": { \"type\": \"string\" },\n \"uid_format\": { \"type\": [\"string\", \"null\"] },\n \"should_support_custom_uid\": { \"type\": \"boolean\" },\n \"default_list_view\": { \"type\": \"string\" },\n \"default_filters\": { \"type\": \"array\", \"items\": { \"type\": \"string\" } },\n \"default_detail_view\": { \"type\": \"string\" },\n \"default_add_query\": { \"type\": \"string\" },\n \"should_display_workflow\": { \"type\": \"boolean\" },\n \"should_limit_edit_to_owner\": { \"type\": \"boolean\" },\n \"fields_to_display\": { \"type\": \"array\", \"items\": { \"type\": \"string\" } },\n \"fields_to_display_for_detail\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" }\n }\n }\n },\n \"should_enable_section_complete_action\": { \"type\": \"boolean\" },\n \"ordering\": { \"type\": \"string\" },\n \"minimum_number_of_signers\": { \"type\": \"integer\" },\n \"columns\": { \"type\": \"array\" },\n \"order\": { \"type\": \"integer\" },\n \"number_of_records\": { \"type\": \"integer\" },\n \"print_header\": { \"type\": \"string\" },\n \"metadata\": { \"type\": \"array\" },\n \"required_certifications\": { \"type\": [\"array\", \"null\"] },\n \"application\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" }\n }\n },\n \"is_archived\": { \"type\": \"boolean\" },\n \"updated_by\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" }\n }\n },\n \"date_updated\": { \"type\": \"string\" },\n \"date_created\": { \"type\": \"string\" },\n \"change_permission\": { \"type\": \"boolean\" },\n \"readonly_fields\": { \"type\": \"array\", \"items\": { \"type\": \"string\" } },\n \"clickable_field\": { \"type\": \"string\" },\n \"hidden_fields\": { \"type\": \"array\", \"items\": { \"type\": \"string\" } },\n \"hidden_fields_detail\": { \"type\": \"array\", \"items\": { \"type\": \"string\" } },\n \"groups\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": { \"type\": \"string\" },\n \"fields\": { \"type\": \"array\", \"items\": { \"type\": \"string\" } }\n }\n }\n },\n \"help_text\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"type\": { \"type\": \"string\" },\n \"name_singular\": { \"type\": \"string\" },\n \"name_plural\": { \"type\": \"string\" },\n \"name_system\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"icon\": { \"type\": \"string\" },\n \"order\": { \"type\": \"string\" },\n \"unique_code\": { \"type\": \"string\" },\n \"uid_format\": { \"type\": \"string\" },\n \"should_support_custom_uid\": { \"type\": \"string\" },\n \"default_list_view\": { \"type\": \"string\" },\n \"default_filters\": { \"type\": \"string\" },\n \"fields_to_display\": { \"type\": \"string\" },\n \"ordering\": { \"type\": \"string\" },\n \"default_detail_view\": { \"type\": \"string\" },\n \"fields_to_display_for_detail\": { \"type\": \"string\" },\n \"should_enable_section_complete_action\": { \"type\": \"string\" },\n \"default_add_query\": { \"type\": \"string\" },\n \"should_display_workflow\": { \"type\": \"string\" },\n \"print_header\": { \"type\": \"string\" },\n \"should_limit_edit_to_owner\": { \"type\": \"string\" },\n \"required_certifications\": { \"type\": \"string\" },\n \"minimum_number_of_signers\": { \"type\": \"string\" },\n \"metadata\": { \"type\": \"string\" },\n \"is_archived\": { \"type\": \"string\" }\n }\n }\n }\n}\n\nThis endpoint allows the client to update the details of a specific table.
\nicon (string): The icon representing the table.
\nname_singular (string): The singular name of the table.
\nname_plural (string): The plural name of the table.
\ndescription (string): A brief description of the table.
\nunique_code (string): A unique code for the table.
\nuid_format (null or string): The format for unique identifiers, if applicable.
\nshould_support_custom_uid (boolean): Indicates if custom unique identifiers are supported.
\ndefault_list_view (string): The default view for listing records.
\ndefault_filters (array of strings): Default filters for records.
\ndefault_detail_view (string): The default view for detailed records.
\ndefault_add_query (string): Default query for adding records.
\nshould_display_workflow (boolean): Indicates if workflow display is enabled.
\nshould_limit_edit_to_owner (boolean): Indicates if editing is limited to the owner.
\nfields_to_display (array of strings): Fields to display in the table.
\nfields_to_display_for_detail (array of strings): Fields to display in detailed records.
\nshould_enable_section_complete_action (boolean): Indicates if section complete action is enabled.
\nordering (string): The ordering of records.
\nminimum_number_of_signers (number): The minimum number of signers required.
\nprint_header (string): Header for printing records.
\nmetadata (array): Additional metadata for the table.
\nis_archived (boolean): Indicates if the table is archived.
\nThe response for this request is a JSON schema representing the updated table details.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"icon\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"name_singular\": {\"type\": \"string\"},\n \"name_plural\": {\"type\": \"string\"},\n \"name_system\": {\"type\": \"null\"},\n \"type\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"unique_code\": {\"type\": \"string\"},\n \"uid_format\": {\"type\": [\"null\", \"string\"]},\n \"should_support_custom_uid\": {\"type\": \"boolean\"},\n \"default_list_view\": {\"type\": \"string\"},\n \"default_filters\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}},\n \"default_detail_view\": {\"type\": \"string\"},\n \"default_add_query\": {\"type\": \"string\"},\n \"should_display_workflow\": {\"type\": \"boolean\"},\n \"should_limit_edit_to_owner\": {\"type\": \"boolean\"},\n \"fields_to_display\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}},\n \"fields_to_display_for_detail\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}},\n \"should_enable_section_complete_action\": {\"type\": \"boolean\"},\n \"ordering\": {\"type\": \"string\"},\n \"minimum_number_of_signers\": {\"type\": \"number\"},\n \"columns\": {\"type\": \"array\"},\n \"order\": {\"type\": \"number\"},\n \"number_of_records\": {\"type\": \"number\"},\n \"print_header\": {\"type\": \"string\"},\n \"metadata\": {\"type\": \"array\"},\n \"required_certifications\": {\"type\": \"null\"},\n \"application\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"}\n }\n },\n \"is_archived\": {\"type\": \"boolean\"},\n \"updated_by\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"}\n }\n },\n \"date_updated\": {\"type\": \"string\"},\n \"date_created\": {\"type\": \"string\"},\n \"change_permission\": {\"type\": \"boolean\"},\n \"readonly_fields\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}},\n \"clickable_field\": {\"type\": \"string\"},\n \"hidden_fields\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}},\n \"hidden_fields_detail\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}},\n \"groups\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\"type\": \"string\"},\n \"fields\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}}\n }\n }\n },\n \"help_text\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"type\": {\"type\": \"string\"},\n \"name_singular\": {\"type\": \"string\"},\n \"name_plural\": {\"type\": \"string\"},\n \"name_system\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"icon\": {\"type\": \"string\"},\n \"order\": {\"type\": \"string\"},\n \"unique_code\": {\"type\": \"string\"},\n \"uid_format\": {\"type\": \"string\"},\n \"should_support_custom_uid\": {\"type\": \"string\"},\n \"default_list_view\": {\"type\": \"string\"},\n \"default_filters\": {\"type\": \"string\"},\n \"fields_to_display\": {\"type\": \"string\"},\n \"ordering\": {\"type\": \"string\"},\n \"default_detail_view\": {\"type\": \"string\"},\n \"fields_to_display_for_detail\": {\"type\": \"string\"},\n \"should_enable_section_complete_action\": {\"type\": \"string\"},\n \"default_add_query\": {\"type\": \"string\"},\n \"should_display_workflow\": {\"type\": \"string\"},\n \"print_header\": {\"type\": \"string\"},\n \"should_limit_edit_to_owner\": {\"type\": \"string\"},\n \"required_certifications\": {\"type\": \"string\"},\n \"minimum_number_of_signers\": {\"type\": \"string\"},\n \"metadata\": {\"type\": \"string\"},\n \"is_archived\": {\"type\": \"string\"}\n }\n }\n }\n}\n\nThe Labii Table API is a versatile tool that allows users to efficiently manage tables within their applications. With this API, users can retrieve a comprehensive list of tables, create new tables, access detailed information about specific tables, and make edits as necessary. This functionality streamlines data organization and enhances the overall management of structured information, providing users with the flexibility to tailor their data storage to meet their specific needs.
\n","_postman_id":"4946b99d-c198-41a0-a25c-e15ebb27d9f9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Column","item":[{"name":"Get Column List","event":[{"listen":"test","script":{"id":"55aad491-3785-47c0-9b03-da202f7fe149","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Validate the response schema for the fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.results).to.be.an('array');"," "," responseData.results.forEach(function(result) {"," pm.expect(result).to.have.property('name').that.is.a('string');"," pm.expect(result).to.have.property('sid').that.is.a('string');"," pm.expect(result).to.have.property('description').that.is.a('string');"," pm.expect(result).to.have.property('widget').that.is.an('object');"," pm.expect(result).to.have.property('is_required').that.is.a('boolean');"," pm.expect(result).to.have.property('should_hide_in_form_view').that.is.a('boolean');"," pm.expect(result).to.have.property('should_hide_in_list_view').that.is.a('boolean');"," pm.expect(result).to.have.property('is_archived').that.is.a('boolean');"," pm.expect(result).to.have.property('order').that.is.a('number');"," pm.expect(result).to.have.property('table').that.is.an('object');"," pm.expect(result).to.have.property('change_permission').that.is.a('boolean');"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"f824f76d-8f3b-4dc5-8c96-3a237b11fc61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/tables/column/list/organization/{{organization_sid_test_administrator}}/list/?table__sid={{table_sid_test_administrator}}","description":"This endpoint retrieves a list of columns for a specific organization and table.
\nMethod: GET
\nURL: https://www.labii.dev/tables/column/list/organization/{{organization_sid_test_administrator}}/list/?table__sid={{table_sid_test_administrator}}
\nThe response will include the following fields:
\npage_size (number) - The number of items per page
page_number (number) - The current page number
page_count (number) - The total number of pages
count (number) - The total count of items
next (string) - The URL for the next page
previous (string) - The URL for the previous page
add_permission (boolean) - Indicates if the user has permission to add columns
results (array) - An array of column objects, each containing:
name (string) - The name of the column
sid (string) - The unique identifier of the column
description (string) - The description of the column
widget (object) - Information about the widget associated with the column, including:
sid (string) - The unique identifier of the widget
name (string) - The name of the widget
documentation_url (string) - The URL to the documentation of the widget
is_required (boolean) - Indicates if the column is required
should_hide_in_form_view (boolean) - Indicates if the column should be hidden in the form view
should_hide_in_list_view (boolean) - Indicates if the column should be hidden in the list view
is_archived (boolean) - Indicates if the column is archived
order (number) - The order of the column
table (object) - Information about the table associated with the column, including:
sid (string) - The unique identifier of the table
name (string) - The name of the table
change_permission (boolean) - Indicates if the user has permission to change the column
This endpoint allows you to create a new column within a specific organization and table.
\nname: The name of the new column.
description: A description for the new column.
widget: Details about the widget used for the column.
default_data: The default data for the column.
configuration: Configuration settings for the column.
is_required: Indicates if the column is required.
should_hide_in_form_view: Specifies whether the column should be hidden in the form view.
should_hide_in_list_view: Specifies whether the column should be hidden in the list view.
sid: The unique identifier for the new column.
name: The name of the new column.
description: A description of the new column.
widget: Details about the widget used for the column.
default_data: The default data for the column.
configuration: Configuration settings for the column.
is_required: Indicates if the column is required.
should_hide_in_form_view: Specifies whether the column should be hidden in the form view.
should_hide_in_list_view: Specifies whether the column should be hidden in the list view.
max_width: The maximum width of the column.
metadata: Additional metadata for the column.
table: Details about the table to which the column belongs.
is_archived: Indicates if the column is archived.
date_created: The date when the column was created.
change_permission: Specifies the permission to change the column.
help_text: Additional help text for the column.
This endpoint retrieves detailed information about a specific column in a table.
\nNo request body is required for this GET request.
\n{{column_sid}} (path parameter) - The unique identifier of the column for which details are to be retrieved.The response for this request is a JSON object conforming to the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"name_system\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"widget\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"documentation_url\": {\"type\": \"string\"}\n }\n },\n \"configuration\": {\"type\": \"null\"},\n \"permission\": {\"type\": \"null\"},\n \"default_data\": {\"type\": \"string\"},\n \"order\": {\"type\": \"integer\"},\n \"is_required\": {\"type\": \"boolean\"},\n \"should_hide_in_form_view\": {\"type\": \"boolean\"},\n \"should_hide_in_list_view\": {\"type\": \"boolean\"},\n \"max_width\": {\"type\": [\"null\", \"integer\"]},\n \"metadata\": {\"type\": \"null\"},\n \"table\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"}\n }\n },\n \"is_archived\": {\"type\": \"boolean\"},\n \"date_created\": {\"type\": \"string\"},\n \"change_permission\": {\"type\": \"boolean\"},\n \"help_text\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"name_system\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"widget\": {\"type\": \"string\"},\n \"configuration\": {\"type\": \"string\"},\n \"permission\": {\"type\": \"string\"},\n \"default_data\": {\"type\": \"string\"},\n \"order\": {\"type\": \"string\"},\n \"is_required\": {\"type\": \"string\"},\n \"should_hide_in_form_view\": {\"type\": \"string\"},\n \"should_hide_in_list_view\": {\"type\": \"string\"},\n \"max_width\": {\"type\": \"string\"},\n \"metadata\": {\"type\": \"string\"},\n \"is_archived\": {\"type\": \"string\"}\n }\n }\n }\n}\n\nThe response includes detailed information about the specified column, including its name, description, widget details, configuration, permissions, default data, and other relevant attributes.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["tables","column","detail","{{column_sid}}",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[{"id":"0ea83285-525c-4d0f-9250-5059d5f0dd13","name":"Get Column Detail","originalRequest":{"method":"GET","header":[],"url":"https://www.labii.dev/tables/column/detail/{{column_sid}}/"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Mon, 04 Nov 2024 04:21:01 GMT","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Allow","value":"GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS","type":"text"},{"key":"Expires","value":"0","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate","type":"text"},{"key":"Pragma","value":"no-cache","type":"text"},{"key":"Server","value":"Labii","type":"text"},{"key":"Access-Control-Allow-Origin","value":"*","type":"text"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin","type":"text"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp","type":"text"},{"key":"Content-Security-Policy","value":"style-src 'self' *.amazonaws.com 'unsafe-inline'; frame-src 'none'; script-src 'self' *.amazonaws.com; img-src 'self' *.amazonaws.com; font-src 'self' data: *.amazonaws.com; default-src 'self' 'unsafe-inline' 'unsafe-eval' https://www.labii.com http://localhost:3000","type":"text"},{"key":"Vary","value":"Accept-Language, Cookie, Origin","type":"text"},{"key":"Content-Language","value":"en","type":"text"},{"key":"X-Frame-Options","value":"DENY","type":"text"},{"key":"Content-Length","value":"3469","type":"text"},{"key":"X-Content-Type-Options","value":"nosniff","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","type":"text"},{"key":"Referrer-Policy","value":"same-origin","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"sid\": \"RUX10a40x563a8TY49dins\",\n \"name\": \"Test Column 2024-11-03\",\n \"name_system\": \"\",\n \"description\": \"Column created by postman.\",\n \"widget\": {\n \"sid\": \"EHKN0a40x1bGLQV16af\",\n \"name\": \"Text\",\n \"documentation_url\": \"https://docs.labii.com/widgets/column-widgets/text-inputs/text\"\n },\n \"configuration\": null,\n \"permission\": null,\n \"default_data\": \"Test\",\n \"order\": 1,\n \"is_required\": true,\n \"should_hide_in_form_view\": false,\n \"should_hide_in_list_view\": false,\n \"max_width\": null,\n \"metadata\": null,\n \"table\": {\n \"sid\": \"gjmp0a40x1254dinsxCHMR\",\n \"name\": \"tests\"\n },\n \"is_archived\": false,\n \"date_created\": \"2024-11-04T04:19:42.071146Z\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"Static encrypted identifier. \",\n \"name\": \"Letters and number only.\",\n \"name_system\": \"The name to identify the column for a widget. \",\n \"description\": \"The description of the column. Include the definition, special formatting, and all other necessary information to help your coworker to fill.\",\n \"widget\": \"The widget to use, or the type of data. Default to Text. The configuration data will be erased if the widget is changed.This endpoint allows the client to update the details of a specific column in a table.
\nname: (string) The name of the column.
description: (string) A brief description of the column.
configuration: (null) The configuration settings for the column.
default_data: (string) The default data for the column.
is_required: (boolean) Indicates whether the column is required.
should_hide_in_form_view: (boolean) Indicates whether the column should be hidden in form view.
should_hide_in_list_view: (boolean) Indicates whether the column should be hidden in list view.
max_width: (null) The maximum width of the column.
metadata: (null) Additional metadata for the column.
The response will be a JSON object with the following schema:
\n{\n \"sid\": \"\",\n \"name\": \"\",\n \"name_system\": \"\",\n \"description\": \"\",\n \"widget\": {\n \"sid\": \"\",\n \"name\": \"\",\n \"documentation_url\": \"\"\n },\n \"configuration\": null,\n \"permission\": null,\n \"default_data\": \"\",\n \"order\": 0,\n \"is_required\": true,\n \"should_hide_in_form_view\": true,\n \"should_hide_in_list_view\": true,\n \"max_width\": null,\n \"metadata\": null,\n \"table\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"is_archived\": true,\n \"date_created\": \"\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"\",\n \"name\": \"\",\n \"name_system\": \"\",\n \"description\": \"\",\n \"widget\": \"\",\n \"configuration\": \"\",\n \"permission\": \"\",\n \"default_data\": \"\",\n \"order\": \"\",\n \"is_required\": \"\",\n \"should_hide_in_form_view\": \"\",\n \"should_hide_in_list_view\": \"\",\n \"max_width\": \"\",\n \"metadata\": \"\",\n \"is_archived\": \"\"\n }\n}\n\nThe Labii Column API is designed to facilitate the management of table structures by allowing users to define and manipulate columns within their tables. This API enables users to retrieve a list of columns, create new columns, access detailed information about specific columns, and edit existing columns as needed. By providing these capabilities, the API streamlines the organization of data within tables, ensuring that users can effectively customize their data schema to fit their unique requirements.
\n","_postman_id":"f2aeda90-4fec-4c71-ae6e-f93e81cbcc57","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Section","item":[{"name":"Get Section List","event":[{"listen":"test","script":{"id":"4d812b19-10f9-47d5-8a72-d3b3593abe68","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Validate the structure of the 'results' array\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array').and.to.have.lengthOf.at.least(1);",""," responseData.results.forEach(function(result) {"," pm.expect(result).to.have.property('name').that.is.a('string');"," pm.expect(result).to.have.property('sid').that.is.a('string');"," pm.expect(result).to.have.property('widget').that.is.an('object');"," pm.expect(result).to.have.property('description').that.is.a('string');"," pm.expect(result).to.have.property('price');"," pm.expect(result).to.have.property('is_archived').that.is.a('boolean');"," pm.expect(result).to.have.property('row');"," pm.expect(result).to.have.property('table').that.is.an('object');"," pm.expect(result).to.have.property('order');"," });","});","","","pm.test(\"Results array should contain at least one element\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array').that.is.not.empty;","});","","","pm.test(\"Verify that the 'widget' object within 'results' contains the fields: sid and name\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array');"," responseData.results.forEach(function(result) {"," pm.expect(result.widget).to.be.an('object');"," pm.expect(result.widget.sid).to.exist;"," pm.expect(result.widget.name).to.exist;"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"d05c78b2-fd34-4c65-a675-fac6595849b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/tables/section/list/organization/{{organization_sid_test_administrator}}/list/?table__sid={{table_sid_test_administrator}}","description":"This endpoint retrieves a list of table sections for a specific organization.
\nMethod: GET
\nURL: https://www.labii.dev/tables/section/list/organization/{{organization_sid_test_administrator}}/list/
Query Parameters:
\ntable__sid: (string) The ID of the tableThe response will contain the following fields:
\npage_size: The number of items per page
page_number: The current page number
page_count: The total number of pages
count: The total count of table sections
next: URL for the next page
previous: URL for the previous page
add_permission: Indicates if the user has permission to add new table sections
results: An array of table section objects, each containing:
name: The name of the section
sid: The ID of the section
widget: Object containing widget details
sid: The ID of the widget
name: The name of the widget
description: The description of the section
price: The price of the section
is_archived: Indicates if the section is archived
row: Details of the row
table: Object containing table details
sid: The ID of the table
name: The name of the table
order: The order of the section
change_permission: Indicates if the user has permission to change the section
This endpoint allows you to create a new section within a specific organization and table.
\nname (string, required): The name of the section.
\ndescription (string, required): Description of the section.
\nwidget (object, required): Details of the widget associated with the section.
\nsid (string, required): The unique identifier of the widget.
\nname (string, required): The name of the widget.
\nThe response for this request is an empty array.
\n{\n \"type\": \"array\",\n \"items\": {}\n}\n\nThis endpoint retrieves the details of a specific table section.
\nMethod: GET
\nURL: https://www.labii.dev/tables/section/detail/{{section_sid}}/
The response for this request is an empty array [].
This request does not require a request body.
\nThe response body for this request is an empty array [].
{\n \"type\": \"array\",\n \"items\": {}\n}\n\nThis endpoint allows the client to update the details of a specific section in a table.
\nThe HTTP PATCH request should be made to https://www.labii.dev/tables/section/detail/{{section_sid}}/.
The request body should be in raw format and include the following parameters:
\nname: (string) The updated name of the section.
description: (string) The updated description of the section.
description_placement: (string) The placement of the description (e.g., Top, Bottom, Left, Right).
data: (string) The updated data for the section.
Example:
\n{\n \"name\": \"Test Section {{currentDate}}\",\n \"description\": \"Test section edited by postnam ...\",\n \"description_placement\": \"Top\",\n \"data\": \"Test\"\n}\n\nThe response for this request is an empty array [].
{\n \"type\": \"array\",\n \"items\": {}\n}\n\nThe Labii Section API is designed to manage unstructured data associated with records, allowing users to efficiently organize and customize their data storage. Sections can be assigned to both tables and specific records, with sections assigned to a table serving as the default for all new records created within that table. This API provides users with the ability to retrieve a list of sections, create new sections, access detailed information about specific sections, and edit existing sections as necessary. By enhancing the management of unstructured data, this API ensures that users can tailor their data organization to meet their specific needs.
\n","_postman_id":"e1d25f1c-f0b1-4138-92d4-e2e731c09cef","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Filter","item":[{"name":"Get Filter List","event":[{"listen":"test","script":{"id":"e34d549c-036d-46da-beac-30bd933fe0bc","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.page_size).to.exist;"," pm.expect(responseData.page_number).to.exist;"," pm.expect(responseData.page_count).to.exist;"," pm.expect(responseData.count).to.exist;"," pm.expect(responseData.next).to.exist;"," pm.expect(responseData.previous).to.exist;"," pm.expect(responseData.add_permission).to.exist;"," pm.expect(responseData.results).to.exist;","});","","","pm.test(\"Each result contains the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array');"," responseData.results.forEach(function(result) {"," pm.expect(result).to.have.property('name');"," pm.expect(result).to.have.property('sid');"," pm.expect(result).to.have.property('description');"," pm.expect(result).to.have.property('owners');"," pm.expect(result).to.have.property('teams');"," pm.expect(result).to.have.property('show_in_menu');"," pm.expect(result).to.have.property('digest_frequency');"," pm.expect(result).to.have.property('is_archived');"," pm.expect(result).to.have.property('table');"," pm.expect(result).to.have.property('change_permission');"," });","});","","","pm.test(\"Owners array is present and contains objects with required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array');"," "," responseData.results.forEach(function(result) {"," pm.expect(result.owners).to.exist.and.to.be.an('array');"," "," result.owners.forEach(function(owner) {"," pm.expect(owner).to.be.an('object');"," pm.expect(owner.sid).to.exist.and.to.be.a('string');"," pm.expect(owner.name).to.exist.and.to.be.a('string');"," });"," });","});","","","pm.test(\"Verify that the 'table' object within each result contains the required fields - sid, name\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array');"," "," responseData.results.forEach(function(result) {"," pm.expect(result.table).to.exist.and.to.have.property('sid');"," pm.expect(result.table).to.exist.and.to.have.property('name');"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"5913a8fc-125a-45c9-9e57-1c8859e1a082","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/tables/filter/list/organization/{{organization_sid_test_edit}}/list/?table__sid={{table_sid_test_edit}}","description":"This endpoint retrieves a list of tables based on the provided organization and table SID.
\nNo request body parameters are required for this request.
\norganization_sid_test_edit (path parameter) - The SID of the organization for which the tables are being retrieved.
table_sid_test_edit (query parameter) - The SID of the specific table for which the details are being retrieved.
The response for this request is a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"page_size\": {\"type\": \"integer\"},\n \"page_number\": {\"type\": \"integer\"},\n \"page_count\": {\"type\": \"integer\"},\n \"count\": {\"type\": \"integer\"},\n \"next\": {\"type\": [\"string\", \"null\"]},\n \"previous\": {\"type\": [\"string\", \"null\"]},\n \"add_permission\": {\"type\": \"boolean\"},\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\"type\": \"string\"},\n \"sid\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"owners\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"}\n }\n }\n },\n \"teams\": {\n \"type\": \"array\",\n \"items\": {}\n },\n \"show_in_menu\": {\"type\": \"boolean\"},\n \"digest_frequency\": {\"type\": \"string\"},\n \"is_archived\": {\"type\": \"boolean\"},\n \"table\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"}\n }\n },\n \"change_permission\": {\"type\": \"boolean\"}\n }\n }\n }\n }\n}\n\nThe response object includes information about the pagination, permissions, and details of the retrieved tables, such as name, SID, description, owners, teams, visibility in the menu, archival status, and change permissions.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["tables","filter","list","organization","{{organization_sid_test_edit}}","list",""],"host":["https://www.labii.dev"],"query":[{"key":"table__sid","value":"{{table_sid_test_edit}}"}],"variable":[]}},"response":[{"id":"56a9a249-7eb3-47bb-aca2-85f62964cc90","name":"Get Filter List","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://www.labii.dev/tables/filter/list/organization/{{organization_sid_test_edit}}/list/?table__sid={{table_sid_test_edit}}","host":["https://www.labii.dev"],"path":["tables","filter","list","organization","{{organization_sid_test_edit}}","list",""],"query":[{"key":"table__sid","value":"{{table_sid_test_edit}}","sortOrder":0}]}},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Date","value":"Mon, 04 Nov 2024 05:12:02 GMT","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Allow","value":"GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS","type":"text"},{"key":"Expires","value":"0","type":"text"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate","type":"text"},{"key":"Pragma","value":"no-cache","type":"text"},{"key":"Server","value":"Labii","type":"text"},{"key":"Access-Control-Allow-Origin","value":"*","type":"text"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin","type":"text"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp","type":"text"},{"key":"Content-Security-Policy","value":"style-src 'self' *.amazonaws.com 'unsafe-inline'; frame-src 'none'; script-src 'self' *.amazonaws.com; img-src 'self' *.amazonaws.com; font-src 'self' data: *.amazonaws.com; default-src 'self' 'unsafe-inline' 'unsafe-eval' https://www.labii.com http://localhost:3000","type":"text"},{"key":"Vary","value":"Accept-Language, Cookie, Origin","type":"text"},{"key":"Content-Language","value":"en","type":"text"},{"key":"X-Frame-Options","value":"DENY","type":"text"},{"key":"Content-Length","value":"454","type":"text"},{"key":"X-Content-Type-Options","value":"nosniff","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","type":"text"},{"key":"Referrer-Policy","value":"same-origin","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"page_size\": 10,\n \"page_number\": 1,\n \"page_count\": 1,\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"add_permission\": false,\n \"results\": [\n {\n \"name\": \"Test Filter 2024-11-03\",\n \"sid\": \"mpsv0a40x1afdbotyDINSX\",\n \"description\": \"Test filter created by postman.\",\n \"owners\": [\n {\n \"sid\": \"HKNQ0a40x31c4JOTY49di\",\n \"name\": \"Test Labii\"\n }\n ],\n \"teams\": [],\n \"show_in_menu\": true,\n \"digest_frequency\": \"None\",\n \"is_archived\": false,\n \"table\": {\n \"sid\": \"hknq0a40x1254ejotyDINS\",\n \"name\": \"tests\"\n },\n \"change_permission\": true\n }\n ]\n}"}],"_postman_id":"5913a8fc-125a-45c9-9e57-1c8859e1a082"},{"name":"Create Filter","event":[{"listen":"prerequest","script":{"id":"28acf77a-abcb-400e-81d2-f3b75e3eb08c","exec":["// update currentDate","const currentDate = js.getCurrentDate();","pm.environment.set(\"currentDate\", currentDate);"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"80556098-c512-4c4b-891c-db5eca2ae110","exec":["// Set the variable","var jsonData = pm.response.json();","pm.environment.set(\"filter_sid\", jsonData.sid);","","","pm.test(\"Response status code is 201\", function () {"," pm.response.to.have.status(201);","});","","","pm.test(\"Response has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.sid).to.exist;"," pm.expect(responseData.table).to.exist.and.to.be.an('object');"," pm.expect(responseData.name).to.exist;"," pm.expect(responseData.description).to.exist;"," pm.expect(responseData.query).to.exist;"," pm.expect(responseData.query_exclude).to.exist;"," pm.expect(responseData.owners).to.exist.and.to.be.an('array');"," pm.expect(responseData.teams).to.exist.and.to.be.an('array');"," pm.expect(responseData.digest_frequency).to.exist;"," pm.expect(responseData.ics).to.exist;"," pm.expect(responseData.show_in_menu).to.exist;"," pm.expect(responseData.is_default).to.exist;"," pm.expect(responseData.is_archived).to.exist;"," pm.expect(responseData.date_updated).to.exist;"," pm.expect(responseData.date_created).to.exist;"," pm.expect(responseData.change_permission).to.exist;"," pm.expect(responseData.help_text).to.exist.and.to.be.an('object');","});","","","pm.test(\"Date updated and date created are in a valid date format\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.date_updated).to.match(/^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$/);"," pm.expect(responseData.date_created).to.match(/^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$/);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","",""],"type":"text/javascript","packages":{}}}],"id":"d9d36a88-9969-4cf9-b8bb-214da530e703","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Filter {{currentDate}}\",\n \"description\": \"Test filter created by postman.\",\n \"show_in_menu\": true,\n \"owners\": [{\n \"sid\": \"{{people_sid_test_edit}}\",\n \"name\": \"Test Labii\"\n }],\n \"query\": {\"is_archived\": false}\n}","options":{"raw":{"language":"json"}}},"url":"https://www.labii.dev/tables/filter/list/organization/{{organization_sid_test_edit}}/list/?table__sid={{table_sid_test_edit}}","description":"This endpoint is used to create a new filter for a specific table within an organization.
\nname (string): The name of the filter.
description (string): A description for the filter.
show_in_menu (boolean): Indicates whether the filter should be displayed in the menu.
owners (array): An array of owners for the filter, where each owner includes:
sid (string): The unique identifier of the owner.
name (string): The name of the owner.
query (object): The query parameters for the filter, including conditions for filtering.
The response will be in JSON format and will include the following fields:
\nsid (string): The unique identifier of the filter.
table (object): Information about the table associated with the filter, including:
sid (string): The unique identifier of the table.
name (string): The name of the table.
name (string): The name of the filter.
description (string): A description for the filter.
query (string): The query parameters for the filter.
query_exclude (string): Additional query parameters to exclude from the filter.
owners (array): An array of owners for the filter, where each owner includes:
sid (string): The unique identifier of the owner.
name (string): The name of the owner.
teams (array): An array of teams associated with the filter.
digest_frequency (string): The frequency of digest for the filter.
ics (string): The ICS (iCalendar) representation of the filter.
show_in_menu (boolean): Indicates whether the filter should be displayed in the menu.
is_default (boolean): Indicates whether the filter is the default filter.
is_archived (boolean): Indicates whether the filter is archived.
date_updated (string): The date when the filter was last updated.
date_created (string): The date when the filter was created.
change_permission (boolean): Indicates the permission to change the filter.
help_text (object): Additional help text for the filter, including:
sid (string): The unique identifier of the help text.
name (string): The name of the help text.
description (string): The description of the help text.
query (string): The query parameters for the help text.
query_exclude (string): Additional query parameters to exclude from the help text.
digest_frequency (string): The frequency of digest for the help text.
show_in_menu (string): Indicates whether the help text should be displayed in the menu.
is_default (string): Indicates whether the help text is the default.
is_archived (string): Indicates whether the help text is archived.
owners (string): The owners of the help text.
teams (string): The teams associated with the help text.
{\n \"sid\": \"\",\n \"table\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"query\": \"\",\n \"query_exclude\": \"\",\n \"owners\": [\n {\n \"sid\": \"\",\n \"name\": \"\"\n }\n ],\n \"teams\": [],\n \"digest_frequency\": \"\",\n \"ics\": \"\",\n \"show_in_menu\": true,\n \"is_default\": true,\n \"is_archived\": true,\n \"date_updated\": \"\",\n \"date_created\": \"\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"query\": \"\",\n \"query_exclude\": \"\",\n \"digest_frequency\": \"\",\n \"show_in_menu\": \"\",\n \"is_default\": \"\",\n \"is_archived\": \"\",\n \"owners\": \"\",\n \"teams\": \"\"\n }\n}\n\nThis endpoint retrieves the details of a specific table filter.
\nNo request body is required for this endpoint.
\nfilter_sid (path parameter) - The unique identifier of the filter.The response will be a JSON object with the following properties:
\nsid (string) - The unique identifier of the filter.
table (object) - Details of the table associated with the filter, including sid and name.
name (string) - The name of the filter.
description (string) - The description of the filter.
query (string) - The query associated with the filter.
query_exclude (string) - The excluded query associated with the filter.
owners (array) - An array of objects containing details of the owners, including sid and name.
teams (array) - An array of teams associated with the filter.
digest_frequency (string) - The frequency of digest for the filter.
ics (string) - The ICS (iCalendar) file for the filter.
show_in_menu (boolean) - Indicates whether the filter should be displayed in the menu.
is_default (boolean) - Indicates whether the filter is the default filter.
is_archived (boolean) - Indicates whether the filter is archived.
date_updated (string) - The date when the filter was last updated.
date_created (string) - The date when the filter was created.
change_permission (boolean) - Indicates whether the user has permission to change the filter.
help_text (object) - Details of the help text associated with the filter, including sid, name, description, query, query_exclude, digest_frequency, show_in_menu, is_default, is_archived, owners, and teams.
Example response:
\n{\n \"sid\": \"\",\n \"table\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"query\": \"\",\n \"query_exclude\": \"\",\n \"owners\": [\n {\n \"sid\": \"\",\n \"name\": \"\"\n }\n ],\n \"teams\": [],\n \"digest_frequency\": \"\",\n \"ics\": \"\",\n \"show_in_menu\": true,\n \"is_default\": true,\n \"is_archived\": true,\n \"date_updated\": \"\",\n \"date_created\": \"\",\n \"change_permission\": true,\n \"help_text\": {\n \"sid\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"query\": \"\",\n \"query_exclude\": \"\",\n \"digest_frequency\": \"\",\n \"show_in_menu\": \"\",\n \"is_default\": \"\",\n \"is_archived\": \"\",\n \"owners\": \"\",\n \"teams\": \"\"\n }\n}\n\nThis endpoint allows the user to update the details of a specific table filter.
\nname (string, required): The name of the filter.
description (string, required): A description of the filter.
query (object, required): The query parameters for the filter.
query_exclude (string, required): The query parameters to exclude.
digest_frequency (string, required): The frequency of digest.
show_in_menu (boolean, required): Indicates whether the filter should be shown in the menu.
is_default (boolean, required): Indicates whether the filter is the default.
is_archived (boolean, required): Indicates whether the filter is archived.
{\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"table\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"}\n }\n },\n \"name\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"query\": {\"type\": \"object\"},\n \"query_exclude\": {\"type\": \"string\"},\n \"owners\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"}\n }\n }\n },\n \"teams\": {\n \"type\": \"array\",\n \"items\": {}\n },\n \"digest_frequency\": {\"type\": \"string\"},\n \"ics\": {\"type\": \"string\"},\n \"show_in_menu\": {\"type\": \"boolean\"},\n \"is_default\": {\"type\": \"boolean\"},\n \"is_archived\": {\"type\": \"boolean\"},\n \"date_updated\": {\"type\": \"string\"},\n \"date_created\": {\"type\": \"string\"},\n \"change_permission\": {\"type\": \"boolean\"},\n \"help_text\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"description\": {\"type\": \"string\"},\n \"query\": {\"type\": \"string\"},\n \"query_exclude\": {\"type\": \"string\"},\n \"digest_frequency\": {\"type\": \"string\"},\n \"show_in_menu\": {\"type\": \"string\"},\n \"is_default\": {\"type\": \"string\"},\n \"is_archived\": {\"type\": \"string\"},\n \"owners\": {\"type\": \"string\"},\n \"teams\": {\"type\": \"string\"}\n }\n }\n }\n}\n\nThis endpoint is used to delete a specific table filter detail.
\nMethod: DELETE
\nURL: https://www.labii.dev/tables/filter/detail/{{filter_sid}}/
The response for this request is a JSON schema, which will include the details of the deletion operation. The schema will outline the structure of the response body, including the properties and their data types.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["tables","filter","detail","{{filter_sid}}",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[],"_postman_id":"e6027972-7afe-443e-a7de-ce51562fe183"}],"id":"464bf6c2-7b78-4115-9ed1-295eb7e00013","description":"The Labii Filter API is a powerful tool that allows users to create and manage filters for table fields, enabling them to restrict display results through customized queries. With this API, users can easily retrieve a list of existing filters, create new filters, access detailed information about specific filters, edit them as needed, and delete filters that are no longer required. By providing flexible filtering options, this API enhances data visibility and usability, allowing users to tailor their data views to meet specific requirements and improve overall decision-making.
\n","_postman_id":"464bf6c2-7b78-4115-9ed1-295eb7e00013","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Row / Record","item":[{"name":"Get Record List","event":[{"listen":"test","script":{"id":"2f64e6ef-0012-4a12-aac6-307aa5f0fb59","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is in an acceptable range\", function () {"," pm.expect(pm.response.responseTime).to.be.below(300);","});","","","pm.test(\"Validate the structure of the 'results' array\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array');"," responseData.results.forEach(function(result) {"," pm.expect(result).to.be.an('object');"," pm.expect(result.sid).to.be.a('string');"," pm.expect(result.uid).to.be.a('string');"," pm.expect(result.name).to.be.a('string');"," pm.expect(result.column_set).to.be.an('array');"," pm.expect(result.description).to.be.a('string');"," pm.expect(result.projects).to.be.an('array');"," result.projects.forEach(function(project) {"," pm.expect(project.sid).to.be.a('string');"," pm.expect(project.name).to.be.a('string');"," });"," pm.expect(result.owner).to.be.an('object');"," pm.expect(result.owner.sid).to.be.a('string');"," pm.expect(result.owner.name).to.be.a('string');"," pm.expect(result.is_template).to.be.a('boolean');"," pm.expect(result.is_archived).to.be.a('boolean');"," pm.expect(result.date_created).to.be.a('string');"," pm.expect(result.date_updated).to.be.a('string');"," pm.expect(result.updated_by).to.be.an('object');"," pm.expect(result.updated_by.sid).to.be.a('string');"," pm.expect(result.updated_by.name).to.be.a('string');"," pm.expect(result.change_permission).to.be.a('boolean');"," });","});","","","pm.test(\"Results array contains all required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array').that.is.not.empty;"," "," responseData.results.forEach(function(result) {"," pm.expect(result.sid).to.be.a('string');"," pm.expect(result.uid).to.be.a('string');"," pm.expect(result.name).to.be.a('string');"," pm.expect(result.column_set).to.be.an('array');"," pm.expect(result.description).to.be.a('string');"," pm.expect(result.projects).to.be.an('array');"," pm.expect(result.owner).to.be.an('object');"," pm.expect(result.is_template).to.be.a('boolean');"," pm.expect(result.is_archived).to.be.a('boolean');"," pm.expect(result.date_created).to.be.a('string');"," pm.expect(result.date_updated).to.be.a('string');"," pm.expect(result.updated_by).to.be.an('object');"," pm.expect(result.change_permission).to.be.a('boolean');"," });","});","","","pm.test(\"Owner object contains the required fields - sid and name\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.results).to.be.an('array');"," "," responseData.results.forEach(function(result) {"," pm.expect(result.owner).to.be.an('object');"," pm.expect(result.owner.sid).to.exist;"," pm.expect(result.owner.name).to.exist;"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"e915b4e9-6c23-4a0e-a56d-0c91fcd67564","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/tables/row/list/organization/{{organization_sid_test_edit}}/list/?table__sid={{table_sid_test_edit}}","description":"This endpoint retrieves a list of rows from a specific table within an organization.
\nRequest:
\nMethod: GET
\nURL: https://www.labii.dev/tables/row/list/organization/{{organization_sid_test_edit}}/list/?table__sid={{table_sid_test_edit}}
Response Body:
The response will include the following fields:
page_size (number): The size of the page
page_number (number): The page number
page_count (number): The total number of pages
count (number): The total count of rows
next (string): Link to the next page
previous (string): Link to the previous page
add_permission (boolean): Indicates if the user has permission to add rows
results (array): An array of row objects, each containing:
sid (string): The unique identifier of the row
uid (string): The user identifier
name (string): The name of the row
column_set (array): An array of columns
description (string): The description of the row
projects (array): An array of project objects, each containing:
sid (string): The unique identifier of the project
name (string): The name of the project
owner (object): The owner of the row, containing:
sid (string): The unique identifier of the owner
name (string): The name of the owner
is_template (boolean): Indicates if the row is a template
is_archived (boolean): Indicates if the row is archived
date_created (string): The date when the row was created
date_updated (string): The date when the row was last updated
updated_by (object): The user who last updated the row, containing:
sid (string): The unique identifier of the user
name (string): The name of the user
change_permission (boolean): Indicates if the user has permission to change the row
This endpoint allows you to create a new record in a table within the specified organization.
\nname (string): The name of the new record.
description (string): A description for the new record.
projects (array): An array of projects associated with the new record.
sid (string): The unique identifier of the project.
name (string): The name of the project.
{{column_sid_date}} (string): The date associated with the new record.
sid (string): The unique identifier of the new record.
uid (string): The user identifier.
version (object): Contains the version information.
version (number): The version number.table (object): Contains information about the table.
sid (string): The unique identifier of the table.
name (string): The name of the table.
projects (array): An array of projects associated with the new record.
sid (string): The unique identifier of the project.
name (string): The name of the project.
name (string): The name of the new record.
description (string): The description of the new record.
column_set (array): Contains the column set information.
section_set (array): Contains the section set information.
is_template (boolean): Indicates if the record is a template.
is_archived (boolean): Indicates if the record is archived.
is_locked (boolean): Indicates if the record is locked.
metadata (array): Contains metadata related to the record.
updated_by (object): Contains information about the user who updated the record.
sid (string): The unique identifier of the user.
name (string): The name of the user.
date_updated (string): The date when the record was updated.
owner (object): Contains information about the owner of the record.
sid (string): The unique identifier of the owner.
name (string): The name of the owner.
date_created (string): The date when the record was created.
data (null): The data associated with the record.
change_permission (boolean): Indicates the change permission for the record.
help_text (object): Contains help text information.
sid (string): The unique identifier of the help text.
rid (string): The resource identifier.
uid (string): The user identifier.
name (string): The name of the help text.
description (string): The description of the help text.
metadata (string): The metadata of the help text.
is_template (string): Indicates if the help text is a template.
is_locked (string): Indicates if the help text is locked.
is_archived (string): Indicates if the help text is archived.
price (string): The price of the help text.
projects (string): The projects associated with the help text.
This endpoint is used to retrieve a list of cells for a specific organization, row, and column.
\nType: Raw
\nThe response will be a JSON object with the following properties:
\nsid (string): The unique identifier of the cell.
\ndata (string): The data stored in the cell.
\nrow (object): Information about the row to which the cell belongs.
\nsid (string): The unique identifier of the row.
\nname (string): The name of the row.
\ncolumn (object): Information about the column to which the cell belongs.
\nsid (string): The unique identifier of the column.
\nname (string): The name of the column.
\nname_system (string): The system name of the column.
\ndescription (string): Description of the column.
\nwidget (object): Information about the widget used for the column.
\nsid (string): The unique identifier of the widget.
\nname (string): The name of the widget.
\ndocumentation_url (string): The URL for the widget documentation.
\nconfiguration (null): Configuration settings for the column.
\npermission (null): Permissions for the column.
\ndefault_data (null): Default data for the column.
\norder (number): The order of the column.
\nis_required (boolean): Indicates if the column is required.
\nshould_hide_in_form_view (boolean): Indicates if the column should be hidden in the form view.
\nshould_hide_in_list_view (boolean): Indicates if the column should be hidden in the list view.
\nmax_width (null): The maximum width of the column.
\nmetadata (array): Additional metadata for the column.
\ntable (object): Information about the table to which the column belongs.
\nsid (string): The unique identifier of the table.
\nname (string): The name of the table.
\nis_archived (boolean): Indicates if the column is archived.
\ndate_created (string): The date when the column was created.
\nchange_permission (boolean): Indicates if permission can be changed for the column.
\nhelp_text (object): Help text for the column.
\nsid (string): The unique identifier of the help text.
\nname (string): The name of the help text.
\nname_system (string): The system name of the help text.
\ndescription (string): Description of the help text.
\nwidget (string): The widget used for the help text.
\nconfiguration (string): Configuration settings for the help text.
\npermission (string): Permissions for the help text.
\ndefault_data (string): Default data for the help text.
\norder (string): The order of the help text.
\nis_required (string): Indicates if the help text is required.
\nshould_hide_in_form_view (string): Indicates if the help text should be hidden in the form view.
\nshould_hide_in_list_view (string): Indicates if the help text should be hidden in the list view.
\nmax_width (string): The maximum width of the help text.
\nmetadata (string): Additional metadata for the help text.
\nis_archived (string): Indicates if the help text is archived.
\nwidget (object): Information about the widget used for the column.
\nsid (string): The unique identifier of the widget.
\nname (string): The name of the widget.
\nupdated_by (object): Information about the user who last updated the column.
\nsid (string): The unique identifier of the user.
\nname (string): The name of the user.
\ndate_updated (string): The date when the column was last updated.
\ndate_created (string): The date when the column was created.
\nchange_permission (boolean): Indicates if permission can be changed for the column.
\nThis endpoint allows you to create a new section within a specific organization's table.
\nname (string, required): The name of the section.
description (string, required): The description of the section.
widget (object, required): The widget configuration for the section.
sid (string, required): The unique identifier for the widget.
name (string, required): The name of the widget.
data (string, required): Additional data for the section.
Example:
\n{\n \"name\": \"Test Section {{currentDate}}\",\n \"description\": \"Test section created by postna ...\",\n \"widget\": {\n \"sid\": \"ehkn0a40x1glqvAFKP\",\n \"name\": \"Plain Text\"\n },\n \"data\": \"Test\"\n}\n#### Response\nThe response will be an array, and the examples of responses are as follows:\n```json\n[]\n\nThis endpoint makes an HTTP GET request to retrieve the details of a specific row in a table. The request should include the record_sid as part of the URL path to identify the specific row.
\nrecord_sid (path parameter): The unique identifier of the record to retrieve details for.The response will contain the details of the specific row in the table.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["tables","row","detail","{{record_sid}}",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[{"id":"2665656d-8686-438b-b941-0fd36a6f152c","name":"Get Record Detail","originalRequest":{"method":"GET","header":[],"url":"https://www.labii.dev/tables/row/detail/{{record_sid}}/"},"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\n \"sid\": \"xADG0a40xa5bczEJOTY49\",\n \"uid\": \"TEST1\",\n \"version\": {\n \"version\": 3,\n \"sid\": \"58ad0a40x347df7bglqvAF\",\n \"name\": \"TEST1: Test Record 2024-11-03 (v3)\"\n },\n \"table\": {\n \"sid\": \"hknq0a40x1254ejotyDINS\",\n \"name\": \"tests\"\n },\n \"projects\": [\n {\n \"sid\": \"ilor0a40x2cd3kpuzEJOT\",\n \"name\": \"Sample Project\"\n }\n ],\n \"name\": \"Test Record 2024-11-03\",\n \"description\": \"Test record created by postman.\",\n \"column_set\": [\n {\n \"column\": {\n \"sid\": \"TWZ30a40x563aaV16afkpu\",\n \"name\": \"date\",\n \"name_system\": \"\",\n \"description\": \"\",\n \"widget\": {\n \"sid\": \"GJMP0a40x1dINSX38ch\",\n \"name\": \"Date\",\n \"documentation_url\": \"https://docs.labii.com/widgets/column-widgets/datetime/date\"\n },\n \"configuration\": null,\n \"permission\": null,\n \"default_data\": null,\n \"order\": 1,\n \"is_required\": false,\n \"should_hide_in_form_view\": false,\n \"should_hide_in_list_view\": false,\n \"max_width\": null,\n \"metadata\": [],\n \"table\": {\n \"sid\": \"hknq0a40x1254ejotyDINS\",\n \"name\": \"tests\"\n },\n \"is_archived\": false,\n \"date_created\": \"2024-11-04T05:51:12.206366Z\",\n \"change_permission\": false,\n \"help_text\": {\n \"sid\": \"Static encrypted identifier. \",\n \"name\": \"Letters and number only.\",\n \"name_system\": \"The name to identify the column for a widget. \",\n \"description\": \"The description of the column. Include the definition, special formatting, and all other necessary information to help your coworker to fill.\",\n \"widget\": \"The widget to use, or the type of data. Default to Text. The configuration data will be erased if the widget is changed.This endpoint makes an HTTP PATCH request to update the details of a specific row in a table. The request body should contain the updated information for the row, including the name, description, projects, and a specific column value.
\nname (string): The updated name for the record.
description (string): The new description for the record.
projects (array): An array of projects with their respective IDs and names.
sid (string): The ID of the project.
name (string): The name of the project.
{{column_sid_date}} (string): The updated value for a specific column, which is determined by the {{column_sid_date}} placeholder.
The response will contain the updated details of the row in the table.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["tables","row","detail","{{record_sid}}",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[{"id":"13456f66-6db7-4ce6-9dbb-87070f0e31f7","name":"Edit Record","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Record {{currentDate}}\",\n \"description\": \"Test record edited by postman.\",\n \"projects\": [{\n \"sid\": \"{{project_sid_test_edit}}\",\n \"name\": \"Sample Project\"\n }],\n \"{{column_sid_date}}\": \"{{currentDate}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.labii.dev/tables/row/detail/{{record_sid}}/"},"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\n \"sid\": \"xADG0a40xa5bczEJOTY49\",\n \"uid\": \"TEST1\",\n \"version\": {\n \"version\": 3,\n \"sid\": \"58ad0a40x347df7bglqvAF\",\n \"name\": \"TEST1: Test Record 2024-11-03 (v3)\"\n },\n \"table\": {\n \"sid\": \"hknq0a40x1254ejotyDINS\",\n \"name\": \"tests\"\n },\n \"projects\": [\n {\n \"sid\": \"ilor0a40x2cd3kpuzEJOT\",\n \"name\": \"Sample Project\"\n }\n ],\n \"name\": \"Test Record 2024-11-03\",\n \"description\": \"Test record edited by postman.\",\n \"column_set\": [\n {\n \"column\": {\n \"sid\": \"TWZ30a40x563aaV16afkpu\",\n \"name\": \"date\",\n \"name_system\": \"\",\n \"description\": \"\",\n \"widget\": {\n \"sid\": \"GJMP0a40x1dINSX38ch\",\n \"name\": \"Date\",\n \"documentation_url\": \"https://docs.labii.com/widgets/column-widgets/datetime/date\"\n },\n \"configuration\": null,\n \"permission\": null,\n \"default_data\": null,\n \"order\": 1,\n \"is_required\": false,\n \"should_hide_in_form_view\": false,\n \"should_hide_in_list_view\": false,\n \"max_width\": null,\n \"metadata\": [],\n \"table\": {\n \"sid\": \"hknq0a40x1254ejotyDINS\",\n \"name\": \"tests\"\n },\n \"is_archived\": false,\n \"date_created\": \"2024-11-04T05:51:12.206366Z\",\n \"change_permission\": false,\n \"help_text\": {\n \"sid\": \"Static encrypted identifier. \",\n \"name\": \"Letters and number only.\",\n \"name_system\": \"The name to identify the column for a widget. \",\n \"description\": \"The description of the column. Include the definition, special formatting, and all other necessary information to help your coworker to fill.\",\n \"widget\": \"The widget to use, or the type of data. Default to Text. The configuration data will be erased if the widget is changed.The Labii Record API is an essential tool for managing records within a database, offering users a comprehensive suite of functionalities. With this API, users can retrieve a list of existing records, create new records, add new record cells and sections, access detailed information about specific records, and edit records as needed. This API streamlines the process of record management, making it easy to organize and manipulate data efficiently to meet various business requirements.
\n","_postman_id":"06b6b79a-a32d-4ab0-a82c-c0ee45aefde3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Version","item":[{"name":"Get Version List","event":[{"listen":"test","script":{"id":"1d8255e7-cec0-4de3-bd82-4991a1c794f2","exec":["// Set the variable","var jsonData = pm.response.json();","pm.environment.set(\"version_sid\", jsonData.results[0].sid);","","","pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is within an acceptable range\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Validate the structure and data types of the response schema\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.page_size).to.be.a('number');"," pm.expect(responseData.page_number).to.be.a('number');"," pm.expect(responseData.page_count).to.be.a('number');"," pm.expect(responseData.count).to.be.a('number');"," pm.expect(responseData.next).to.be.null;"," pm.expect(responseData.previous).to.be.null;"," pm.expect(responseData.add_permission).to.be.true;"," "," responseData.results.forEach(function(result) {"," pm.expect(result).to.be.an('object');"," pm.expect(result.sid).to.be.a('string');"," pm.expect(result.name).to.be.a('string');"," pm.expect(result.hash).to.be.a('string');"," pm.expect(result.previousHash).to.be.a('string');"," pm.expect(result.version).to.be.a('number');"," pm.expect(result.activity_message).to.be.a('string');"," pm.expect(result.commit).to.be.null;"," pm.expect(result.is_valid).to.be.true;"," "," pm.expect(result.row).to.be.an('object');"," pm.expect(result.row.sid).to.be.a('string');"," pm.expect(result.row.name).to.be.a('string');"," "," pm.expect(result.updated_by).to.be.an('object');"," pm.expect(result.updated_by.sid).to.be.a('string');"," pm.expect(result.updated_by.name).to.be.a('string');"," "," pm.expect(result.date_created).to.be.a('string');"," pm.expect(result.change_permission).to.be.true;"," });","});","","","pm.test(\"Results array is present and contains the expected number of elements\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.results).to.exist.and.to.be.an('array');"," pm.expect(responseData.results).to.have.lengthOf(1);","});","","","pm.test(\"Validate the fields in the 'results' array\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array').and.to.have.lengthOf.at.least(1, \"Results array should not be empty\");",""," responseData.results.forEach(function(result) {"," pm.expect(result.sid).to.be.a('string', \"sid should be a string\");"," pm.expect(result.name).to.be.a('string', \"name should be a string\");"," pm.expect(result.hash).to.exist;"," pm.expect(result.version).to.exist;"," pm.expect(result.activity_message).to.exist;"," pm.expect(result.is_valid).to.exist;"," pm.expect(result.date_created).to.exist;"," pm.expect(result.change_permission).to.exist;"," });","});","",""],"type":"text/javascript","packages":{}}}],"id":"8bf57300-2d4f-4dde-9aac-ec23d6cad9c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/tables/version/list/organization/{{organization_sid_test_edit}}/list/?row__sid={{record_sid}}","description":"This endpoint retrieves a list of table versions for a specific organization and row, based on the provided record SID.
\nMethod: GET
\nURL: https://www.labii.dev/tables/version/list/organization/{{organization_sid_test_edit}}/list/?row__sid={{record_sid}}
\nThe response will include the following fields:
\npage_size (number): The size of the page
page_number (number): The page number
page_count (number): The total number of pages
count (number): The total count of versions
next (string): URL for the next page
previous (string): URL for the previous page
add_permission (boolean): Indicates if the user has permission to add versions
results (array): An array of version objects, each containing the following fields:
sid (string): The version ID
name (string): The version name
hash (string): The hash of the version
previousHash (string): The hash of the previous version
version (number): The version number
activity_message (string): The activity message
commit (string): The commit details
is_valid (boolean): Indicates if the version is valid
row (object): The row details, including sid and name
updated_by (object): The user who updated the version, including sid and name
date_created (string): The date of creation
change_permission (boolean): Indicates if the user has permission to change the version
This endpoint retrieves the details of a specific version of tables. The request should include the version_sid path parameter to identify the version.
\nThis request does not require a request body.
\nid: The unique identifier for the table version.
name: The name of the table version.
description: The description of the table version.
created_at: The timestamp when the table version was created.
updated_at: The timestamp when the table version was last updated.
This endpoint is used to update the details of a specific table version.
\nMethod: PATCH
URL: https://www.labii.dev/tables/version/detail/{{version_sid}}/
Headers:
\n{ \"commit\": \"Edit version from postman\"}
\nThe response for this request is a JSON object conforming to the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n }\n}\n\nThis endpoint allows you to update a specific row detail in a table by sending an HTTP PATCH request to the specified URL. You can also choose to restore to a specific version by providing the version ID in the query parameter.
\nrecord_sid (path parameter): The unique identifier of the record.
version_sid (query parameter): The version ID to which the restoration should be made.
The response of this request is a JSON schema representing the updated row detail in the table. The schema will outline the structure of the data that will be returned upon a successful update or restoration operation.
\nExample JSON Schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"type\": \"integer\"\n },\n \"email\": {\n \"type\": \"string\",\n \"format\": \"email\"\n }\n // ... additional properties based on the table's schema\n }\n}\n\nThe Labii Version API is designed to facilitate version control for records, allowing users to manage and track changes effectively. This API enables users to retrieve a list of versions for a specific record, access detailed information about individual versions, edit version commits, and restore records from previous versions as needed. By providing these capabilities, the API enhances data integrity and accountability, ensuring that users can maintain a clear history of changes and easily revert to earlier states when necessary.
\n","_postman_id":"3cf927da-c524-4c36-8977-0f54da713c69","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Activity","item":[{"name":"Get Activity List","event":[{"listen":"test","script":{"id":"765dd85a-12c1-43ba-b961-f59d6822bb4c","exec":["// Set the variable","var jsonData = pm.response.json();","pm.environment.set(\"activity_sid\", jsonData.results[0].sid);","","","pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Validate the response schema for page_size, page_number, page_count, count, next, previous, add_permission, and results array with required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.page_size).to.exist;"," pm.expect(responseData.page_number).to.exist;"," pm.expect(responseData.page_count).to.exist;"," pm.expect(responseData.count).to.exist;"," pm.expect(responseData.next).to.exist;"," pm.expect(responseData.previous).to.exist;"," pm.expect(responseData.add_permission).to.exist;"," "," pm.expect(responseData.results).to.be.an('array');"," responseData.results.forEach(function(result) {"," pm.expect(result.sid).to.exist;"," pm.expect(result.date_created).to.exist;"," pm.expect(result.icon).to.exist;"," pm.expect(result.row).to.exist;"," pm.expect(result.version).to.exist;"," pm.expect(result.user).to.exist;"," pm.expect(result.action).to.exist;"," pm.expect(result.field).to.exist;"," pm.expect(result.change_permission).to.exist;"," });","});","",""],"type":"text/javascript","packages":{}}}],"id":"b3fd5dfc-10a4-4b0a-a349-3f28eca82cb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/tables/activity/list/organization/{{organization_sid_test_edit}}/list/?row__sid={{record_sid}}","description":"This endpoint retrieves the list of activities for a specific organization.
\nMethod: GET
\nURL: https://www.labii.dev/tables/activity/list/organization/{{organization_sid_test_edit}}/list/?row__sid={{record_sid}}
The response will contain the following fields:
\npage_size (number) - The number of items per page
page_number (number) - The current page number
page_count (number) - The total number of pages
count (number) - The total count of activities
next (string) - URL for the next page
previous (string) - URL for the previous page
add_permission (boolean) - Indicates if the user has permission to add activities
results (array) - An array of activity objects, each containing:
sid (string) - The ID of the activity
date_created (string) - The date and time when the activity was created
icon (string) - The icon associated with the activity
row (object) - The row information associated with the activity, containing:
sid (string) - The ID of the row
name (string) - The name of the row
version (object) - The version information associated with the activity, containing:
sid (string) - The ID of the version
name (string) - The name of the version
user (object) - The user information associated with the activity, containing:
sid (string) - The ID of the user
name (string) - The name of the user
first_name (string) - The first name of the user
last_name (string) - The last name of the user
email (string) - The email address of the user
action (string) - The action performed in the activity
field (string) - The field related to the activity
change_permission (boolean) - Indicates if the user has permission to change the activity
This endpoint retrieves the details of a specific activity from the tables.
\nMethod: GET
\nEndpoint: https://www.labii.dev/tables/activity/detail/{{activity_sid}}/
The response for this request follows the JSON schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"icon\": { \"type\": \"string\" },\n \"row\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" }\n }\n },\n \"version\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" }\n }\n },\n \"user\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"first_name\": { \"type\": \"string\" },\n \"last_name\": { \"type\": \"string\" },\n \"email\": { \"type\": \"string\" }\n }\n },\n \"action\": { \"type\": \"string\" },\n \"field\": { \"type\": \"string\" },\n \"old_data\": { \"type\": [\"null\", \"string\"] },\n \"new_data\": { \"type\": \"string\" },\n \"date_created\": { \"type\": \"string\" },\n \"change_permission\": { \"type\": \"boolean\" },\n \"help_text\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"old_data\": { \"type\": \"string\" },\n \"new_data\": { \"type\": \"string\" }\n }\n }\n }\n}\n\nThe Labii Activity API is a valuable tool for monitoring and managing activities associated with records. This API enables users to retrieve a comprehensive list of activities linked to a specific record, as well as access detailed information about each individual activity. By providing insights into record-related actions and changes, the API enhances transparency and accountability, making it easier for users to track and analyze the history of interactions with their data.
\n","_postman_id":"f7c61ad1-0dcb-433b-8b4f-2b19f4c2b30f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Visitor","item":[{"name":"Get Visitor List","event":[{"listen":"test","script":{"id":"c6f0910e-cdd2-483c-996b-c5d4f8972ca9","exec":["// Set the variable","var jsonData = pm.response.json();","pm.environment.set(\"visitor_sid\", jsonData.results[0].sid);","","","pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Validate the response schema\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData).to.have.property('page_size');"," pm.expect(responseData).to.have.property('page_number');"," pm.expect(responseData).to.have.property('page_count');"," pm.expect(responseData).to.have.property('count');"," pm.expect(responseData).to.have.property('next');"," pm.expect(responseData).to.have.property('previous');"," pm.expect(responseData).to.have.property('add_permission');"," pm.expect(responseData).to.have.property('results').that.is.an('array');","});","","","pm.test(\"Results array contains required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array').that.is.not.empty;"," "," responseData.results.forEach(function(result) {"," pm.expect(result.sid).to.exist;"," pm.expect(result.updated_by).to.be.an('object').that.has.all.keys('sid', 'name');"," pm.expect(result.date_created).to.exist;"," pm.expect(result.change_permission).to.exist;"," });","});","","","pm.test(\"Updated_by object contains required fields - sid, name\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array');"," responseData.results.forEach(function(result) {"," pm.expect(result.updated_by).to.be.an('object');"," pm.expect(result.updated_by.sid).to.exist.and.to.be.a('string');"," pm.expect(result.updated_by.name).to.exist.and.to.be.a('string');"," });","});","",""],"type":"text/javascript","packages":{}}}],"id":"7db106c5-217e-4af9-9f62-7e9d74bb33d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/tables/visitor/list/organization/{{organization_sid_test_edit}}/list/?row__sid={{record_sid}}","description":"This endpoint retrieves a list of visitors associated with a specific organization.
\nMethod: GET
\nPath: /tables/visitor/list/organization/{{organization_sid_test_edit}}/list/
\nQuery Parameters:
\npage_size (integer): The number of items per page.
\npage_number (integer): The current page number.
\npage_count (integer): The total number of pages.
\ncount (integer): The total count of visitors.
\nnext (string): URL for the next page of results.
\nprevious (string): URL for the previous page of results.
\nadd_permission (boolean): Indicates if the user has permission to add visitors.
\nresults (array): An array of visitor objects, each containing:
\nsid (string): The visitor's SID.
\nupdated_by (object): Information about the user who last updated the visitor.
\nsid (string): The SID of the user.
\nname (string): The name of the user.
\ndate_created (string): The date when the visitor was created.
\nchange_permission (boolean): Indicates if the user has permission to modify the visitor.
\nThis endpoint retrieves the details of a visitor by their unique identifier.
\nMethod: GET
\nURL: https://www.labii.dev/tables/visitor/detail/{{visitor_sid}}/
The response will be a JSON object with the following schema:
\n{\n \"sid\": \"string\",\n \"row\": {\n \"sid\": \"string\",\n \"name\": \"string\"\n },\n \"updated_by\": {\n \"sid\": \"string\",\n \"name\": \"string\"\n },\n \"date_created\": \"string\",\n \"change_permission\": true\n}\n\nThe Labii Visitor API provides users with a streamlined way to manage and monitor visitor interactions with records. This API enables users to retrieve a comprehensive list of visitors associated with a specific record, as well as view detailed information about each visitor. By facilitating easy access to visitor data, the API enhances the ability to analyze engagement and interactions, supporting better decision-making and record management.
\n","_postman_id":"c6a602fe-3fba-4332-a31c-c2ec781c5150","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Signer","item":[{"name":"Get Signer List","event":[{"listen":"test","script":{"id":"5fc109bb-1565-435f-830e-ee2f12d29680","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Validate the response schema for the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData).to.have.property('page_size');"," pm.expect(responseData).to.have.property('page_number');"," pm.expect(responseData).to.have.property('page_count');"," pm.expect(responseData).to.have.property('count');"," pm.expect(responseData).to.have.property('next');"," pm.expect(responseData).to.have.property('previous');"," pm.expect(responseData).to.have.property('add_permission');"," pm.expect(responseData).to.have.property('results');","});","","","pm.test(\"Results array is present and contains the expected number of elements\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.results).to.exist.and.to.be.an('array');"," pm.expect(responseData.results).to.have.lengthOf(1);","});","","","pm.test(\"Each 'result' object within the 'results' array has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.results).to.be.an('array');"," responseData.results.forEach(function(result) {"," pm.expect(result).to.have.property('sid');"," pm.expect(result).to.have.property('row');"," pm.expect(result).to.have.property('order');"," pm.expect(result).to.have.property('signer');"," pm.expect(result).to.have.property('role');"," pm.expect(result).to.have.property('minimum_number_of_signers');"," pm.expect(result).to.have.property('change_permission');"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"f7914bee-83a2-4f32-89fa-71c085e54a68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/tables/signer/list/organization/{{organization_sid_test_edit}}/list/?row__sid={{record_sid}}","description":"This endpoint retrieves the list of signers for a specific organization.
\nMethod: GET
\nURL: https://www.labii.dev/tables/signer/list/organization/{{organization_sid_test_edit}}/list/?row__sid={{record_sid}}
The response will contain the following fields:
\npage_size (number) - The number of items per page
page_number (number) - The current page number
page_count (number) - The total number of pages
count (number) - The total count of signers
next (string) - The URL for the next page
previous (string) - The URL for the previous page
add_permission (boolean) - Indicates if the user has permission to add signers
results (array) - An array of signer objects, each containing the following fields:
sid (string) - The signer ID
row (object) - The row information
sid (string) - The row ID
name (string) - The name of the row
order (number) - The order of the signer
signer (object) - The signer information
sid (string) - The signer ID
name (string) - The name of the signer
role (string) - The role of the signer
signature (null) - The signature of the signer
svg (null) - The SVG representation of the signature
date_signed (null) - The date when the signer signed
comment (null) - Any comment provided by the signer
minimum_number_of_signers (number) - The minimum number of signers required
change_permission (boolean) - Indicates if the user has permission to change signers
This endpoint makes an HTTP POST request to retrieve a list of signers for a specific organization and record.
\nType: Raw
\nDescription: The request body should contain a JSON object with the following parameters:
\nsigner (object): Contains the details of the signer including sid and name.
role (string): Specifies the role of the signer.
The response for this request is a JSON object with the following schema:
\n{\n \"sid\": \"\",\n \"row\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"order\": 0,\n \"signer\": {\n \"sid\": \"\",\n \"name\": \"\"\n },\n \"role\": \"\",\n \"signature\": null,\n \"svg\": null,\n \"date_signed\": null,\n \"comment\": null,\n \"minimum_number_of_signers\": 0,\n \"change_permission\": true\n}\n\nsid (string): Identifier for the response.
row (object): Contains the details of the row including sid and name.
order (number): Specifies the order of the signer.
signer (object): Contains the details of the signer including sid and name.
role (string): Specifies the role of the signer.
signature (null): The signature of the signer.
svg (null): SVG representation of the signature.
date_signed (null): Date when the signer signed.
comment (null): Any additional comments.
minimum_number_of_signers (number): Minimum number of signers required.
change_permission (boolean): Indicates if change permission is granted.
This endpoint retrieves the details of a signer by their unique identifier.
\nMethod: GET
\nEndpoint: https://www.labii.dev/tables/signer/detail/{{signer_sid}}/
\nThe response for this request follows the JSON schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\n \"type\": \"string\"\n },\n \"row\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n },\n \"order\": {\n \"type\": \"integer\"\n },\n \"signer\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n },\n \"role\": {\n \"type\": \"string\"\n },\n \"signature\": {\n \"type\": [\"null\", \"string\"]\n },\n \"svg\": {\n \"type\": [\"null\", \"string\"]\n },\n \"date_signed\": {\n \"type\": [\"null\", \"string\"]\n },\n \"comment\": {\n \"type\": [\"null\", \"string\"]\n },\n \"minimum_number_of_signers\": {\n \"type\": \"integer\"\n },\n \"change_permission\": {\n \"type\": \"boolean\"\n }\n }\n}\n\nThis endpoint retrieves details of a specific signer from the tables.
\nMethod: GET
\nEndpoint: https://www.labii.dev/tables/signer/detail/{{signer_sid}}/
\nHeaders: (if any)
\n{\n \"role\": \"Witness\"\n}\n\nThe response for this request follows the JSON schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\n \"type\": \"string\"\n },\n \"row\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n },\n \"order\": {\n \"type\": \"integer\"\n },\n \"signer\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n },\n \"role\": {\n \"type\": \"string\"\n },\n \"signature\": {\n \"type\": [\"null\", \"string\"]\n },\n \"svg\": {\n \"type\": [\"null\", \"string\"]\n },\n \"date_signed\": {\n \"type\": [\"null\", \"string\"]\n },\n \"comment\": {\n \"type\": [\"null\", \"string\"]\n },\n \"minimum_number_of_signers\": {\n \"type\": \"integer\"\n },\n \"change_permission\": {\n \"type\": \"boolean\"\n }\n }\n}\n\nThis endpoint is used to update the details of a signer and trigger the sign action.
\npassword (string, required): The password for the signer.sid (string): The unique identifier for the response.
row (object): An object containing the details of the signer's row.
sid (string): The unique identifier for the row.
name (string): The name of the signer.
order (integer): The order of the signer.
signer (object): An object containing the details of the signer.
sid (string): The unique identifier for the signer.
name (string): The name of the signer.
role (string): The role of the signer.
signature (string): The signature of the signer.
svg (string): The SVG representation of the signature.
date_signed (string): The date when the signer signed.
comment (string): Any additional comment provided.
minimum_number_of_signers (integer): The minimum number of signers required.
change_permission (boolean): Indicates if there is a change permission.
This endpoint is used to send an HTTP PATCH request to update the details of a specific signer in the tables. The signer_sid path parameter is used to specify the signer, and the action query parameter is set to \"reject\" to indicate the rejection action.
password (string): The password for authentication.
comment (string): A comment explaining the rejection.
The response of this request is documented as a JSON schema.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["tables","signer","detail","{{signer_sid}}",""],"host":["https://www.labii.dev"],"query":[{"key":"action","value":"reject"}],"variable":[]}},"response":[],"_postman_id":"f1f05dd0-4261-4438-9188-db189f5acf71"},{"name":"Delete Signer","event":[{"listen":"test","script":{"id":"68883ece-23c8-453c-8673-d21677ac9ca9","exec":["pm.test(\"Response status code is 204\", function () {"," pm.response.to.have.status(204);","});","","","pm.test(\"Response time is less than 500ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(500);","});","",""],"type":"text/javascript","packages":{}}}],"id":"b86ba637-17ab-41cc-8e32-f9fe2b9734ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://www.labii.dev/tables/signer/detail/{{signer_sid}}/","description":"This endpoint is used to delete the details of a specific signer from the tables.
\nThis request does not require a request body.
\nUpon successful deletion, the response will not contain a message body. The status code will indicate the success of the operation.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}},"urlObject":{"path":["tables","signer","detail","{{signer_sid}}",""],"host":["https://www.labii.dev"],"query":[],"variable":[]}},"response":[],"_postman_id":"b86ba637-17ab-41cc-8e32-f9fe2b9734ea"}],"id":"1c0e36b9-0563-4ec2-9c31-44ebf9f6110a","description":"The Labii Signer API is a crucial tool for managing the signing process of records, allowing users to define and control who has the authority to sign. With this API, users can easily retrieve a list of signers, create new signers, access detailed information about specific signers, edit signer details, and manage signing actions such as signing or rejecting a record. Additionally, users can delete signers as needed. This functionality enhances the integrity and accountability of record management, ensuring that only authorized individuals can approve or reject records in a streamlined manner.
\n","_postman_id":"1c0e36b9-0563-4ec2-9c31-44ebf9f6110a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}},{"name":"Permission","item":[{"name":"Get Permission List","event":[{"listen":"test","script":{"id":"2c924f78-f64c-4ca0-b3f4-3a9b68ad3169","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Validate the response schema for the fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.page_size).to.exist;"," pm.expect(responseData.page_number).to.exist;"," pm.expect(responseData.page_count).to.exist;"," pm.expect(responseData.count).to.exist;"," pm.expect(responseData.next).to.exist;"," pm.expect(responseData.previous).to.exist;"," pm.expect(responseData.add_permission).to.exist;"," pm.expect(responseData.results).to.exist.and.to.be.an('array');","});","","","pm.test(\"Each result object contains the required fields\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData.results).to.be.an('array').that.is.not.empty;",""," responseData.results.forEach(function(result) {"," pm.expect(result).to.have.property('sid').that.is.a('string').and.is.not.empty;"," pm.expect(result).to.have.property('people').that.is.an('object').and.is.not.empty;"," pm.expect(result.people).to.have.property('sid').that.is.a('string').and.is.not.empty;"," pm.expect(result.people).to.have.property('name').that.is.a('string').and.is.not.empty;"," pm.expect(result).to.have.property('permission').that.is.a('number');"," pm.expect(result).to.have.property('change_permission').that.is.a('boolean');"," });","});","","","pm.test(\"Permission and change_permission fields are in the expected format and range\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," "," responseData.results.forEach(function(result) {"," pm.expect(result.permission).to.be.a('number');"," pm.expect(result.change_permission).to.be.a('boolean');"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"6b5d2495-1ef5-4ba5-abc8-7bba4b9da719","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.labii.dev/tables/permission/list/organization/{{organization_sid_test_edit}}/list/?row__sid={{record_sid}}","description":"This endpoint retrieves the list of table permissions for a specific organization and record.
\nMethod: GET
\nURL: https://www.labii.dev/tables/permission/list/organization/{{organization_sid_test_edit}}/list/?row__sid={{record_sid}}
The response for this request can be represented as a JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"page_size\": { \"type\": \"integer\" },\n \"page_number\": { \"type\": \"integer\" },\n \"page_count\": { \"type\": \"integer\" },\n \"count\": { \"type\": \"integer\" },\n \"next\": { \"type\": [\"string\", \"null\"] },\n \"previous\": { \"type\": [\"string\", \"null\"] },\n \"add_permission\": { \"type\": \"boolean\" },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"people\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" }\n }\n },\n \"permission\": { \"type\": \"integer\" },\n \"change_permission\": { \"type\": \"boolean\" }\n }\n }\n }\n }\n}\n\nThis endpoint allows the user to create a new permission entry for a specific organization and record.
\npeople.sid (string): The SID of the person for whom the permission is being set.
people.name (string): The name of the person for whom the permission is being set.
permission (string): The level of permission to be granted.
The response of this request is a JSON object conforming to the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"people\": {\n \"type\": \"object\",\n \"properties\": {\n \"sid\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n },\n \"permission\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n\nThis endpoint retrieves the details of a specific table permission.
\nGET https://www.labii.dev/tables/permission/detail/{{permission_sid}}/\n\nThis is a simple HTTP GET request to retrieve the details of a specific table permission.
\npermission_sid (path) - The unique identifier of the table permission.The response for this request is a JSON object representing the details of the table permission.
\n{\n \"permission_id\": \"string\",\n \"table_id\": \"string\",\n \"access_level\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n}\n\nThis endpoint is used to update the permission details for a specific table.
\nMethod: PATCH
URL: https://www.labii.dev/tables/permission/detail/{{permission_sid}}/
Type: JSON
\nDescription: The request should include the updated permission for the table.
\nExample:
\n{\n \"permission\": \"Read\"\n}\n\nThe response for this request will be in JSON format. Below is a JSON schema representing the response:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"permission_sid\": {\n \"type\": \"string\"\n },\n \"table_id\": {\n \"type\": \"string\"\n },\n \"permission\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n\nThis API endpoint sends an HTTP DELETE request to delete the details of a specific permission from a table.
\nMethod: DELETE
\nURL: https://www.labii.dev/tables/permission/detail/{{permission_sid}}/
Path Parameters:
\npermission_sid: The unique identifier of the permission detail to be deleted.The response for this request is a JSON schema. The schema includes the following properties:
\nstatus: The status of the response.
message: A message indicating the result of the delete operation.
The Labii Permission API is essential for managing access controls to records, defining who has read and write permissions. This API allows users to efficiently retrieve a list of existing permissions, create new permissions, access detailed information about specific permissions, edit them as necessary, and delete permissions that are no longer needed. By providing granular control over record access, this API enhances security and ensures that sensitive data is only accessible to authorized users, promoting effective data governance within the organization.
\n","_postman_id":"aa476c3e-08b6-47f8-ac64-b8c15fb4f220","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]}},"event":[{"listen":"prerequest","script":{"id":"41f909ca-1545-4ece-b120-8d8bca4c14fd","type":"text/javascript","exec":["js = {"," getCurrentDate: function(){"," const date = new Date();"," const year = date.getFullYear();"," const month = String(date.getMonth() + 1).padStart(2, '0');"," const day = String(date.getDate()).padStart(2, '0');"," return `${year}-${month}-${day}`;"," },"," getNextWeekDate: function(){"," const date = new Date();"," date.setDate(date.getDate() + 7);"," const year = date.getFullYear();"," const month = String(date.getMonth() + 1).padStart(2, '0');"," const day = String(date.getDate()).padStart(2, '0');"," return `${year}-${month}-${day}`;"," }","}"]}},{"listen":"test","script":{"id":"e15c602c-8f37-4294-89b8-af3abc2aad15","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://www.labii.dev"},{"key":"apiKey","value":"yFlMjSup.IbHOCjyRiTb8QOO9Ltsbr"}]}