PRproductive
Widgets

Create a widget

Changed on

Create a new widget.

post/api/v2/widgets

Request

  • Base URL
    https://developer.productive.io (the document declares no server; this is the origin it was published from)
  • URL
    https://developer.productive.io/api/v2/widgets
  • Auth
    none declared

Request body

Example request

{
  "data": {
    "type": "widgets",
    "attributes": {
      "title": "Revenue by Project",
      "widget_type_id": 3,
      "column_position": 0,
      "row_position": 0,
      "width": 6,
      "height": 4
    },
    "relationships": {
      "dashboard": {
        "data": {
          "type": "dashboards",
          "id": "34"
        }
      }
    }
  }
}

Response

Single widget

Example response

{
  "data": {
    "id": "56",
    "type": "widgets",
    "attributes": {
      "title": "Revenue by Project",
      "widget_type_id": 3,
      "column_position": 0,
      "row_position": 0,
      "width": 6,
      "height": 4,
      "content": {}
    },
    "relationships": {
      "dashboard": {
        "data": {
          "type": "dashboards",
          "id": "34"
        }
      },
      "filter": {
        "data": null
      }
    }
  },
  "included": []
}

Changes

  • fa3060fd0144Revision changes
    • warning

      added the new bad_decimal_format enum value to the // response property for the response status

    • warning

      added the new non_finite_number enum value to the // response property for the response status

    • warning

      added the new null_bytes_in_params enum value to the // response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • f11a8740641aRevision changes
    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from integer to no type for status

    • warning

      deleted the header request parameter X-Organization-Id

    This list may be incomplete.