Procore BIM Model Properties API

openapi: 3.2.0
info:
  title: Procore REST BIM Model Properties API
  version: v1.0/v2.0
  description: Merged from the per-resource OpenAPI documents Procore publishes through its developer portal (https://developers.procore.com/api/v1/resource_groups). Originals are kept verbatim in openapi/_original/resources/.
  x-source: https://developers.procore.com/api/v1/resource_groups
servers:
- url: https://api.procore.com
  description: Production
security:
- bearerAuth: []
tags:
- name: BIM Model Properties
paths:
  /rest/v1.0/bim_model_revisions/{id}/properties:
    parameters:
    - name: Procore-Company-Id
      in: header
      description: Unique company identifier associated with the Procore User Account.
      required: true
      schema:
        type: integer
    x-compliance-level: full
    get:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: List BIM Model Revision properties
      description: Lists properties for a specific BIM Model Revision.
      tags:
      - BIM Model Properties
      parameters:
      - name: id
        in: path
        description: BIM Model Revision ID
        required: true
        schema:
          type: integer
      - name: project_id
        in: query
        required: true
        description: Unique identifier for the project.
        schema:
          type: integer
      - name: page
        in: query
        description: Page
        schema:
          type: integer
      - name: per_page
        in: query
        description: Elements per page
        schema:
          type: integer
      - name: filters[object_id]
        in: query
        description: Filter item(s) with matching object_id.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
      - name: filters[category]
        in: query
        description: Filter item(s) with matching category.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: filters[name]
        in: query
        description: Filter item(s) with matching name.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: filters[value]
        in: query
        description: Filter item(s) with matching value.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: filters[query]
        in: query
        description: Filter item(s) containing query. Searchable fields include Property Category, Name, and Value
        schema:
          type: string
      - name: filters[curated_list]
        in: query
        description: Filter item(s) to return a curated list of properties
        schema:
          type: boolean
      - name: filters[has_uom]
        in: query
        description: Filter item(s) to return properties with/without unit of measurement (uom).
        schema:
          type: boolean
      responses:
        '200':
          description: BIM Model Properties listed successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  oneOf:
                  - type: object
                    description: BIM Model Property
                    properties:
                      object_id:
                        type: integer
                        description: Object ID
                        example: 126
                      category:
                        type: string
                        description: Category
                        example: DATA REDUCTION 105
                      name:
                        type: string
                        description: Name
                        example: Specified Lighting Load
                      typed_value:
                        type: string
                        description: Property value in native type. The typed_value can be null for models published to Procore when native values were not captured in the publishing process.
                        example: LcRevitElement Level GROUND FLOOR - 30
                      uom:
                        type:
                        - string
                        - 'null'
                        description: The unit of measure for the property value. The value is null when unit of measure does not exist for a property.
                        default: null
                        example: null
                      value:
                        type: string
                        description: Property display value same as typed_value.
                        example: LcRevitElement Level GROUND FLOOR - 30
                  - type: object
                    description: BIM Model Property
                    properties:
                      object_id:
                        type: integer
                        description: Object ID
                        example: 126
                      category:
                        type: string
                        description: Property Category
                        example: Top Constraint
                      name:
                        type: string
                        description: Property Name
                        example: Elevation
                      typed_value:
                        type: number
                        description: Property value in native type. Numeric value can contain numbers with very high decimal precision. The typed_value can be null for models published to Procore when native values were not captured in the publishing process.
                        example: 14.7402790213
                      uom:
                        type:
                        - string
                        - 'null'
                        description: The unit of measure for the property value. The value is null when unit of measure does not exist for a property.
                        example: ft
                      value:
                        type: string
                        description: Property display value. For numeric values with uom, the typed_value is concatenated with uom. Decimal values are truncated to four decimal places.
                        example: 14.7402 ft
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                  message:
                    type: string
                  fields:
                    type: string
                  reason:
                    description: A human-readable code providing additional detail on the cause of the error.
                    type: string
                  error:
                    description: Description of the error thrown.
                    type:
                    - string
                    - 'null'
                    example: Invalid Token
        '401':
          description: User does not have permission to view BIM Model Property
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                  message:
                    type: string
                  fields:
                    type: string
                  reason:
                    description: A human-readable code providing additional detail on the cause of the error.
                    type: string
                  error:
                    description: Description of the error thrown.
                    type:
                    - string
                    - 'null'
                    example: Invalid Token
        '403':
          description: User does not have permission to view BIM Model Property
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                  message:
                    type: string
                  fields:
                    type: string
                  reason:
                    description: A human-readable code providing additional detail on the cause of the error.
                    type: string
                  error:
                    description: Description of the error thrown.
                    type:
                    - string
                    - 'null'
                    example: Invalid Token
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                  message:
                    type: string
                  fields:
                    type: string
                  reason:
                    description: A human-readable code providing additional detail on the cause of the error.
                    type: string
                  error:
                    description: Description of the error thrown.
                    type:
                    - string
                    - 'null'
                    example: Invalid Token
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                  message:
                    type: string
                  fields:
                    type: string
                  reason:
                    description: A human-readable code providing additional detail on the cause of the error.
                    type: string
                  error:
                    description: Description of the error thrown.
                    type:
                    - string
                    - 'null'
                    example: Invalid Token
      x-code-samples:
      - id: node_request
        title: Node.js
        content: "const request = require('request');\n\nconst options = {\n  method: 'GET',\n  url: 'https://api.procore.com/rest/v1.0/bim_model_revisions/%7Bid%7D/properties',\n  qs: {\n    project_id: 'SOME_INTEGER_VALUE',\n    page: 'SOME_INTEGER_VALUE',\n    per_page: 'SOME_INTEGER_VALUE',\n    'filters[object_id]': 'SOME_ARRAY_VALUE',\n    'filters[category]': 'SOME_ARRAY_VALUE',\n    'filters[name]': 'SOME_ARRAY_VALUE',\n    'filters[value]': 'SOME_ARRAY_VALUE',\n    'filters[query]': 'SOME_STRING_VALUE',\n    'filters[curated_list]': 'SOME_BOOLEAN_VALUE',\n    'filters[has_uom]': 'SOME_BOOLEAN_VALUE'\n  }\n};\n\nrequest(options, function (error, response, body) {\n  if (error) throw new Error(error);\n\n  console.log(body);\n});\n"
      - id: python_python3
        title: Python3
        content: 'import http.client


          conn = http.client.HTTPSConnection("api.procore.com")


          conn.request("GET", "/rest/v1.0/bim_model_revisions/%7Bid%7D/properties?project_id=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Bobject_id%5D=SOME_ARRAY_VALUE&filters%5Bcategory%5D=SOME_ARRAY_VALUE&filters%5Bname%5D=SOME_ARRAY_VALUE&filters%5Bvalue%5D=SOME_ARRAY_VALUE&filters%5Bquery%5D=SOME_STRING_VALUE&filters%5Bcurated_list%5D=SOME_BOOLEAN_VALUE&filters%5Bhas_uom%5D=SOME_BOOLEAN_VALUE")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - id: shell_curl
        title: Curl
        content: "curl --request GET \\\n  --url 'https://api.procore.com/rest/v1.0/bim_model_revisions/%7Bid%7D/properties?project_id=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Bobject_id%5D=SOME_ARRAY_VALUE&filters%5Bcategory%5D=SOME_ARRAY_VALUE&filters%5Bname%5D=SOME_ARRAY_VALUE&filters%5Bvalue%5D=SOME_ARRAY_VALUE&filters%5Bquery%5D=SOME_STRING_VALUE&filters%5Bcurated_list%5D=SOME_BOOLEAN_VALUE&filters%5Bhas_uom%5D=SOME_BOOLEAN_VALUE'"
      - id: csharp_httpclient
        title: C#
        content: "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n    Method = HttpMethod.Get,\n    RequestUri = new Uri(\"https://api.procore.com/rest/v1.0/bim_model_revisions/%7Bid%7D/properties?project_id=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Bobject_id%5D=SOME_ARRAY_VALUE&filters%5Bcategory%5D=SOME_ARRAY_VALUE&filters%5Bname%5D=SOME_ARRAY_VALUE&filters%5Bvalue%5D=SOME_ARRAY_VALUE&filters%5Bquery%5D=SOME_STRING_VALUE&filters%5Bcurated_list%5D=SOME_BOOLEAN_VALUE&filters%5Bhas_uom%5D=SOME_BOOLEAN_VALUE\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n    response.EnsureSuccessStatusCode();\n    var body = await response.Content.ReadAsStringAsync();\n    Console.WriteLine(body);\n}"
      x-rate-limit-enabled: true
      x-procore-kong-tags:
      - rate-limit:enabled
      x-changelog:
      - summary: Added query parameter to support filtering properties with/without unit of measurement (uom)
        description: 'Added a new query parameter to filter properties with/without uom.

          When true the response will contain properties that have uom.

          When false the response will contain properties that have ''null'' uom value'
        endpoint: GET /bim_model_revisions/{id}/properties
        type: feature
        breaking: false
        datestamp: '2023-03-29'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: bim-model-revision-properties?version=1.0#list-bim-model-revision-properties
      operationId: listBimModelRevisionProperties
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer