POST api/Dashboard

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
countryId	string	None.
entityId	string	None.
regionId	string	None.
stateId	string	None.
locationId	string	None.
complianceCategoryId	string	None.
frequencyId	string	None.
ComplianceFrequencyId	string	None.
compliance_Owner_ReviwerId	string	None.
compliance_TypeId	string	None.
compliance_MonthId	string	None.
ownerOrReviwer	integer	None.
assessmentCycleId	string	None.
Month2	string	None.
Month	string	None.
ClientId	globally unique identifier	None.
From_Date	string	None.
To_Date	string	None.
CriticalityId	integer	None.
ComplianceTypeId	string	None.
sEcho	string	None.
iDisplayStart	integer	None.
iDisplayLength	integer	None.
sSearch	string	None.
ids	Collection of string	None.
DateFrom	date	None.
OwnerId	string	None.
ReviewerId	string	None.
Role	string	None.
UserId	string	None.
ownerList	string	None.
reviewerList	string	None.
adminAssignedStateRoles	string	None.
countryIds	string	None.
entityIds	string	None.
regionIds	string	None.
stateIds	string	None.
locationIds	string	None.
ComplianceTypeIds	string	None.
complianceCategoryIds	string	None.
compliancePeriodicityIds	string	None.

Request Formats

application/json, text/json

Sample:

{
  "countryId": "sample string 1",
  "entityId": "sample string 2",
  "regionId": "sample string 3",
  "stateId": "sample string 4",
  "locationId": "sample string 5",
  "complianceCategoryId": "sample string 6",
  "frequencyId": "sample string 7",
  "ComplianceFrequencyId": "sample string 8",
  "compliance_Owner_ReviwerId": "sample string 9",
  "compliance_TypeId": "sample string 10",
  "compliance_MonthId": "sample string 11",
  "ownerOrReviwer": 12,
  "assessmentCycleId": "sample string 13",
  "Month2": "sample string 14",
  "Month": "sample string 15",
  "ClientId": "66dfe647-71a3-411a-8db5-27c8a11cda34",
  "From_Date": "sample string 17",
  "To_Date": "sample string 18",
  "CriticalityId": 19,
  "ComplianceTypeId": "sample string 20",
  "sEcho": "sample string 21",
  "iDisplayStart": 22,
  "iDisplayLength": 23,
  "sSearch": "sample string 24",
  "ids": [
    "sample string 1",
    "sample string 2"
  ],
  "DateFrom": "2024-12-29T09:45:28.6456585+00:00",
  "OwnerId": "sample string 26",
  "ReviewerId": "sample string 27",
  "Role": "sample string 28",
  "UserId": "sample string 29",
  "ownerList": "sample string 30",
  "reviewerList": "sample string 31",
  "adminAssignedStateRoles": "sample string 32",
  "countryIds": "sample string 33",
  "entityIds": "sample string 34",
  "regionIds": "sample string 35",
  "stateIds": "sample string 36",
  "locationIds": "sample string 37",
  "ComplianceTypeIds": "sample string 38",
  "complianceCategoryIds": "sample string 39",
  "compliancePeriodicityIds": "sample string 40"
}

application/xml, text/xml

Sample:

<DashboardFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.CustomModel">
  <ClientId>66dfe647-71a3-411a-8db5-27c8a11cda34</ClientId>
  <ComplianceFrequencyId>sample string 8</ComplianceFrequencyId>
  <ComplianceTypeId>sample string 20</ComplianceTypeId>
  <ComplianceTypeIds>sample string 38</ComplianceTypeIds>
  <CriticalityId>19</CriticalityId>
  <DateFrom>2024-12-29T09:45:28.6456585+00:00</DateFrom>
  <From_Date>sample string 17</From_Date>
  <Month>sample string 15</Month>
  <Month2>sample string 14</Month2>
  <OwnerId>sample string 26</OwnerId>
  <ReviewerId>sample string 27</ReviewerId>
  <Role>sample string 28</Role>
  <To_Date>sample string 18</To_Date>
  <UserId>sample string 29</UserId>
  <adminAssignedStateRoles>sample string 32</adminAssignedStateRoles>
  <assessmentCycleId>sample string 13</assessmentCycleId>
  <complianceCategoryId>sample string 6</complianceCategoryId>
  <complianceCategoryIds>sample string 39</complianceCategoryIds>
  <compliancePeriodicityIds>sample string 40</compliancePeriodicityIds>
  <compliance_MonthId>sample string 11</compliance_MonthId>
  <compliance_Owner_ReviwerId>sample string 9</compliance_Owner_ReviwerId>
  <compliance_TypeId>sample string 10</compliance_TypeId>
  <countryId>sample string 1</countryId>
  <countryIds>sample string 33</countryIds>
  <entityId>sample string 2</entityId>
  <entityIds>sample string 34</entityIds>
  <frequencyId>sample string 7</frequencyId>
  <iDisplayLength>23</iDisplayLength>
  <iDisplayStart>22</iDisplayStart>
  <ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ids>
  <locationId>sample string 5</locationId>
  <locationIds>sample string 37</locationIds>
  <ownerList>sample string 30</ownerList>
  <ownerOrReviwer>12</ownerOrReviwer>
  <regionId>sample string 3</regionId>
  <regionIds>sample string 35</regionIds>
  <reviewerList>sample string 31</reviewerList>
  <sEcho>sample string 21</sEcho>
  <sSearch>sample string 24</sSearch>
  <stateId>sample string 4</stateId>
  <stateIds>sample string 36</stateIds>
</DashboardFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of CustomDashboardMaster

Name	Type	Additional information
C_Country	integer	None.
C_Entity	integer	None.
C_Region	integer	None.
C_States	integer	None.
C_Location	integer	None.
C_Category	integer	None.
C_Frequency	integer	None.
C_OwRv	integer	None.
P_Country	integer	None.
P_Entity	integer	None.
P_Region	integer	None.
P_States	integer	None.
P_Location	integer	None.
P_Category	integer	None.
P_Frequency	integer	None.
P_OwRv	integer	None.
N_Country	integer	None.
N_Entity	integer	None.
N_Region	integer	None.
N_States	integer	None.
N_Location	integer	None.
N_Category	integer	None.
N_Frequency	integer	None.
N_OwRv	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "C_Country": 1,
    "C_Entity": 2,
    "C_Region": 3,
    "C_States": 4,
    "C_Location": 5,
    "C_Category": 6,
    "C_Frequency": 7,
    "C_OwRv": 8,
    "P_Country": 9,
    "P_Entity": 10,
    "P_Region": 11,
    "P_States": 12,
    "P_Location": 13,
    "P_Category": 14,
    "P_Frequency": 15,
    "P_OwRv": 16,
    "N_Country": 17,
    "N_Entity": 18,
    "N_Region": 19,
    "N_States": 20,
    "N_Location": 21,
    "N_Category": 22,
    "N_Frequency": 23,
    "N_OwRv": 24
  },
  {
    "C_Country": 1,
    "C_Entity": 2,
    "C_Region": 3,
    "C_States": 4,
    "C_Location": 5,
    "C_Category": 6,
    "C_Frequency": 7,
    "C_OwRv": 8,
    "P_Country": 9,
    "P_Entity": 10,
    "P_Region": 11,
    "P_States": 12,
    "P_Location": 13,
    "P_Category": 14,
    "P_Frequency": 15,
    "P_OwRv": 16,
    "N_Country": 17,
    "N_Entity": 18,
    "N_Region": 19,
    "N_States": 20,
    "N_Location": 21,
    "N_Category": 22,
    "N_Frequency": 23,
    "N_OwRv": 24
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomDashboardMaster xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.CustomModel">
  <CustomDashboardMaster>
    <C_Category>6</C_Category>
    <C_Country>1</C_Country>
    <C_Entity>2</C_Entity>
    <C_Frequency>7</C_Frequency>
    <C_Location>5</C_Location>
    <C_OwRv>8</C_OwRv>
    <C_Region>3</C_Region>
    <C_States>4</C_States>
    <N_Category>22</N_Category>
    <N_Country>17</N_Country>
    <N_Entity>18</N_Entity>
    <N_Frequency>23</N_Frequency>
    <N_Location>21</N_Location>
    <N_OwRv>24</N_OwRv>
    <N_Region>19</N_Region>
    <N_States>20</N_States>
    <P_Category>14</P_Category>
    <P_Country>9</P_Country>
    <P_Entity>10</P_Entity>
    <P_Frequency>15</P_Frequency>
    <P_Location>13</P_Location>
    <P_OwRv>16</P_OwRv>
    <P_Region>11</P_Region>
    <P_States>12</P_States>
  </CustomDashboardMaster>
  <CustomDashboardMaster>
    <C_Category>6</C_Category>
    <C_Country>1</C_Country>
    <C_Entity>2</C_Entity>
    <C_Frequency>7</C_Frequency>
    <C_Location>5</C_Location>
    <C_OwRv>8</C_OwRv>
    <C_Region>3</C_Region>
    <C_States>4</C_States>
    <N_Category>22</N_Category>
    <N_Country>17</N_Country>
    <N_Entity>18</N_Entity>
    <N_Frequency>23</N_Frequency>
    <N_Location>21</N_Location>
    <N_OwRv>24</N_OwRv>
    <N_Region>19</N_Region>
    <N_States>20</N_States>
    <P_Category>14</P_Category>
    <P_Country>9</P_Country>
    <P_Entity>10</P_Entity>
    <P_Frequency>15</P_Frequency>
    <P_Location>13</P_Location>
    <P_OwRv>16</P_OwRv>
    <P_Region>11</P_Region>
    <P_States>12</P_States>
  </CustomDashboardMaster>
</ArrayOfCustomDashboardMaster>