Canoe Intelligence Terms API

openapi: 3.2.0
info:
  title: Canoe Intelligence Terms API
  version: '1.0'
  description: 'Operations tagged Terms across 3 of this provider''s published API definitions: canoe-intelligence-api-docs-v1-original.yaml, canoe-intelligence-api-openapi-original.json, canoe-intelligence-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.canoesoftware.com
  description: Production API
tags:
- name: Terms
  description: ''
paths:
  Get Terms:
    get:
      tags:
      - Terms
      summary: null
      description: '/v1/terms


        Fetch all terms accessible by the current API user.

        '
      operationId: GetTerms
      parameters:
      - name: term_id
        in: query
        description: Specifying one or more IDs returns the specified Term(s).
        required: false
        schema:
          type: string
        examples:
          term_id single:
            value: term_id_1
          term_id multiple:
            value: term_id_1,term_id_2,term_id_3
      - name: name
        in: query
        description: The name of the Term.  This can either be the formal Term name or any of its associated aliases. To search based on a part of the fund name or alias, append an asterisk * character anywhere within the name parameter.  For example, searching Series* returns all Terms with names starting with Series.
        required: false
        schema:
          type: string
        examples:
          exact name:
            value: Series Term
          part of name:
            value: Series*
      - name: fund_name
        in: query
        description: Specifying a Fund name returns the Term(s) associated with the Fund.  This can either be the formal Fund name or any of its associated aliases.  To search based on a part of the Fund name or alias, append an asterisk * character anywhere within the name parameter.  For example, searching *LP returns all Terms associated with Fund names ending with LP.
        required: false
        schema:
          type: string
        examples:
          exact name:
            value: Fund Example
          part of name:
            value: Fund*
      - name: fund_id
        in: query
        description: Specifying one or more IDs returns the Term(s) associated with the specified Fund(s).
        required: false
        schema:
          type: string
        examples:
          fund_id single:
            value: fund_id_1
          fund_id multiple:
            value: fund_id_1,fund_id_2
      - name: custom_field
        in: query
        description: An indexed string of one or more custom field IDs, which relate to term specific custom fields, and one or more custom field values for each. Specify the custom field ID and then the custom field value(s). When filtering on multiple values, separate them by commas.  Filter on additional custom fields by separating with an ampersand. Example:- /v1/funds?custom_field[bfa7ec21-9a73-4640-03b2-0e32aa1ae8a6]=value1,value2&custom_field[867e4563-c2b5-e788-d050-4ce151dec635]=value1
        required: false
        schema:
          type: string
        examples:
          custom_field:
            value: custom_field[bfa7ec21-9a73-4640-03b2-0e32aa1ae8a6]=value1,value2
      - name: page
        in: query
        description: This page of results to retrieve.  For example, if you specify "2" you will receive all Terms on page 2.  The default is 1.
        required: false
        schema:
          type: string
        examples:
          page 1:
            value: 1
          page 5 multiple:
            value: 5
      - name: perPage
        in: query
        description: The number of Terms for each paginated download. The default is 100.
        required: false
        schema:
          type: string
        examples:
          3 per page:
            value: 3
          50 per page:
            value: 50
      - name: fields
        in: query
        description: The fields you need in the partial response. The value of the fields parameter must be a comma-separated (U+002C COMMA, ",") list that refers to the name(s) of the fields to be returned.
        required: false
        schema:
          type: string
        examples:
          fields:
            value: name,designation,aliases
      requestBody:
        content:
          application/json:
            schema:
              type: string
            examples:
              bash:
                description: "-\n      curl -X GET \\\n          \"https://api.canoesoftware.com/v1/terms\" \\\n          -H \"Authorization: Bearer {token}\" \\\n          -H \"Accept: application/json\" \\\n          -H \"X-Requested-With: XMLHttpRequest\"\n"
                summary: Bash
              Javascript:
                description: "-\n      const url = new URL(\n          \"https://api.canoesoftware.com/v1/terms\"\n      );\n\n      let headers = {\n          \"Authorization\": \"Bearer {token}\",\n          \"Accept\": \"application/json\",\n          \"X-Requested-With\": \"XMLHttpRequest\",\n          \"Content-Type\": \"application/json\",\n      };\n\n      fetch(url, {\n          method: \"GET\",\n          headers: headers,\n      })\n          .then(response => response.json())\n          .then(json => console.log(json));\n"
                summary: JavaScript
              PHP:
                description: "-\n      $client = new \\GuzzleHttp\\Client();\n      $response = $client->get(\n          'https://api.canoesoftware.com/v1/terms',\n          [\n              'headers' => [\n                  'Authorization' => 'Bearer {token}',\n                  'Accept' => 'application/json',\n                  'X-Requested-With' => 'XMLHttpRequest',\n              ],\n          ]\n      );\n      $body = $response->getBody();\n      print_r(json_decode((string) $body));\n"
                summary: PHP
              Python:
                description: "-\n      import requests\n      import json\n\n      url = 'https://api.canoesoftware.com/v1/terms'\n      headers = {\n        'Authorization': 'Bearer {token}',\n        'Accept': 'application/json',\n        'X-Requested-With': 'XMLHttpRequest'\n      }\n      response = requests.request('GET', url, headers=headers)\n      response.json()\n"
                summary: Python
              CSharp:
                description: "-\n      using RestSharp;\n\n      var client = new RestClient(\"https://api.canoesoftware.com/\");\n      var request = new RestRequest(\"v1/terms\", Method.Get);\n      request.AddParameter(\"Authorization\", string.Format(\"Bearer {token}\"), ParameterType.HttpHeader);\n      request.AddHeader(\"Accept\", \"application/json\");\n      request.AddHeader(\"X-Requested-With\", \"XMLHttpRequest\");\n      var response = client.Execute(request);\n      Console.WriteLine(response.Content);\n"
                summary: CSharp
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GetTerms'
  Create A Single Term:
    post:
      tags:
      - Terms
      summary: null
      description: '/v1/terms


        Create a new term based on the input parameters.

        '
      operationId: CreateSingleTerm
      parameters:
      - name: name
        in: body
        description: The name of the Term.
        required: true
        schema:
          type: string
          example:
            name: Sample Term 1
      - name: designation
        in: body
        description: The Term's designation. The available designations are draw, close, series or share_class
        required: true
        schema:
          type: string
          example:
            designation: draw
      - name: aliases
        in: body
        description: Aliases of the Term name. These are user-created. If there are multiple aliases, separate them by commas.
        required: false
        schema:
          type: string
          example:
            aliases: Term Alias 1, Term Alias 2
      - name: fund_id
        in: body
        description: The ID of the Fund to associate the Term. To retrieve these, use the v1/funds endpoint.
        required: true
        schema:
          type: string
          example:
            fund_id: fund_id_1
      - name: custom_fields
        in: body
        description: The array of objects that contain the id of an existing custom field and a new value
        required: false
        schema:
          type: array
          example:
            custom_fields:
            - id: 1
              value: 1000
      - name: custom_fields.*.id
        in: body
        description: ID of the fund custom field.
        required: true
        schema:
          type: string
          example:
            downstream_ids:
            - id: 1
      - name: custom_fields.*.value
        in: body
        description: The value of the custom Field.
        required: true
        schema:
          type: string
          example:
            downstream_ids:
            - value: 1000
      - name: date_format
        in: body
        description: If an extracted date format is ambiguous for month vs day (e.g. 03/08/2024), Canoe will normalize the value based on this setting. For MM-DD-YYYY, enter "US" for DD-MM-YYYY, enter "International"
        required: false
        schema:
          type: string
          example:
            date_format: US
      requestBody:
        content:
          application/json:
            schema:
              type: string
            examples:
              bash:
                description: "-               \n      curl -X POST \\\n      \"https://api.canoesoftware.com/v1/terms\" \\\n      -H \"Authorization: Bearer {token}\" \\\n      -H \"Accept: application/json\" \\\n      -H \"X-Requested-With: XMLHttpRequest\" \\\n      -H \"Content-Type: application/json\" \\\n      -d '{\"name\":\"Sample Term 1.\",\"designation\":\"draw\",\"aliases\":\"Sample Alias 1, Sample Alias 2\",\"fund_id\":\"fund_id_1\"}'\n"
                summary: Bash
              Javascript:
                description: "-\n      const url = new URL(\"https://api.canoesoftware.com/v1/terms\");\n\n      let headers = {\n          \"Authorization\": \"Bearer {token}\",\n          \"Accept\": \"application/json\",\n          \"X-Requested-With\": \"XMLHttpRequest\",\n          \"Content-Type\": \"application/json\",\n      };\n\n      let body = {\n          \"name\": \"Sample Term 1\",\n          \"designation\": \"draw\",\n          \"aliases\": \"Sample Alias 1, Sample Alias 2\",\n          \"fund_id\": \"fund_id_1\"\n      }\n\n      fetch(url, {\n          method: \"POST\",\n          headers: headers,\n          body: body\n      })\n      .then(response => response.json())\n      .then(json => console.log(json));\n"
                summary: JavaScript
              PHP:
                description: "-                  \n      $client = new \\GuzzleHttp\\Client();\n      $response = $client->post('https://api.canoesoftware.com/v1/terms',\n        [\n            'headers' => [\n                'Authorization' => 'Bearer {token}',\n                'Accept' => 'application/json',\n                'X-Requested-With' => 'XMLHttpRequest',\n                'Content-Type' => 'application/json',\n            ],\n            'json' => [\n                'name' => 'Sample Term 1',\n                'designation' => 'draw',\n                'aliases' => 'Sample Alias 1, Sample Alias 2',\n                'fund_id' => 'fund_id_1',\n            ],\n        ]\n        );\n      $body = $response->getBody(); print_r(json_decode((string) $body));\n"
                summary: PHP
              Python:
                description: "-                  \n      import requests\n      import json\n\n      url = 'https://api.canoesoftware.com/v1/terms'\n      payload = {\n          \"name\": \"Sample Term 1\",\n          \"designation\": \"draw\",\n          \"aliases\": \"Sample Alias 1, Sample Alias 2\",\n          \"fund_id\": \"fund_id_1\"\n      }\n      headers = {\n        'Authorization': 'Bearer {token}',\n        'Accept': 'application/json',\n        'X-Requested-With': 'XMLHttpRequest',\n        'Content-Type': 'application/json'\n      }\n      response = requests.request('POST', url, headers=headers, json=payload)\n      response.json()\n"
                summary: Python
              CSharp:
                description: "-\n      using RestSharp;\n\n      var client = new RestClient(\"https://api.canoesoftware.com/\");\n      var request = new RestRequest(\"/v1/terms\", Method.Post);\n      request.AddParameter(\"Authorization\", string.Format(\"Bearer {token}\"), ParameterType.HttpHeader);\n      request.AddHeader(\"Accept\", \"application/json\");\n      request.AddHeader(\"X-Requested-With\", \"XMLHttpRequest\");\n      request.AddHeader(\"Content-Type\", \"application/json\");\n      var body = new\n      {\n          name = \"Sample Term 1\",\n          designation = \"draw\",\n          aliases = \"Sample Alias 1, Sample Alias 2\",\n          fund_id = \"fund_id_1\"\n      };\n      request.AddJsonBody(body);\n      var response = client.Execute(request);\n      Console.WriteLine(response.Content);\n"
                summary: CSharp
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GetTerms'
  Update A Single Term:
    put:
      tags:
      - Terms
      summary: null
      description: '/v1/terms/{id}


        Update the specified term based on the input parameters.

        '
      operationId: UpdateSingleTerm
      parameters:
      - name: id
        in: path
        description: The id of the term to edit.
        required: true
        schema:
          type: string
          example: 1
      - name: name
        in: body
        description: The name of the Term.
        required: false
        schema:
          type: string
          example:
            name: Sample Term 1
      - name: designation
        in: body
        description: The Term's designation. The available designations are draw, close, series or share_class
        required: false
        schema:
          type: string
          example:
            designation: draw
      - name: aliases
        in: body
        description: Aliases of the Term name. These are user-created. If there are multiple aliases, separate them by commas.
        required: false
        schema:
          type: string
          example:
            aliases: Term Alias 1, Term Alias 2
      - name: custom_fields
        in: body
        description: The array of objects that contain the id of an existing custom field and a new value
        required: false
        schema:
          type: array
          example:
            custom_fields:
            - id: 1
              value: 1000
      - name: custom_fields.*.id
        in: body
        description: ID of the term custom field.
        required: true
        schema:
          type: string
          example:
            downstream_ids:
            - id: 1
      - name: custom_fields.*.value
        in: body
        description: The value of the term custom field.
        required: true
        schema:
          type: string
          example:
            downstream_ids:
            - value: 1000
      - name: date_format
        in: body
        description: If an extracted date format is ambiguous for month vs day (e.g. 03/08/2024), Canoe will normalize the value based on this setting. For MM-DD-YYYY, enter "US" for DD-MM-YYYY, enter "International"
        required: false
        schema:
          type: string
          example:
            date_format: US
      - name: extraction_status
        in: body
        description: the Extraction Status on a term. The accepted values are "Ready For Extract" and "Not Ready For Extract"
        required: false
        schema:
          type: string
          example:
            extraction_status: Ready For Extract
      requestBody:
        content:
          application/json:
            schema:
              type: string
            examples:
              bash:
                description: "-\n      curl -X PUT \\\n      \"https://api.canoesoftware.com/v1/terms/term_1\" \\\n      -H \"Authorization: Bearer {token}\" \\\n      -H \"Accept: application/json\" \\\n      -H \"X-Requested-With: XMLHttpRequest\" \\\n      -H \"Content-Type: application/json\" \\\n      -d '{\"name\":\"Sample Term 1.\",\"designation\":\"draw\",\"aliases\":\"Sample Alias 1, Sample Alias 2\"}'\n"
                summary: Bash
              Javascript:
                description: "-\n      const url = new URL(\"https://api.canoesoftware.com/v1/terms/term_1\");\n\n      let headers = {\n          \"Authorization\": \"Bearer {token}\",\n          \"Accept\": \"application/json\",\n          \"X-Requested-With\": \"XMLHttpRequest\",\n          \"Content-Type\": \"application/json\",\n      };\n\n      let body = {\n          \"name\": \"Sample Term 1\",\n          \"designation\": \"draw\",\n          \"aliases\": \"Sample Alias 1, Sample Alias 2\",\n      }\n\n      fetch(url, {\n          method: \"PUT\",\n          headers: headers,\n          body: body\n      })\n      .then(response => response.json())\n      .then(json => console.log(json));\n"
                summary: JavaScript
              PHP:
                description: "-\n      $client = new \\GuzzleHttp\\Client();\n      $response = $client->put('https://api.canoesoftware.com/v1/terms/term_1',\n        [\n            'headers' => [\n                'Authorization' => 'Bearer {token}',\n                'Accept' => 'application/json',\n                'X-Requested-With' => 'XMLHttpRequest',\n                'Content-Type' => 'application/json',\n            ],\n            'json' => [\n                'name' => 'Sample Term 1',\n                'designation' => 'draw',\n                'aliases' => 'Sample Alias 1, Sample Alias 2'\n            ],\n        ]\n        );\n      $body = $response->getBody(); print_r(json_decode((string) $body));\n"
                summary: PHP
              Python:
                description: "-\n      import requests\n      import json\n\n      url = 'https://api.canoesoftware.com/v1/terms/term_1'\n      payload = {\n          \"name\": \"Sample Term 1\",\n          \"designation\": \"draw\",\n          \"aliases\": \"Sample Alias 1, Sample Alias 2\",\n      }\n      headers = {\n        'Authorization': 'Bearer {token}',\n        'Accept': 'application/json',\n        'X-Requested-With': 'XMLHttpRequest',\n        'Content-Type': 'application/json'\n      }\n      response = requests.request('PUT', url, headers=headers, json=payload)\n      response.json()\n"
                summary: Python
              CSharp:
                description: "-\n      using RestSharp;\n\n      var client = new RestClient(\"https://api.canoesoftware.com/\");\n      var request = new RestRequest(\"/v1/terms/term_1\", Method.Put);\n      request.AddParameter(\"Authorization\", string.Format(\"Bearer {token}\"), ParameterType.HttpHeader);\n      request.AddHeader(\"Accept\", \"application/json\");\n      request.AddHeader(\"X-Requested-With\", \"XMLHttpRequest\");\n      request.AddHeader(\"Content-Type\", \"application/json\");\n      var body = new\n      {\n          name = \"Sample Term 1\",\n          designation = \"draw\",\n          aliases = \"Sample Alias 1, Sample Alias 2\"\n      };\n      request.AddJsonBody(body);\n      var response = client.Execute(request);\n      Console.WriteLine(response.Content);\n"
                summary: CSharp
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GetTerms'
  Delete A Single Term:
    delete:
      tags:
      - Terms
      summary: null
      description: '/v1/terms/{id}


        Delete a single term based on the term''s id.

        '
      operationId: DeleteSingleTerm
      parameters:
      - name: id
        in: path
        description: The id of the Term to delete.  Note that the final Term on a Fund cannot be deleted.  Use PUT v1/terms/{id} to update the Term or use DELETE v1/funds/{id} to delete the Fund, which will also delete the Term.  WARNING - This will delete the term as well as it's associated documents and allocations.
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: string
            examples:
              bash:
                description: "-\n      curl -X DELETE \\\n      \"https://api.canoesoftware.com/v1/terms/1\" \\\n      -H \"Authorization: Bearer {token}\" \\\n      -H \"Accept: application/json\" \\\n      -H \"X-Requested-With: XMLHttpRequest\"\n"
                summary: Bash
              Javascript:
                description: "-\n      const url = new URL(\"\n          https://api.canoesoftware.com/v1/terms/1\"\n      );\n\n      let headers = {\n          \"Authorization\": \"Bearer {token}\",\n          \"Accept\": \"application/json\",\n          \"X-Requested-With\": \"XMLHttpRequest\",\n          \"Content-Type\": \"application/json\",\n      };\n\n      fetch(url, {\n          method: \"DELETE\",\n          headers: headers,\n      })\n      .then(response => response.json())\n      .then(json => console.log(json));\n"
                summary: JavaScript
              PHP:
                description: "-\n      $client = new \\GuzzleHttp\\Client();\n      $response = $client->delete(\n          'https://api.canoesoftware.com/v1/terms/1',\n          [\n              'headers' => [\n                  'Authorization' => 'Bearer {token}',\n                  'Accept' => 'application/json',\n                  'X-Requested-With' => 'XMLHttpRequest',\n              ],\n          ]\n      );\n      $body = $response->getBody();\n      print_r(json_decode((string) $body));\n"
                summary: PHP
              Python:
                description: "-\n      import requests\n      import json\n\n      url = 'https://api.canoesoftware.com/v1/terms/1'\n      headers = {\n        'Authorization': 'Bearer {token}',\n        'Accept': 'application/json',\n        'X-Requested-With': 'XMLHttpRequest'\n      }\n      response = requests.request('DELETE', url, headers=headers)\n      response.json()\n"
                summary: Python
              CSharp:
                description: "-\n      using RestSharp;\n\n      var client = new RestClient(\"https://api.canoesoftware.com/\");\n      var request = new RestRequest(\"v1/terms/1\", Method.Delete);\n      request.AddParameter(\"Authorization\", string.Format(\"Bearer {token}\"), ParameterType.HttpHeader);\n      request.AddHeader(\"Accept\", \"application/json\");\n      request.AddHeader(\"X-Requested-With\", \"XMLHttpRequest\");\n      var response = client.Execute(request);\n      Console.WriteLine(response.Content);\n"
                summary: CSharp
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeleteTerm'
        '400':
          description: Invalid Term provided.
        '422':
          Description: Single Term Response, if only one term exists on the fund.
          content:
            application/json:
              schema:
                type: array
                items:
                  example:
                    message: '5a2044f0-4db9-11ed-a40f-0242ac120004 cannot be deleted because it is the last Term on the parent Fund. Use the Delete a single Fund endpoint to delete the Fund ID: fund_id_1'
  /v1/terms:
    get:
      tags:
      - Terms
      summary: Get Terms
      description: Fetch all terms accessible by the current API user.
      operationId: GetTerms
      parameters:
      - name: term_id
        in: query
        description: Specifying one or more IDs returns the specified Term(s).
        required: false
        schema:
          type: string
        examples:
          term_id single:
            value: term_id_1
          term_id multiple:
            value: term_id_1,term_id_2,term_id_3
      - name: name
        in: query
        description: The name of the Term.  This can either be the formal Term name or any of its associated aliases. To search based on a part of the fund name or alias, append an asterisk * character anywhere within the name parameter.  For example, searching Series* returns all Terms with names starting with Series.
        required: false
        schema:
          type: string
        examples:
          exact name:
            value: Series Term
          part of name:
            value: Series*
      - name: fund_name
        in: query
        description: Specifying a Fund name returns the Term(s) associated with the Fund.  This can either be the formal Fund name or any of its associated aliases.  To search based on a part of the Fund name or alias, append an asterisk * character anywhere within the name parameter.  For example, searching *LP returns all Terms associated with Fund names ending with LP.
        required: false
        schema:
          type: string
        examples:
          exact name:
            value: Fund Example
          part of name:
            value: Fund*
      - name: fund_id
        in: query
        description: Specifying one or more IDs returns the Term(s) associated with the specified Fund(s).
        required: false
        schema:
          type: string
        examples:
          fund_id single:
            value: fund_id_1
          fund_id multiple:
            value: fund_id_1,fund_id_2
      - name: custom_field
        in: query
        description: An indexed string of one or more custom field IDs, which relate to term specific custom fields, and one or more custom field values for each. Specify the custom field ID and then the custom field value(s). When filtering on multiple values, separate them by commas.  Filter on additional custom fields by separating with an ampersand. Example:- /v1/funds?custom_field[bfa7ec21-9a73-4640-03b2-0e32aa1ae8a6]=value1,value2&custom_field[867e4563-c2b5-e788-d050-4ce151dec635]=value1
        required: false
        schema:
          type: string
        examples:
          custom_field:
            value: custom_field[bfa7ec21-9a73-4640-03b2-0e32aa1ae8a6]=value1,value2
      - name: page
        in: query
        description: This page of results to retrieve.  For example, if you specify "2" you will receive all Terms on page 2.  The default is 1.
        required: false
        schema:
          type: string
        examples:
          page 1:
            value: '1'
          page 5 multiple:
            value: '5'
      - name: perPage
        in: query
        description: The number of Terms for each paginated download. The default is 100.
        required: false
        schema:
          type: string
        examples:
          3 per page:
            value: '3'
          50 per page:
            value: '50'
      - name: fields
        in: query
        description: The fields you need in the partial response. The value of the fields parameter must be a comma-separated (U+002C COMMA, ",") list that refers to the name(s) of the fields to be returned.
        required: false
        schema:
          type: string
        examples:
          fields:
            value: name,designation,aliases
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GetTerms_2'
      x-codeSamples:
      - lang: bash
        label: Bash
        source: "curl -X GET \\\n          \"https://api.canoesoftware.com/v1/terms\" \\\n          -H \"Authorization: Bearer {token}\" \\\n          -H \"Accept: application/json\" \\\n          -H \"X-Requested-With: XMLHttpRequest\""
      - lang: javascript
        label: JavaScript
        source: "const url = new URL(\n          \"https://api.canoesoftware.com/v1/terms\"\n      );\n\n      let headers = {\n          \"Authorization\": \"Bearer {token}\",\n          \"Accept\": \"application/json\",\n          \"X-Requested-With\": \"XMLHttpRequest\",\n          \"Content-Type\": \"application/json\",\n      };\n\n      fetch(url, {\n          method: \"GET\",\n          headers: headers,\n      })\n          .then(response => response.json())\n          .then(json => console.log(json));"
      - lang: php
        label: PHP
        source: "$client = new \\GuzzleHttp\\Client();\n      $response = $client->get(\n          'https://api.canoesoftware.com/v1/terms',\n          [\n              'headers' => [\n                  'Authorization' => 'Bearer {token}',\n                  'Accept' => 'application/json',\n                  'X-Requested-With' => 'XMLHttpRequest',\n              ],\n          ]\n      );\n      $body = $response->getBody();\n      print_r(json_decode((string) $body));"
      - lang: python
        label: Python
        source: "import requests\n      import json\n\n      url = 'https://api.canoesoftware.com/v1/terms'\n      headers = {\n        'Authorization': 'Bearer {token}',\n        'Accept': 'application/json',\n        'X-Requested-With': 'XMLHttpRequest'\n      }\n      response = requests.request('GET', url, headers=headers)\n      response.json()"
      - lang: csharp
        label: CSharp
        source: "using RestSharp;\n\n      var client = new RestClient(\"https://api.canoesoftware.com/\");\n      var request = new RestRequest(\"v1/terms\", Method.Get);\n      request.AddParameter(\"Authorization\", string.Format(\"Bearer {token}\"), ParameterType.HttpHeader);\n      request.AddHeader(\"Accept\", \"application/json\");\n      request.AddHeader(\"X-Requested-With\", \"XMLHttpRequest\");\n      var response = client.Execute(request);\n      Console.WriteLine(response.Content);"
      security:
      - bearerAuth: []
    post:
      tags:
      - Terms
      summary: Create A Single Term
      description: Create a new term based on the input parameters.
      operationId: CreateSingleTerm
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the Term.
                  example: Sample Term 1
                designation:
                  type: string
                  description: The Term's designation. The available designations are draw, close, series or share_class
                  example: draw
                aliases:
                  type: string
                  description: Aliases of the Term name. These are user-created. If there are multiple aliases, separate them by commas.
                  example: Term Alias 1, Term Alias 2
                fund_id:
                  type: string
                  description: The ID of the Fund to associate the Term. To retrieve these, use the v1/funds endpoint.
                  example: fund_id_1
                custom_fields:
                  type: array
                  description: The array of objects that contain the id of an existing custom field and a new value
                  example:
                  - id: 1
                    value: 1000
              required:
              - name
              - designation
              - fund_id
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GetTerms_2'
      x-codeSamples:
      - lang: bash
        label: Bash
        source: "curl -X POST \\\n      \"https://api.canoesoftware.com/v1/terms\" \\\n      -H \"Authorization: Bearer {token}\" \\\n      -H \"Accept: application/json\" \\\n      -H \"X-Requested-With: XMLHttpRequest\" \\\n      -H \"Content-Type: application/json\" \\\n      -d '{\"name\":\"Sample Term 1.\",\"designation\":\"draw\",\"aliases\":\"Sample Alias 1, Sample Alias 2\",\"fund_id\":\"fund_id_1\"}'

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/canoe-intelligence/refs/heads/main/openapi/canoe-intelligence-terms-api-openapi.yml