Procore PDF Template Configs API

openapi: 3.2.0
info:
  title: Procore REST PDF Template Configs 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: PDF Template Configs
paths:
  /rest/v1.0/companies/{company_id}/pdf_template_configs:
    parameters:
    - name: Procore-Company-Id
      in: header
      description: Unique company identifier associated with the Procore User Account.
      required: true
      schema:
        type: integer
    - name: company_id
      in: path
      description: Unique identifier for the company.
      required: true
      schema:
        type: integer
    x-compliance-level: partial
    get:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: List PDF template configs
      description: Returns a list of PDF template configs
      parameters:
      - name: page
        in: query
        description: Page
        schema:
          type: integer
      - name: per_page
        in: query
        description: Elements per page
        schema:
          type: integer
      - name: filters[record_generic_tool_id]
        in: query
        required: false
        description: Return item(s) with the specified Generic Tool ID.
        schema:
          type: integer
      - name: filters[project_id]
        in: query
        description: Return item(s) with the Project ID.
        schema:
          type: integer
      - name: filters[template_name]
        in: query
        description: Return item(s) with provided template_name.
        schema:
          type: string
      - name: filters[only_parent]
        in: query
        description: Return only parent records.
        schema:
          type: boolean
      - name: scope
        in: query
        description: Return only scoped records.
        schema:
          type: string
          enum:
          - inspections
      tags:
      - PDF Template Configs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      description: ID
                      example: 333675
                    description:
                      type: string
                      description: description of the PdfTemplateConfig
                      example: pdf template config description
                    template_name:
                      type: string
                      description: PdfTemplate name
                      example: bid_single
                    default_project:
                      type: boolean
                      description: set the configs as default to every company's project
                    pdf_config_options:
                      type: object
                      properties:
                        collapse_na_sections:
                          type: boolean
                        show_na_items:
                          type: boolean
                        show_status_change:
                          type: boolean
                        show_activity_details:
                          type: boolean
                        disclaimer_footer_text:
                          type: boolean
                        attendees_table_format:
                          type: boolean
                        attendees_phone_number_display:
                          type: boolean
        '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.0/companies/%7Bcompany_id%7D/pdf_template_configs',\n  qs: {\n    page: 'SOME_INTEGER_VALUE',\n    per_page: 'SOME_INTEGER_VALUE',\n    'filters[record_generic_tool_id]': 'SOME_INTEGER_VALUE',\n    'filters[project_id]': 'SOME_INTEGER_VALUE',\n    'filters[template_name]': 'SOME_STRING_VALUE',\n    'filters[only_parent]': 'SOME_BOOLEAN_VALUE',\n    scope: 'SOME_STRING_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/companies/%7Bcompany_id%7D/pdf_template_configs?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Brecord_generic_tool_id%5D=SOME_INTEGER_VALUE&filters%5Bproject_id%5D=SOME_INTEGER_VALUE&filters%5Btemplate_name%5D=SOME_STRING_VALUE&filters%5Bonly_parent%5D=SOME_BOOLEAN_VALUE&scope=SOME_STRING_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/companies/%7Bcompany_id%7D/pdf_template_configs?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Brecord_generic_tool_id%5D=SOME_INTEGER_VALUE&filters%5Bproject_id%5D=SOME_INTEGER_VALUE&filters%5Btemplate_name%5D=SOME_STRING_VALUE&filters%5Bonly_parent%5D=SOME_BOOLEAN_VALUE&scope=SOME_STRING_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/companies/%7Bcompany_id%7D/pdf_template_configs?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Brecord_generic_tool_id%5D=SOME_INTEGER_VALUE&filters%5Bproject_id%5D=SOME_INTEGER_VALUE&filters%5Btemplate_name%5D=SOME_STRING_VALUE&filters%5Bonly_parent%5D=SOME_BOOLEAN_VALUE&scope=SOME_STRING_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: Responds with a list of PDF template configs
        description: Provides a response body containing all PDF template configs visible to the internal user for a given company
        endpoint: GET /companies/{company_id}/pdf_template_configs
        type: new
        breaking: false
        datestamp: '2021-10-18'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: pdf-template-configs?version=1.0#list-pdf-template-configs
      operationId: listPdfTemplateConfigs
  /rest/v1.0/companies/{company_id}/pdf_template_configs/{id}:
    parameters:
    - name: Procore-Company-Id
      in: header
      description: Unique company identifier associated with the Procore User Account.
      required: true
      schema:
        type: integer
    - name: company_id
      in: path
      description: Unique identifier for the company.
      required: true
      schema:
        type: integer
    - name: id
      in: path
      description: PDF Template Configs ID
      required: true
      schema:
        type: integer
    x-compliance-level: full
    get:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Return a PDF Template Config
      tags:
      - PDF Template Configs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    description: ID
                    example: 333675
                  description:
                    type: string
                    description: description of the PdfTemplateConfig
                    example: pdf template config description
                  template_name:
                    type: string
                    description: PdfTemplate name
                    example: bid_single
                  default_project:
                    type: boolean
                    description: set the configs as default to every company's project
                  pdf_config_options:
                    type: object
                    properties:
                      collapse_na_sections:
                        type: boolean
                      show_na_items:
                        type: boolean
                      show_status_change:
                        type: boolean
                      show_activity_details:
                        type: boolean
                      disclaimer_footer_text:
                        type: boolean
                      attendees_table_format:
                        type: boolean
                      attendees_phone_number_display:
                        type: boolean
        '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
      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/companies/%7Bcompany_id%7D/pdf_template_configs/%7Bid%7D'\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/companies/%7Bcompany_id%7D/pdf_template_configs/%7Bid%7D")


          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/companies/%7Bcompany_id%7D/pdf_template_configs/%7Bid%7D"
      - 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/companies/%7Bcompany_id%7D/pdf_template_configs/%7Bid%7D\"),\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: Responds with a pdf template configs
        description: Provides a response body containing a PDF template configs
        endpoint: GET /companies/{company_id}/pdf_template_configs/{id}
        type: new
        breaking: false
        datestamp: '2021-10-18'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: pdf-template-configs?version=1.0#return-a-pdf-template-config
      operationId: returnAPdfTemplateConfig
    delete:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Delete PDF Template Config
      tags:
      - PDF Template Configs
      responses:
        '200':
          description: OK
        '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
      x-code-samples:
      - id: node_request
        title: Node.js
        content: "const request = require('request');\n\nconst options = {\n  method: 'DELETE',\n  url: 'https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/pdf_template_configs/%7Bid%7D'\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("DELETE", "/rest/v1.0/companies/%7Bcompany_id%7D/pdf_template_configs/%7Bid%7D")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - id: shell_curl
        title: Curl
        content: "curl --request DELETE \\\n  --url https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/pdf_template_configs/%7Bid%7D"
      - id: csharp_httpclient
        title: C#
        content: "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n    Method = HttpMethod.Delete,\n    RequestUri = new Uri(\"https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/pdf_template_configs/%7Bid%7D\"),\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 an endpoint to delete pdf template configs
        description: Deletes a PDF Template Configs for a given id.
        endpoint: DELETE /companies/{company_id}/pdf_template_configs/{id}
        type: new
        breaking: false
        datestamp: '2021-10-18'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: pdf-template-configs?version=1.0#delete-pdf-template-config
      operationId: deletePdfTemplateConfig
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer