Procore Action Plan Approver Signature API

openapi: 3.2.0
info:
  title: Procore REST Action Plan Approver Signature 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 Approver Signature
paths:
  /rest/v1.0/projects/{project_id}/action_plans/plan_approvers/{plan_approver_id}/signature:
    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: plan_approver_id
      in: path
      required: true
      description: Action Plan Approver ID
      schema:
        type: integer
    x-compliance-level: full
    get:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Show Action Plan Approver Signature
      description: Get the details of an Action Plan Approver Signature
      tags:
      - Action Plan Approver Signature
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                description: Action Plan Party Signature (Show)
                properties:
                  id:
                    type: integer
                    description: Unique identifier for this signature record.
                    example: 32
                  attachment:
                    type: object
                    properties:
                      id:
                        type: integer
                        description: Unique identifier of the Prostore file containing the signature image.
                        example: 23
                      content_type:
                        type: string
                        description: MIME type of the signature file.
                        example: image/png
                      name:
                        type: string
                        description: File name of the uploaded signature image.
                        example: action_plan_party_signature_1.png
                      url:
                        type: string
                        description: URL to download the signature image. The URL is temporary and expires after a period.
                        example: https://storage.procore.com/files/signature.png
                  captured_at:
                    type: string
                    format: date-time
                    description: Timestamp in ISO 8601 format when the signature was captured.
                    example: '2015-02-07T00:00:00Z'
                  captured_by:
                    type:
                    - object
                    - 'null'
                    properties:
                      id:
                        type: integer
                        description: Party Person ID
                        example: 23
                      first_name:
                        type: string
                        description: First name of the Party Person
                        example: Paul
                      last_name:
                        type: string
                        description: Last name of the Party Person
                        example: Admin
                      name:
                        type: string
                        description: Full name of the Party Person
                        example: Paul Admin
                      user_id:
                        type: integer
                        description: User ID of the login account associated with this party person.
                        example: 453
                      is_employee:
                        type: boolean
                        description: Whether this party person is an employee of the current company, as opposed to an external vendor contact.
                        example: true
                      employee_id:
                        type:
                        - string
                        - 'null'
                        description: Employee ID string for this party person. Null if no employee ID is assigned.
                        example: '12'
                      login:
                        type: string
                        description: Email address (login) of the party person's user account.
                        example: login@example.com
                      updated_at:
                        type: string
                        format: date-time
                        description: Time the Party Person was updated
                        example: '2018-09-20T21:39:40Z'
                      vendor:
                        type:
                        - object
                        - 'null'
                        properties:
                          id:
                            type: integer
                            description: Unique identifier of the vendor company this party person belongs to.
                            example: 223
                          name:
                            type: string
                            description: Name of the vendor company this party person belongs to.
                            example: Freddie's Excavating
        '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/projects/%7Bproject_id%7D/action_plans/plan_approvers/%7Bplan_approver_id%7D/signature'\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/action_plans/plan_approvers/%7Bplan_approver_id%7D/signature")


          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/action_plans/plan_approvers/%7Bplan_approver_id%7D/signature"
      - 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/action_plans/plan_approvers/%7Bplan_approver_id%7D/signature\"),\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 Action Plan Approver Signature show endpoint
        description: View the details of an Action Plan Approver Signature.
        endpoint: GET /projects/{project_id}/action_plans/plan_approvers/{plan_approver_id}/signature
        type: new
        breaking: false
        datestamp: '2021-02-12'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: action-plan-approver-signature?version=1.0#show-action-plan-approver-signature
      operationId: showActionPlanApproverSignature
    delete:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Delete Action Plan Approver Signature
      description: Delete an Action Plan Approver Signature
      tags:
      - Action Plan Approver Signature
      responses:
        '204':
          description: No Content
        '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
        '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
        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/action_plans/plan_approvers/%7Bplan_approver_id%7D/signature'\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/action_plans/plan_approvers/%7Bplan_approver_id%7D/signature")


          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/action_plans/plan_approvers/%7Bplan_approver_id%7D/signature"
      - 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/action_plans/plan_approvers/%7Bplan_approver_id%7D/signature\"),\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 Action Plan Approver Signature delete endpoint
        description: Delete an Action Plan Approver Signature.
        endpoint: DELETE /projects/{project_id}/action_plans/plan_approvers/{plan_approver_id}/signature
        type: new
        breaking: false
        datestamp: '2021-02-12'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: action-plan-approver-signature?version=1.0#delete-action-plan-approver-signature
      operationId: deleteActionPlanApproverSignature
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer