Procore Pre Processing V 2 Controller API

openapi: 3.2.0
info:
  title: Procore REST Pre Processing V 2 Controller 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: pre-processing-v-2-controller
paths:
  /rest/v2.0/companies/{company_id}/file_processors/preprocess/{item_type}/{item_id}:
    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: partial
    get:
      tags:
      - pre-processing-v-2-controller
      summary: Retrieve pre-processed file metadata (company scope, v2)
      description: Company-level GET without project_id. Includes allowed_actions. Brotli compression is applied when requested via Accept-Encoding.
      operationId: getPreProcessedFileCompany
      parameters:
      - name: company_id
        in: path
        description: Unique identifier of the company
        required: true
        schema:
          type: string
      - name: item_type
        in: path
        description: Item type discriminator
        required: true
        schema:
          type: string
      - name: item_id
        in: path
        description: Unique identifier of the item
        required: true
        schema:
          type: string
      - name: attachment_id
        in: query
        description: Optional Prostore attachment identifier
        required: false
        schema:
          type: string
      - name: no_previews
        in: query
        description: When true, omit image previews in the response
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      x-rate-limit-enabled: true
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      x-code-samples:
      - id: node_request
        title: Node.js
        content: "const request = require('request');\n\nconst options = {\n  method: 'GET',\n  url: 'http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D',\n  qs: {attachment_id: 'SOME_STRING_VALUE', no_previews: 'SOME_BOOLEAN_VALUE'}\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.HTTPConnection("localhost:8080")


          conn.request("GET", "/rest/v2.0/companies/%7Bcompany_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D?attachment_id=SOME_STRING_VALUE&no_previews=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 'http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D?attachment_id=SOME_STRING_VALUE&no_previews=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(\"http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D?attachment_id=SOME_STRING_VALUE&no_previews=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}"
    post:
      tags:
      - pre-processing-v-2-controller
      summary: Trigger pre-processing for a file (company scope, v2)
      description: Company-level pre-process trigger without project_id in the path. Tools that require a project may return 400 from the service layer.
      operationId: preProcessFileCompany
      parameters:
      - name: company_id
        in: path
        description: Unique identifier of the company
        required: true
        schema:
          type: string
      - name: item_type
        in: path
        description: Item type discriminator (e.g. document_revision, FileVersion)
        required: true
        schema:
          type: string
      - name: item_id
        in: path
        description: Unique identifier of the item to pre-process
        required: true
        schema:
          type: string
      - name: replace_existing
        in: query
        description: When true, replace any existing pre-processed artifacts
        required: false
        schema:
          type: boolean
          default: false
      - name: attachment_id
        in: query
        description: Optional Prostore attachment identifier
        required: false
        schema:
          type: string
      - name: optimize
        in: query
        description: When true, request optimization passes where supported
        required: false
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      x-rate-limit-enabled: true
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      x-code-samples:
      - id: node_request
        title: Node.js
        content: "const request = require('request');\n\nconst options = {\n  method: 'POST',\n  url: 'http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D',\n  qs: {\n    replace_existing: 'SOME_BOOLEAN_VALUE',\n    attachment_id: 'SOME_STRING_VALUE',\n    optimize: '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.HTTPConnection("localhost:8080")


          conn.request("POST", "/rest/v2.0/companies/%7Bcompany_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D?replace_existing=SOME_BOOLEAN_VALUE&attachment_id=SOME_STRING_VALUE&optimize=SOME_BOOLEAN_VALUE")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - id: shell_curl
        title: Curl
        content: "curl --request POST \\\n  --url 'http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D?replace_existing=SOME_BOOLEAN_VALUE&attachment_id=SOME_STRING_VALUE&optimize=SOME_BOOLEAN_VALUE'"
      - id: csharp_httpclient
        title: C#
        content: "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n    Method = HttpMethod.Post,\n    RequestUri = new Uri(\"http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D?replace_existing=SOME_BOOLEAN_VALUE&attachment_id=SOME_STRING_VALUE&optimize=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}"
  /rest/v2.0/companies/{company_id}/projects/{project_id}/file_processors/preprocess/{item_type}/{item_id}:
    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: partial
    get:
      tags:
      - pre-processing-v-2-controller
      summary: Retrieve pre-processed file metadata (project scope, v2)
      description: Returns pre-processed document metadata in a v2 envelope with allowed_actions from the authenticated user's tool roles.
      operationId: getPreProcessedFileProject
      parameters:
      - name: company_id
        in: path
        description: Unique identifier of the company
        required: true
        schema:
          type: string
      - name: project_id
        in: path
        description: Unique identifier of the project
        required: true
        schema:
          type: string
      - name: item_type
        in: path
        description: Item type discriminator
        required: true
        schema:
          type: string
      - name: item_id
        in: path
        description: Unique identifier of the item
        required: true
        schema:
          type: string
      - name: attachment_id
        in: query
        description: Optional Prostore attachment identifier
        required: false
        schema:
          type: string
      - name: no_previews
        in: query
        description: When true, omit image previews in the response
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      x-rate-limit-enabled: true
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      x-code-samples:
      - id: node_request
        title: Node.js
        content: "const request = require('request');\n\nconst options = {\n  method: 'GET',\n  url: 'http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D',\n  qs: {attachment_id: 'SOME_STRING_VALUE', no_previews: 'SOME_BOOLEAN_VALUE'}\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.HTTPConnection("localhost:8080")


          conn.request("GET", "/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D?attachment_id=SOME_STRING_VALUE&no_previews=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 'http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D?attachment_id=SOME_STRING_VALUE&no_previews=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(\"http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D?attachment_id=SOME_STRING_VALUE&no_previews=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}"
    post:
      tags:
      - pre-processing-v-2-controller
      summary: Trigger pre-processing for a file (project scope, v2)
      description: Creates a process to pre-process the document and upload to storage. Response uses the v2 data envelope; no permissions object on POST.
      operationId: preProcessFileProject
      parameters:
      - name: company_id
        in: path
        description: Unique identifier of the company
        required: true
        schema:
          type: string
      - name: project_id
        in: path
        description: Unique identifier of the project
        required: true
        schema:
          type: string
      - name: item_type
        in: path
        description: Item type discriminator (e.g. document_revision, FileVersion)
        required: true
        schema:
          type: string
      - name: item_id
        in: path
        description: Unique identifier of the item to pre-process
        required: true
        schema:
          type: string
      - name: replace_existing
        in: query
        description: When true, replace any existing pre-processed artifacts
        required: false
        schema:
          type: boolean
          default: false
      - name: attachment_id
        in: query
        description: Optional Prostore attachment identifier
        required: false
        schema:
          type: string
      - name: optimize
        in: query
        description: When true, request optimization passes where supported
        required: false
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      x-rate-limit-enabled: true
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      x-code-samples:
      - id: node_request
        title: Node.js
        content: "const request = require('request');\n\nconst options = {\n  method: 'POST',\n  url: 'http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D',\n  qs: {\n    replace_existing: 'SOME_BOOLEAN_VALUE',\n    attachment_id: 'SOME_STRING_VALUE',\n    optimize: '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.HTTPConnection("localhost:8080")


          conn.request("POST", "/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D?replace_existing=SOME_BOOLEAN_VALUE&attachment_id=SOME_STRING_VALUE&optimize=SOME_BOOLEAN_VALUE")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - id: shell_curl
        title: Curl
        content: "curl --request POST \\\n  --url 'http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D?replace_existing=SOME_BOOLEAN_VALUE&attachment_id=SOME_STRING_VALUE&optimize=SOME_BOOLEAN_VALUE'"
      - id: csharp_httpclient
        title: C#
        content: "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n    Method = HttpMethod.Post,\n    RequestUri = new Uri(\"http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/preprocess/%7Bitem_type%7D/%7Bitem_id%7D?replace_existing=SOME_BOOLEAN_VALUE&attachment_id=SOME_STRING_VALUE&optimize=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}"
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer