POST api/ClientDashboard
Request Information
URI Parameters
None.
Body Parameters
CustomClientDashboardName | Description | Type | Additional information |
---|---|---|---|
ClientDashboardMasterID | globally unique identifier |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
|
ReportID | string |
None. |
|
WorkSpaceID | string |
None. |
|
Categories | Collection of Category |
None. |
|
ClientID | globally unique identifier |
None. |
|
ClientName | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "ClientDashboardMasterID": "dd3de38a-98fa-4ad2-a542-d788adb58ea3", "Name": "sample string 2", "Description": "sample string 3", "ReportID": "sample string 4", "WorkSpaceID": "sample string 5", "Categories": [ { "CategoryName": "sample string 1", "CategoryID": "31bea534-0eef-40ad-ac49-aeb10bda732b" }, { "CategoryName": "sample string 1", "CategoryID": "31bea534-0eef-40ad-ac49-aeb10bda732b" } ], "ClientID": "1963e270-401c-42ba-b2e7-0af7dded85c7", "ClientName": "sample string 7" }
application/xml, text/xml
Sample:
<CustomClientDashboard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.CustomModel"> <Categories> <Category> <CategoryID>31bea534-0eef-40ad-ac49-aeb10bda732b</CategoryID> <CategoryName>sample string 1</CategoryName> </Category> <Category> <CategoryID>31bea534-0eef-40ad-ac49-aeb10bda732b</CategoryID> <CategoryName>sample string 1</CategoryName> </Category> </Categories> <ClientDashboardMasterID>dd3de38a-98fa-4ad2-a542-d788adb58ea3</ClientDashboardMasterID> <ClientID>1963e270-401c-42ba-b2e7-0af7dded85c7</ClientID> <ClientName>sample string 7</ClientName> <Description>sample string 3</Description> <Name>sample string 2</Name> <ReportID>sample string 4</ReportID> <WorkSpaceID>sample string 5</WorkSpaceID> </CustomClientDashboard>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CustomClientDashboardName | Description | Type | Additional information |
---|---|---|---|
ClientDashboardMasterID | globally unique identifier |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
|
ReportID | string |
None. |
|
WorkSpaceID | string |
None. |
|
Categories | Collection of Category |
None. |
|
ClientID | globally unique identifier |
None. |
|
ClientName | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ClientDashboardMasterID": "e90b4b48-7441-4305-aec7-7696b101df39", "Name": "sample string 2", "Description": "sample string 3", "ReportID": "sample string 4", "WorkSpaceID": "sample string 5", "Categories": [ { "CategoryName": "sample string 1", "CategoryID": "3fd914bf-9ac9-48b0-bb05-62b2869e1a38" }, { "CategoryName": "sample string 1", "CategoryID": "3fd914bf-9ac9-48b0-bb05-62b2869e1a38" } ], "ClientID": "d2ac7dda-b589-4825-87ce-7b283e9fae0d", "ClientName": "sample string 7" }
application/xml, text/xml
Sample:
<CustomClientDashboard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.CustomModel"> <Categories> <Category> <CategoryID>3fd914bf-9ac9-48b0-bb05-62b2869e1a38</CategoryID> <CategoryName>sample string 1</CategoryName> </Category> <Category> <CategoryID>3fd914bf-9ac9-48b0-bb05-62b2869e1a38</CategoryID> <CategoryName>sample string 1</CategoryName> </Category> </Categories> <ClientDashboardMasterID>e90b4b48-7441-4305-aec7-7696b101df39</ClientDashboardMasterID> <ClientID>d2ac7dda-b589-4825-87ce-7b283e9fae0d</ClientID> <ClientName>sample string 7</ClientName> <Description>sample string 3</Description> <Name>sample string 2</Name> <ReportID>sample string 4</ReportID> <WorkSpaceID>sample string 5</WorkSpaceID> </CustomClientDashboard>