POST api/Dashboard?param={param}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
param

string

Required

Body Parameters

DashboardFilter
NameDescriptionTypeAdditional 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": "4b16a9dd-855f-4ba5-93a5-627157c30d38",
  "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:57:42.0939372+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>4b16a9dd-855f-4ba5-93a5-627157c30d38</ClientId>
  <ComplianceFrequencyId>sample string 8</ComplianceFrequencyId>
  <ComplianceTypeId>sample string 20</ComplianceTypeId>
  <ComplianceTypeIds>sample string 38</ComplianceTypeIds>
  <CriticalityId>19</CriticalityId>
  <DateFrom>2024-12-29T09:57:42.0939372+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 DashboardPieChartData
NameDescriptionTypeAdditional information
R_HIGH

integer

None.

R_Medium

integer

None.

R_LOW

integer

None.

E_HIGH

integer

None.

E_Medium

integer

None.

E_LOW

integer

None.

RegularHigh_C

integer

None.

RegularHigh_PC

integer

None.

RegularHigh_NC

integer

None.

RegularMedium_C

integer

None.

RegularMedium_PC

integer

None.

RegularMedium_NC

integer

None.

RegularLow_C

integer

None.

RegularLow_PC

integer

None.

RegularLow_NC

integer

None.

EventHigh_C

integer

None.

EventHigh_PC

integer

None.

EventHigh_NC

integer

None.

EventMedium_C

integer

None.

EventMedium_PC

integer

None.

EventMedium_NC

integer

None.

EventLow_C

integer

None.

EventLow_PC

integer

None.

EventLow_NC

integer

None.

EventConfirmed

integer

None.

EventNotConfirmed

integer

None.

EventNotOccured

integer

None.

Regular_C

integer

None.

Regular_P

integer

None.

Regular_N

integer

None.

Event_C

integer

None.

Event_P

integer

None.

Event_N

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "R_HIGH": 1,
    "R_Medium": 2,
    "R_LOW": 3,
    "E_HIGH": 4,
    "E_Medium": 5,
    "E_LOW": 6,
    "RegularHigh_C": 7,
    "RegularHigh_PC": 8,
    "RegularHigh_NC": 9,
    "RegularMedium_C": 10,
    "RegularMedium_PC": 11,
    "RegularMedium_NC": 12,
    "RegularLow_C": 13,
    "RegularLow_PC": 14,
    "RegularLow_NC": 15,
    "EventHigh_C": 16,
    "EventHigh_PC": 17,
    "EventHigh_NC": 18,
    "EventMedium_C": 19,
    "EventMedium_PC": 20,
    "EventMedium_NC": 21,
    "EventLow_C": 22,
    "EventLow_PC": 23,
    "EventLow_NC": 24,
    "EventConfirmed": 25,
    "EventNotConfirmed": 26,
    "EventNotOccured": 27,
    "Regular_C": 28,
    "Regular_P": 29,
    "Regular_N": 30,
    "Event_C": 31,
    "Event_P": 32,
    "Event_N": 33
  },
  {
    "R_HIGH": 1,
    "R_Medium": 2,
    "R_LOW": 3,
    "E_HIGH": 4,
    "E_Medium": 5,
    "E_LOW": 6,
    "RegularHigh_C": 7,
    "RegularHigh_PC": 8,
    "RegularHigh_NC": 9,
    "RegularMedium_C": 10,
    "RegularMedium_PC": 11,
    "RegularMedium_NC": 12,
    "RegularLow_C": 13,
    "RegularLow_PC": 14,
    "RegularLow_NC": 15,
    "EventHigh_C": 16,
    "EventHigh_PC": 17,
    "EventHigh_NC": 18,
    "EventMedium_C": 19,
    "EventMedium_PC": 20,
    "EventMedium_NC": 21,
    "EventLow_C": 22,
    "EventLow_PC": 23,
    "EventLow_NC": 24,
    "EventConfirmed": 25,
    "EventNotConfirmed": 26,
    "EventNotOccured": 27,
    "Regular_C": 28,
    "Regular_P": 29,
    "Regular_N": 30,
    "Event_C": 31,
    "Event_P": 32,
    "Event_N": 33
  }
]

application/xml, text/xml

Sample:
<ArrayOfDashboardPieChartData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.CustomModel">
  <DashboardPieChartData>
    <E_HIGH>4</E_HIGH>
    <E_LOW>6</E_LOW>
    <E_Medium>5</E_Medium>
    <EventConfirmed>25</EventConfirmed>
    <EventHigh_C>16</EventHigh_C>
    <EventHigh_NC>18</EventHigh_NC>
    <EventHigh_PC>17</EventHigh_PC>
    <EventLow_C>22</EventLow_C>
    <EventLow_NC>24</EventLow_NC>
    <EventLow_PC>23</EventLow_PC>
    <EventMedium_C>19</EventMedium_C>
    <EventMedium_NC>21</EventMedium_NC>
    <EventMedium_PC>20</EventMedium_PC>
    <EventNotConfirmed>26</EventNotConfirmed>
    <EventNotOccured>27</EventNotOccured>
    <Event_C>31</Event_C>
    <Event_N>33</Event_N>
    <Event_P>32</Event_P>
    <R_HIGH>1</R_HIGH>
    <R_LOW>3</R_LOW>
    <R_Medium>2</R_Medium>
    <RegularHigh_C>7</RegularHigh_C>
    <RegularHigh_NC>9</RegularHigh_NC>
    <RegularHigh_PC>8</RegularHigh_PC>
    <RegularLow_C>13</RegularLow_C>
    <RegularLow_NC>15</RegularLow_NC>
    <RegularLow_PC>14</RegularLow_PC>
    <RegularMedium_C>10</RegularMedium_C>
    <RegularMedium_NC>12</RegularMedium_NC>
    <RegularMedium_PC>11</RegularMedium_PC>
    <Regular_C>28</Regular_C>
    <Regular_N>30</Regular_N>
    <Regular_P>29</Regular_P>
  </DashboardPieChartData>
  <DashboardPieChartData>
    <E_HIGH>4</E_HIGH>
    <E_LOW>6</E_LOW>
    <E_Medium>5</E_Medium>
    <EventConfirmed>25</EventConfirmed>
    <EventHigh_C>16</EventHigh_C>
    <EventHigh_NC>18</EventHigh_NC>
    <EventHigh_PC>17</EventHigh_PC>
    <EventLow_C>22</EventLow_C>
    <EventLow_NC>24</EventLow_NC>
    <EventLow_PC>23</EventLow_PC>
    <EventMedium_C>19</EventMedium_C>
    <EventMedium_NC>21</EventMedium_NC>
    <EventMedium_PC>20</EventMedium_PC>
    <EventNotConfirmed>26</EventNotConfirmed>
    <EventNotOccured>27</EventNotOccured>
    <Event_C>31</Event_C>
    <Event_N>33</Event_N>
    <Event_P>32</Event_P>
    <R_HIGH>1</R_HIGH>
    <R_LOW>3</R_LOW>
    <R_Medium>2</R_Medium>
    <RegularHigh_C>7</RegularHigh_C>
    <RegularHigh_NC>9</RegularHigh_NC>
    <RegularHigh_PC>8</RegularHigh_PC>
    <RegularLow_C>13</RegularLow_C>
    <RegularLow_NC>15</RegularLow_NC>
    <RegularLow_PC>14</RegularLow_PC>
    <RegularMedium_C>10</RegularMedium_C>
    <RegularMedium_NC>12</RegularMedium_NC>
    <RegularMedium_PC>11</RegularMedium_PC>
    <Regular_C>28</Regular_C>
    <Regular_N>30</Regular_N>
    <Regular_P>29</Regular_P>
  </DashboardPieChartData>
</ArrayOfDashboardPieChartData>