Procore Action Plan Template Sections API

openapi: 3.2.0
info:
  title: Procore REST Action Plan Template Sections 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: Action Plan Template Sections
paths:
  /rest/v1.0/companies/{company_id}/recycle_bin/action_plans/plan_template_sections:
    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
    get:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: List Recycled Action Plan Template Sections
      description: Returns all Recycled Action Plan Template Sections for a given company
      tags:
      - Action Plan Template Sections
      parameters:
      - name: page
        in: query
        description: Page
        schema:
          type: integer
      - name: per_page
        in: query
        description: Elements per page
        schema:
          type: integer
      - name: filters[created_at]
        in: query
        description: 'Return item(s) created within the specified ISO 8601 datetime range.

          Formats:

          `YYYY-MM-DD`...`YYYY-MM-DD` - Date

          `YYYY-MM-DDTHH:MM:SSZ`...`YYYY-MM-DDTHH:MM:SSZ` - DateTime with UTC Offset

          `YYYY-MM-DDTHH:MM:SS+XX:00...`YYYY-MM-DDTHH:MM:SS+XX:00` - Datetime with Custom Offset'
        required: false
        schema:
          type: string
          format: date
      - name: filters[id]
        in: query
        description: Return item(s) with the specified IDs.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
      - name: filters[plan_template_id]
        in: query
        description: Return section(s) associated with the specified Action Plan Template ID(s).
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
      - name: filters[updated_at]
        in: query
        description: 'Return item(s) last updated within the specified ISO 8601 datetime range.

          Formats:

          `YYYY-MM-DD`...`YYYY-MM-DD` - Date

          `YYYY-MM-DDTHH:MM:SSZ`...`YYYY-MM-DDTHH:MM:SSZ` - DateTime with UTC Offset

          `YYYY-MM-DDTHH:MM:SS+XX:00`...`YYYY-MM-DDTHH:MM:SS+XX:00` - Datetime with Custom Offset'
        required: false
        schema:
          type: string
          format: date
      responses:
        '200':
          description: OK
          headers:
            Per-Page:
              description: Number of items retrieved per page
              schema:
                type: integer
            Total:
              description: Total number of items to be retrieved
              schema:
                type: integer
            Link:
              description: Link headers for the first, prev, next, and last link
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                description: Recycled Action Plan Template Sections (Index)
                items:
                  type: object
                  description: Recycled Action Plan Template Section (Show)
                  properties:
                    id:
                      type: integer
                      description: Unique identifier of the deleted template section.
                      example: 43584
                    created_at:
                      type: string
                      format: date-time
                      description: Timestamp when the section was created. ISO 8601 format.
                      example: '2018-09-20T21:39:40Z'
                    deleted_at:
                      type: string
                      format: date-time
                      description: Timestamp when the section was moved to the recycle bin. ISO 8601 format.
                      example: '2017-01-16T18:42:12Z'
                    plan_template_id:
                      type: integer
                      description: Unique identifier of the parent Action Plan Template.
                      example: 57
                    position:
                      type: integer
                      description: Ordinal position of this section within the template. Use to determine display order.
                      example: 3
                    title:
                      type: string
                      description: Title of the template section.
                      example: A New Action Plan Template Section
                    updated_at:
                      type: string
                      format: date-time
                      description: Timestamp when the section 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
      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/recycle_bin/action_plans/plan_template_sections',\n  qs: {\n    page: 'SOME_INTEGER_VALUE',\n    per_page: 'SOME_INTEGER_VALUE',\n    'filters[created_at]': 'SOME_STRING_VALUE',\n    'filters[id]': 'SOME_ARRAY_VALUE',\n    'filters[plan_template_id]': 'SOME_ARRAY_VALUE',\n    'filters[updated_at]': '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/recycle_bin/action_plans/plan_template_sections?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Bcreated_at%5D=SOME_STRING_VALUE&filters%5Bid%5D=SOME_ARRAY_VALUE&filters%5Bplan_template_id%5D=SOME_ARRAY_VALUE&filters%5Bupdated_at%5D=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/recycle_bin/action_plans/plan_template_sections?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Bcreated_at%5D=SOME_STRING_VALUE&filters%5Bid%5D=SOME_ARRAY_VALUE&filters%5Bplan_template_id%5D=SOME_ARRAY_VALUE&filters%5Bupdated_at%5D=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/recycle_bin/action_plans/plan_template_sections?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Bcreated_at%5D=SOME_STRING_VALUE&filters%5Bid%5D=SOME_ARRAY_VALUE&filters%5Bplan_template_id%5D=SOME_ARRAY_VALUE&filters%5Bupdated_at%5D=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: Added Recycled Company Action Plan Template Section list endpoint
        description: Get a list of Recycled Company Action Plan Template Sections.
        endpoint: GET /companies/{company_id}/recycle_bin/action_plans/plan_template_sections
        type: new
        breaking: false
        datestamp: '2021-03-10'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: company-action-plan-template-sections?version=1.0#list-recycled-action-plan-template-sections
      operationId: listRecycledActionPlanTemplateSections
  /rest/v1.0/companies/{company_id}/recycle_bin/action_plans/plan_template_sections/{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: Action Plan Template Section ID
      required: true
      schema:
        type: integer
    x-compliance-level: full
    get:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Show Recycled Action Plan Template Section
      description: Returns a Recycled Action Plan Template Section
      tags:
      - Action Plan Template Sections
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                description: Recycled Action Plan Template Section (Show)
                properties:
                  id:
                    type: integer
                    description: Unique identifier of the deleted template section.
                    example: 43584
                  created_at:
                    type: string
                    format: date-time
                    description: Timestamp when the section was created. ISO 8601 format.
                    example: '2018-09-20T21:39:40Z'
                  deleted_at:
                    type: string
                    format: date-time
                    description: Timestamp when the section was moved to the recycle bin. ISO 8601 format.
                    example: '2017-01-16T18:42:12Z'
                  plan_template_id:
                    type: integer
                    description: Unique identifier of the parent Action Plan Template.
                    example: 57
                  position:
                    type: integer
                    description: Ordinal position of this section within the template. Use to determine display order.
                    example: 3
                  title:
                    type: string
                    description: Title of the template section.
                    example: A New Action Plan Template Section
                  updated_at:
                    type: string
                    format: date-time
                    description: Timestamp when the section was last modified. ISO 8601 format.
                    example: '2018-09-20T21:39:40Z'
        '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
        '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: 'GET',\n  url: 'https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/recycle_bin/action_plans/plan_template_sections/%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/recycle_bin/action_plans/plan_template_sections/%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/recycle_bin/action_plans/plan_template_sections/%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/recycle_bin/action_plans/plan_template_sections/%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 Recycled Company Action Plan Template Section show endpoint
        description: View the details of a Recycled Company Action Plan Template Section.
        endpoint: GET /companies/{company_id}/recycle_bin/action_plans/plan_template_sections/{id}
        type: new
        breaking: false
        datestamp: '2021-03-10'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: company-action-plan-template-sections?version=1.0#show-recycled-action-plan-template-section
      operationId: showRecycledActionPlanTemplateSection
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer