POST api/Dashboard?Month={Month}¶m={param}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Month | string |
Required |
|
param | string |
Required |
Body Parameters
DashboardFilterName | Description | 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": "1301d586-9ffe-4fb9-8913-e77edcc416ca", "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:09:53.448453+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>1301d586-9ffe-4fb9-8913-e77edcc416ca</ClientId> <ComplianceFrequencyId>sample string 8</ComplianceFrequencyId> <ComplianceTypeId>sample string 20</ComplianceTypeId> <ComplianceTypeIds>sample string 38</ComplianceTypeIds> <CriticalityId>19</CriticalityId> <DateFrom>2024-12-29T09:09:53.448453+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 DashboardComplianceDataName | Description | Type | Additional information |
---|---|---|---|
ExtendedDueDate | date |
None. |
|
Response | string |
None. |
|
Status | string |
None. |
|
EventCategory | string |
None. |
|
EventSubCategory | string |
None. |
|
EventCount | integer |
None. |
|
ReviewerId | globally unique identifier |
None. |
|
OwnerId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[ { "ExtendedDueDate": "2024-12-29T09:09:53.448453+00:00", "Response": "sample string 2", "Status": "sample string 3", "EventCategory": "sample string 4", "EventSubCategory": "sample string 5", "EventCount": 6, "ReviewerId": "89b31ada-5cdd-4200-9ad1-58a8ceab90df", "OwnerId": "9f8c474d-06b0-4fa8-836e-c4eb33dd4478" }, { "ExtendedDueDate": "2024-12-29T09:09:53.448453+00:00", "Response": "sample string 2", "Status": "sample string 3", "EventCategory": "sample string 4", "EventSubCategory": "sample string 5", "EventCount": 6, "ReviewerId": "89b31ada-5cdd-4200-9ad1-58a8ceab90df", "OwnerId": "9f8c474d-06b0-4fa8-836e-c4eb33dd4478" } ]
application/xml, text/xml
Sample:
<ArrayOfDashboardComplianceData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.CustomModel"> <DashboardComplianceData> <EventCategory>sample string 4</EventCategory> <EventCount>6</EventCount> <EventSubCategory>sample string 5</EventSubCategory> <ExtendedDueDate>2024-12-29T09:09:53.448453+00:00</ExtendedDueDate> <OwnerId>9f8c474d-06b0-4fa8-836e-c4eb33dd4478</OwnerId> <Response>sample string 2</Response> <ReviewerId>89b31ada-5cdd-4200-9ad1-58a8ceab90df</ReviewerId> <Status>sample string 3</Status> </DashboardComplianceData> <DashboardComplianceData> <EventCategory>sample string 4</EventCategory> <EventCount>6</EventCount> <EventSubCategory>sample string 5</EventSubCategory> <ExtendedDueDate>2024-12-29T09:09:53.448453+00:00</ExtendedDueDate> <OwnerId>9f8c474d-06b0-4fa8-836e-c4eb33dd4478</OwnerId> <Response>sample string 2</Response> <ReviewerId>89b31ada-5cdd-4200-9ad1-58a8ceab90df</ReviewerId> <Status>sample string 3</Status> </DashboardComplianceData> </ArrayOfDashboardComplianceData>