PUT api/ComplianceReport?clientId={clientId}&roleName={roleName}&assessmentCycleId={assessmentCycleId}

Request Information

URI Parameters

Name	Type	Additional information
clientId	globally unique identifier	Required
roleName	string	Required
assessmentCycleId	globally unique identifier	Required

Body Parameters

CustomComplianceReport

Name	Type	Additional information
entityId	string	None.
countryId	string	None.
regionId	string	None.
stateId	string	None.
locationId	string	None.
complianceCategoryId	string	None.
complianceFrequencyId	string	None.
critcalTypeId	integer	None.
requirementCategoryId	string	None.
actId	string	None.
complianceStatus	string	None.
delayedComplianceOnly	string	None.
isAuditDone	string	None.
complianceStatusbyAuditor	string	None.
ownerOrReviewer	string	None.
complianceType	string	None.
viewReport	string	None.
complianceMonth	string	None.
fromDate	string	None.
toDate	string	None.
searchText	string	None.
periodicity	string	None.
adminAssignedStateRoles	string	None.

Request Formats

application/json, text/json

Sample:

{
  "entityId": "sample string 1",
  "countryId": "sample string 2",
  "regionId": "sample string 3",
  "stateId": "sample string 4",
  "locationId": "sample string 5",
  "complianceCategoryId": "sample string 6",
  "complianceFrequencyId": "sample string 7",
  "critcalTypeId": 8,
  "requirementCategoryId": "sample string 9",
  "actId": "sample string 10",
  "complianceStatus": "sample string 11",
  "delayedComplianceOnly": "sample string 12",
  "isAuditDone": "sample string 13",
  "complianceStatusbyAuditor": "sample string 14",
  "ownerOrReviewer": "sample string 15",
  "complianceType": "sample string 16",
  "viewReport": "sample string 17",
  "complianceMonth": "sample string 18",
  "fromDate": "sample string 19",
  "toDate": "sample string 20",
  "searchText": "sample string 21",
  "periodicity": "sample string 22",
  "adminAssignedStateRoles": "sample string 23"
}

application/xml, text/xml

Sample:

<CustomComplianceReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.CustomModel">
  <actId>sample string 10</actId>
  <adminAssignedStateRoles>sample string 23</adminAssignedStateRoles>
  <complianceCategoryId>sample string 6</complianceCategoryId>
  <complianceFrequencyId>sample string 7</complianceFrequencyId>
  <complianceMonth>sample string 18</complianceMonth>
  <complianceStatus>sample string 11</complianceStatus>
  <complianceStatusbyAuditor>sample string 14</complianceStatusbyAuditor>
  <complianceType>sample string 16</complianceType>
  <countryId>sample string 2</countryId>
  <critcalTypeId>8</critcalTypeId>
  <delayedComplianceOnly>sample string 12</delayedComplianceOnly>
  <entityId>sample string 1</entityId>
  <fromDate>sample string 19</fromDate>
  <isAuditDone>sample string 13</isAuditDone>
  <locationId>sample string 5</locationId>
  <ownerOrReviewer>sample string 15</ownerOrReviewer>
  <periodicity>sample string 22</periodicity>
  <regionId>sample string 3</regionId>
  <requirementCategoryId>sample string 9</requirementCategoryId>
  <searchText>sample string 21</searchText>
  <stateId>sample string 4</stateId>
  <toDate>sample string 20</toDate>
  <viewReport>sample string 17</viewReport>
</CustomComplianceReport>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ComplianceReportDataForExcel

Name	Type	Additional information
complianceNumber	integer	None.
groupEntityName	string	None.
entityName	string	None.
countryName	string	None.
regionName	string	None.
stateName	string	None.
locationName	string	None.
opertatingUnit	string	None.
categoryName	string	None.
requirmentCategory	string	None.
act	string	None.
section	string	None.
complianceTitle	string	None.
actionItems	string	None.
criticality	string	None.
releventAuthority	string	None.
frequencyOfCompl	string	None.
PeriodicityOfCompl	string	None.
eventCategory	string	None.
eventSubCategory	string	None.
impactOfNonCompliance	string	None.
dueDate	date	None.
evidenceToBeMentained	string	None.
finalComplianceStatus	string	None.
complianceStatusByOwner	string	None.
ownerRemarkandEvidence	string	None.
paymentSubmitionDate	date	None.
systeLogDate	date	None.
delayedDays	integer	None.
ComplianceStatusByReviewer	string	None.
reviewDate	date	None.
reviewerRemark	string	None.
ComplianceStatusByAuditor	string	None.
AuditDate	date	None.
auditorRemark	string	None.
auditorName	string	None.
currentComplianceOwnerName	string	None.
currentComplianceReviewerName	string	None.
currentComplianceOwnerEmail	string	None.
currentComplianceReviewerEmail	string	None.
evudenceSubmited	string	None.
functionName	string	None.
categoryHeadName	string	None.
depertmentHeadName	string	None.
categoryHeadEmail	string	None.
depertmentHeadEmail	string	None.
response	string	None.
createdDate	string	None.
modifiedDate	string	None.
originalResponse	string	None.
statusDescription	string	None.
isAttachment	string	None.
complianceType	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "complianceNumber": 1,
    "groupEntityName": "sample string 2",
    "entityName": "sample string 3",
    "countryName": "sample string 4",
    "regionName": "sample string 5",
    "stateName": "sample string 6",
    "locationName": "sample string 7",
    "opertatingUnit": "sample string 8",
    "categoryName": "sample string 9",
    "requirmentCategory": "sample string 10",
    "act": "sample string 11",
    "section": "sample string 12",
    "complianceTitle": "sample string 13",
    "actionItems": "sample string 14",
    "criticality": "sample string 15",
    "releventAuthority": "sample string 16",
    "frequencyOfCompl": "sample string 17",
    "PeriodicityOfCompl": "sample string 18",
    "eventCategory": "sample string 19",
    "eventSubCategory": "sample string 20",
    "impactOfNonCompliance": "sample string 21",
    "dueDate": "2024-12-29T09:28:39.5299997+00:00",
    "evidenceToBeMentained": "sample string 22",
    "finalComplianceStatus": "sample string 23",
    "complianceStatusByOwner": "sample string 24",
    "ownerRemarkandEvidence": "sample string 25",
    "paymentSubmitionDate": "2024-12-29T09:28:39.5299997+00:00",
    "systeLogDate": "2024-12-29T09:28:39.5299997+00:00",
    "delayedDays": 26,
    "ComplianceStatusByReviewer": "sample string 27",
    "reviewDate": "2024-12-29T09:28:39.5299997+00:00",
    "reviewerRemark": "sample string 28",
    "ComplianceStatusByAuditor": "sample string 29",
    "AuditDate": "2024-12-29T09:28:39.5299997+00:00",
    "auditorRemark": "sample string 30",
    "auditorName": "sample string 31",
    "currentComplianceOwnerName": "sample string 32",
    "currentComplianceReviewerName": "sample string 33",
    "currentComplianceOwnerEmail": "sample string 34",
    "currentComplianceReviewerEmail": "sample string 35",
    "evudenceSubmited": "sample string 36",
    "functionName": "sample string 37",
    "categoryHeadName": "sample string 38",
    "depertmentHeadName": "sample string 39",
    "categoryHeadEmail": "sample string 40",
    "depertmentHeadEmail": "sample string 41",
    "response": "sample string 42",
    "createdDate": "sample string 43",
    "modifiedDate": "sample string 44",
    "originalResponse": "sample string 45",
    "statusDescription": "sample string 46",
    "isAttachment": "sample string 47",
    "complianceType": "sample string 48"
  },
  {
    "complianceNumber": 1,
    "groupEntityName": "sample string 2",
    "entityName": "sample string 3",
    "countryName": "sample string 4",
    "regionName": "sample string 5",
    "stateName": "sample string 6",
    "locationName": "sample string 7",
    "opertatingUnit": "sample string 8",
    "categoryName": "sample string 9",
    "requirmentCategory": "sample string 10",
    "act": "sample string 11",
    "section": "sample string 12",
    "complianceTitle": "sample string 13",
    "actionItems": "sample string 14",
    "criticality": "sample string 15",
    "releventAuthority": "sample string 16",
    "frequencyOfCompl": "sample string 17",
    "PeriodicityOfCompl": "sample string 18",
    "eventCategory": "sample string 19",
    "eventSubCategory": "sample string 20",
    "impactOfNonCompliance": "sample string 21",
    "dueDate": "2024-12-29T09:28:39.5299997+00:00",
    "evidenceToBeMentained": "sample string 22",
    "finalComplianceStatus": "sample string 23",
    "complianceStatusByOwner": "sample string 24",
    "ownerRemarkandEvidence": "sample string 25",
    "paymentSubmitionDate": "2024-12-29T09:28:39.5299997+00:00",
    "systeLogDate": "2024-12-29T09:28:39.5299997+00:00",
    "delayedDays": 26,
    "ComplianceStatusByReviewer": "sample string 27",
    "reviewDate": "2024-12-29T09:28:39.5299997+00:00",
    "reviewerRemark": "sample string 28",
    "ComplianceStatusByAuditor": "sample string 29",
    "AuditDate": "2024-12-29T09:28:39.5299997+00:00",
    "auditorRemark": "sample string 30",
    "auditorName": "sample string 31",
    "currentComplianceOwnerName": "sample string 32",
    "currentComplianceReviewerName": "sample string 33",
    "currentComplianceOwnerEmail": "sample string 34",
    "currentComplianceReviewerEmail": "sample string 35",
    "evudenceSubmited": "sample string 36",
    "functionName": "sample string 37",
    "categoryHeadName": "sample string 38",
    "depertmentHeadName": "sample string 39",
    "categoryHeadEmail": "sample string 40",
    "depertmentHeadEmail": "sample string 41",
    "response": "sample string 42",
    "createdDate": "sample string 43",
    "modifiedDate": "sample string 44",
    "originalResponse": "sample string 45",
    "statusDescription": "sample string 46",
    "isAttachment": "sample string 47",
    "complianceType": "sample string 48"
  }
]

application/xml, text/xml

Sample:

<ArrayOfComplianceReportDataForExcel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.CustomModel">
  <ComplianceReportDataForExcel>
    <AuditDate>2024-12-29T09:28:39.5299997+00:00</AuditDate>
    <ComplianceStatusByAuditor>sample string 29</ComplianceStatusByAuditor>
    <ComplianceStatusByReviewer>sample string 27</ComplianceStatusByReviewer>
    <PeriodicityOfCompl>sample string 18</PeriodicityOfCompl>
    <act>sample string 11</act>
    <actionItems>sample string 14</actionItems>
    <auditorName>sample string 31</auditorName>
    <auditorRemark>sample string 30</auditorRemark>
    <categoryHeadEmail>sample string 40</categoryHeadEmail>
    <categoryHeadName>sample string 38</categoryHeadName>
    <categoryName>sample string 9</categoryName>
    <complianceNumber>1</complianceNumber>
    <complianceStatusByOwner>sample string 24</complianceStatusByOwner>
    <complianceTitle>sample string 13</complianceTitle>
    <complianceType>sample string 48</complianceType>
    <countryName>sample string 4</countryName>
    <createdDate>sample string 43</createdDate>
    <criticality>sample string 15</criticality>
    <currentComplianceOwnerEmail>sample string 34</currentComplianceOwnerEmail>
    <currentComplianceOwnerName>sample string 32</currentComplianceOwnerName>
    <currentComplianceReviewerEmail>sample string 35</currentComplianceReviewerEmail>
    <currentComplianceReviewerName>sample string 33</currentComplianceReviewerName>
    <delayedDays>26</delayedDays>
    <depertmentHeadEmail>sample string 41</depertmentHeadEmail>
    <depertmentHeadName>sample string 39</depertmentHeadName>
    <dueDate>2024-12-29T09:28:39.5299997+00:00</dueDate>
    <entityName>sample string 3</entityName>
    <eventCategory>sample string 19</eventCategory>
    <eventSubCategory>sample string 20</eventSubCategory>
    <evidenceToBeMentained>sample string 22</evidenceToBeMentained>
    <evudenceSubmited>sample string 36</evudenceSubmited>
    <finalComplianceStatus>sample string 23</finalComplianceStatus>
    <frequencyOfCompl>sample string 17</frequencyOfCompl>
    <functionName>sample string 37</functionName>
    <groupEntityName>sample string 2</groupEntityName>
    <impactOfNonCompliance>sample string 21</impactOfNonCompliance>
    <isAttachment>sample string 47</isAttachment>
    <locationName>sample string 7</locationName>
    <modifiedDate>sample string 44</modifiedDate>
    <opertatingUnit>sample string 8</opertatingUnit>
    <originalResponse>sample string 45</originalResponse>
    <ownerRemarkandEvidence>sample string 25</ownerRemarkandEvidence>
    <paymentSubmitionDate>2024-12-29T09:28:39.5299997+00:00</paymentSubmitionDate>
    <regionName>sample string 5</regionName>
    <releventAuthority>sample string 16</releventAuthority>
    <requirmentCategory>sample string 10</requirmentCategory>
    <response>sample string 42</response>
    <reviewDate>2024-12-29T09:28:39.5299997+00:00</reviewDate>
    <reviewerRemark>sample string 28</reviewerRemark>
    <section>sample string 12</section>
    <stateName>sample string 6</stateName>
    <statusDescription>sample string 46</statusDescription>
    <systeLogDate>2024-12-29T09:28:39.5299997+00:00</systeLogDate>
  </ComplianceReportDataForExcel>
  <ComplianceReportDataForExcel>
    <AuditDate>2024-12-29T09:28:39.5299997+00:00</AuditDate>
    <ComplianceStatusByAuditor>sample string 29</ComplianceStatusByAuditor>
    <ComplianceStatusByReviewer>sample string 27</ComplianceStatusByReviewer>
    <PeriodicityOfCompl>sample string 18</PeriodicityOfCompl>
    <act>sample string 11</act>
    <actionItems>sample string 14</actionItems>
    <auditorName>sample string 31</auditorName>
    <auditorRemark>sample string 30</auditorRemark>
    <categoryHeadEmail>sample string 40</categoryHeadEmail>
    <categoryHeadName>sample string 38</categoryHeadName>
    <categoryName>sample string 9</categoryName>
    <complianceNumber>1</complianceNumber>
    <complianceStatusByOwner>sample string 24</complianceStatusByOwner>
    <complianceTitle>sample string 13</complianceTitle>
    <complianceType>sample string 48</complianceType>
    <countryName>sample string 4</countryName>
    <createdDate>sample string 43</createdDate>
    <criticality>sample string 15</criticality>
    <currentComplianceOwnerEmail>sample string 34</currentComplianceOwnerEmail>
    <currentComplianceOwnerName>sample string 32</currentComplianceOwnerName>
    <currentComplianceReviewerEmail>sample string 35</currentComplianceReviewerEmail>
    <currentComplianceReviewerName>sample string 33</currentComplianceReviewerName>
    <delayedDays>26</delayedDays>
    <depertmentHeadEmail>sample string 41</depertmentHeadEmail>
    <depertmentHeadName>sample string 39</depertmentHeadName>
    <dueDate>2024-12-29T09:28:39.5299997+00:00</dueDate>
    <entityName>sample string 3</entityName>
    <eventCategory>sample string 19</eventCategory>
    <eventSubCategory>sample string 20</eventSubCategory>
    <evidenceToBeMentained>sample string 22</evidenceToBeMentained>
    <evudenceSubmited>sample string 36</evudenceSubmited>
    <finalComplianceStatus>sample string 23</finalComplianceStatus>
    <frequencyOfCompl>sample string 17</frequencyOfCompl>
    <functionName>sample string 37</functionName>
    <groupEntityName>sample string 2</groupEntityName>
    <impactOfNonCompliance>sample string 21</impactOfNonCompliance>
    <isAttachment>sample string 47</isAttachment>
    <locationName>sample string 7</locationName>
    <modifiedDate>sample string 44</modifiedDate>
    <opertatingUnit>sample string 8</opertatingUnit>
    <originalResponse>sample string 45</originalResponse>
    <ownerRemarkandEvidence>sample string 25</ownerRemarkandEvidence>
    <paymentSubmitionDate>2024-12-29T09:28:39.5299997+00:00</paymentSubmitionDate>
    <regionName>sample string 5</regionName>
    <releventAuthority>sample string 16</releventAuthority>
    <requirmentCategory>sample string 10</requirmentCategory>
    <response>sample string 42</response>
    <reviewDate>2024-12-29T09:28:39.5299997+00:00</reviewDate>
    <reviewerRemark>sample string 28</reviewerRemark>
    <section>sample string 12</section>
    <stateName>sample string 6</stateName>
    <statusDescription>sample string 46</statusDescription>
    <systeLogDate>2024-12-29T09:28:39.5299997+00:00</systeLogDate>
  </ComplianceReportDataForExcel>
</ArrayOfComplianceReportDataForExcel>