1. Oracle Primavera Cloud REST API
  2. Tasks
  3. Company

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
Request Body - 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.
  • companyId
  • companyName,postalCode,countryCode
Show Source
Nested Schema : businessRoleTypes
Type: array
The business types for a company.
Show Source
  • 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
Nested Schema : companyLaborTypes
Type: array
List of labor union types applicable for the company.
Show Source
Nested Schema : companyWorkTypes
Type: array
List of types of work or specialties of the company.
Show Source
Nested Schema : configuredFields
Type: array
The list of configured fields for a company.
Show Source
  • 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 : ApiEntityCompanyEnterpriseCertificationInput
Type: object
Title: ApiEntityCompanyEnterpriseCertificationInput
Show Source
Nested Schema : ApiEntityCompanyLaborTypeInput
Type: object
Title: ApiEntityCompanyLaborTypeInput
Show Source
Nested Schema : ApiEntityCompanyWorkTypeInput
Type: object
Title: ApiEntityCompanyWorkTypeInput
Show Source
  • The system-generated identifier of a company.
  • A unique identifier for type of work of the company.
  • 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.
  • companyUdfValueId
  • columnDefinitionId
  • columnName
  • columnLabel
Show Source
  • Allowed Values: [ "DELETE" ]
    Provide value for this field during object update to delete the assigned configured field value.
  • Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
  • Minimum Length: 1
    Maximum Length: 100
    The user-specified UDF column label.
  • Minimum Length: 1
    Maximum Length: 100
    The user-specified UDF column name.
  • 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.
  • The system-generated identifier of a company.
  • This holds values for Date type configured fields.
  • 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.
  • Maximum Length: 1000
    This holds values for Boolean, List and Text type configured fields.
Examples

Back to Top

Response

Supported Media Types

200 Response

The object was successfully updated.
Body ()
Root Schema : List<ApiEntityERPSyncApiResponse>
Type: array
Title: List<ApiEntityERPSyncApiResponse>
Show Source
Nested Schema : ApiEntityERPSyncApiResponse
Type: object
Title: ApiEntityERPSyncApiResponse
Show Source
  • 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.
  • 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.
  • The primary key field name associated with the integrated object.
    The field is non-persistable and thus maximum length is not applicable.
  • The unique identifier for the integrated object.
  • Maximum Length: 255
    The unique identifier of the object in an external source.
  • The response code representing the state of the API operation.
  • 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.
Match One Schema
Show Source
Nested Schema : ProjectIdentifier
Type: object
Title: ProjectIdentifier
Show Source
Nested Schema : CBSSheetCodeIdentifier
Type: object
Title: CBSSheetCodeIdentifier
Show Source
Nested Schema : ResourceIdentifier
Type: object
Title: ResourceIdentifier
Show Source

207 Response

The object was successfully integrated.
Body ()
Root Schema : List<ApiEntityERPSyncApiResponse>
Type: array
Title: List<ApiEntityERPSyncApiResponse>
Show Source
Nested Schema : ApiEntityERPSyncApiResponse
Type: object
Title: ApiEntityERPSyncApiResponse
Show Source
  • 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.
  • 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.
  • The primary key field name associated with the integrated object.
    The field is non-persistable and thus maximum length is not applicable.
  • The unique identifier for the integrated object.
  • Maximum Length: 255
    The unique identifier of the object in an external source.
  • The response code representing the state of the API operation.
  • 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.
Match One Schema
Show Source
Nested Schema : ProjectIdentifier
Type: object
Title: ProjectIdentifier
Show Source
Nested Schema : CBSSheetCodeIdentifier
Type: object
Title: CBSSheetCodeIdentifier
Show Source
Nested Schema : ResourceIdentifier
Type: object
Title: ResourceIdentifier
Show Source

400 Response

Invalid Input.
Back to Top