dalux-client 0.1.3

Add your description here

swagger-client

Getting started To access data objects through a service, a customer specific API key is required. Contact [e-mail] to activate the API for your company profile if you have not done so already. The key is tied to individual API identities found in settings under API identities. # Calling a service The documentation only provides a part of the url specified for requests, e.g. GET /4.0/projects To complete the request, you must append the API base url. The base URL is optained by contacting [e-mail]. to get all projects, you would call {BASE_URL}/4.0/projects Authorization is provided by adding your API key to a header parameter called ‘X-API-KEY’ Example with curl curl GET '{BASE_URL}/4.0/projects' --header 'X-API-KEY: {YOUR_API_KEY}' # Common object model Dalux expose a number of API's. They share an overarching object architecture which is described in a Common object model

This Python package is automatically generated by the Swagger Codegen project:

• API version: 4.12
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 3.14+

Installation & Usage

pip install

pip install dalux-client

Then import the package:

import dalux_client 

Then import the package:

import dalux_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import dalux_client
from dalux_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
configuration = dalux_client.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = dalux_client.CompaniesApi(dalux_client.ApiClient(configuration))
project_id = 'project_id_example' # str | The ID of the project
company_id = 'company_id_example' # str | ID of the company

try:
    api_response = api_instance.get_project_company(project_id, company_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompaniesApi->get_project_company: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = dalux_client.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = dalux_client.CompaniesApi(dalux_client.ApiClient(configuration))
project_id = 'project_id_example' # str | The ID of the project

try:
    api_response = api_instance.list_project_companies(project_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompaniesApi->list_project_companies: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = dalux_client.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = dalux_client.CompaniesApi(dalux_client.ApiClient(configuration))
body = dalux_client.ProjectCompany() # ProjectCompany | Assign a valid company id from the company-catalog to the catalogCompanyId, in order to establish a link between this company and one listed in the company-catalog. Linking will import name, vatNumber and address from the corresponding company in the company-catalog. Changing the vatNumber on a linked company will unlink the company from the company-catalog.
project_id = 'project_id_example' # str | The ID of the project
company_id = 'company_id_example' # str | ID of the company

try:
    api_response = api_instance.patch_project_company(body, project_id, company_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompaniesApi->patch_project_company: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = dalux_client.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = dalux_client.CompaniesApi(dalux_client.ApiClient(configuration))
body = dalux_client.ProjectCompany() # ProjectCompany | Assign a valid company id from the company-catalog to the catalogCompanyId, in order to establish a link between this company and one listed in the company-catalog. Linking will import name, vatNumber and address from the corresponding company in the company-catalog. Changing the vatNumber on a linked company will unlink the company from the company-catalog.
project_id = 'project_id_example' # str | The ID of the project

try:
    api_response = api_instance.post_project_company(body, project_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompaniesApi->post_project_company: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
CompaniesApi	get_project_company	GET /3.0/projects/{projectId}/companies/{companyId}
CompaniesApi	list_project_companies	GET /3.1/projects/{projectId}/companies
CompaniesApi	patch_project_company	PATCH /3.0/projects/{projectId}/companies/{companyId}
CompaniesApi	post_project_company	POST /3.1/projects/{projectId}/companies
CompanyCatalogApi	get_companies	GET /2.2/companyCatalog	Get companies registrered on the company-catalog
CompanyCatalogApi	get_company	GET /1.2/companyCatalog/{catalogCompanyId}
CompanyCatalogApi	list_company_metadata	GET /1.0/companyCatalog/{catalogCompanyId}/metadata	Get metadata of a specific company from the company-catalog
CompanyCatalogApi	list_company_metadata_mappings	GET /1.0/companyCatalog/{catalogCompanyId}/metadata/1.0/mappings	Get all metadata available for a PATCH company-catalog operation
CompanyCatalogApi	list_company_metadata_values	GET /1.0/companyCatalog/{catalogCompanyId}/metadata/1.0/mappings/{key}/values	Get available values for metadata in a PATCH company-catalog operation
CompanyCatalogApi	list_metadata_mappings_for_companies	GET /1.0/companyCatalog/metadata/1.0/mappings	Get all metadata available for a POST company-catalog operation
CompanyCatalogApi	list_metadata_values_for_companies	GET /1.0/companyCatalog/metadata/1.0/mappings/{key}/values	Get available values for metadata in a POST company-catalog operation
CompanyCatalogApi	patch_company	PATCH /2.1/companyCatalog/{catalogCompanyId}
CompanyCatalogApi	post_company	POST /2.2/companyCatalog
FileAreasApi	getfilearea	GET /1.0/projects/{projectId}/file_areas/{fileAreaId}	Retrieve a specific file area
FileAreasApi	getfileareas	GET /5.1/projects/{projectId}/file_areas	Retrieve the file areas on the given project
FileRevisionsApi	get_file_revision_content	GET /2.0/projects/{projectId}/file_areas/{fileAreaId}/files/{fileId}/revisions/{fileRevisionId}/content	Retrieve content of a specific revision
FileUploadApi	create_upload	POST /1.0/projects/{projectId}/file_areas/{fileAreaId}/upload	Create a new upload slot and return a GUID pointing to that slot
FileUploadApi	finish_upload	POST /2.0/projects/{projectId}/file_areas/{fileAreaId}/upload/{uploadGuid}/finalize	Finish uploading a file
FileUploadApi	upload_file_part	POST /1.0/projects/{projectId}/file_areas/{fileAreaId}/upload/{uploadGuid}	Upload a part of a file
FilesApi	get_file_properties_mapping	GET /1.0/projects/{projectId}/file_areas/{fileAreaId}/files/{fileId}/properties/1.0/mappings	Retrieve properties mapping for a specific file.
FilesApi	get_file_property_mapping_values	GET /1.0/projects/{projectId}/file_areas/{fileAreaId}/files/properties/1.0/mappings/{filePropertyId}/values	Retrieve valid property values for a specific file property mapping
FilesApi	getfile	GET /5.0/projects/{projectId}/file_areas/{fileAreaId}/files/{fileId}	Retrieve a specific file
FilesApi	list_files	GET /6.0/projects/{projectId}/file_areas/{fileAreaId}/files	Browse all files on the given project
FoldersApi	get_folder	GET /5.0/projects/{projectId}/file_areas/{fileAreaId}/folders/{folderId}	Retrieve a specific folder
FoldersApi	get_folder_files_properties	GET /1.0/projects/{projectId}/file_areas/{fileAreaId}/folders/{folderId}/files/properties/1.0/mappings	Retrieve all properties for each file type in a specific folder
FoldersApi	list_folders	GET /5.1/projects/{projectId}/file_areas/{fileAreaId}/folders	Browse all folders on the given project
FormsApi	get_form	GET /1.2/projects/{projectId}/forms/{formId}	Retrieve a specific form
FormsApi	get_project_form_attachments	GET /2.1/projects/{projectId}/forms/attachments	Retrieve attachments on forms on a project in incremental updates
FormsApi	get_project_forms	GET /2.1/projects/{projectId}/forms	Retrieve forms on a project
InspectionPlansApi	list_inspection_plan_item_zones	GET /1.1/projects/{projectId}/inspectionPlanItemZones	Browse all inspection plan item zones on the given project
InspectionPlansApi	list_inspection_plan_items	GET /1.1/projects/{projectId}/inspectionPlanItems	Browse all inspection plan items on the given project
InspectionPlansApi	list_inspection_plan_registrations	GET /2.1/projects/{projectId}/inspectionPlanRegistrations	Browse all inspection plan registrations on the given project, excluding planned registrations
InspectionPlansApi	list_inspection_plans	GET /1.2/projects/{projectId}/inspectionPlans	Browse all inspection plans on the given project
ProjectTemplatesApi	list_project_templates	GET /1.1/projectTemplates	Get all available project templates on the company profile
ProjectsApi	get_project	GET /5.0/projects/{projectId}	Get a specific project
ProjectsApi	list_metadata_mappings_for_projects	GET /1.0/projects/metadata/1.0/mappings	Get all metadata available for POST project operations
ProjectsApi	list_metadata_values_for_projects	GET /1.0/projects/metadata/1.0/mappings/{key}/values	Get available values for metadata in POST project operation
ProjectsApi	list_project_metadata	GET /1.0/projects/{projectId}/metadata	Get metadata of a specific project
ProjectsApi	list_project_metadata_mappings	GET /1.0/projects/{projectId}/metadata/1.0/mappings	Get all metadata available for PATCH project operations
ProjectsApi	list_project_metadata_values	GET /1.0/projects/{projectId}/metadata/1.0/mappings/{key}/values	Get available values for metadata in PATCH project operation
ProjectsApi	list_projects	GET /5.1/projects	Get all available projects
ProjectsApi	patch_project	PATCH /5.0/projects/{projectId}	update a project
ProjectsApi	post_project	POST /5.0/projects	Create a new project
TasksApi	get_project_task_attachments	GET /1.1/projects/{projectId}/tasks/attachments	Retrieve attachments on tasks on a project
TasksApi	get_project_task_changes	GET /2.2/projects/{projectId}/tasks/changes	Retrieve task, approval, safety issue, safety observation and good practice changes on a project
TasksApi	get_project_tasks	GET /5.1/projects/{projectId}/tasks	Retrieve tasks, approvals, safety issues, safety observations and good practices on a project
TasksApi	get_task	GET /3.3/projects/{projectId}/tasks/{taskId}	Retrieve a specific task/approval/safety issue/safety observation/good practice
TestPlansApi	list_test_plan_item_zones	GET /1.1/projects/{projectId}/testPlanItemZones	Browse all test plan item zones on the given project
TestPlansApi	list_test_plan_items	GET /1.1/projects/{projectId}/testPlanItems	Browse all test plan items on the given project
TestPlansApi	list_test_plan_registrations	GET /1.1/projects/{projectId}/testPlanRegistrations	Browse all test plan registrations on the given project, excluding planned registrations
TestPlansApi	list_test_plans	GET /1.2/projects/{projectId}/testPlans	Browse all test plans on the given project
UsersApi	get_project_user	GET /1.1/projects/{projectId}/users/{userId}	Get user on project
UsersApi	get_user	GET /1.1/users/{userId}	Get a specific user
UsersApi	list_project_users	GET /1.2/projects/{projectId}/users	Get users on project
VersionSetsApi	get_version_set	GET /2.0/projects/{projectId}/version_sets/{versionSetId}	Retrieve a specific version set
VersionSetsApi	get_version_sets	GET /2.1/projects/{projectId}/version_sets	Retrieve the version sets on the given project
VersionSetsApi	list_file_area_sersion_sets	GET /2.1/projects/{projectId}/file_areas/{fileAreaId}/version_sets	Browse all version sets on the given file area and project
VersionSetsApi	list_version_set_files	GET /3.0/projects/{projectId}/version_sets/{versionSetId}/files	Browse all files on the given project and given version set
WorkPackagesApi	list_workpackages	GET /1.0/projects/{projectId}/workpackages	Browse all work packages on the given project

Documentation For Models

• ApiTaskGet
• BIMObject
• BasicFieldMapping
• BuildingReference
• CatalogCompanyMetadata
• CatalogCompanyMetadataFieldValue
• CatalogueCompany
• Coordinate3D
• DateChange
• DateMappingValue
• DateTimeMappingValue
• DrawingReference
• ErrorField
• ErrorModel
• File
• FileArea
• FileDateProperty
• FileIntegerProperty
• FilePropertyField
• FilePropertyMapping
• FileReferenceProperty
• FileTextProperty
• Folder
• Form
• FormAttachment
• FormAttachmentRelation
• FormAttachmentRelationUserDefinedField
• FormUserDefinedFields
• FormUserFieldRelation
• Gps
• InlineResponse200
• InlineResponse2001
• InlineResponse20010
• InlineResponse20011
• InlineResponse20012
• InlineResponse20012Items
• InlineResponse20013
• InlineResponse20014
• InlineResponse20014Items
• InlineResponse20015
• InlineResponse20016
• InlineResponse20017
• InlineResponse20017Items
• InlineResponse20018
• InlineResponse20019
• InlineResponse20019Items
• InlineResponse2002
• InlineResponse20020
• InlineResponse20020Metadata
• InlineResponse20021
• InlineResponse20022
• InlineResponse20023
• InlineResponse20024
• InlineResponse20025
• InlineResponse20026
• InlineResponse20027
• InlineResponse20028
• InlineResponse20029
• InlineResponse2003
• InlineResponse20030
• InlineResponse20031
• InlineResponse20031Items
• InlineResponse20032
• InlineResponse20033
• InlineResponse20034
• InlineResponse20034Items
• InlineResponse20035
• InlineResponse20036
• InlineResponse20037
• InlineResponse20038
• InlineResponse20038Items
• InlineResponse20039
• InlineResponse2004
• InlineResponse20040
• InlineResponse20041
• InlineResponse2004Items
• InlineResponse2005
• InlineResponse2006
• InlineResponse2007
• InlineResponse2008
• InlineResponse2009
• InlineResponse200Items
• InlineResponse201
• InspectionPlan
• InspectionPlanItem
• InspectionPlanItemRelation
• InspectionPlanItemZone
• InspectionPlanRegistration
• IntegerMappingValue
• LevelReference
• Link
• ListReferenceMappingValue
• ListReferenceMappingValueReference
• ListResponse
• Location
• LocationChange
• LocationCoordinate
• MappingObject
• MappingValue
• MediaFile
• ObjectReference
• ObjectResponse
• OneOfFilePropertyFieldValuesItems
• PatchCatalogueCompany
• PatchProject
• PlanBase
• PlanItemBase
• PlanItemZoneBase
• PlanRegistrationBase
• PostCatalogueCompany
• PostProject
• Project
• ProjectCompany
• ProjectMetadata
• ProjectMetadataFieldValue
• ProjectModule
• ProjectTemplate
• ProjectUser
• Reference
• Response
• RoleRelation
• RoomReference
• TaskAttachmentRelation
• TaskChangeFields
• TaskChanges
• TaskTypeReference
• TemplateReference
• TestPlan
• TestPlanItem
• TestPlanItemRelation
• TestPlanItemZone
• TestPlanRegistration
• TextMappingValue
• TotalItemsMetadata
• TotalItemsMetadataMetadata
• TotalRemainingItemsMetadata
• TotalRemainingItemsMetadataMetadata
• UploadGuid
• UploadGuidFinalizeBody
• User
• UserDefinedField
• UserFieldValue
• UserRelation
• VersionSet
• WorkflowReference
• Workpackage
• ZoneLayerReference
• ZoneReference
• ZoneSelection

Documentation For Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header

Author

[e-mail]