Batch Integrate Companies with an External Data Source
post
/api/restapi/company/syncBatch
Send a request to this endpoint to create or update one or more integrated companies. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityExternallySourcedCompanyInput
Type:
object
Title:
ApiEntityExternallySourcedCompanyInput
This entity represents a ExternallySourcedCompany object, a unique ExternallySourcedCompany object can be identified by the following combinations of the fields.
Show Source
- companyId
- companyName,postalCode,countryCode
-
addressLine1: string
Minimum Length:
0
Maximum Length:200
The first line of the address of a location.
This might be the building number and street address. -
addressLine2: string
Minimum Length:
0
Maximum Length:200
The second line of the address of a location.
This might be a neighborhood or town. -
businessRoleTypes: array
businessRoleTypes
The business types for a company.
-
cityName(required): string
Minimum Length:
0
Maximum Length:200
The city name for a location. -
companyEnterpriseCertifications: array
companyEnterpriseCertifications
List of enterprise certifications held by the company.
-
companyId: integer
(int64)
The system-generated identifier of a company.
-
companyLaborTypes: array
companyLaborTypes
List of labor union types applicable for the company.
-
companyName(required): string
Minimum Length:
1
Maximum Length:255
The name of the company. -
companyWorkTypes: array
companyWorkTypes
List of types of work or specialties of the company.
-
configuredFields: array
configuredFields
The list of configured fields for a company.
-
countryCode(required): string
Minimum Length:
0
Maximum Length:3
The country for a location. -
description: string
Minimum Length:
0
Maximum Length:4000
Additional information about the company. -
distance: number(double)Read Only:true
Deprecated. As of 23.12.The distance the company is willing to travel for the project from the corporate office. -
distanceMetric: stringRead Only:true
Allowed Values:[ "KILOMETERS", "MILES" ]
Deprecated. As of 23.12.The distance measure to be used for corporate office distance. Valid options include kilometer and mile. -
fax: string
Minimum Length:
0
Maximum Length:32
The fax number for the company. -
isTenantOwned: booleanRead Only:true
Deprecated. As of 23.12.Indicates whether or not the company is an application tenant. -
latitude: number
(double)
Minimum Value:
-90
Maximum Value:90
The latitude of a company. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
longitude: number
(double)
Minimum Value:
-180
Maximum Value:180
The geographical coordinate for the longitude of the location.
The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service. -
offices: arrayofficesRead Only:true
Deprecated. As of 23.12.Offices associated with the company. -
organizationId: integer
(int64)
The unique identifier for the organization.
-
performanceRating: string
Allowed Values:
[ "NO_PERFORMANCE_RATING", "PERFORMANCE_LEVEL_FIVE", "PERFORMANCE_LEVEL_FOUR", "PERFORMANCE_LEVEL_THREE", "PERFORMANCE_LEVEL_TWO", "PERFORMANCE_LEVEL_ONE" ]
Performance Rating of a Company determined by the tenant. -
phone: string
Minimum Length:
0
Maximum Length:32
The phone number for the company. -
postalCode(required): string
Minimum Length:
0
Maximum Length:20
The postal code, post code, or zip code of a location. -
qualificationStatus: string
Allowed Values:
[ "CONDITIONALLY_QUALIFIED", "NOT_QUALIFIED", "NO_STATUS", "QUALIFIED" ]
Qualification status of a Company according to the tenant -
sourceId: string
Maximum Length:
255
The unique identifier of company data in an external source.Example:coarse
-
sourceSiteId: string
Maximum Length:
255
The unique identifier of a company site in an external source. -
stateName(required): string
Minimum Length:
0
Maximum Length:200
The state, region, or province of a location. -
status: string
Allowed Values:
[ "ACTIVE", "INACTIVE" ]
The status of the company. Valid values are Active and Inactive. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
url: string
Minimum Length:
0
Maximum Length:255
The website of the company. -
workspaceCode: stringMinimum Length:0
Maximum Length:60
Deprecated. As of 23.12.The user-specified identifier of the company's workspace. -
workspaceId: integer(int64)Read Only:true
Deprecated. As of 23.12.The workspace that the company was created in. All changes to the company must be made in the owning workspace.
Nested Schema : businessRoleTypes
Type:
array
The business types for a company.
Show Source
-
Array of:
string
Allowed Values:
[ "ARCHITECT", "ARCHITECT_ENGINEER", "CONSTRUCTION_MANAGER", "CONSULTANT", "CONTRACTOR", "CUSTOMER", "DESIGN_CONSULTANT", "DEVELOPER", "ENGINEER", "HEAD_CONTRACTOR", "OTHER", "OWNER", "OWNER_REP", "PROJECT_MANAGER", "QUANTITY_SURVEYOR", "RESELLER", "SUB_CONTRACTOR", "SUPPLIER", "VENDOR" ]
Nested Schema : companyEnterpriseCertifications
Type:
array
List of enterprise certifications held by the company.
Show Source
-
Array of:
object ApiEntityCompanyEnterpriseCertificationInput
Title:
ApiEntityCompanyEnterpriseCertificationInput
Nested Schema : companyLaborTypes
Type:
array
List of labor union types applicable for the company.
Show Source
-
Array of:
object ApiEntityCompanyLaborTypeInput
Title:
ApiEntityCompanyLaborTypeInput
Nested Schema : companyWorkTypes
Type:
array
List of types of work or specialties of the company.
Show Source
-
Array of:
object ApiEntityCompanyWorkTypeInput
Title:
ApiEntityCompanyWorkTypeInput
Nested Schema : configuredFields
Type:
array
The list of configured fields for a company.
Show Source
-
Array of:
object ApiEntityCompanyConfiguredFieldValueInput
Title:
ApiEntityCompanyConfiguredFieldValueInput
This entity represents a CompanyConfiguredFieldValue object, a unique CompanyConfiguredFieldValue object can be identified by the following combinations of the fields.- companyUdfValueId
- columnDefinitionId
- columnName
- columnLabel
Nested Schema : offices
Type:
array
Read Only:
true
Deprecated. As of 23.12.Offices associated with the company.
Show Source
-
Array of:
object ApiEntityOffice
Title:
ApiEntityOffice
Nested Schema : ApiEntityCompanyEnterpriseCertificationInput
Type:
object
Title:
Show Source
ApiEntityCompanyEnterpriseCertificationInput
-
certificationId: integer
(int64)
A unique identifier for the enterprise certification held by the company.
-
companyEnterpriseCertificationTypeName: string
Allowed Values:
[ "DISABLED_VETERAN_BUSINESS_ENTERPRISE_DVBE", "DISADVANTAGED_BUSINESS_ENTERPRISE_DBE", "EIGHT_A_BUSINESS", "SMALL_BUSINESS_ENTERPRISE_SBE", "UNDERUTILIZED_BUSINESS_HUB", "WOMEN_BUSINESS_ENTERPRISE_WBE", "MINORITY_BUSINESS_ENTERPRISE_MBE" ]
Enterprise Certifications held by the Company -
companyId: integer
(int64)
The system-generated identifier of a company.
-
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : ApiEntityCompanyLaborTypeInput
Type:
object
Title:
Show Source
ApiEntityCompanyLaborTypeInput
-
companyId: integer
(int64)
The system-generated identifier of a company.
-
companyLaborTypeName: string
Allowed Values:
[ "NON_UNION", "PREVAILING_WAGE", "UNION" ]
Labor union types applicable for the Company -
laborTypeAssociationId: integer
(int64)
A unique identifier for labor type applicable for the company.
-
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : ApiEntityCompanyWorkTypeInput
Type:
object
Title:
Show Source
ApiEntityCompanyWorkTypeInput
-
companyId: integer
(int64)
The system-generated identifier of a company.
-
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
workTypeId: integer
(int64)
A unique identifier for type of work of the company.
-
workTypeName: string
Allowed Values:
[ "PROCUREMENT_AND_CONTRACTING_REQUIREMENTS", "SOLICITATION", "INSTRUCTIONS_FOR_PROCUREMENT", "AVAILABLE_INFORMATION", "PROCUREMENT_FORMS_AND_SUPPLEMENTS", "CONTRACTING_FORMS_AND_SUPPLEMENTS", "PROJECT_FORMS", "CONDITIONS_OF_THE_CONTRACT", "REVISIONS_CLARIFICATIONS_AND_MODIFICATIONS", "SUMMARY", "ADMINISTRATIVE_REQUIREMENTS", "QUALITY_REQUIREMENTS", "TEMPORARY_FACILITIES_AND_CONTROLS", "PRODUCT_REQUIREMENTS", "EXECUTION_AND_CLOSEOUT_REQUIREMENTS", "PERFORMANCE_REQUIREMENTS", "LIFE_CYCLE_ACTIVITIES", "EXISTING_CONDITIONS", "ASSESSMENT", "SUBSURFACE_INVESTIGATION", "DEMOLITION_AND_STRUCTURE_MOVING", "SITE_REMEDIATION", "CONTAMINATED_SITE_MATERIAL_REMOVAL", "FACILITY_REMEDIATION", "CONCRETE", "CONCRETE_FORMING_AND_ACCESSORIES", "CONCRETE_REINFORCING", "CAST_IN_PLACE_CONCRETE", "CAST_DECKS_AND_UNDERLAYMENT", "GROUTING", "MASS_CONCRETE", "CONCRETE_CUTTING_AND_BORING", "MASONRY", "UNIT_MASONRY", "STONE_ASSEMBLIES", "REFRACTORY_MASONRY", "CORROSION_RESISTANT_MASONRY", "MANUFACTURED_MASONRY", "METALS", "METAL_DECKING", "COLD_FORMED_METAL_FRAMING", "METAL_FABRICATIONS", "DECORATIVE_METAL", "WOOD_PLASTICS_AND_COMPOSITES", "ROUGH_CARPENTRY", "ARCHITECTURAL_WOODWORK", "PLASTIC_FABRICATIONS", "STRUCTURAL_COMPOSITES", "COMPOSITE_FABRICATIONS", "THERMAL_AND_MOISTURE_PROTECTION", "DAMPPROOFING_AND_WATERPROOFING", "THERMAL_PROTECTION", "ROOFING_AND_SIDING_PANELS", "MEMBRANE_ROOFING", "FLASHING_AND_SHEET_METAL", "ROOF_AND_WALL_SPECIALTIES_AND_ACCESSORIES", "FIRE_AND_SMOKE_PROTECTION", "JOINT_PROTECTION", "OPENINGS", "DOORS_AND_FRAMES", "SPECIALTY_DOORS_AND_FRAMES", "ENTRANCES_STOREFRONTS_AND_CURTAIN_WALLS", "WINDOWS", "ROOF_WINDOWS_AND_SKYLIGHTS", "HARDWARE", "GLAZING", "LOUVERS_AND_VENTS", "FINISHES", "PLASTER_AND_GYPSUM_BOARD", "SPECIALIZED_SYSTEMS", "CEILINGS", "FLOORING", "ACOUSTIC_TREATMENT", "PAINTING_AND_COATING", "SPECIALTIES", "INFORMATION_SPECIALTIES", "FIREPLACES_AND_STOVES", "SAFETY_SPECIALTIES", "STORAGE_SPECIALTIES", "OTHER_SPECIALTIES", "EQUIPMENT", "VEHICLE_AND_PEDESTRIAN_EQUIPMENT", "COMMERCIAL_EQUIPMENT", "RESIDENTIAL_EQUIPMENT", "FOODSERVICE_EQUIPMENT", "EDUCATIONAL_AND_SCIENTIFIC_EQUIPMENT", "HEALTHCARE_EQUIPMENT", "FACILITY_MAINTENANCE_AND_OPERATION_EQUIPMENT", "OTHER_EQUIPMENT", "FURNISHINGS", "ART", "WINDOW_TREATMENTS", "CASEWORK", "FURNISHINGS_AND_ACCESSORIES", "FURNITURE", "OTHER_FURNISHINGS", "SPECIAL_CONSTRUCTION", "SPECIAL_FACILITY_COMPONENTS", "SPECIAL_PURPOSE_ROOMS", "SPECIAL_STRUCTURES", "INTEGRATED_CONSTRUCTION", "LIFTS", "DUMBWAITERS", "ELEVATORS", "ESCALATORS_AND_MOVING_WALKS", "TURNTABLES", "SCAFFOLDING", "FIRE_SUPPRESSION", "WATER_BASED_FIRE_SUPPRESSION_SYSTEMS", "FIRE_EXTINGUISHING_SYSTEMS", "FIRE_PUMPS", "FIRE_SUPPRESSION_WATER_STORAGE", "PLUMBING", "PLUMBING_PIPING", "PLUMBING_EQUIPMENT", "PLUMBING_FIXTURES", "POOL_AND_FOUNTAIN_PLUMBING_SYSTEMS", "GAS_AND_VACUUM_SYSTEMS_FOR_LABORATORY_AND_HEALTHCARE", "HEATING_VENTILATING_AND_AIR_CONDITIONING_HVAC", "FACILITY_FUEL_SYSTEMS", "HVAC_PIPING_AND_PUMPS", "HVAC_AIR_DISTRIBUTION", "HVAC_AIR_CLEANING_DEVICES", "CENTRAL_HEATING_EQUIPMENT", "CENTRAL_COOLING_EQUIPMENT", "CENTRAL_HVAC_EQUIPMENT", "DECENTRALIZED_HVAC_EQUIPMENT", "INTEGRATED_AUTOMATION", "INTEGRATED_AUTOMATION_NETWORK_EQUIPMENT", "INTEGRATED_AUTOMATION_INSTRUMENTATION_AND_TERMINAL_DEVICES", "PROCESS_CONTROL_AND_ENTERPRISE_MANAGEMENT_SYSTEMS", "INTEGRATED_AUTOMATION_FACILITY_CONTROLS", "INTEGRATED_AUTOMATION_CONTROL_SEQUENCES", "ELECTRICAL", "MEDIUM_VOLTAGE_ELECTRICAL_DISTRIBUTION", "LOW_VOLTAGE_ELECTRICAL_DISTRIBUTION", "WELLS", "LIGHTING", "COMMUNICATIONS", "STRUCTURED_CABLING", "DATA_COMMUNICATIONS", "VOICE_COMMUNICATIONS", "AUDIO_VIDEO_COMMUNICATIONS", "DISTRIBUTED_COMMUNICATIONS_AND_MONITORING_SYSTEMS", "ACCESS_CONTROL", "VIDEO_SURVEILLANCE", "SECURITY_DETECTION_ALARM_AND_MONITORING", "INSTRUMENTATION_FOR_PROCESS_SYSTEMS", "EARTHWORK", "SITE_CLEARING", "EARTH_MOVING", "EARTHWORK_METHODS", "SHORING_AND_UNDERPINNING", "BASES_BALLASTS_AND_PAVING", "SITE_IMPROVEMENTS", "WETLANDS", "IRRIGATION", "PLANTING", "UTILITIES", "WATER_UTILITIES", "SANITARY_SEWERAGE", "COMMUNICATIONS_UTILITIES", "TRANSPORTATION", "GUIDEWAYS_RAILWAYS", "TRACTION_POWER", "TRANSPORTATION_FARE_COLLECTION_EQUIPMENT", "BRIDGES", "WATERWAY_AND_MARINE_CONSTRUCTION", "WATERWAY_AND_MARINE_CONSTRUCTION_AND_EQUIPMENT", "COASTAL_CONSTRUCTION", "MARINE_CONSTRUCTION_AND_EQUIPMENT", "DAM_CONSTRUCTION_AND_EQUIPMENT", "PROCESS_INTERCONNECTIONS", "LIQUIDS_PROCESS_PIPING", "SOLID_AND_MIXED_MATERIALS_PIPING_AND_CHUTES", "COMMISSIONING_OF_PROCESS_SYSTEMS", "PRIMARY_CONTROL_DEVICES", "MATERIAL_PROCESSING_AND_HANDLING_EQUIPMENT", "PIECE_MATERIAL_HANDLING_EQUIPMENT", "MANUFACTURING_EQUIPMENT", "CONTAINER_PROCESSING_AND_PACKAGING", "MATERIAL_STORAGE", "MOBILE_PLANT_EQUIPMENT", "PROCESS_HEATING_COOLING_AND_DRYING_EQUIPMENT", "PROCESS_HEATING_EQUIPMENT", "PROCESS_COOLING_EQUIPMENT", "PROCESS_DRYING_EQUIPMENT", "GAS_HANDLING_EQUIPMENT", "LIQUID_HANDLING_EQUIPMENT", "GAS_AND_LIQUID_PURIFICATION_EQUIPMENT", "GAS_AND_LIQUID_STORAGE", "POLLUTION_AND_WASTE_CONTROL_EQUIPMENT", "NOISE_POLLUTION_CONTROL", "ODOR_CONTROL", "SOLID_WASTE_CONTROL_AND_REUSE", "WASTE_THERMAL_PROCESSING_EQUIPMENT", "INDUSTRY_SPECIFIC_MANUFACTURING_EQUIPMENT", "USER_DEFINED_TEXTILES_AND_APPAREL_MANUFACTURING_EQUIPMENT", "WATER_AND_WASTEWATER_EQUIPMENT", "WATER_AND_WASTEWATER_PRELIMINARY_TREATMENT_EQUIPMENT", "WATER_AND_WASTEWATER_CHEMICAL_FEED_EQUIPMENT", "WATER_AND_WASTEWATER_SECONDARY_TREATMENT_EQUIPMENT", "WATER_AND_WASTEWATER_RESIDUALS_HANDLING_AND_TREATMENT", "ELECTRICAL_POWER_GENERATION_TESTING", "USER_DEFINED_PETROLEUM_AND_COAL_PRODUCTS_MANUFACTURING", "USER_DEFINED_FABRICATED_METAL_PRODUCT_MANUFACTURING", "USER_DEFINED_FURNITURE_AND_RELATED_PRODUCT_MANUFACTURING", "COMBINED_HEAT_AND_POWER_GENERATION", "GENERAL_REQUIREMENTS", "PRICE_AND_PAYMENT_PROCEDURES", "WATER_REMEDIATION", "PRECAST_CONCRETE", "METAL_JOISTS", "FINISH_CARPENTRY", "STEEP_SLOPE_ROOFING", "WALL_FINISHES", "INTERIOR_SPECIALTIES", "EXTERIOR_SPECIALTIES", "ENTERTAINMENT_AND_RECREATION_EQUIPMENT", "MULTIPLE_SEATING", "SPECIAL_INSTRUMENTATION", "CONVEYING_EQUIPMENT", "OTHER_CONVEYING_EQUIPMENT", "ELECTRICAL_PROTECTION", "ELECTRONIC_SAFETY_AND_SECURITY", "LIFE_SAFETY", "EXCAVATION_SUPPORT_AND_PROTECTION", "SPECIAL_FOUNDATIONS_AND_LOAD_BEARING_ELEMENTS", "TUNNELING_AND_MINING", "EXTERIOR_IMPROVEMENTS", "STORMWATER_UTILITIES", "HYDROCARBON_UTILITIES", "HYDRONIC_AND_STEAM_ENERGY_UTILITIES", "TRANSPORTATION_SIGNALING_AND_CONTROL_EQUIPMENT", "TRANSPORTATION_CONSTRUCTION_AND_EQUIPMENT", "WATERWAY_AND_MARINE_SIGNALING_AND_CONTROL_EQUIPMENT", "WATERWAY_CONSTRUCTION_AND_EQUIPMENT", "GAS_AND_VAPOR_PROCESS_PIPING_AND_DUCTWORK", "PROCESS_PIPING_AND_EQUIPMENT_PROTECTION", "BULK_MATERIAL_PROCESSING_EQUIPMENT", "PROCESS_GAS_AND_LIQUID_HANDLING_PURIFICATION_AND_STORAGE", "AIR_POLLUTION_CONTROL", "WATER_POLLUTION_CONTROL_EQUIPMENT", "WATER_AND_WASTEWATER_CLARIFICATION_AND_MIXING_EQUIPMENT", "WATER_AND_WASTEWATER_ADVANCED_TREATMENT_EQUIPMENT", "STRUCTURAL_METAL_FRAMING", "STRUCTURAL_PLASTICS", "TILING", "FACILITY_ELECTRICAL_POWER_GENERATING_AND_STORING_EQUIPMENT", "ELECTRICAL_UTILITIES", "ELECTRICAL_POWER_GENERATION", "ELECTRICAL_POWER_GENERATION_EQUIPMENT" ]
Types of Work or Specialties of the Company
Nested Schema : ApiEntityCompanyConfiguredFieldValueInput
Type:
object
Title:
ApiEntityCompanyConfiguredFieldValueInput
This entity represents a CompanyConfiguredFieldValue object, a unique CompanyConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- companyUdfValueId
- columnDefinitionId
- columnName
- columnLabel
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
columnDefinitionId: integer
(int64)
Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
-
columnLabel: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column label. -
columnName: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column name. -
companyConfiguredFieldValueId: integer
(int64)
The unique identifier for the company configured field. This value should not be provided in create operation request data; however, it is required for update requests.
-
companyId: integer
(int64)
The system-generated identifier of a company.
-
costValue: numberRead Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record. -
costValueWorkspace1: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace1 currency conversion. -
costValueWorkspace2: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace2 currency conversion. -
costValueWorkspace3: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace3 currency conversion. -
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
exceptionMessage: stringRead Only:true
Maximum Length:1000
Deprecated. As of 23.10.Provides the error message for why the formula calculation resulted in an error. -
hasException: booleanRead Only:true
Deprecated. As of 23.10.Determines if formula calculation hit an error calculating a value for this field. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
textValue: string
Maximum Length:
1000
This holds values for Boolean, List and Text type configured fields. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : ApiEntityOffice
Type:
object
Title:
Show Source
ApiEntityOffice
-
addressLine1: string
Maximum Length:
200
The first line of the address of a location.
This might be the building number and street address. -
addressLine2: string
Maximum Length:
200
The second line of the address of a location.
This might be a neighborhood or town. -
cityName: string
Maximum Length:
200
The name of the city for a location. -
companyId: integer
(int64)
The unique identifier for the company.The company object can also be identified by its unique criteria.
-
companyName: string
Minimum Length:
1
Maximum Length:255
The name of the company. -
countryCode: string
Minimum Length:
0
Maximum Length:3
The country for a location. -
distance: number
(double)
The distance the company is willing to travel for the project from this office.
-
distanceMetric: string
Allowed Values:
[ "KILOMETERS", "MILES" ]
The distance measure to be used. Valid options include kilometer and mile. -
fax: string
Maximum Length:
32
The fax number for the office. -
isCorporateOffice: boolean
Indicates if the office is the headquarters of the company.
-
latitude: number
(double)
Minimum Value:
-90
Maximum Value:90
The geographical coordinate for the latitude of the location.
The default format for latitude is decimal degrees, but the format you need to use will depend on your geolocation service. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
longitude: number
(double)
Minimum Value:
-180
Maximum Value:180
The geographical coordinate for the longitude of the location.
The default format for longitude is decimal degrees, but the format you need to use will depend on your geolocation service. -
officeCountryCode: string
Minimum Length:
0
Maximum Length:200
The country for a location. -
officeId: integer
(int64)
The unique identifier of an office.
-
officeName: string
Minimum Length:
1
Maximum Length:255
The name of the office. -
officePostalCode: string
Minimum Length:
0
Maximum Length:200
The postal code, post code, or zip code of a location. -
orgOfficeId: integer
(int64)
The unique identifier of the organization of the office.
-
phone: string
Maximum Length:
32
The phone number for the office. -
postalCode: string
Minimum Length:
0
Maximum Length:20
The postal code, post code, or zip code of a location. -
stateName: string
Maximum Length:
200
The state, region, or province of a location. -
updateDate: string
(date-time)
Date when the record was last updated.
Examples
Back to Top
Response
Supported Media Types
- application/json
200 Response
The object was successfully updated.
Root Schema : List<ApiEntityERPSyncApiResponse>
Type:
array
Title:
Show Source
List<ApiEntityERPSyncApiResponse>
-
Array of:
object ApiEntityERPSyncApiResponse
Title:
ApiEntityERPSyncApiResponse
Nested Schema : ApiEntityERPSyncApiResponse
Type:
object
Title:
Show Source
ApiEntityERPSyncApiResponse
-
identifier: object
identifier
The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked. -
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
message: string
Message is populated based on result of the operation.
Success - Message will not be populated. Please refer the statusCode.
Failure - Error message or reason for operation failure is populated.
Warning - warning message is populated.
The field is non-persistable and thus maximum length is not applicable. -
primaryKeyName: string
The primary key field name associated with the integrated object.
The field is non-persistable and thus maximum length is not applicable. -
primaryKeyValue: integer
(int64)
The unique identifier for the integrated object.
-
sourceId: string
Maximum Length:
255
The unique identifier of the object in an external source. -
statusCode: integer
(int32)
The response code representing the state of the API operation.
-
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated.
Nested Schema : identifier
Type:
object
The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.
Match One Schema
Show Source
-
object
ProjectIdentifier
Title:
ProjectIdentifier
-
object
CBSSheetCodeIdentifier
Title:
CBSSheetCodeIdentifier
-
object
ResourceIdentifier
Title:
ResourceIdentifier
Nested Schema : ProjectIdentifier
Type:
object
Title:
Show Source
ProjectIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CBSSheetCodeIdentifier
Type:
object
Title:
Show Source
CBSSheetCodeIdentifier
-
cbsCode: string
Maximum Length:
60
The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition. -
cbsSheetCodeId: integer
(int64)
The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.
-
costSheetId: integer
(int64)
The unique identifier of a cost sheet.
-
parentId: integer
(int64)
The system-generated identifier of a parent cost item in a cost sheet.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ResourceIdentifier
Type:
object
Title:
Show Source
ResourceIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
resourceClass: string
Allowed Values:
[ "RESOURCE", "ROLE" ]
The class identifies the item as a resource or a role. -
resourceCode: string
Maximum Length:
60
The unique identifier for the resource or role. -
resourceId: integer
(int64)
The unique identifier for the resource or role.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
207 Response
The object was successfully integrated.
Root Schema : List<ApiEntityERPSyncApiResponse>
Type:
array
Title:
Show Source
List<ApiEntityERPSyncApiResponse>
-
Array of:
object ApiEntityERPSyncApiResponse
Title:
ApiEntityERPSyncApiResponse
Nested Schema : ApiEntityERPSyncApiResponse
Type:
object
Title:
Show Source
ApiEntityERPSyncApiResponse
-
identifier: object
identifier
The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked. -
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
message: string
Message is populated based on result of the operation.
Success - Message will not be populated. Please refer the statusCode.
Failure - Error message or reason for operation failure is populated.
Warning - warning message is populated.
The field is non-persistable and thus maximum length is not applicable. -
primaryKeyName: string
The primary key field name associated with the integrated object.
The field is non-persistable and thus maximum length is not applicable. -
primaryKeyValue: integer
(int64)
The unique identifier for the integrated object.
-
sourceId: string
Maximum Length:
255
The unique identifier of the object in an external source. -
statusCode: integer
(int32)
The response code representing the state of the API operation.
-
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated.
Nested Schema : identifier
Type:
object
The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.
Match One Schema
Show Source
-
object
ProjectIdentifier
Title:
ProjectIdentifier
-
object
CBSSheetCodeIdentifier
Title:
CBSSheetCodeIdentifier
-
object
ResourceIdentifier
Title:
ResourceIdentifier
Nested Schema : ProjectIdentifier
Type:
object
Title:
Show Source
ProjectIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CBSSheetCodeIdentifier
Type:
object
Title:
Show Source
CBSSheetCodeIdentifier
-
cbsCode: string
Maximum Length:
60
The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition. -
cbsSheetCodeId: integer
(int64)
The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.
-
costSheetId: integer
(int64)
The unique identifier of a cost sheet.
-
parentId: integer
(int64)
The system-generated identifier of a parent cost item in a cost sheet.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ResourceIdentifier
Type:
object
Title:
Show Source
ResourceIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
resourceClass: string
Allowed Values:
[ "RESOURCE", "ROLE" ]
The class identifies the item as a resource or a role. -
resourceCode: string
Maximum Length:
60
The unique identifier for the resource or role. -
resourceId: integer
(int64)
The unique identifier for the resource or role.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
400 Response
Invalid Input.