PUT api/dashboard/{id}/setwidget

Add widget to dashboard
Request Information

URI Parameters

Name	Description	Type	Additional information
id	Dashboard Id	integer	Required
Body Parameters

Widget to be added to dashboard
SetInternalWidgetCommandDataContract
Name	Type	Additional information
PropertyConfig	PropertyWidgetConfigDataContract	None.
EventConfig	EventWidgetConfigDataContract	None.
GroupConfig	GroupWidgetConfigDataContract	None.
IntervalConfig	IntervalWidgetConfigDataContract	None.
TodoConfig	TodoWidgetConfigDataContract	None.
TodoTaskConfig	TodoTaskWidgetConfigDataContract	None.
IntegrationsConfig	IntegrationsWidgetConfigDataContract	None.
Layout	WidgetLayoutDataContract	None.
Title	string	None.
Description	string	None.
Category	EnumDataContract	None.
ViewType	EnumDataContract	None.
WidgetType	EnumDataContract	None.
Id	integer	None.
Request Formats

application/x-www-form-urlencoded

Sample:
Sample not available.
application/json, text/json

Sample:
{
  "PropertyConfig": {
    "RoleStatuses": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "MarketingFlags": {
      "sample string 1": true,
      "sample string 3": true
    },
    "DatesSetting": 0,
    "StartDate": "2025-11-13T01:58:49.7719209Z",
    "EndDate": "2025-11-13T01:58:49.7719209Z",
    "Interval": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Filter": {
      "Name": "sample string 1",
      "CustomFilterConfig": "sample string 2",
      "BranchId": 1,
      "BranchIds": [
        1,
        2
      ],
      "EventBranchIds": [
        1,
        2
      ],
      "Order": 0,
      "SearchTerm": "sample string 3",
      "FilterType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ShowDeleted": true,
      "ShowCancelled": true,
      "OwningTeamId": 6,
      "Id": 7
    },
    "RoleTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Id": 1
  },
  "EventConfig": {
    "EventTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "EventCategories": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "EventStatuses": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "OfferStatuses": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "DatesSetting": 0,
    "StartDate": "2025-11-13T01:58:49.7719209Z",
    "EndDate": "2025-11-13T01:58:49.7719209Z",
    "Interval": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Filter": {
      "Name": "sample string 1",
      "CustomFilterConfig": "sample string 2",
      "BranchId": 1,
      "BranchIds": [
        1,
        2
      ],
      "EventBranchIds": [
        1,
        2
      ],
      "Order": 0,
      "SearchTerm": "sample string 3",
      "FilterType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ShowDeleted": true,
      "ShowCancelled": true,
      "OwningTeamId": 6,
      "Id": 7
    },
    "RoleTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Id": 1
  },
  "GroupConfig": {
    "SearchStatuses": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Grades": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "DatesSetting": 0,
    "StartDate": "2025-11-13T01:58:49.7719209Z",
    "EndDate": "2025-11-13T01:58:49.7719209Z",
    "Interval": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Filter": {
      "Name": "sample string 1",
      "CustomFilterConfig": "sample string 2",
      "BranchId": 1,
      "BranchIds": [
        1,
        2
      ],
      "EventBranchIds": [
        1,
        2
      ],
      "Order": 0,
      "SearchTerm": "sample string 3",
      "FilterType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ShowDeleted": true,
      "ShowCancelled": true,
      "OwningTeamId": 6,
      "Id": 7
    },
    "RoleTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Id": 1
  },
  "IntervalConfig": {
    "DateInterval": 0,
    "Negotiators": [
      1,
      2
    ],
    "EventCategory": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "EventTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "BranchId": 1,
    "IncludeDrafts": true,
    "StartDate": "2025-11-13T01:58:49.7719209Z",
    "EndDate": "2025-11-13T01:58:49.7719209Z",
    "Interval": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Filter": {
      "Name": "sample string 1",
      "CustomFilterConfig": "sample string 2",
      "BranchId": 1,
      "BranchIds": [
        1,
        2
      ],
      "EventBranchIds": [
        1,
        2
      ],
      "Order": 0,
      "SearchTerm": "sample string 3",
      "FilterType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ShowDeleted": true,
      "ShowCancelled": true,
      "OwningTeamId": 6,
      "Id": 7
    },
    "RoleTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Id": 3
  },
  "TodoConfig": {
    "FilterCategory": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "BranchId": 1,
    "Negotiators": [
      1,
      2
    ],
    "Statuses": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "ToDoTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Schedules": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Priorities": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Intervals": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "IncludeGlobal": true,
    "OnlyGlobal": true,
    "Sort": "sample string 4",
    "Order": "sample string 5",
    "OwningNegotiatorId": 1,
    "StartDate": "2025-11-13T01:58:49.7719209Z",
    "EndDate": "2025-11-13T01:58:49.7719209Z",
    "Interval": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Filter": {
      "Name": "sample string 1",
      "CustomFilterConfig": "sample string 2",
      "BranchId": 1,
      "BranchIds": [
        1,
        2
      ],
      "EventBranchIds": [
        1,
        2
      ],
      "Order": 0,
      "SearchTerm": "sample string 3",
      "FilterType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ShowDeleted": true,
      "ShowCancelled": true,
      "OwningTeamId": 6,
      "Id": 7
    },
    "RoleTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Id": 6
  },
  "TodoTaskConfig": {
    "Statuses": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Schedules": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "NegotiatorIds": [
      1,
      2
    ],
    "BranchId": 1,
    "OwningNegotiatorId": 1,
    "ClaimedNegotiatorId": 1,
    "IsOverdueOnly": true,
    "StartDate": "2025-11-13T01:58:49.7719209Z",
    "EndDate": "2025-11-13T01:58:49.7719209Z",
    "Interval": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Filter": {
      "Name": "sample string 1",
      "CustomFilterConfig": "sample string 2",
      "BranchId": 1,
      "BranchIds": [
        1,
        2
      ],
      "EventBranchIds": [
        1,
        2
      ],
      "Order": 0,
      "SearchTerm": "sample string 3",
      "FilterType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ShowDeleted": true,
      "ShowCancelled": true,
      "OwningTeamId": 6,
      "Id": 7
    },
    "RoleTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Id": 3
  },
  "IntegrationsConfig": {
    "AppId": 1,
    "BaseUrl": "sample string 2",
    "SandboxSettings": "sample string 3",
    "StartDate": "2025-11-13T01:58:49.7719209Z",
    "EndDate": "2025-11-13T01:58:49.7719209Z",
    "Interval": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Filter": {
      "Name": "sample string 1",
      "CustomFilterConfig": "sample string 2",
      "BranchId": 1,
      "BranchIds": [
        1,
        2
      ],
      "EventBranchIds": [
        1,
        2
      ],
      "Order": 0,
      "SearchTerm": "sample string 3",
      "FilterType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ShowDeleted": true,
      "ShowCancelled": true,
      "OwningTeamId": 6,
      "Id": 7
    },
    "RoleTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    ],
    "Id": 4
  },
  "Layout": {
    "X": 1,
    "Y": 2,
    "Width": 3,
    "Height": 4,
    "WidgetId": 5
  },
  "Title": "sample string 1",
  "Description": "sample string 2",
  "Category": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ViewType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "WidgetType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Id": 3
}
Response Information

Resource Description

IHttpActionResult
None.
Response Formats

application/json, text/json

Sample:
Sample not available.