Vertex Flow OpenAPI specification opens the product life cycle data to the digital world.
\nWith Vertex OpenAPI service you can share your product related data on mobile, desktop or B2B level systems (e.g. ERP/CRM). OpenAPI is based on OAS3 standard. You can find more info about Vertex products at https://kben.vertex.fi.
\nWant to try? If you have some questions or ideas feel free to contact us: helpdesk(at)vertex.fi
\nOpenAPI authentication is based on Bearer token (JWT) or OAuth2. E.g.:
\nVersion 1 with Bearer token (JWT) (v1)
\nUse jwt authentication for v1 related endpoints, e.g.: http://localhost:8080/api/rest/v1/users/hello
Version 2 with OAuth2 (v2, since Flow 2025)
\nUse OAuth2 authentication for v2 related endpoints, e.g.: http://localhost:8080/api/rest/v2/users/hello
Generic error response is JSON formatted:
\n{\n \"fields\":{},\n \"type\":\"UNAUTHORIZED\",\n \"userMessage\":\"The provided token is not valid\",\n \"devMessage\":\"Specify valid token in request header.\"\n}\n\nMore detailed error information for application user. E.g. what data is missing or incorrect
\nInternal error codes for application developer to handle certain error cases:
\nFIELD_VALIDATION, // missing required attribute etc...\nINTERNAL, // unexpected error\nINVALID_CREDENTIALS, // wrong or missing username or password\nUNAUTHORIZED, // missing user credentials (no valid token etc...)\nACCESS_DENIED, // no permissions\nRESOURCE_NOT_FOUND, // object with the requested code not found\nRESOURCE_EXPIRED, // requested object is no longer valid\nRESOURCE_ALREADY_EXISTS, // object with the same code already exists\nOTHER\n\nMessage tells to the end user what has happened.
\nMessage tells what kind of parameters etc. is needed to make successful API request.
\nVersion 1.0.0, Initial implementation. 2019-11-30
\nVersion 1.0.1, Error response and status code refactoring. 2020-02-21
\nVersion 1.1.1, Initial API for Flow/DS 2021. 2020-11-20
\nVersion 1.2.0, New features added. 2021-01-08
\nVersion 1.3.0, New features and bug fixes. 2021-01-25
\nVersion 1.4.0, New features and bug fixes. 2020-02-12
\nVersion 1.5.0, Improvements and bug fixes. 2020-03-26
\nVersion 1.6.0, Improvements and bug fixes. 2021-04-16
\nVersion 1.7.0, Improvements (e.g. unique code as path parameter may include / char) and bug fixes. 2022-01-31
\nVersion 1.8.0, Minor improvements and bug fixes. 2022-05-20
\nVersion 1.8.1, Transfer status (ERP) info added into object data and bug fixes. 2023-03-16
\nVersion 1.9.0, Improvements: Adding multiple files for document and create item with BOM with one single post. 2023-04-28
\nVersion 1.10.0, Improvements 2024-12-27
\nVersion 2.1.0 (or 1.11.0), Improvements 2025-12-27
\nThis endpoint is used to authenticate a user by verifying their credentials. It allows users to log in to the system using their username and password. Used for v1 API endpoints.
\nMethod: PUT
\nURL: http://localhost:8080/api/rest/v1/users/login
The request must include a JSON payload with the following structure:
\n{\n \"username\": \"{{username}}\", // The username of the user attempting to log in\n \"password\": \"{{password}}\" // The password associated with the username\n}\n\nBoth username and password are required fields.
Upon successful authentication, the server will respond with a JSON object containing user details and a token for session management. The structure of the response will typically include:
\nstatus: Indicates the success or failure of the authentication attempt.
\ntoken: A session token used for subsequent authenticated requests.
\nuser: An object containing user-specific information such as user ID, roles, and permissions.
\nMake sure to handle both successful and error responses appropriately in your application.
\n","urlObject":{"path":["api","rest","v1","users","login"],"host":["http://localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"d9fd99f7-20d3-4e3e-8266-cfaef7b854ba","name":"Invalid username or password","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"This endpoint is used to obtain an access token from the OpenID Connect provider. It allows clients to authenticate and receive a token that can be used for subsequent requests to protected resources. Used for v2 API endpoints.
\nPOST
{{authBaseUrl}}/auth/realms/{{flow-realm}}/protocol/openid-connect/token
The request body must be sent in x-www-form-urlencoded format and includes the following parameters:
grant_type (string): The type of grant being requested. Typically, this is set to \"client_credentials\" for client authentication.
\nclient_id (string): The unique identifier for the client application requesting the token.
\nclient_secret (string): The secret associated with the client application, used for authentication.
\nUpon a successful request, the response will return a JSON object with the following fields:
\naccess_token (string): The token that can be used to access protected resources.
\nexpires_in (integer): The duration in seconds for which the access token is valid.
\nrefresh_expires_in (integer): The duration in seconds for which the refresh token is valid.
\ntoken_type (string): The type of token returned (e.g., \"Bearer\").
\nnot-before-policy (integer): The timestamp indicating when the token is valid from.
\nscope (string): The scope of access granted by the token.
\n{\n \"access_token\": \"\",\n \"expires_in\": 0,\n \"refresh_expires_in\": 0,\n \"token_type\": \"\",\n \"not-before-policy\": 0,\n \"scope\": \"\"\n}\n\nThis structure provides the necessary information for clients to authenticate and manage their session with the OpenID Connect provider.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"880760ec-7a79-46b9-af18-e8dc65579566","id":"880760ec-7a79-46b9-af18-e8dc65579566","name":"users","type":"folder"}},"urlObject":{"path":["auth","realms","{{flow-realm}}","protocol","openid-connect","token"],"host":["{{authBaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"bc13e8e7-a113-4cfa-8130-e67cd9645a61","name":"Login user (Oauth2)","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"vertex-openapi-v2-client","type":"text"},{"key":"client_secret","value":"{{clientSecret}}","type":"text"}]},"url":"{{authBaseUrl}}/auth/realms/{{flow-realm}}/protocol/openid-connect/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 29 Jul 2025 08:24:27 GMT"},{"key":"Server","value":"Apache/2.4.63 (Win64) OpenSSL/3.3.2"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=0; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"1035"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJiWVZHTnVRcnBEQUFRaExsamVSX3Y0MHFqeXpFNjRaUEZ6QS1BU3V2QVNFIn0.eyJleHAiOjE3NTM3Nzg5NjcsImlhdCI6MTc1Mzc3NzQ2NywianRpIjoiZGEyNGE1NGEtNDYyYy00OTA2LWEwNTgtNjJlYTVjODEzOGRkIiwiaXNzIjoiaHR0cHM6Ly9sb2NhbGhvc3QudmVydGV4LmZpL2F1dGgvcmVhbG1zL3ZlcnRleC1mbG93LXJlYWxtIiwic3ViIjoiZGE3OTY4ZDUtNzBlNC00ZjUzLWIyYjEtMDFhNmFhM2U3YWY2IiwidHlwIjoiQmVhcmVyIiwiYXpwIjoidmVydGV4LW9wZW5hcGktdjItY2xpZW50IiwiYWNyIjoiMSIsImFsbG93ZWQtb3JpZ2lucyI6WyIvKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiIsImRlZmF1bHQtcm9sZXMtdmVydGV4LWZsb3ctcmVhbHMiXX0sInJlc291cmNlX2FjY2VzcyI6eyJ2ZXJ0ZXgtb3BlbmFwaS12Mi1jbGllbnQiOnsicm9sZXMiOlsidW1hX3Byb3RlY3Rpb24iXX19LCJzY29wZSI6ImVtYWlsIHByb2ZpbGUiLCJjbGllbnRIb3N0IjoiMTI3LjAuMC4xIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJzZXJ2aWNlLWFjY291bnQtdmVydGV4LW9wZW5hcGktdjItY2xpZW50IiwiY2xpZW50QWRkcmVzcyI6IjEyNy4wLjAuMSIsImNsaWVudF9pZCI6InZlcnRleC1vcGVuYXBpLXYyLWNsaWVudCJ9.h1vAU3uET5rvU604Lux9xgNyMZhC-XzrEXI3-76wqPC6Q6XcXJL7buHEoWsscjDI00_huIiQ1sLH62N2v6HWwn16aecT9cZSLcnkA7PuVD5mrAcjkIauPR70s_7h-2TMuIP5pFkuUTeZpnuNxCaA93jnJNEwmx-iCXAdYnth2eKCZgwftQL9U39Mf73I7BynvYXjAUlgbx3LkyXn9nQ4bLuDZMX3mxRZleju997o0ne77-Vl4O8HnEL_wiDFNP1q2snivKm5J2JyTI0OfP9H8Pa0NimCLf7hjEOaN2JjxG7rzJ9OOg0CjXSMm9lK-LZa2NTetpV8gGfNMETyAE6hbw\",\n \"expires_in\": 1500,\n \"refresh_expires_in\": 0,\n \"token_type\": \"Bearer\",\n \"not-before-policy\": 0,\n \"scope\": \"email profile\"\n}"}],"_postman_id":"32a3a3f7-88c7-48f7-bc70-5b75841d4748"},{"name":"Hello OpenApi","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);"," // valid return value"," pm.test(\"Response body is correct\", function () {"," pm.response.to.have.body(\"Hello OpenApi\");"," });","});"],"type":"text/javascript","id":"824a0c74-a9cf-45f2-bf98-3038b590e246"}}],"id":"3bad7e8c-b9ab-4563-81bf-0cb487436b9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:8080/api/rest/v1/users/hello","description":"My first OpenAPI function.
\n","urlObject":{"path":["api","rest","v1","users","hello"],"host":["http://localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"de3785d9-b101-40eb-ba65-0b0edc8254ea","name":"default response","originalRequest":{"method":"GET","header":[],"url":"http://localhost:8080/api/rest/v1/users/hello"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"This API request retrieves information about the currently authenticated user.
\nThe purpose of this request is to obtain details such as the user's ID, name, username, initials, and other related properties.
\nThe response will be in JSON format and may include the following fields:
\nid: The unique identifier of the user.
name: The full name of the user.
username: The username of the user.
initials: The initials of the user.
properties: An object containing additional properties such as:
LOCALE: The locale setting of the user.
CONTENTLANG: The content language preference of the user
This API endpoint retrieves detailed information about a user based on the provided user ID.
\nThe response will return a JSON object containing user details. Below are the possible fields in the response:
\nid: The unique identifier of the user.
\nname: The full name of the user.
\nusername: The username associated with the user account.
\ninitials: The initials of the user.
\nproperties: Additional properties related to the user (can be null).
\nUser identifier
\n","type":"text/plain"},"type":"any","value":"{{userId}}","key":"userId"}]}},"response":[{"id":"db2fca6b-6202-462c-84f0-68d8dd759bcb","name":"Gets the username information (any user)","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://localhost:8080/api/rest/v1/users/:userId?get-organization=true","host":["http://localhost:8080"],"path":["api","rest","v1","users",":userId"],"query":[{"key":"get-organization","value":"true"}],"variable":[{"key":"userId","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS, HEAD"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-type, responseType, Accept, Authorization"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"90"},{"key":"Date","value":"Wed, 30 Jul 2025 08:21:02 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5\",\n \"name\": \"Suunnittelija Sami\",\n \"username\": \"Sami\",\n \"initials\": \"SS\",\n \"properties\": null\n}"}],"_postman_id":"5df03bae-b85e-4a91-afc0-942227c9cebb"},{"name":"Gets users (list)","event":[{"listen":"test","script":{"exec":["var userSchema = {"," \"$schema\": \"http://json-schema.org/draft-07/schema\","," \"$id\": \"http://example.com/example.json\","," \"type\": \"array\","," \"title\": \"The Root Schema\","," \"items\": {"," \"type\": \"object\","," \"title\": \"The Root Schema\","," \"description\": \"The root schema comprises the entire JSON document.\","," \"default\": {},"," \"additionalProperties\": true,"," \"required\": ["," \"id\","," \"name\","," \"username\","," \"initials\","," \"properties\","," \"organization\""," ],"," \"properties\": {"," \"id\": {"," \"$id\": \"#/properties/id\","," \"type\": \"string\","," \"title\": \"The Id Schema\","," \"description\": \"An explanation about the purpose of this instance.\","," \"default\": \"\","," \"examples\": ["," \"5\""," ]"," },"," \"name\": {"," \"$id\": \"#/properties/name\","," \"type\": \"string\","," \"title\": \"The Name Schema\","," \"description\": \"An explanation about the purpose of this instance.\","," \"default\": \"\","," \"examples\": ["," \"Sami Suunnittelija\""," ]"," },"," \"username\": {"," \"$id\": \"#/properties/username\","," \"type\": \"string\","," \"title\": \"The Username Schema\","," \"description\": \"An explanation about the purpose of this instance.\","," \"default\": null,"," \"examples\": ["," \"Sami\""," ]"," },"," \"initials\": {"," \"$id\": \"#/properties/initials\","," \"type\": \"string\","," \"title\": \"The Initials Schema\","," },"," \"properties\": {"," \"$id\": \"#/properties/properties\","," \"type\": \"object\","," \"title\": \"The Properties Schema\","," \"description\": \"An explanation about the purpose of this instance.\","," \"default\": null,"," \"examples\": ["," {"," \"CONTENTLANG\": \"fi\","," \"LOCALE\": \"en_FI\""," }"," ],"," \"additionalProperties\": true,"," \"properties\": {"," \"LOCALE\": {"," \"$id\": \"#/properties/properties/properties/LOCALE\","," \"type\": \"string\","," \"title\": \"The Locale Schema\","," \"description\": \"An explanation about the purpose of this instance.\","," \"default\": \"\","," \"examples\": ["," \"en_FI\""," ]"," },"," \"CONTENTLANG\": {"," \"$id\": \"#/properties/properties/properties/CONTENTLANG\","," \"type\": \"string\","," \"title\": \"The Contentlang Schema\","," \"description\": \"An explanation about the purpose of this instance.\","," \"default\": \"\","," \"examples\": ["," \"fi\""," ]"," }"," }"," },"," \"organization\": {"," \"type\": \"object\","," \"properties\": {"," \"id\": {"," \"type\": \"string\""," },"," \"code\": {"," \"type\": \"string\""," },"," \"name\": {"," \"type\": \"string\""," },"," \"type\": {"," \"type\": \"string\""," },"," \"region\": {"," \"type\": \"string\""," }"," }"," }"," }"," }","};","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);"," var jsonData = pm.response.json();"," "," var Ajv = require('ajv'); // Import Ajv here"," var ajv = new Ajv(); // Create a new instance of Ajv",""," pm.test(\"Schema is valid\", function() {"," var schemaOk = ajv.validate(userSchema, jsonData); // Validate using the correct order"," console.log(\"Ok: \" + schemaOk);"," "," if (!schemaOk) {"," console.log(\"Schema error description (if any): \" + ajv.errorsText(ajv.errors)); // Log errors if any"," }"," pm.expect(schemaOk).to.be.true; "," });"," "," pm.test(\"Password exposed\", function() {"," pm.expect(pm.response.text()).not.to.include(\"password\");"," });","});",""],"type":"text/javascript","packages":{},"id":"c3be0670-4422-4829-9e66-e857ddff7334"}}],"id":"ce6dc0e3-2cb6-45d7-bdd9-5b8078d27beb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:8080/api/rest/v1/users/list?get-organization=true","description":"This endpoint retrieves a list of users from the system. It is particularly useful for obtaining user information along with their associated organization details.
\nThe purpose of this request is to fetch the current user's information, including their organization details, when the query parameter get-organization is set to true.
On a successful request, the response will return a JSON array of user objects with the following structure:
\n[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"username\": \"\",\n \"initials\": \"\",\n \"properties\": {},\n \"organization\": {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"region\": \"\"\n }\n }\n]\n\nid: Unique identifier for the user.
\nname: Full name of the user.
\nusername: The username associated with the user account. Not available in user list mode.
\ninitials: Initials of the user.
\nproperties: Additional properties related to the user (if any). Not available in user list mode.
\norganization: An object containing details about the user's organization:
\nid: Unique identifier for the organization.
\ncode: Code representing the organization.
\nname: Name of the organization.
\ntype: Type of the organization.
\nregion: Region where the organization operates.
\nInclude organization details
\n","type":"text/plain"},"key":"get-organization","value":"true"}],"variable":[]}},"response":[],"_postman_id":"ce6dc0e3-2cb6-45d7-bdd9-5b8078d27beb"},{"name":"Gets timeline data for a user","id":"0e8e6845-4fc8-4ca6-ac66-8067be766147","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:8080/api/rest/v1/users/timeline/:userid/:islimit/:fetchAll/:showSignIns","description":"Gets timeline data (user actions) for a user. Requires Flow option USERLOGSTD.
\n","urlObject":{"path":["api","rest","v1","users","timeline",":userid",":islimit",":fetchAll",":showSignIns"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"49784888-4091-4aeb-956c-5fed9c627ba4","description":{"content":"Identifier of the user
\n","type":"text/plain"},"type":"any","value":"","key":"userid"},{"id":"8e11f80e-60e7-43e0-bd77-6916e93fd685","description":{"content":"Limit data to latest 200 actions (true) or unlimited (false)
\n","type":"text/plain"},"type":"any","value":"false","key":"islimit"},{"id":"976cbaa4-3cab-4185-886e-49d49f4d5b9e","description":{"content":"Get detailed data (true) or limited (false)
\n","type":"text/plain"},"type":"any","value":"false","key":"fetchAll"},{"id":"7050a7b5-1f29-4aba-b535-9960db3112f0","description":{"content":"Include sign in actions (true) or exclude (false)
\n","type":"text/plain"},"type":"any","value":"false","key":"showSignIns"}]}},"response":[],"_postman_id":"0e8e6845-4fc8-4ca6-ac66-8067be766147"}],"id":"880760ec-7a79-46b9-af18-e8dc65579566","description":"User data related API functions.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"58ddfa79-dd42-4a33-b92a-9bc7649b518e","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"c836a905-de1b-42fe-9c90-ec5b48f48271","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"880760ec-7a79-46b9-af18-e8dc65579566"},{"name":"organizations","item":[{"name":"Get all organizations","id":"38c926b2-c0a5-48fa-8686-562633842cb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:8080/api/rest/v1/organizations","description":"This endpoint retrieves a list of organizations from the API.
\nThis endpoint does not require any query parameters.
\nThe response will be in JSON format and will include a list of organizations. Each organization object typically contains details such as:
\nid: Unique identifier for the organization.
code: A code representing the organization.
name: The name of the organization.
type: The type of organization.
region: The region where the organization is located.
[\n {\n \"id\": \"9\",\n \"code\": \"9\",\n \"name\": \"MR-Design Oy\",\n \"type\": \"company\",\n \"region\": \"FIN\"\n }\n]\n\nThis endpoint retrieves detailed information about a specific organization based on the provided organization ID.
\norganizationId (string): The unique identifier of the organization whose details you want to retrieve.On a successful request, the API will return a 200 OK status with a JSON response containing the following fields:
id (string): The unique identifier of the organization.
code (string): The code associated with the organization.
name (string): The name of the organization.
type (string): The type/category of the organization.
region (string): The region where the organization is located.
The response will be in the following format:
\n{\n \"id\": \"9\",\n \"code\": \"9\",\n \"name\": \"MR-Design Oy\",\n \"type\": \"company\",\n \"region\": \"FIN\"\n}\n\nOrganization data (user management) related API functions.
\n","_postman_id":"3d34f7ae-9e62-4aaa-b731-ea8ebf6f84d2"},{"name":"objects","item":[{"name":"find","item":[{"name":"Search for objects","id":"1a419341-d8f0-4ba9-bbf5-3313df2e8a85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:8080/api/rest/v1/objects/find/:searchString","description":"Search objects by single string.
\n","urlObject":{"path":["api","rest","v1","objects","find",":searchString"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"a0765c3e-19ee-469a-b5bc-b4814a41a051","description":{"content":"Any search string
\n","type":"text/plain"},"type":"any","value":"","key":"searchString"}]}},"response":[{"id":"86bb0474-f50f-4c27-8630-954426613f60","name":"Search for objects","originalRequest":{"method":"GET","header":[],"url":"http://localhost:8080/api/rest/v1/objects/find/Kiteen*"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS, HEAD"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-type, responseType, Accept, Authorization"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"7631"},{"key":"Date","value":"Fri, 01 Nov 2019 14:02:48 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"baseClass\": \"doc\",\n \"type\": \"model\",\n \"objCode\": \"SER000002\",\n \"revision\": \"0\",\n \"revisionCount\": 16,\n \"label\": \"SER000002, Kiteennostolaite, kokoonpano\",\n \"name\": \"SER000002\",\n \"author\": \"Seppo Suunnittelupäällikkö\",\n \"creator\": \"Seppo Suunnittelupäällikkö\",\n \"owner\": \"\",\n \"status\": \"draft\",\n \"dated\": null,\n \"creationTime\": 1516800649000,\n \"modifiedTime\": 1516800649000,\n \"description\": \"Kiteennostolaite, kokoonpano\",\n \"thumbnailSource\": null,\n \"thumbnailMimeType\": null,\n \"thumbnail\": null,\n \"icon\": \"iVBORw0KGgoAAAANSUhEUgAAABYAAAAWCAYAAADEtGw7AAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAACoSURBVHjaYvz//z8DLQATA40AC7oA35ZNZHvhk48fI1aDQYZ+lpVl4GVkJN3UR4/wBwVZhg5oGGMDX4Ap5/+/f3jV8JJqMMjQ4H//GXY+fUpdF4NcCjIUOcYHNIxHDR4E6ZiNmZlBSVyCqDIEZ1mBDbAD8XV2NgZ2OTkw/ycQ/8JS1PI+fkx6zmNHY7MTUZ7QL/I+EygTyIo8UOBTUtAjA8YhV+cBBBgAJ7g22LXw6kkAAAAASUVORK5CYII=\",\n \"extAttributes\": {\n \"ZMAX\": null,\n \"DESCR1_FI\": null,\n \"DESCR2_EN\": null,\n \"CREATELIGHTSAT\": null,\n \"DESCR3_FI\": \"\",\n \"DRAWN_BY\": \"RS\",\n \"XMAX\": null,\n \"CREATEIFC\": null,\n \"CREATESAT\": null,\n \"AMOUNTEQ\": null,\n \"DICTIONARYID2\": null,\n \"DICTIONARYID3\": null,\n \"CONN_ID\": null,\n \"YMIN\": null,\n \"SAVE_TIME\": \"2003-03-21 10:05:51\",\n \"CREATESTEP\": null,\n \"WEIGHT\": \"\",\n \"CREATELIGHTMODEL\": null,\n \"DESCR3_EN\": null,\n \"YMAX\": null,\n \"DESCR2_FI\": \"\",\n \"MEASURED\": null,\n \"DESCR1_EN\": null,\n \"PARAMETERS\": null,\n \"D_DATE\": \"2018-01-24\",\n \"NOUPDATE\": \"\",\n \"REV_BY\": null,\n \"ZMIN\": null,\n \"XMIN\": null,\n \"DIMEQ\": \"\",\n \"CREATEREFMODEL\": null,\n \"CREATELIGHTSTEP\": null,\n \"CHANGEDOCID\": null\n },\n \"connections\": null\n },\n {\n \"baseClass\": \"doc\",\n \"type\": \"drawing\",\n \"objCode\": \"10280\",\n \"revision\": \"0\",\n \"revisionCount\": 9,\n \"label\": \"10280, Kiteennostolaite, kokoonpano\",\n \"name\": \"10280\",\n \"author\": \"Seppo Suunnittelupäällikkö\",\n \"creator\": \"Mikko Suunnittelija\",\n \"owner\": \"\",\n \"status\": \"approved\",\n \"dated\": null,\n \"creationTime\": 1047373398000,\n \"modifiedTime\": 1516794801000,\n \"description\": \"Kiteennostolaite, kokoonpano\",\n \"thumbnailSource\": null,\n \"thumbnailMimeType\": null,\n \"thumbnail\": null,\n \"icon\": \"iVBORw0KGgoAAAANSUhEUgAAABYAAAAWCAYAAADEtGw7AAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAACJSURBVHja7JWLCsAgCEXVot+uPrzchA1GGGy5BoMuGER0NB+EzAwzRDBJ/wN7WXLOw4mOMaJ6IMVLKfGI5N5xF1qjnrNa692I1Re/kmMNroIREYjIBPfWaHdYu2cpqLemoOdoTd5HI60NyNVkWEIIdrD0sdgpAZdSwDn3HNz2o1W4fpDp4E2AAQCfAYhpRLDuRQAAAABJRU5ErkJggg==\",\n \"extAttributes\": {\n \"DESCR1_FI\": \"Kiteennostolaite, kokoonpano\",\n \"SPBOOKLET\": \"\",\n \"DESCR2_EN\": \"\",\n \"DESCR3_FI\": \"\",\n \"DRAWN_BY\": \"MP\",\n \"MOD_ID\": \"\",\n \"DICTIONARYID2\": null,\n \"DICTIONARYID3\": null,\n \"CONN_ID\": \"\",\n \"REPLACED\": \"\",\n \"MANUFBOOKLET\": null,\n \"R_DESCR_EN\": null,\n \"TOLER\": \"\",\n \"REPLACE\": \"\",\n \"WEIGHT\": \"\",\n \"ES_KENT\": null,\n \"DESCR3_EN\": \"\",\n \"DESCR2_FI\": \"\",\n \"MEASURED\": null,\n \"DESCR1_EN\": \"\",\n \"D_DATE\": \"2002-01-09\",\n \"REV_BY\": null,\n \"TRANSFERED_I\": null,\n \"CHANGEDOCID\": \"\",\n \"WPBOOKLET\": null\n },\n \"connections\": null\n },\n {\n \"baseClass\": \"item\",\n \"type\": \"item\",\n \"objCode\": \"10280\",\n \"revision\": \"1\",\n \"revisionCount\": 4,\n \"label\": \"10280, Kiteennostolaite, kokoonpano\",\n \"name\": \"10280\",\n \"author\": \"Seppo Suunnittelupäällikkö\",\n \"creator\": \"Seppo Suunnittelupäällikkö\",\n \"owner\": \"\",\n \"status\": \"approved\",\n \"dated\": null,\n \"creationTime\": 1515052272000,\n \"modifiedTime\": 1515053767000,\n \"description\": \"Kiteennostolaite, kokoonpano\",\n \"thumbnailSource\": null,\n \"thumbnailMimeType\": null,\n \"thumbnail\": null,\n \"icon\": \"iVBORw0KGgoAAAANSUhEUgAAABYAAAAWCAYAAADEtGw7AAAAB3RJTUUH3QYGChY1j+P7DwAAAAlwSFlzAAALEgAACxIB0t1+/AAAAIJJREFUeNpj/P//PwMtABNNTAUCFhijsbGRKk6vr69nRDEYKkiRoUDH0T4oSDKYkZERjKluMCmAhRTFpCRNgi5ub2+HBwFVg2LRokW0CYrr16/D2cS6ligXkwtGDSbeYOTkBgMwPkiObIPxJTd8ciQlN6oGBbkAxcXI5SmlgHHI1XkAtPghTa8HGIUAAAAASUVORK5CYII=\",\n \"extAttributes\": {\n \"DESCR1_FI\": \"Kiteennostolaite, kokoonpano\",\n \"DESCR2_EN\": \"\",\n \"ABC_CLASS\": \"A\",\n \"ITEMGROUP\": \"SUB_ASSEMBLY\",\n \"INSTOCK\": \"\",\n \"SPAREPART\": \"\",\n \"DICTIONARYID2\": \"\",\n \"PURCHASE\": \"\",\n \"DENSITY\": \"\",\n \"USE_PURCHASECOST\": \"\",\n \"DESCRIPTION2_FI\": \"\",\n \"SPDESCR1_EN\": \"\",\n \"COLOR\": \"\",\n \"SALESDESCR1_FI\": \"\",\n \"SPDESCR1_SV\": \"\",\n \"COMPONENT_REPRE\": \"\",\n \"MODBOOKLET_IMG\": \"\",\n \"WEARPART\": \"\",\n \"SALESDICTIONARYID1\": \"\",\n \"WEIGHT\": \"0.0\",\n \"SPEC\": \"\",\n \"STANDARD\": \"\",\n \"UNIT\": \"KPL\",\n \"DESCR2_FI\": \"\",\n \"EDITABLE_UNITPRICE\": \"true\",\n \"MEASURED\": \"\",\n \"ALLOWPRICING\": \"\",\n \"DESCR1_EN\": \"\",\n \"COMPONENT_LIBRARY\": \"\",\n \"DESCRIPTION2_EN\": \"\",\n \"COMPONENT_PARAMETERS\": \"\",\n \"TEMPLATEITEM\": \"\",\n \"PREVENTTRANSFER\": \"\",\n \"PDMTAGID\": \"\",\n \"TRANSFERED_I\": null,\n \"SPDESCR1_FI\": \"\",\n \"PIC_ID\": \"10280\",\n \"SPDICTIONARYID1\": \"\",\n \"VENDOR\": \"\",\n \"MODBOOKLET\": \"true\",\n \"MARK_STD\": \"\",\n \"SALESDESCR1_EN\": \"\",\n \"SPDESCR1_DE\": \"\"\n },\n \"connections\": null\n },\n {\n \"baseClass\": \"product\",\n \"type\": \"product\",\n \"objCode\": \"T0004\",\n \"revision\": \"0\",\n \"revisionCount\": 1,\n \"label\": \"Kiteennostolaite\",\n \"name\": \"Kiteennostolaite\",\n \"author\": \"Seppo Suunnittelupäällikkö\",\n \"creator\": \"Mikko Suunnittelija\",\n \"owner\": \"\",\n \"status\": \"1182941803863\",\n \"dated\": null,\n \"creationTime\": 1047311259000,\n \"modifiedTime\": 1515051309000,\n \"description\": \"\",\n \"thumbnailSource\": null,\n \"thumbnailMimeType\": null,\n \"thumbnail\": null,\n \"icon\": \"iVBORw0KGgoAAAANSUhEUgAAABYAAAAWCAYAAADEtGw7AAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAABYSURBVHjaYvz//z8DLQATA43AqMGYBjMyMv7HRRMrNhrGowYPkMGMtCqEGEAGwzCEi0rjEkOXg7FhGCXnAQEjcg4C8bE4hCgxvGEMs4wssdGCfugaDBBgANjsWQOzmINmAAAAAElFTkSuQmCC\",\n \"extAttributes\": {},\n \"connections\": null\n },\n {\n \"baseClass\": \"doc\",\n \"type\": \"model\",\n \"objCode\": \"10280\",\n \"revision\": \"0\",\n \"revisionCount\": 16,\n \"label\": \"10280, Kiteennostolaite, kokoonpano\",\n \"name\": \"10280\",\n \"author\": \"Mikko Suunnittelija\",\n \"creator\": \"Mikko Suunnittelija\",\n \"owner\": \"\",\n \"status\": \"approved\",\n \"dated\": null,\n \"creationTime\": 1047367284000,\n \"modifiedTime\": 1047367284000,\n \"description\": \"Kiteennostolaite, kokoonpano\",\n \"thumbnailSource\": null,\n \"thumbnailMimeType\": null,\n \"thumbnail\": null,\n \"icon\": \"iVBORw0KGgoAAAANSUhEUgAAABYAAAAWCAYAAADEtGw7AAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAACoSURBVHjaYvz//z8DLQATA40AC7oA35ZNZHvhk48fI1aDQYZ+lpVl4GVkJN3UR4/wBwVZhg5oGGMDX4Ap5/+/f3jV8JJqMMjQ4H//GXY+fUpdF4NcCjIUOcYHNIxHDR4E6ZiNmZlBSVyCqDIEZ1mBDbAD8XV2NgZ2OTkw/ycQ/8JS1PI+fkx6zmNHY7MTUZ7QL/I+EygTyIo8UOBTUtAjA8YhV+cBBBgAJ7g22LXw6kkAAAAASUVORK5CYII=\",\n \"extAttributes\": {\n \"ZMAX\": null,\n \"DESCR1_FI\": null,\n \"DESCR2_EN\": null,\n \"CREATELIGHTSAT\": null,\n \"DESCR3_FI\": \"\",\n \"DRAWN_BY\": \"MP\",\n \"XMAX\": null,\n \"CREATEIFC\": null,\n \"CREATESAT\": null,\n \"AMOUNTEQ\": null,\n \"DICTIONARYID2\": null,\n \"DICTIONARYID3\": null,\n \"CONN_ID\": null,\n \"YMIN\": null,\n \"SAVE_TIME\": \"2003-03-21 10:05:51\",\n \"CREATESTEP\": null,\n \"WEIGHT\": \"\",\n \"CREATELIGHTMODEL\": null,\n \"DESCR3_EN\": null,\n \"YMAX\": null,\n \"DESCR2_FI\": \"\",\n \"MEASURED\": null,\n \"DESCR1_EN\": null,\n \"PARAMETERS\": null,\n \"D_DATE\": \"2002-01-09\",\n \"NOUPDATE\": \"\",\n \"REV_BY\": null,\n \"ZMIN\": null,\n \"XMIN\": null,\n \"DIMEQ\": \"\",\n \"CREATEREFMODEL\": null,\n \"CREATELIGHTSTEP\": null,\n \"CHANGEDOCID\": null\n },\n \"connections\": null\n }\n]"}],"_postman_id":"1a419341-d8f0-4ba9-bbf5-3313df2e8a85"},{"name":"Search for objects","id":"f2358c54-0f5f-4ba3-a859-7ae676575a11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:8080/api/rest/v1/objects/:code","description":"Search objects by object code.
\n","urlObject":{"path":["api","rest","v1","objects",":code"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"945bf7ba-cfe3-48f9-b8aa-9bd7adb572ce","description":{"content":"Unique object identifier
\n","type":"text/plain"},"type":"any","value":"10280","key":"code"}]}},"response":[{"id":"4196287b-3dbf-4433-ad39-4a12a4885521","name":"default response","originalRequest":{"method":"GET","header":[],"url":"http://localhost:8080/api/rest/v1/objects/This endpoint allows you to search for objects using a JSON payload. The request can be customized using the following query parameters:
\nget-assignee: (boolean) If set to true, the response will include information about the assignee of the object.
\nget-object-mode: (boolean) If set to true, the response will include the mode of the object.
\nfields: (string) A list of fields to include in the response. In this request, the fields specified are e.g. classification and description. Parameter can be used to optimize data payload (without fields parameter all the metadata is fetched).
The request body should be in JSON format and includes e.g. the following parameters:
\nname (string): The name of the object you are searching for.
\nbaseClass (string): The basetype of the object (e.g., \"item\" or \"doc\").
\nextAttributes (object): Additional attributes related to the object, which can be left empty.
\n{\n \"objCode\": \"*19\",\n \"baseClass\": \"item\",\n \"extAttributes\": {}\n}\n\nOn a successful request, the server will respond with a status code of 200 and a JSON array containing the following fields:
\nobjCode (string): The code of the object.
\nobjectMode (string|null): The mode of the object, if applicable.
\ndescription (string): A description of the object.
\nassignee (object): Information about the assignee, including:
\nuserName (string): The name of the assignee.
\nuserId (string): The ID of the assignee.
\ntype (string): The type of the object.
\nclassification (string): The classification of the object.
\nrevision (string): The revision information of the object.
\n[\n {\n \"objCode\": \"\",\n \"objectMode\": null,\n \"description\": \"\",\n \"assignee\": {\n \"userName\": \"\",\n \"userId\": \"\"\n },\n \"type\": \"\",\n \"classification\": \"\",\n \"revision\": \"\"\n }\n]\n\nApply assignee data (optional, default = false)
\n","type":"text/plain"},"key":"get-assignee","value":"true"},{"description":{"content":"Apply object mode data (optional, default = false)
\n","type":"text/plain"},"key":"get-object-mode","value":"true"},{"description":{"content":"Requested metadata field names (optional)
\n","type":"text/plain"},"key":"fields","value":"classification"},{"description":{"content":"Requested metadata field names (optional)
\n","type":"text/plain"},"key":"fields","value":"description"},{"description":{"content":"Apply status history data (optional, default = false)
\n","type":"text/plain"},"key":"get-state-history","value":"false"}],"variable":[]}},"response":[{"id":"a4c106d1-7e5d-4770-9b6b-5f7950ff7e98","name":"default response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"http://localhost:8080/api/rest/v1/objects/find"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""}],"_postman_id":"4c63dbfa-bc92-4ddb-8625-5f4c8ee21815"},{"name":"Get single object","id":"8764ee37-9dee-4398-99df-022d58645aaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"objname\": \"Search single object using json formatted data.
\n","urlObject":{"path":["api","rest","v1","objects","getSingle"],"host":["http://localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"a3df1a5d-103f-4524-b247-9eeeacef5b7e","name":"default response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"http://localhost:8080/api/rest/v1/objects/getSingle"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""}],"_postman_id":"8764ee37-9dee-4398-99df-022d58645aaa"},{"name":"Search for connections of the specified object.","id":"5798a1e4-7ce7-4e77-b849-186c065caed1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"}],"url":"http://localhost:8080/api/rest/v1/objects/:type/:code/connections","description":"Gets all the connections of the object.
\n","urlObject":{"path":["api","rest","v1","objects",":type",":code","connections"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"1bc18631-5abe-431b-ad34-f2a15efc274c","description":{"content":"Type of the object e.g. item
\n","type":"text/plain"},"type":"any","value":"Code of the object
\n","type":"text/plain"},"type":"any","value":"Functions to search data objects. Read more: https://kbfi.vertex.fi/flow
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"f517cb23-a4e7-4ded-a46c-f5af582e683c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"d78a39df-422a-4a59-afeb-d41619021d2a"}}],"_postman_id":"86b1fdec-c90b-4369-8e4f-0406ac0acb76"},{"name":"classifications","item":[{"name":"Get classifications","id":"90577cba-d043-4a39-8398-99871ae57a6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"}],"url":"http://localhost:8080/api/rest/v1/objects/classifications","description":"Gets all classifications.
\n","urlObject":{"path":["api","rest","v1","objects","classifications"],"host":["http://localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"8cb94f02-84e3-40e0-97c2-7691c6834bf2","name":"Internal server error.","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"}],"url":"http://localhost:8080/api/rest/v1/objects/classifications/:type","description":"Gets the classifications of specified type.
\n","urlObject":{"path":["api","rest","v1","objects","classifications",":type"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"09c04d26-0396-4387-b162-4e8252e72c98","description":{"content":"Object type e.g. item
\n","type":"text/plain"},"type":"any","value":"Funtions for classifications, read more: https://kbfi.vertex.fi/flow/luokitteiden-hallinta
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"58ab79f2-8ca4-4cef-803b-07c4b4fdff9d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"51fa0d57-43b5-4037-823d-3af82d03edd8"}}],"_postman_id":"87679004-2edd-4c09-8a66-fc56aedc23f0"},{"name":"codes","item":[{"name":"Unique code","id":"69887a24-b85e-41f8-80f8-02ad2c915057","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"}],"url":"http://localhost:8080/api/rest/v1/objects/code/:codeId","description":"Gets the unique code for a new object. Every object should have unique identifier (code).
\n","urlObject":{"path":["api","rest","v1","objects","code",":codeId"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"41104b04-2a28-4825-904b-0f7ecd3b84c3","description":{"content":"Identifier of the code series
\n","type":"text/plain"},"type":"any","value":"Bearer + JWT token
\n"}],"url":"http://localhost:8080/api/rest/v1/objects/codes/:type","description":"Gets the possible code series (one or many) for new object.
\n","urlObject":{"path":["api","rest","v1","objects","codes",":type"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"0d0fe6ff-460f-43c9-b266-06eab4a524eb","description":{"content":"Type of the object e.g. item
\n","type":"text/plain"},"type":"any","value":"Functions to get unique object codes.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"c66c9037-e4ac-44aa-a5aa-4f8812147477"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"92719b4b-61ef-4329-8d75-91cdfacc948f"}}],"_postman_id":"db79fa11-7635-4a3c-923b-9abcf70d01ed"},{"name":"status","item":[{"name":"Gets properties of the required state","id":"00561034-249f-449f-875d-e897d2f36fac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"}],"url":"http://localhost:8080/api/rest/v1/objects/status/:statusId","description":"Gets status specific data.
\n","urlObject":{"path":["api","rest","v1","objects","status",":statusId"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"168510ee-7da1-43ef-bda3-0b28d3b17f15","description":{"content":"Identifier of the status
\n","type":"text/plain"},"type":"any","value":"","key":"statusId"}]}},"response":[{"id":"ed82a713-aeed-4246-81d6-2c1da52566fc","name":"successful operation","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"}],"url":"http://localhost:8080/api/rest/v1/objects/to-status/:type/:code/:revision","description":"Gets the possible (next) states (statusId) for the object.
\n","urlObject":{"path":["api","rest","v1","objects","to-status",":type",":code",":revision"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"6c395a8c-1af1-4e24-a367-97e85910b71d","description":{"content":"Type of the object e.g. item
\n","type":"text/plain"},"type":"any","value":"document","key":"type"},{"id":"ea92e992-778f-4b43-9649-69fc9b5ad6fe","description":{"content":"Object code
\n","type":"text/plain"},"type":"any","value":"D100359","key":"code"},{"id":"a7b898a3-43e9-45c6-9e24-1a555890e9a1","description":{"content":"Revision identifier
\n","type":"text/plain"},"type":"any","value":"A","key":"revision"}]}},"response":[{"id":"2c5ffd92-6356-4bb7-849c-5ad691dcea7a","name":"Internal server error.","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"}],"url":"http://localhost:8080/api/rest/v1/objects/:type/:code/:revision/state-transitions","description":"Gets the possible state transitions for object.
\n","urlObject":{"path":["api","rest","v1","objects",":type",":code",":revision","state-transitions"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"d0a44fba-e385-48d2-84c8-ab336028b7be","description":{"content":"Type of the object e.g. item
\n","type":"text/plain"},"type":"any","value":"document","key":"type"},{"id":"7964767e-3de8-4cc3-8a62-03ff82390099","description":{"content":"Object code
\n","type":"text/plain"},"type":"any","value":"D100359","key":"code"},{"id":"cdde4afb-5e5d-401f-bee8-41dde71517aa","description":{"content":"Revision identifier
\n","type":"text/plain"},"type":"any","value":"0","key":"revision"}]}},"response":[{"id":"c4d37cbd-e6c1-4786-a25e-92c51d053476","name":"successful operation","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"}],"url":"http://localhost:8080/api/rest/v1/objects/:type/:code/:revision/state-transition/:stateTransitionId","description":"Make state transition to object.
\n","urlObject":{"path":["api","rest","v1","objects",":type",":code",":revision","state-transition",":stateTransitionId"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"ef177011-97ab-4086-a436-805be045e04e","description":{"content":"Type of the object e.g. item
\n","type":"text/plain"},"type":"any","value":"","key":"type"},{"id":"388e2c02-0e42-40fb-af67-999b8d7e9d6f","description":{"content":"Object code
\n","type":"text/plain"},"type":"any","value":"","key":"code"},{"id":"df8b619b-8be3-439f-a264-8c2b857b649d","description":{"content":"Revision identifier
\n","type":"text/plain"},"type":"any","value":"","key":"revision"},{"id":"a9a4be95-e865-4735-9cca-964c4cdc5e7c","type":"any","value":"","key":"stateTransitionId"}]}},"response":[{"id":"c7f95157-0339-40b6-82fc-8176d3f1b02d","name":"Internal server error.","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"}],"url":"http://localhost:8080/api/rest/v1/objects/:type/:code/:revision/state/:statusId","description":"Change status of the object.
\n","urlObject":{"path":["api","rest","v1","objects",":type",":code",":revision","state",":statusId"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"a056f337-ea91-46f3-ace4-a81bf9a989da","description":{"content":"Type of the object e.g. item
\n","type":"text/plain"},"type":"any","value":"","key":"type"},{"id":"7122cf4d-72ce-47a5-a8ab-9fc8e185f070","description":{"content":"Object code
\n","type":"text/plain"},"type":"any","value":"","key":"code"},{"id":"dcb91759-691f-4742-8346-1877a3995290","description":{"content":"Revision identifier
\n","type":"text/plain"},"type":"any","value":"","key":"revision"},{"id":"1b916c4d-fb01-4254-8470-c1a79a805c9a","description":{"content":"Id of the state
\n","type":"text/plain"},"type":"any","value":"","key":"statusId"}]}},"response":[{"id":"02adf94d-ce76-4e2a-b6dd-6c8824b57927","name":"Internal server error.","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Workflow related functions. Read more: https://kbfi.vertex.fi/flow/tila-ja-tyokierto
\n","_postman_id":"19f5ee2a-4009-4b10-b9e5-d88213abad6a"},{"name":"assignees","item":[{"name":"Get assignees","id":"1b904e3e-0f39-416f-86d7-96b1da6b3b13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/api/rest/v1/objects/:statusId/list-assignees","description":"Gets possible assignees (users) by status. Since v. 1.10.0.
\n","urlObject":{"path":["api","rest","v1","objects",":statusId","list-assignees"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"f28d402d-7fc4-4354-845f-be6182ec4ef3","description":{"content":"Identifier of the status
\n","type":"text/plain"},"type":"any","value":"","key":"statusId"}]}},"response":[],"_postman_id":"1b904e3e-0f39-416f-86d7-96b1da6b3b13"},{"name":"Get assignee (object)","id":"4ecd89c5-d3ad-49cb-961a-9c5f5f918821","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:8080/api/rest/v1/objects/:type/:code/assignee","description":"Gets current assignee of the object. Since v. 1.10.0
\n","urlObject":{"path":["api","rest","v1","objects",":type",":code","assignee"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"28a5d803-46ba-4d12-bc45-50348e17ed80","description":{"content":"Type of the object
\n","type":"text/plain"},"type":"any","value":"","key":"type"},{"id":"10be5e54-909a-41e5-b15e-c6c1663cf789","description":{"content":"Code of the object
\n","type":"text/plain"},"type":"any","value":"","key":"code"}]}},"response":[],"_postman_id":"4ecd89c5-d3ad-49cb-961a-9c5f5f918821"},{"name":"Set assignee (object)","id":"2873f680-32d0-457d-b997-6a279a8947db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[],"url":"http://localhost:8080/api/rest/v1/objects/:type/:code/:revision/set-assignee/:userId","description":"Sets assignee of the object. Since v. 1.10.0
\n","urlObject":{"path":["api","rest","v1","objects",":type",":code",":revision","set-assignee",":userId"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"f9f122bc-802a-4822-a4db-ac7aa34f42b1","description":{"content":"Type of the object
\n","type":"text/plain"},"type":"any","value":"","key":"type"},{"id":"c49b1749-36fe-49c8-b629-53de67873b80","description":{"content":"Code of the object
\n","type":"text/plain"},"type":"any","value":"","key":"code"},{"id":"a693f7ec-c3f3-445f-94ce-83d496f96427","description":{"content":"Revision of the object
\n","type":"text/plain"},"type":"any","value":"","key":"revision"},{"id":"c3228301-3b08-4774-bdb6-2f0d5d71b764","description":{"content":"Assignee (userId)
\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[],"_postman_id":"2873f680-32d0-457d-b997-6a279a8947db"}],"id":"4e523049-e7be-4b85-a0aa-f768404df8bd","description":"Function to deal with assignees. Read more: https://kbfi.vertex.fi/flow/vastuuhenkilot
\n","_postman_id":"4e523049-e7be-4b85-a0aa-f768404df8bd"},{"name":"Create new object","id":"5b05111a-b941-4201-b0e8-031f0b92c226","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\"description\":\"description\",\r\n\"name\":\"name\",\r\n\"classificationDescr\": \"Osa\",\r\n\"extAttributes\":{\"descr1_fi\":\"kuvaus suomeksi\", \"classification\":\"10|12\"}\r\n}"},"url":"http://localhost:8080/api/rest/v1/objects/:type/:code","description":"Creates new object.
\n","urlObject":{"path":["api","rest","v1","objects",":type",":code"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"ce6a756d-fcad-45d3-961f-4bac2963b441","description":{"content":"Object type (e.g. document, model, drawing, ...)
\n","type":"text/plain"},"type":"any","value":"model","key":"type"},{"id":"deea4fe9-495b-4bb7-89f0-d325c61a051f","description":{"content":"Unique code of the obejct (e.g. D1000012, VX123456), for more info look at the codes section
\n","type":"text/plain"},"type":"any","value":"vx-malli","key":"code"}]}},"response":[{"id":"45418ccd-c978-4afb-a46b-352466e13b88","name":"successful operation","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"revision\": \"0\",\r\n \"type\": \"document\",\r\n \"objCode\": \"D100340\"\r\n}"},"url":"http://localhost:8080/api/rest/v1/objects/connection/:type/:code/:revision","description":"Create connection between objects. Returns true if connection was succesfully made. Returns false if connection already exists.
\n","urlObject":{"path":["api","rest","v1","objects","connection",":type",":code",":revision"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"a1499f1f-08a6-4f6d-9137-417a352a3107","description":{"content":"Type of the object
\n","type":"text/plain"},"type":"any","value":"item","key":"type"},{"id":"1b8afbed-acce-44a9-bbaa-82405d0ac25f","description":{"content":"Unique code of the object
\n","type":"text/plain"},"type":"any","value":"10280","key":"code"},{"id":"6d51b332-cdfb-407c-9fb4-536d61d2f9ae","description":{"content":"Revision of the object
\n","type":"text/plain"},"type":"any","value":"0","key":"revision"}]}},"response":[{"id":"1f199bac-ee24-4880-9ca9-651a55ff8a64","name":"Create connection between objects","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Copy latest revision of document or item to a new object. Since v. 1.10.0.
\n","urlObject":{"path":["api","rest","v1","objects","copy",":type",":code"],"host":["http://localhost:8080"],"query":[{"description":{"content":"New code for copied object
\n","type":"text/plain"},"key":"new-code","value":""}],"variable":[{"id":"e61f4580-b1fa-420f-89e1-1daf9e59c755","description":{"content":"Object type (e.g. document or item)
\n","type":"text/plain"},"type":"any","value":"","key":"type"},{"id":"985d9eed-8e0f-4ed5-88f8-97ded1c4de8a","description":{"content":"Code of the source object (item or document)
\n","type":"text/plain"},"type":"any","value":"","key":"code"}]}},"response":[],"_postman_id":"4b3d51fd-5349-4bc2-baf0-373c1d1e2502"},{"name":"Edit existing object","id":"82ec031d-a2e1-425d-b2ab-8d146c26205e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"description\": \"New description\",\r\n \"objname\": \"New name\",\r\n \"extAttributes\": {\r\n }\r\n}"},"url":"http://localhost:8080/api/rest/v1/objects/:type/:code","description":"Edit metadata of the existing object (latest revision of the object).
\n","urlObject":{"path":["api","rest","v1","objects",":type",":code"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"2af164aa-c90d-4c52-84b6-74dfc10d131a","description":{"content":"Type of the object
\n","type":"text/plain"},"type":"any","value":"","key":"type"},{"id":"b2bd61d3-5aec-494f-9744-09c7c8509d82","description":{"content":"Code of the object
\n","type":"text/plain"},"type":"any","value":"","key":"code"}]}},"response":[{"id":"32fb55f7-15d2-4fae-9d42-efdc068ef049","name":"Internal server error.","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"}],"url":"http://localhost:8080/api/rest/v1/objects/:type/required-attributes","urlObject":{"path":["api","rest","v1","objects",":type","required-attributes"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"50fe4027-0c79-424e-b9ac-2d8405801fad","type":"any","value":"item","key":"type"}]}},"response":[{"id":"f2b088ce-1608-4bc1-b113-2b82efc5c607","name":"successful operation","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"}],"url":"http://localhost:8080/api/rest/v1/objects/:type/attributes","urlObject":{"path":["api","rest","v1","objects",":type","attributes"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"439a7c80-eeab-40ca-8fc4-7d2ed65612f8","type":"any","value":"item","key":"type"}]}},"response":[{"id":"feb6808a-c77e-42a6-a106-d9c7f269cd3c","name":"Internal server error.","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"}],"url":"http://localhost:8080/api/rest/v1/objects/:type/:code/:revision/permissions","description":"Get user permissions of PDM object (eg. read, write, ...).
\n","urlObject":{"path":["api","rest","v1","objects",":type",":code",":revision","permissions"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"18582849-8921-4424-b1ac-8b693f87db47","type":"any","value":"item","key":"type"},{"id":"44bbc67b-439d-4df3-96e6-c5f89aa7813c","type":"any","value":"10280","key":"code"},{"id":"694d3fe9-a917-4a12-9de5-57d757859982","type":"any","value":"0","key":"revision"}]}},"response":[{"id":"2993a0e4-1533-4768-96dd-a24ece3655f1","name":"Successful operation","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Functions to handle product data management objects such as documents, products, projects, items etc... Read for more: https://kbfi.vertex.fi/flow/flow-n-objektit-ja-tyokalut
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2bd7f21e-f612-4751-af66-8cf6fbd9fe74"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b36c1c46-473b-4128-b10d-542fb3a0b7ad"}}],"_postman_id":"25c30313-3eaf-4666-8e00-82780454288f"},{"name":"documents","item":[{"name":"files","item":[{"name":"download","item":[{"name":"primary","item":[{"name":"Download primary file","id":"2d8e5f37-b883-4773-9492-5eb7e7526e9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"baseClass\": \"doc\",\r\n \"type\": \"drawing\",\r\n \"objCode\": \"\",\r\n \"revision\": \"\"\r\n}"},"url":"http://localhost:8080/api/rest/v1/files/download/primary","description":"Download a copy of the primary document file
\n","urlObject":{"path":["api","rest","v1","files","download","primary"],"host":["http://localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"69cba55a-11b7-4d84-9e04-5de5a70a9ef9","name":"You have no permission to the file.","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"}],"url":"http://localhost:8080/api/rest/v1/files/download/primary/:type/:code","description":"Download a copy of the primary document file
\n","urlObject":{"path":["api","rest","v1","files","download","primary",":type",":code"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"caeee97a-1ba4-472f-9c1a-19877c60213b","type":"any","value":"Bearer + JWT token
\n"}],"url":"http://localhost:8080/api/rest/v1/files/download/:fileId","description":"Download a copy of the document file
\n","urlObject":{"path":["api","rest","v1","files","download",":fileId"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"a76fe297-4840-4bae-a16b-2a2193b4fb62","type":"any","value":"Bearer + JWT token
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"objCode\": \"VX3000074\",\r\n \"revision\": \"0\",\r\n \"type\": \"drawing\",\r\n \"baseClass\": \"doc\"\r\n}"},"url":"http://localhost:8080/api/rest/v1/files/download/viewer","description":"Download a copy of the viewer file
\n","urlObject":{"path":["api","rest","v1","files","download","viewer"],"host":["http://localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"b09e9104-7d7a-457e-b009-46e5eee0fa53","name":"Viewer file as stream.","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"http://localhost:8080/api/rest/v1/files/listnames","description":"Get objects file information as JSON without checking permissions
\n","urlObject":{"path":["api","rest","v1","files","listnames"],"host":["http://localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"e556724f-5347-48b6-a6cc-58d576069e9a","name":"You have no permission to document.","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"objCode\": \"D1000X\",\r\n \"revision\": \"1\",\r\n \"baseClass\": \"doc\"\r\n}"},"url":"http://localhost:8080/api/rest/v1/files/list","description":"Get objects file information as JSON.
\n","urlObject":{"path":["api","rest","v1","files","list"],"host":["http://localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"e8b64cb5-0df3-4622-99d0-49a767db94f0","name":"You must login first.","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"},{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"file","value":"Uploads file into file server and simultaneously creates a new document object.
\n","urlObject":{"path":["api","rest","v1","files","upload"],"host":["http://localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"8580caaa-c59f-4613-88e7-1d80de6d3a7f","name":"Body doesn't contain data to save the file","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Function to handle files of the document (e.g. upload or download).
\n","_postman_id":"ed504a1e-be2b-40bc-b446-e70e9fbd6c9c"},{"name":"Checkout the document","id":"9293118e-7353-4309-855d-b4de5b386019","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"http://localhost:8080/api/rest/v1/documents/:type/:code/checkout","description":"Checkout the document object for editing. This is how you prevent other user to edit same document simultaneously
\n","urlObject":{"path":["api","rest","v1","documents",":type",":code","checkout"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"6bb4e13f-1ee0-47ab-bdaf-c03fc0450eef","description":{"content":"Document type identifier (model, drawing, ...)
\n","type":"text/plain"},"type":"any","value":"Unique identifier of the document
\n","type":"text/plain"},"type":"any","value":"Bearer + JWT token
\n"},{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"File to upload
\n","type":"file","value":null},{"key":"checkinComment","value":"comment","description":"Optional description of the changes made (v. 1.9.1)
\n","type":"text"}]},"url":"http://localhost:8080/api/rest/v1/documents/:type/:code/:overwrite/:newRevision/checkin","description":"Checks in document and uploads new file for latest or new revision.
\n","urlObject":{"path":["api","rest","v1","documents",":type",":code",":overwrite",":newRevision","checkin"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"80c64360-7f81-4fd3-844d-ef842597eba6","description":{"content":"Document type
\n","type":"text/plain"},"type":"any","value":"document","key":"type"},{"id":"b75e5a87-d69a-4972-b92c-e0a21aa2c59f","description":{"content":"Unique code of the document
\n","type":"text/plain"},"type":"any","value":"code-value","key":"code"},{"id":"507e8ccb-01b0-4bbd-9eca-b399b0236545","description":{"content":"Overwrite or create new revison, true / false
\n","type":"text/plain"},"type":"any","value":"true","key":"overwrite"},{"id":"e687f57c-47fa-4ea5-bf4c-8392aa5fcb93","description":{"content":"Revision identifier, e.g. A, B
\n","type":"text/plain"},"type":"any","value":"0","key":"newRevision"}]}},"response":[],"_postman_id":"7e59929f-7fae-4633-a255-3943b6b09559"},{"name":"Uncheck object","id":"5eeee111-12cc-46ec-98b5-bac1dcd75fe4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"extAttributes\": {\"checkoutComment\": \"test\"}\r\n}"},"url":"http://localhost:8080/api/rest/v1/documents/:type/:code/uncheck","description":"Changes is not made, undo changes and release the object for other users..
\n","urlObject":{"path":["api","rest","v1","documents",":type",":code","uncheck"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"9a36c1d8-421c-430a-a3f8-02d19f08168d","description":{"content":"Document type identifier (model, drawing, ...)
\n","type":"text/plain"},"type":"any","value":"Unique identifier of the item object
\n","type":"text/plain"},"type":"any","value":"Bearer + JWT token
\n"},{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"Document file to upload
\n","type":"file","value":null}]},"url":"http://localhost:8080/api/rest/v1/documents/:type/:code/:revision/uploadFile/:primary","description":"Uploads a new file for a existing document object (latest revision). New revision is created.
\n","urlObject":{"path":["api","rest","v1","documents",":type",":code",":revision","uploadFile",":primary"],"host":["http://localhost:8080"],"query":[],"variable":[{"id":"6910969b-e68d-4bab-ae27-dce883c0fd7d","description":{"content":"Document type identifier (model, drawing, ...)
\n","type":"text/plain"},"type":"any","value":"model","key":"type"},{"id":"c91b1a5c-d80e-4130-a584-58c4ad3fa7ec","description":{"content":"Unique identifier of the document
\n","type":"text/plain"},"type":"any","value":"VX3001504","key":"code"},{"id":"0f765ad2-92e4-4d78-9d1e-c17df34bb247","description":{"content":"Revision identifier of the document
\n","type":"text/plain"},"type":"any","value":"0","key":"revision"},{"id":"c695e0a0-9eed-4df8-91f2-cebd362128f2","type":"any","value":"true","key":"primary"}]}},"response":[{"id":"164ab120-7772-4e93-b07b-bffdfbc5095e","name":"successful operation","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer + JWT token
\n"},{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"File to upload
\n","type":"file","value":null}]},"url":"http://localhost:8080/api/rest/v1/documents/:type/:code/:revision/uploadFile/viewer?create-thumbnail=false","description":"Uploads a new viewer file for a existing document object.
\n","urlObject":{"path":["api","rest","v1","documents",":type",":code",":revision","uploadFile","viewer"],"host":["http://localhost:8080"],"query":[{"description":{"content":"Generate thumbnail preview image from uploaded pdf viewer file. Default false. (since Flow 26.0.3)
\n","type":"text/plain"},"key":"create-thumbnail","value":"false"}],"variable":[{"description":{"content":"Type (id) of the document
\n","type":"text/plain"},"type":"any","value":"","key":"type"},{"description":{"content":"Unique code of the document
\n","type":"text/plain"},"type":"any","value":"","key":"code"},{"description":{"content":"Revision identifier
\n","type":"text/plain"},"type":"any","value":"","key":"revision"}]}},"response":[{"id":"7d1fa15a-3a60-4cde-b0b3-0b02420431ad","name":"Object must be checked out by user","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"