Procore Drawing Uploads API

openapi: 3.2.0
info:
  title: Procore REST Drawing Uploads 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: Drawing Uploads
paths:
  /rest/v1.1/projects/{project_id}/drawing_uploads/{id}:
    parameters:
    - name: Procore-Company-Id
      in: header
      description: Unique company identifier associated with the Procore User Account.
      required: true
      schema:
        type: integer
    - name: id
      in: path
      description: Drawing Upload ID
      required: true
      schema:
        type: integer
    - name: project_id
      in: path
      required: true
      description: Unique identifier for the project.
      schema:
        type: integer
    - name: view
      in: query
      description: 'Specifies the level of detail returned in the response.

        The ''with_drawing_log_imports'' view provides additional data as shown below.

        The ''normal'' view is the default if not specified.'
      schema:
        type: string
        enum:
        - normal
        - with_drawing_log_imports
    x-compliance-level: full
    get:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Show Drawing Upload
      description: Get the details of a single Drawing Upload
      tags:
      - Drawing Uploads
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: DrawingUpload
                type: object
                description: Drawing Upload
                properties:
                  id:
                    type: integer
                    description: Drawing Upload ID
                    example: 85
                  project_id:
                    type: integer
                    description: Unique identifier for the project.
                    example: 2
                  company_id:
                    type:
                    - integer
                    - 'null'
                    description: Unique identifier for the company.
                    example: 3
                  created_by_id:
                    type: integer
                    description: ID of creator
                    example: 5
                  created_at:
                    type: string
                    format: date-time
                    description: Drawing Upload created at
                    example: '2016-08-08T21:35:58Z'
                  updated_at:
                    type: string
                    format: date-time
                    description: Drawing Upload updated at
                    example: '2016-08-08T21:35:58Z'
                  error_email_sent:
                    type: boolean
                    description: Error email sent status
                    example: false
                  notify_on_success:
                    type: boolean
                    description: Notify on success status
                    example: false
                  deletion_in_progress:
                    type: boolean
                    description: Deletion in progress status
                    example: false
                  success_email_sent:
                    type: boolean
                    description: Success email sent status
                    example: false
                  drawing_area_id:
                    type: integer
                    description: Drawing Area ID
                    example: 1
                  status:
                    type: string
                    enum:
                    - in_queue
                    - in_progress
                    - mechanical_turk
                    - failed
                    - ready_for_review
                    - reviewed
                    example: in_progress
                  pre_adaptive_complete:
                    type: boolean
                    description: Pre adaptive complete status
                    example: false
                  drawing_number_contains_revision:
                    type: boolean
                    description: Drawing number contains revision
                    example: false
                  get_info_from_filename:
                    type: boolean
                    description: Get info from filename
                    example: false
                  language:
                    type:
                    - string
                    - 'null'
                    description: Language for OCR
                    example: es
                  drawing_log_imports:
                    type: array
                    description: Drawing Log Imports (Only included in 'with_drawing_log_imports' view)
                    items:
                      title: DrawingLogImport
                      type: object
                      description: Drawing Log Import
                      properties:
                        id:
                          type: integer
                          description: Drawing Log Import ID
                          example: 85
                        filename:
                          type: string
                          description: Filename
                          example: example.pdf
                        drawing_set_id:
                          type: integer
                          description: Drawing Set ID
                          example: 42
                        drawing_date:
                          type: string
                          format: date
                          description: Drawing date
                          example: '2021-09-07'
                        received_date:
                          type: string
                          format: date
                          description: Received date
                          example: '2021-09-07'
                        default_revision:
                          type: string
                          description: Default Revision for any Drawing Revisions in the Import
                          example: '23'
                        drawing_id:
                          type: integer
                          description: Drawing ID
                          example: 88
                        custom_fields:
                          type: object
                          properties:
                            custom_field_%{custom_field_string_definition_id}:
                              type: object
                              properties:
                                data_type:
                                  type: string
                                  description: Data type of the Custom Field Definition
                                  example: string
                                value:
                                  type: string
                                  description: The value of the custom field
                                  example: custom field value
                                variant:
                                  type: string
                                  description: The variant of the Custom Field Definition (e.g. `phone_number`). Present only when the definition has an associated variant.
                                  example: phone_number
                            custom_field_%{custom_field_decimal_definition_id}:
                              type: object
                              properties:
                                data_type:
                                  type: string
                                  description: Data type of the Custom Field Definition
                                  example: decimal
                                value:
                                  type: number
                                  description: The value of the custom field
                                  example: 2.2
                            custom_field_%{custom_field_boolean_definition_id}:
                              type: object
                              properties:
                                data_type:
                                  type: string
                                  description: Data type of the Custom Field Definition
                                  example: boolean
                                value:
                                  type: boolean
                                  description: The value of the custom field
                                  example: true
                            custom_field_%{custom_field_lov_entry_definition_id}:
                              type: object
                              properties:
                                data_type:
                                  type: string
                                  description: Data type of the Custom Field Definition
                                  example: lov_entry
                                value:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      description: ID of the LOV Entry
                                      example: 1
                                    label:
                                      type: string
                                      description: Label of the LOV Entry
                                      example: Open
                                variant:
                                  type: string
                                  description: The variant of the Custom Field Definition (e.g. `project_directory`). Present only when the definition has an associated variant.
                                  example: with_code
                            custom_field_%{custom_field_lov_entries_definition_id}:
                              type: object
                              properties:
                                data_type:
                                  type: string
                                  description: Data type of the Custom Field Definition
                                  example: lov_entries
                                value:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        description: ID of the LOV Entry
                                        example: 2
                                      label:
                                        type: string
                                        description: Label of the LOV Entry
                                        example: Open
        '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: Unauthorized
          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: Forbidden
          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
        default:
          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.1/projects/%7Bproject_id%7D/drawing_uploads/%7Bid%7D',\n  qs: {view: 'SOME_STRING_VALUE'},\n  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}\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")


          headers = { ''Authorization'': "Bearer REPLACE_BEARER_TOKEN" }


          conn.request("GET", "/rest/v1.1/projects/%7Bproject_id%7D/drawing_uploads/%7Bid%7D?view=SOME_STRING_VALUE", headers=headers)


          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.1/projects/%7Bproject_id%7D/drawing_uploads/%7Bid%7D?view=SOME_STRING_VALUE' \\\n  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"
      - 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.1/projects/%7Bproject_id%7D/drawing_uploads/%7Bid%7D?view=SOME_STRING_VALUE\"),\n    Headers =\n    {\n        { \"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\" },\n    },\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 new drawing upload endpoint
        description: Show drawing upload. For additional information on using the Create Drawing Upload endpoint, see the [Direct Drawing Uploads](https://developers.procore.com/documentation/tutorial-direct-drawing-uploads) tutorial
        endpoint: GET /projects/{project_id}/drawing_uploads/{id}
        type: new
        breaking: true
        datestamp: '2021-07-12'
        versions:
        - '1.1'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: drawings?version=1.1#show-drawing-upload
      - summary: Added query parameter to specify view
        description: 'An optional query parameter to change the level of detail in the response.


          `with_drawing_log_imports` returns drawing log imports for the drawing upload.


          `normal` is the default if not specified.'
        endpoint: GET /projects/{project_id}/drawing_uploads/{id}
        type: feature
        breaking: false
        datestamp: '2021-09-07'
        versions:
        - '1.1'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: drawings?version=1.1#show-drawing-upload
      operationId: showDrawingUpload
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer