Jump to

• Request
• Response

View a Company

get

/api/restapi/company/{companyId}

This endpoint returns companies that meet the following requirements:

• The object is associated with a company with an ID value that matches the value of the {companyId} path parameter.

Request

Path Parameters

• companyId(required): integer(int64)
  The system-generated identifier of a company.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityCompany

Type: object

Title: ApiEntityCompany

Show Source

• 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: 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: 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: 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)
  The distance the company is willing to travel for the project from the corporate office.
• distanceMetric: string
  Allowed Values: [ "KILOMETERS", "MILES" ]

  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: boolean
  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)
  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: array offices
  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: 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: 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)
  Date when the record was last updated.
• url: string
  Minimum Length: 0

  Maximum Length: 255

  The website of the company.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of the company's workspace.
• workspaceId: integer (int64)
  The workspace that the company was created in. All changes to the company must be made in the owning workspace.

{
    "title":"ApiEntityCompany",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"The status of the company. Valid values are Active and Inactive.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTIVE",
                "INACTIVE"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Additional information about the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "url":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The website of the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companyEnterpriseCertifications":{
            "type":"array",
            "description":"List of enterprise certifications held by the company.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCompanyEnterpriseCertification",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "companyWorkTypes":{
            "type":"array",
            "description":"List of types of work or specialties of the company.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCompanyWorkType",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "companyLaborTypes":{
            "type":"array",
            "description":"List of labor union types applicable for the company.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCompanyLaborType",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "offices":{
            "type":"array",
            "description":"Offices associated with the company.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityOffice",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a company.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCompanyConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of the company's workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The workspace that the company was created in. All changes to the company must be made in the owning workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of company data in an external source.",
            "example":"coarse",
            "exampleSetFlag":true,
            "types":[
                "string"
            ]
        },
        "distance":{
            "type":"number",
            "description":"The distance the company is willing to travel for the project from the corporate office.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "distanceMetric":{
            "type":"string",
            "description":"The distance measure to be used for corporate office distance. Valid options include kilometer and mile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "KILOMETERS",
                "MILES"
            ]
        },
        "businessRoleTypes":{
            "type":"array",
            "description":"The business types for a company.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ],
                "enum":[
                    "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"
                ]
            },
            "types":[
                "array"
            ]
        },
        "companyId":{
            "type":"integer",
            "description":"The system-generated identifier of a company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "companyName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "phone":{
            "maxLength":"32",
            "minLength":"0",
            "type":"string",
            "description":"The phone number for the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fax":{
            "maxLength":"32",
            "minLength":"0",
            "type":"string",
            "description":"The fax number for the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "addressLine1":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string",
            "description":"The first line of the address of a location. <br />This might be the building number and street address.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "addressLine2":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string",
            "description":"The second line of the address of a location. <br />This might be a neighborhood or town.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "cityName":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string",
            "description":"The city name for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "stateName":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string",
            "description":"The state, region, or province of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "postalCode":{
            "maxLength":"20",
            "minLength":"0",
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "countryCode":{
            "maxLength":"3",
            "minLength":"0",
            "type":"string",
            "description":"The country for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "latitude":{
            "maximum":"90",
            "minimum":"-90",
            "type":"number",
            "description":"The latitude of a company.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "longitude":{
            "maximum":"180",
            "minimum":"-180",
            "type":"number",
            "description":"The geographical coordinate for the longitude of the location. <br />The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "isTenantOwned":{
            "type":"boolean",
            "description":"Indicates whether or not the company is an application tenant.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "sourceSiteId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of a company site in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "organizationId":{
            "type":"integer",
            "description":"The unique identifier for the organization.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "qualificationStatus":{
            "type":"string",
            "description":"Qualification status of a Company according to the tenant",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CONDITIONALLY_QUALIFIED",
                "NOT_QUALIFIED",
                "NO_STATUS",
                "QUALIFIED"
            ]
        },
        "performanceRating":{
            "type":"string",
            "description":"Performance Rating of a Company determined by the tenant.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NO_PERFORMANCE_RATING",
                "PERFORMANCE_LEVEL_FIVE",
                "PERFORMANCE_LEVEL_FOUR",
                "PERFORMANCE_LEVEL_THREE",
                "PERFORMANCE_LEVEL_TWO",
                "PERFORMANCE_LEVEL_ONE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

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" ]

{
    "type":"array",
    "description":"The business types for a company.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ],
        "enum":[
            "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"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : companyEnterpriseCertifications

Type: array

List of enterprise certifications held by the company.

Show Source

• Array of: object ApiEntityCompanyEnterpriseCertification
  Title: ApiEntityCompanyEnterpriseCertification

{
    "type":"array",
    "description":"List of enterprise certifications held by the company.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCompanyEnterpriseCertification",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : companyLaborTypes

Type: array

List of labor union types applicable for the company.

Show Source

• Array of: object ApiEntityCompanyLaborType
  Title: ApiEntityCompanyLaborType

{
    "type":"array",
    "description":"List of labor union types applicable for the company.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCompanyLaborType",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : companyWorkTypes

Type: array

List of types of work or specialties of the company.

Show Source

• Array of: object ApiEntityCompanyWorkType
  Title: ApiEntityCompanyWorkType

{
    "type":"array",
    "description":"List of types of work or specialties of the company.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCompanyWorkType",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a company.

Show Source

• Array of: object ApiEntityCompanyConfiguredFieldValue
  Title: ApiEntityCompanyConfiguredFieldValue

{
    "type":"array",
    "description":"The list of configured fields for a company.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCompanyConfiguredFieldValue",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : offices

Type: array

Offices associated with the company.

Show Source

• Array of: object ApiEntityOffice
  Title: ApiEntityOffice

{
    "type":"array",
    "description":"Offices associated with the company.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityOffice",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCompanyEnterpriseCertification

Type: object

Title: ApiEntityCompanyEnterpriseCertification

Show Source

• 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)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityCompanyEnterpriseCertification",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companyId":{
            "type":"integer",
            "description":"The system-generated identifier of a company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "certificationId":{
            "type":"integer",
            "description":"A unique identifier for the enterprise certification held by the company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "companyEnterpriseCertificationTypeName":{
            "type":"string",
            "description":"Enterprise Certifications held by the Company",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityCompanyLaborType

Type: object

Title: ApiEntityCompanyLaborType

Show Source

• 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)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityCompanyLaborType",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companyId":{
            "type":"integer",
            "description":"The system-generated identifier of a company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "laborTypeAssociationId":{
            "type":"integer",
            "description":"A unique identifier for labor type applicable for the company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "companyLaborTypeName":{
            "type":"string",
            "description":"Labor union types applicable for the Company",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NON_UNION",
                "PREVAILING_WAGE",
                "UNION"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityCompanyWorkType

Type: object

Title: ApiEntityCompanyWorkType

Show Source

• companyId: integer (int64)
  The system-generated identifier of a company.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  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

{
    "title":"ApiEntityCompanyWorkType",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companyId":{
            "type":"integer",
            "description":"The system-generated identifier of a company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workTypeId":{
            "type":"integer",
            "description":"A unique identifier for type of work of the company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workTypeName":{
            "type":"string",
            "description":"Types of Work or Specialties of the Company",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityCompanyConfiguredFieldValue

Type: object

Title: ApiEntityCompanyConfiguredFieldValue

Show Source

• 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: number
  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)
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  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: string
  Maximum Length: 1000

  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  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)
  Date when the record was last updated.

{
    "title":"ApiEntityCompanyConfiguredFieldValue",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companyId":{
            "type":"integer",
            "description":"The system-generated identifier of a company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":"1000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "exceptionMessage":{
            "maxLength":"1000",
            "type":"string",
            "description":"Provides the error message for why the formula calculation resulted in an error.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companyConfiguredFieldValueId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"Determines if formula calculation hit an error calculating a value for this field.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityOffice

Type: object

Title: ApiEntityOffice

Show Source

• 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.

{
    "title":"ApiEntityOffice",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "officeName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the office.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "isCorporateOffice":{
            "type":"boolean",
            "description":"Indicates if the office is the headquarters of the company.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "orgOfficeId":{
            "type":"integer",
            "description":"The unique identifier of the organization of the office.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "longitude":{
            "maximum":"180",
            "minimum":"-180",
            "type":"number",
            "description":"The geographical coordinate for the longitude of the location. <br />The default format for longitude is decimal degrees, but the format you need to use will depend on your geolocation service.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "latitude":{
            "maximum":"90",
            "minimum":"-90",
            "type":"number",
            "description":"The geographical coordinate for the latitude of the location. <br />The default format for latitude is decimal degrees, but the format you need to use will depend on your geolocation service.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "companyName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "postalCode":{
            "maxLength":"20",
            "minLength":"0",
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "countryCode":{
            "maxLength":"3",
            "minLength":"0",
            "type":"string",
            "description":"The country for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "distance":{
            "type":"number",
            "description":"The distance the company is willing to travel for the project from this office.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "distanceMetric":{
            "type":"string",
            "description":"The distance measure to be used. Valid options include kilometer and mile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "KILOMETERS",
                "MILES"
            ]
        },
        "officeId":{
            "type":"integer",
            "description":"The unique identifier of an office.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "companyId":{
            "type":"integer",
            "description":"The unique identifier for the company.The company object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "phone":{
            "maxLength":"32",
            "type":"string",
            "description":"The phone number for the office.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fax":{
            "maxLength":"32",
            "type":"string",
            "description":"The fax number for the office.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "addressLine1":{
            "maxLength":"200",
            "type":"string",
            "description":"The first line of the address of a location. <br />This might be the building number and street address.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "addressLine2":{
            "maxLength":"200",
            "type":"string",
            "description":"The second line of the address of a location. <br />This might be a neighborhood or town.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "cityName":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the city for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "stateName":{
            "maxLength":"200",
            "type":"string",
            "description":"The state, region, or province of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "officeCountryCode":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string",
            "description":"The country for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "officePostalCode":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested company does not exist, or you do not have access to it.

Back to Top