Incorrect documentation for the Update Custom Field item on Card API endpoint

XMLWordPrintable

    • Severity 3 - Minor

      Issue Summary

      The PUT Update Custom Field item on Card (/cards/{idCard}/customField/{idCustomField}/item) API documentation states that the number value requires an integer value, while it requires a string value.

      Steps to Reproduce

      1. Create a Custom field with the Number type
      2. Perform a PUT Update Custom Field item on Card API request with the following JSON value, as the documentation suggests:
      {
        "value": {
          "number": 2154
        }
      }

      Expected Results

      The Custom field value is updated.

      Actual Results

      The following error message is thrown:

      {
      "message": "Invalid custom field item value.",	"error": "ERROR"
      } 

      Workaround

      Pass the number value as a string value (with double quotes).
      Example:

      {
        "value": {
          "number": "2154"
        }
      } 

              Assignee:
              Aditya Poudyal
              Reporter:
              Alisson Dalmago
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: