GET api/EngagementOverview?clientId={clientId}&roleName={roleName}

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

Collection of EngagementList

Name	Type	Additional information
engagementId	globally unique identifier	None.
progress_Color	string	None.
engagementName	string	None.
engagementType	string	None.
consultant	string	None.
startTime	date	None.
endTime	date	None.
progressbar_Count	integer	None.
engagementStatus	string	None.
projectId	globally unique identifier	None.
scanList	Collection of ScanDetails	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "engagementId": "b07cf54c-bfa5-4ec7-9fac-41cd87b00e35",
    "progress_Color": "sample string 2",
    "engagementName": "sample string 3",
    "engagementType": "sample string 4",
    "consultant": "sample string 5",
    "startTime": "2025-03-19T17:02:55.3230755+00:00",
    "endTime": "2025-03-19T17:02:55.3230755+00:00",
    "progressbar_Count": 6,
    "engagementStatus": "sample string 7",
    "projectId": "fc6cc359-c80f-4bbb-9a42-a12f3e5b5daa",
    "scanList": [
      {
        "scanId": "e25dfe85-2280-48af-939a-7d27bd23deab",
        "scanType": "sample string 2"
      },
      {
        "scanId": "e25dfe85-2280-48af-939a-7d27bd23deab",
        "scanType": "sample string 2"
      }
    ]
  },
  {
    "engagementId": "b07cf54c-bfa5-4ec7-9fac-41cd87b00e35",
    "progress_Color": "sample string 2",
    "engagementName": "sample string 3",
    "engagementType": "sample string 4",
    "consultant": "sample string 5",
    "startTime": "2025-03-19T17:02:55.3230755+00:00",
    "endTime": "2025-03-19T17:02:55.3230755+00:00",
    "progressbar_Count": 6,
    "engagementStatus": "sample string 7",
    "projectId": "fc6cc359-c80f-4bbb-9a42-a12f3e5b5daa",
    "scanList": [
      {
        "scanId": "e25dfe85-2280-48af-939a-7d27bd23deab",
        "scanType": "sample string 2"
      },
      {
        "scanId": "e25dfe85-2280-48af-939a-7d27bd23deab",
        "scanType": "sample string 2"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfEngagementList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.CustomModel">
  <EngagementList>
    <consultant>sample string 5</consultant>
    <endTime>2025-03-19T17:02:55.3230755+00:00</endTime>
    <engagementId>b07cf54c-bfa5-4ec7-9fac-41cd87b00e35</engagementId>
    <engagementName>sample string 3</engagementName>
    <engagementStatus>sample string 7</engagementStatus>
    <engagementType>sample string 4</engagementType>
    <progress_Color>sample string 2</progress_Color>
    <progressbar_Count>6</progressbar_Count>
    <projectId>fc6cc359-c80f-4bbb-9a42-a12f3e5b5daa</projectId>
    <scanList>
      <ScanDetails>
        <scanId>e25dfe85-2280-48af-939a-7d27bd23deab</scanId>
        <scanType>sample string 2</scanType>
      </ScanDetails>
      <ScanDetails>
        <scanId>e25dfe85-2280-48af-939a-7d27bd23deab</scanId>
        <scanType>sample string 2</scanType>
      </ScanDetails>
    </scanList>
    <startTime>2025-03-19T17:02:55.3230755+00:00</startTime>
  </EngagementList>
  <EngagementList>
    <consultant>sample string 5</consultant>
    <endTime>2025-03-19T17:02:55.3230755+00:00</endTime>
    <engagementId>b07cf54c-bfa5-4ec7-9fac-41cd87b00e35</engagementId>
    <engagementName>sample string 3</engagementName>
    <engagementStatus>sample string 7</engagementStatus>
    <engagementType>sample string 4</engagementType>
    <progress_Color>sample string 2</progress_Color>
    <progressbar_Count>6</progressbar_Count>
    <projectId>fc6cc359-c80f-4bbb-9a42-a12f3e5b5daa</projectId>
    <scanList>
      <ScanDetails>
        <scanId>e25dfe85-2280-48af-939a-7d27bd23deab</scanId>
        <scanType>sample string 2</scanType>
      </ScanDetails>
      <ScanDetails>
        <scanId>e25dfe85-2280-48af-939a-7d27bd23deab</scanId>
        <scanType>sample string 2</scanType>
      </ScanDetails>
    </scanList>
    <startTime>2025-03-19T17:02:55.3230755+00:00</startTime>
  </EngagementList>
</ArrayOfEngagementList>