> For the complete documentation index, see [llms.txt](https://knowledge.out-smart.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledge.out-smart.com/openapi/objects.md). # Objects ## Get objects by filter > This api is used to fetch objects based on a filter. Filters can be given by adding a key and values array to the URL.\ > Adding a single filter: \&key=key1\&value=value1\ > Adding multiple filters: \&key\[]=key1\&value\[]=value1\&key\[]=key2\&value\[]=value2 ```json {"openapi":"3.1.0","info":{"title":"OpenApi","version":"1.0.0"},"servers":[{"url":"{{api_url}}"},{"url":"https://www.werkbonapp.nl"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/openapi/8/object/":{"get":{"summary":"Get objects by filter","parameters":[{"name":"token","in":"query","schema":{"type":"string"}},{"name":"software_token","in":"query","schema":{"type":"string"}},{"name":"key","in":"query","schema":{"type":"string"}},{"name":"value","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Response_200"}},"tags":["Objects"],"description":"This api is used to fetch objects based on a filter. Filters can be given by adding a key and values array to the URL.\nAdding a single filter: &key=key1&value=value1\nAdding multiple filters: &key[]=key1&value[]=value1&key[]=key2&value[]=value2"}}}} ``` ## Get objects > This api is used to sync objects with WorkorderApp.\ > Each object record can contain the following data:\ > \ > \| Parameter | Description | Required | Type (size) |\ > \|---------------------------|---------------------------------------------------------------------------------------------------------------------------|----------|---------------|\ > \| obj\_code | Unique code of the object. Used as reference for other entities | Y | Varchar (255) |\ > \| obj\_sup\_code | Supplier code. Used as reference to supplier entity | N | Varchar (255) |\ > \| obj\_debiteur\_nummer | Debtor number. Used as reference to customer clients. | Y | Varchar (255) |\ > \| obj\_adr\_code | Address code. Used as a reference to the addres of a customer client. | N | Varchar (255) |\ > \| obj\_obj\_code | Parent object code. | N | Varchar (255) |\ > \| obj\_image | Url of the image name. POST: An external url should be provided. GET: You will receive a workorderapp url. | N | Varchar (255) |\ > \| obj\_description | Description of the object | Y | Varchar (255) |\ > \| obj\_price | Price of the object | N | Decimal (7,2) |\ > \| obj\_floor\_level | Floor level of the object | N | Int (10) |\ > \| obj\_location | Textual description of the location of the object | N | Varchar (255) |\ > \| obj\_latitude | Latitude of the location of the object | N | Float (10,6) |\ > \| obj\_longitude | Longitude of the location of the object | N | Float (10,6) |\ > \| obj\_type | Type | N | Varchar (255) |\ > \| obj\_model | Model | N | Varchar (255) |\ > \| obj\_brand | Brand | N | Varchar (255) |\ > \| obj\_date\_warranty\_expires | Expiration date of the warranty | N | Varchar (255) |\ > \| obj\_serialnumber | Serialnumber of the object | N | Varchar (255) |\ > \| obj\_date\_last\_inspection | Date of last inspection | N | Varchar (255) |\ > \| obj\_date\_installation | Date of installation | N | Varchar (255) |\ > \| obj\_freefield\_1 | | N | Varchar (255) |\ > \| obj\_freefield\_2 | | N | Varchar (255) |\ > \| obj\_freefield\_3 | | N | Varchar (255) |\ > \| obj\_freefield\_4 | | N | Varchar (255) |\ > \| obj\_freefield\_5 | | N | Varchar (255) |\ > \| obj\_freefield\_6 | | N | Varchar (255) |\ > \| obj\_freefield\_7 | | N | Varchar (255) |\ > \| obj\_freefield\_8 | | N | Varchar (255) |\ > \| obj\_freefield\_9 | | N | Varchar (255) |\ > \| obj\_freefield\_10 | | N | Varchar (255) |\ > \| obj\_freefield\_11 | | N | Varchar (255) |\ > \| obj\_freefield\_12 | | N | Varchar (255) |\ > \| obj\_freefield\_13 | | N | Varchar (255) |\ > \| obj\_freefield\_14 | | N | Varchar (255) |\ > \| obj\_freefield\_15 | | N | Varchar (255) |\ > \| obj\_freefield\_16 | | N | Varchar (255) |\ > \| obj\_freefield\_17 | | N | Varchar (255) |\ > \| obj\_freefield\_18 | | N | Varchar (255) |\ > \| obj\_freefield\_19 | | N | Varchar (255) |\ > \| obj\_freefield\_20 | | N | Varchar (255) |\ > \| obj\_order | Sort order of an object | N | Int (10) |\ > \| obj\_created | Timestamp of creating | N | DateTime |\ > \| obj\_modified | Timestamp of modifying | N | DateTime | ```json {"openapi":"3.1.0","info":{"title":"OpenApi","version":"1.0.0"},"servers":[{"url":"{{api_url}}"},{"url":"https://www.werkbonapp.nl"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/objects/":{"get":{"summary":"Get objects","parameters":[{"name":"token","in":"query","schema":{"type":"string"}},{"name":"software_token","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Response_200"}},"tags":["Objects"],"description":"This api is used to sync objects with WorkorderApp.\nEach object record can contain the following data:\n\n| Parameter | Description | Required | Type (size) |\n|---------------------------|---------------------------------------------------------------------------------------------------------------------------|----------|---------------|\n| obj_code | Unique code of the object. Used as reference for other entities | Y | Varchar (255) |\n| obj_sup_code | Supplier code. Used as reference to supplier entity | N | Varchar (255) |\n| obj_debiteur_nummer | Debtor number. Used as reference to customer clients. | Y | Varchar (255) |\n| obj_adr_code | Address code. Used as a reference to the addres of a customer client. | N | Varchar (255) |\n| obj_obj_code | Parent object code. | N | Varchar (255) |\n| obj_image | Url of the image name. POST: An external url should be provided. GET: You will receive a workorderapp url. | N | Varchar (255) |\n| obj_description | Description of the object | Y | Varchar (255) |\n| obj_price | Price of the object | N | Decimal (7,2) |\n| obj_floor_level | Floor level of the object | N | Int (10) |\n| obj_location | Textual description of the location of the object | N | Varchar (255) |\n| obj_latitude | Latitude of the location of the object | N | Float (10,6) |\n| obj_longitude | Longitude of the location of the object | N | Float (10,6) |\n| obj_type | Type | N | Varchar (255) |\n| obj_model | Model | N | Varchar (255) |\n| obj_brand | Brand | N | Varchar (255) |\n| obj_date_warranty_expires | Expiration date of the warranty | N | Varchar (255) |\n| obj_serialnumber | Serialnumber of the object | N | Varchar (255) |\n| obj_date_last_inspection | Date of last inspection | N | Varchar (255) |\n| obj_date_installation | Date of installation | N | Varchar (255) |\n| obj_freefield_1 | | N | Varchar (255) |\n| obj_freefield_2 | | N | Varchar (255) |\n| obj_freefield_3 | | N | Varchar (255) |\n| obj_freefield_4 | | N | Varchar (255) |\n| obj_freefield_5 | | N | Varchar (255) |\n| obj_freefield_6 | | N | Varchar (255) |\n| obj_freefield_7 | | N | Varchar (255) |\n| obj_freefield_8 | | N | Varchar (255) |\n| obj_freefield_9 | | N | Varchar (255) |\n| obj_freefield_10 | | N | Varchar (255) |\n| obj_freefield_11 | | N | Varchar (255) |\n| obj_freefield_12 | | N | Varchar (255) |\n| obj_freefield_13 | | N | Varchar (255) |\n| obj_freefield_14 | | N | Varchar (255) |\n| obj_freefield_15 | | N | Varchar (255) |\n| obj_freefield_16 | | N | Varchar (255) |\n| obj_freefield_17 | | N | Varchar (255) |\n| obj_freefield_18 | | N | Varchar (255) |\n| obj_freefield_19 | | N | Varchar (255) |\n| obj_freefield_20 | | N | Varchar (255) |\n| obj_order | Sort order of an object | N | Int (10) |\n| obj_created | Timestamp of creating | N | DateTime |\n| obj_modified | Timestamp of modifying | N | DateTime |"}}}} ``` ## Add object > This api is used to sync objects with WorkorderApp.\ > Each object record can contain the following data:\ > \ > \| Parameter | Description | Required | Type (size) |\ > \|---------------------------|---------------------------------------------------------------------------------------------------------------------------|----------|---------------|\ > \| obj\_code | Unique code of the object. Used as reference for other entities | Y | Varchar (255) |\ > \| obj\_sup\_code | Supplier code. Used as reference to supplier entity | N | Varchar (255) |\ > \| obj\_debiteur\_nummer | Debtor number. Used as reference to customer clients. | Y | Varchar (255) |\ > \| obj\_adr\_code | Address code. Used as a reference to the addres of a customer client. | N | Varchar (255) |\ > \| obj\_obj\_code | Parent object code. | N | Varchar (255) |\ > \| obj\_image | Url of the image name. POST: An external url should be provided. GET: You will receive a workorderapp url. | N | Varchar (255) |\ > \| obj\_description | Description of the object | Y | Varchar (255) |\ > \| obj\_price | Price of the object | N | Decimal (7,2) |\ > \| obj\_floor\_level | Floor level of the object | N | Int (10) |\ > \| obj\_location | Textual description of the location of the object | N | Varchar (255) |\ > \| obj\_latitude | Latitude of the location of the object | N | Float (10,6) |\ > \| obj\_longitude | Longitude of the location of the object | N | Float (10,6) |\ > \| obj\_type | Type | N | Varchar (255) |\ > \| obj\_model | Model | N | Varchar (255) |\ > \| obj\_brand | Brand | N | Varchar (255) |\ > \| obj\_date\_warranty\_expires | Expiration date of the warranty | N | Varchar (255) |\ > \| obj\_serialnumber | Serialnumber of the object | N | Varchar (255) |\ > \| obj\_date\_last\_inspection | Date of last inspection | N | Varchar (255) |\ > \| obj\_date\_installation | Date of installation | N | Varchar (255) |\ > \| obj\_freefield\_1 | | N | Varchar (255) |\ > \| obj\_freefield\_2 | | N | Varchar (255) |\ > \| obj\_freefield\_3 | | N | Varchar (255) |\ > \| obj\_freefield\_4 | | N | Varchar (255) |\ > \| obj\_freefield\_5 | | N | Varchar (255) |\ > \| obj\_freefield\_6 | | N | Varchar (255) |\ > \| obj\_freefield\_7 | | N | Varchar (255) |\ > \| obj\_freefield\_8 | | N | Varchar (255) |\ > \| obj\_freefield\_9 | | N | Varchar (255) |\ > \| obj\_freefield\_10 | | N | Varchar (255) |\ > \| obj\_freefield\_11 | | N | Varchar (255) |\ > \| obj\_freefield\_12 | | N | Varchar (255) |\ > \| obj\_freefield\_13 | | N | Varchar (255) |\ > \| obj\_freefield\_14 | | N | Varchar (255) |\ > \| obj\_freefield\_15 | | N | Varchar (255) |\ > \| obj\_freefield\_16 | | N | Varchar (255) |\ > \| obj\_freefield\_17 | | N | Varchar (255) |\ > \| obj\_freefield\_18 | | N | Varchar (255) |\ > \| obj\_freefield\_19 | | N | Varchar (255) |\ > \| obj\_freefield\_20 | | N | Varchar (255) |\ > \| obj\_order | Sort order of an object | N | Int (10) |\ > \| obj\_created | Timestamp of creating | N | DateTime |\ > \| obj\_modified | Timestamp of modifying | N | DateTime | ```json {"openapi":"3.1.0","info":{"title":"OpenApi","version":"1.0.0"},"servers":[{"url":"{{api_url}}"},{"url":"https://www.werkbonapp.nl"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/objects/":{"post":{"summary":"Add object","parameters":[{"name":"token","in":"query","schema":{"type":"string"}},{"name":"software_token","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Response_200"}},"tags":["Objects"],"description":"This api is used to sync objects with WorkorderApp.\nEach object record can contain the following data:\n\n| Parameter | Description | Required | Type (size) |\n|---------------------------|---------------------------------------------------------------------------------------------------------------------------|----------|---------------|\n| obj_code | Unique code of the object. Used as reference for other entities | Y | Varchar (255) |\n| obj_sup_code | Supplier code. Used as reference to supplier entity | N | Varchar (255) |\n| obj_debiteur_nummer | Debtor number. Used as reference to customer clients. | Y | Varchar (255) |\n| obj_adr_code | Address code. Used as a reference to the addres of a customer client. | N | Varchar (255) |\n| obj_obj_code | Parent object code. | N | Varchar (255) |\n| obj_image | Url of the image name. POST: An external url should be provided. GET: You will receive a workorderapp url. | N | Varchar (255) |\n| obj_description | Description of the object | Y | Varchar (255) |\n| obj_price | Price of the object | N | Decimal (7,2) |\n| obj_floor_level | Floor level of the object | N | Int (10) |\n| obj_location | Textual description of the location of the object | N | Varchar (255) |\n| obj_latitude | Latitude of the location of the object | N | Float (10,6) |\n| obj_longitude | Longitude of the location of the object | N | Float (10,6) |\n| obj_type | Type | N | Varchar (255) |\n| obj_model | Model | N | Varchar (255) |\n| obj_brand | Brand | N | Varchar (255) |\n| obj_date_warranty_expires | Expiration date of the warranty | N | Varchar (255) |\n| obj_serialnumber | Serialnumber of the object | N | Varchar (255) |\n| obj_date_last_inspection | Date of last inspection | N | Varchar (255) |\n| obj_date_installation | Date of installation | N | Varchar (255) |\n| obj_freefield_1 | | N | Varchar (255) |\n| obj_freefield_2 | | N | Varchar (255) |\n| obj_freefield_3 | | N | Varchar (255) |\n| obj_freefield_4 | | N | Varchar (255) |\n| obj_freefield_5 | | N | Varchar (255) |\n| obj_freefield_6 | | N | Varchar (255) |\n| obj_freefield_7 | | N | Varchar (255) |\n| obj_freefield_8 | | N | Varchar (255) |\n| obj_freefield_9 | | N | Varchar (255) |\n| obj_freefield_10 | | N | Varchar (255) |\n| obj_freefield_11 | | N | Varchar (255) |\n| obj_freefield_12 | | N | Varchar (255) |\n| obj_freefield_13 | | N | Varchar (255) |\n| obj_freefield_14 | | N | Varchar (255) |\n| obj_freefield_15 | | N | Varchar (255) |\n| obj_freefield_16 | | N | Varchar (255) |\n| obj_freefield_17 | | N | Varchar (255) |\n| obj_freefield_18 | | N | Varchar (255) |\n| obj_freefield_19 | | N | Varchar (255) |\n| obj_freefield_20 | | N | Varchar (255) |\n| obj_order | Sort order of an object | N | Int (10) |\n| obj_created | Timestamp of creating | N | DateTime |\n| obj_modified | Timestamp of modifying | N | DateTime |"}}}} ``` ## Get changed objects > This api is used to fetch changed objects. A change can be made from the app. Once the information is processed the api can be called with the obj\_code parameter. The changed indicator will be set to 0 so the record won't be shown again. ```json {"openapi":"3.1.0","info":{"title":"OpenApi","version":"1.0.0"},"servers":[{"url":"{{api_url}}"},{"url":"https://www.werkbonapp.nl"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/objects/changed/":{"get":{"summary":"Get changed objects","parameters":[{"name":"token","in":"query","schema":{"type":"string"}},{"name":"software_token","in":"query","schema":{"type":"string"}},{"name":"obj_code","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Response_200"}},"tags":["Objects"],"description":"This api is used to fetch changed objects. A change can be made from the app. Once the information is processed the api can be called with the obj_code parameter. The changed indicator will be set to 0 so the record won't be shown again."}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://knowledge.out-smart.com/openapi/objects.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.