Procore Time And Material Attachment API

openapi: 3.2.0
info:
  title: Procore REST Time And Material Attachment 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: Time And Material Attachment
paths:
  /rest/v1.0/projects/{project_id}/time_and_material_entry_attachments/{id}:
    parameters:
    - name: Procore-Company-Id
      in: header
      description: Unique company identifier associated with the Procore User Account.
      required: true
      schema:
        type: integer
    - name: project_id
      in: path
      required: true
      description: Unique identifier for the project.
      schema:
        type: integer
    - name: id
      in: path
      description: Unique identifier of the Time & Material attachment.
      required: true
      schema:
        type: integer
    x-compliance-level: full
    delete:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Delete a Time and Material Attachment
      description: Deleting a Time and Material Attachment from a specified Project
      tags:
      - Time And Material Attachment
      parameters:
      - name: id
        in: path
        description: ID of the Time and Material Attachment
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                description: Time and Material Entry Attachment
                properties:
                  id:
                    type: integer
                    description: Unique identifier of the Time & Material entry attachment.
                    example: 1200
                  attachment_id:
                    type: integer
                    description: Identifier of the underlying stored file for this attachment.
                    example: 1233
                  content_type:
                    type: string
                    description: MIME type of the attached file (e.g., image/jpeg, application/pdf).
                    example: image/jpeg
                  presentation_url:
                    type: string
                    description: Publicly accessible URL for viewing the attached file in a browser.
                    example: http://www.example.com/presentation_url
                  url:
                    type: string
                    description: Direct download URL for the attached file.
                    example: http://www.example.com/
                  thumbnail_url:
                    type: string
                    description: URL for a thumbnail preview of the attached file.
                    example: http://www.example.com/thumbnail_url
                  filename:
                    type: string
                    description: Original filename of the uploaded attachment.
                    example: Example Filename
        '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
        '404':
          description: Not found
          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/projects/%7Bproject_id%7D/time_and_material_entry_attachments/%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/projects/%7Bproject_id%7D/time_and_material_entry_attachments/%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/projects/%7Bproject_id%7D/time_and_material_entry_attachments/%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/projects/%7Bproject_id%7D/time_and_material_entry_attachments/%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 destroy endpoint for Project Time and Material Entry attachments
        description: Added the ability to delete a Project Time and Material Entry attachment
        endpoint: DELETE /projects/{project_id}/time_and_material_entry_attachments/{id}
        type: new
        breaking: false
        datestamp: '2021-06-15'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: time-and-material-attachment?version=1.0#delete-a-time-and-material-attachment
      operationId: deleteATimeAndMaterialAttachment
    get:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Show an individual time and material attachment
      description: Return detailed information about a specific time and material attachment
      tags:
      - Time And Material Attachment
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                description: Time and Material Entry Attachment
                properties:
                  id:
                    type: integer
                    description: Unique identifier of the Time & Material entry attachment.
                    example: 1200
                  attachment_id:
                    type: integer
                    description: Identifier of the underlying stored file for this attachment.
                    example: 1233
                  content_type:
                    type: string
                    description: MIME type of the attached file (e.g., image/jpeg, application/pdf).
                    example: image/jpeg
                  presentation_url:
                    type: string
                    description: Publicly accessible URL for viewing the attached file in a browser.
                    example: http://www.example.com/presentation_url
                  url:
                    type: string
                    description: Direct download URL for the attached file.
                    example: http://www.example.com/
                  thumbnail_url:
                    type: string
                    description: URL for a thumbnail preview of the attached file.
                    example: http://www.example.com/thumbnail_url
                  filename:
                    type: string
                    description: Original filename of the uploaded attachment.
                    example: Example Filename
        '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/projects/%7Bproject_id%7D/time_and_material_entry_attachments/%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/projects/%7Bproject_id%7D/time_and_material_entry_attachments/%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/projects/%7Bproject_id%7D/time_and_material_entry_attachments/%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/projects/%7Bproject_id%7D/time_and_material_entry_attachments/%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 show endpoint for an individual project Time and Material Entry attachment
        description: Added the ability to view a Time and Material Entry attachment
        endpoint: GET /projects/{project_id}/time_and_material_entry_attachments/{id}
        type: new
        breaking: false
        datestamp: '2021-06-15'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: time-and-material-attachment?version=1.0#show-an-individual-time-and-material-attachment
      - summary: Added show endpoint for all project Time and Material Entry attachments
        description: Added the ability to view a Time and Material Entry attachment
        endpoint: GET /projects/{project_id}/time_and_material_entry_attachments/{id}
        type: new
        breaking: false
        datestamp: '2021-06-15'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: time-and-material-attachment?version=1.0#show-an-individual-time-and-material-attachment
      operationId: showAnIndividualTimeAndMaterialAttachment
  /rest/v1.0/projects/{project_id}/time_and_material_entry_attachments/bulk_destroy:
    parameters:
    - name: Procore-Company-Id
      in: header
      description: Unique company identifier associated with the Procore User Account.
      required: true
      schema:
        type: integer
    - name: project_id
      in: path
      required: true
      description: Unique identifier for the project.
      schema:
        type: integer
    x-compliance-level: full
    delete:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Bulk Delete Time and Material Attachments
      description: Delete multiple Time and Material Attachments with one request.
      tags:
      - Time And Material Attachment
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - time_and_material_entry_attachment
              properties:
                time_and_material_entry_attachment:
                  description: Parameters for bulk-destroying Time & Material attachments.
                  type: object
                  properties:
                    time_and_material_entry_attachment_ids:
                      type: array
                      description: Array of attachment identifiers to delete.
                      items:
                        type: integer
                        description: Unique identifier of a Time & Material attachment to delete.
                        example: 65
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                description: Array of Time and Material Attachments
                items:
                  type: object
                  description: Time and Material Entry Attachment
                  properties:
                    id:
                      type: integer
                      description: Unique identifier of the Time & Material entry attachment.
                      example: 1200
                    attachment_id:
                      type: integer
                      description: Identifier of the underlying stored file for this attachment.
                      example: 1233
                    content_type:
                      type: string
                      description: MIME type of the attached file (e.g., image/jpeg, application/pdf).
                      example: image/jpeg
                    presentation_url:
                      type: string
                      description: Publicly accessible URL for viewing the attached file in a browser.
                      example: http://www.example.com/presentation_url
                    url:
                      type: string
                      description: Direct download URL for the attached file.
                      example: http://www.example.com/
                    thumbnail_url:
                      type: string
                      description: URL for a thumbnail preview of the attached file.
                      example: http://www.example.com/thumbnail_url
                    filename:
                      type: string
                      description: Original filename of the uploaded attachment.
                      example: Example Filename
        '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
        '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
        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
        mimeType: application/json
        title: Node.js
        content: "const request = require('request');\n\nconst options = {\n  method: 'DELETE',\n  url: 'https://api.procore.com/rest/v1.0/projects/%7Bproject_id%7D/time_and_material_entry_attachments/bulk_destroy',\n  headers: {'content-type': 'application/json'},\n  body: {\n    time_and_material_entry_attachment: {time_and_material_entry_attachment_ids: [65]}\n  },\n  json: true\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
        mimeType: application/json
        title: Python3
        content: 'import http.client


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


          payload = "{\"time_and_material_entry_attachment\":{\"time_and_material_entry_attachment_ids\":[65]}}"


          headers = { ''content-type'': "application/json" }


          conn.request("DELETE", "/rest/v1.0/projects/%7Bproject_id%7D/time_and_material_entry_attachments/bulk_destroy", payload, headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - id: shell_curl
        mimeType: application/json
        title: Curl
        content: "curl --request DELETE \\\n  --url https://api.procore.com/rest/v1.0/projects/%7Bproject_id%7D/time_and_material_entry_attachments/bulk_destroy \\\n  --header 'content-type: application/json' \\\n  --data '{\"time_and_material_entry_attachment\":{\"time_and_material_entry_attachment_ids\":[65]}}'"
      - id: csharp_httpclient
        mimeType: application/json
        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/projects/%7Bproject_id%7D/time_and_material_entry_attachments/bulk_destroy\"),\n    Content = new StringContent(\"{\\\"time_and_material_entry_attachment\\\":{\\\"time_and_material_entry_attachment_ids\\\":[65]}}\")\n    {\n        Headers =\n        {\n            ContentType = new MediaTypeHeaderValue(\"application/json\")\n        }\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 bulk destroy endpoint for project Time and Material Entry attachments
        description: Added the ability to bulk delete a Time and Material Entry attachment
        endpoint: DELETE /projects/{project_id}/time_and_material_entry_attachments/bulk_destroy
        type: new
        breaking: false
        datestamp: '2021-06-15'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: time-and-material-attachment?version=1.0#bulk-delete-time-and-material-attachments
      operationId: bulkDeleteTimeAndMaterialAttachments
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer