Procore Company Action Plan Template Reference API

openapi: 3.2.0
info:
  title: Procore REST Company Action Plan Template Reference 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: Company Action Plan Template Reference
paths:
  /rest/v1.0/companies/{company_id}/action_plans/plan_template_references:
    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: full
    post:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Create Company Action Plan Template Reference
      description: Create a Company Action Plan Template Reference
      tags:
      - Company Action Plan Template Reference
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - plan_template_reference
              properties:
                plan_template_reference:
                  type: object
                  required:
                  - payload
                  - plan_template_item_id
                  - type
                  properties:
                    plan_template_item_id:
                      type: integer
                      description: ID of the associated Template Item
                      example: 54
                    type:
                      type: string
                      description: Company Action Plan Template Reference Type
                      enum:
                      - attachment
                      example: attachment
                    payload:
                      type: object
                      description: To upload an attachment you must upload the entire payload as `multipart/form-data` content-type
                      properties:
                        attachment:
                          type: string
                          format: binary
                          description: 'Reference Attachment.

                            To upload an attachment you must upload the entire payload as `multipart/form-data` content-type

                            with the `attachment` file.'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                description: Company Action Plan Template Reference (Show)
                properties:
                  id:
                    type: integer
                    description: Unique identifier of the template reference.
                    example: 12
                  plan_template_item_id:
                    type: integer
                    description: Unique identifier of the template item this reference is attached to.
                    example: 54
                  created_at:
                    type: string
                    format: date-time
                    description: Timestamp when the reference was created. ISO 8601 format.
                    example: '2018-09-20T21:39:40Z'
                  payload:
                    type: object
                    description: Contains type-specific attributes. For company templates, only the attachment type is supported.
                    properties:
                      attachment:
                        type: object
                        properties:
                          id:
                            type: integer
                            description: ID
                            example: 5324
                          url:
                            type: string
                            description: Image URL
                            example: http://www.example.com/
                          thumbnail_url:
                            type:
                            - string
                            - 'null'
                            description: Image Thumbnail URL
                            example: http://www.example.com/
                          name:
                            type: string
                            description: File Name
                            example: january_receipt_copy.jpg
                          content_type:
                            type: string
                            description: Content Type
                            example: image/jpg
                  plan_template_id:
                    type: integer
                    description: Unique identifier of the parent Action Plan Template.
                    example: 985
                  type:
                    type: string
                    description: Type of reference attached to the template item. Company templates only support 'attachment'.
                    enum:
                    - attachment
                    example: attachment
                  updated_at:
                    type: string
                    format: date-time
                    description: Timestamp when the reference was last modified. ISO 8601 format.
                    example: '2018-09-20T21:39:40Z'
        '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
      x-code-samples:
      - id: node_request
        mimeType: multipart/form-data
        title: Node.js
        content: "const request = require('request');\n\nconst options = {\n  method: 'POST',\n  url: 'https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/action_plans/plan_template_references',\n  headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},\n  formData: {\n    plan_template_reference: '{\"plan_template_item_id\":54,\"type\":\"attachment\",\"payload\":{\"attachment\":\"string\"}}'\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
        mimeType: multipart/form-data
        title: Python3
        content: 'import http.client


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


          payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"plan_template_reference\"\r\n\r\n{\"plan_template_item_id\":54,\"type\":\"attachment\",\"payload\":{\"attachment\":\"string\"}}\r\n-----011000010111000001101001--\r\n"


          headers = { ''content-type'': "multipart/form-data; boundary=---011000010111000001101001" }


          conn.request("POST", "/rest/v1.0/companies/%7Bcompany_id%7D/action_plans/plan_template_references", payload, headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - id: shell_curl
        mimeType: multipart/form-data
        title: Curl
        content: "curl --request POST \\\n  --url https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/action_plans/plan_template_references \\\n  --header 'content-type: multipart/form-data' \\\n  --form 'plan_template_reference={\"plan_template_item_id\":54,\"type\":\"attachment\",\"payload\":{\"attachment\":\"string\"}}'"
      - id: csharp_httpclient
        mimeType: multipart/form-data
        title: C#
        content: "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n    Method = HttpMethod.Post,\n    RequestUri = new Uri(\"https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/action_plans/plan_template_references\"),\n    Content = new MultipartFormDataContent\n    {\n        new StringContent(\"{\\\"plan_template_item_id\\\":54,\\\"type\\\":\\\"attachment\\\",\\\"payload\\\":{\\\"attachment\\\":\\\"string\\\"}}\")\n        {\n            Headers =\n            {\n                ContentDisposition = new ContentDispositionHeaderValue(\"form-data\")\n                {\n                    Name = \"plan_template_reference\",\n                }\n            }\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 Company Action Plan Template References create endpoint
        description: Create a Company Action Plan Template References for a given Company.
        endpoint: POST /companies/{company_id}/action_plans/plan_template_references
        type: new
        breaking: false
        datestamp: '2021-02-08'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: company-action-plan-template-references?version=1.0#create-company-action-plan-template-reference
      operationId: createCompanyActionPlanTemplateReference
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer