Procore Generic Tool Status API

openapi: 3.2.0
info:
  title: Procore REST Generic Tool Status 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: Generic Tool Status
paths:
  /rest/v1.0/companies/{company_id}/generic_tools/{generic_tool_id}/statuses:
    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: generic_tool_id
      in: path
      description: Unique identifier for the Generic Tool
      required: true
      schema:
        type: integer
    x-compliance-level: partial
    post:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Create Generic Tool Status
      description: 'Create a new Generic Tool Status for the specified Generic Tool.

        For more information on Generic Tool and Correspondence Tool endpoints,

        see Working with the Correspondence Tool.'
      tags:
      - Generic Tool Status
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - generic_tool_status
              properties:
                generic_tool_status:
                  title: Generic Tool Status
                  type: object
                  required:
                  - status_name
                  - status
                  properties:
                    status_name:
                      type: string
                      description: The name of the generic tool status.
                      example: In Review
                    status:
                      type: string
                      description: The status of the generic tool status.
                      example: Open
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    description: ID
                    example: 5324
                  status_name:
                    type: string
                    description: Status Name
                    example: In Review
                  status:
                    type: string
                    description: Status
                    example: Open
                  is_used:
                    type: boolean
                    description: Is Used in generic tool item or workflow
                    example: true
        '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
        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: 'POST',\n  url: 'https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/generic_tools/%7Bgeneric_tool_id%7D/statuses',\n  headers: {'content-type': 'application/json'},\n  body: {generic_tool_status: {status_name: 'In Review', status: 'Open'}},\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 = "{\"generic_tool_status\":{\"status_name\":\"In Review\",\"status\":\"Open\"}}"


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


          conn.request("POST", "/rest/v1.0/companies/%7Bcompany_id%7D/generic_tools/%7Bgeneric_tool_id%7D/statuses", payload, headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - id: shell_curl
        mimeType: application/json
        title: Curl
        content: "curl --request POST \\\n  --url https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/generic_tools/%7Bgeneric_tool_id%7D/statuses \\\n  --header 'content-type: application/json' \\\n  --data '{\"generic_tool_status\":{\"status_name\":\"In Review\",\"status\":\"Open\"}}'"
      - id: csharp_httpclient
        mimeType: application/json
        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/generic_tools/%7Bgeneric_tool_id%7D/statuses\"),\n    Content = new StringContent(\"{\\\"generic_tool_status\\\":{\\\"status_name\\\":\\\"In Review\\\",\\\"status\\\":\\\"Open\\\"}}\")\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: Updated body requirements to include status
        description: Status property is now required in the body of generic_tool_status body object.
        endpoint: POST /companies/{company_id}/generic_tools/{generic_tool_id}/statuses
        type: feature
        breaking: true
        datestamp: '2022-05-24'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: correspondences?version=1.0#create-generic-tool-status
      - summary: Add is_successful to the request body
        description: Updated the POST request to permit the is_successful attribute for generic tool statuses
        endpoint: POST /companies/{company_id}/generic_tools/{generic_tool_id}/statuses
        type: feature
        breaking: false
        datestamp: '2024-01-16'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: correspondences?version=1.0#create-generic-tool-status
      operationId: createGenericToolStatus
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer