Sign in
latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

21de3aa0b170

Engagements

Search Engagements

Use this API to search for engagements associated with a specific vendor by key terms and filters.

post/api/vendor/v1/engagements-search

Query parameters

pageinteger

Page number of the results list (0…N).

sizeinteger

Number of records per page (1…N).

sort'name,asc' | 'name,desc' | 'createdDate,asc' | 'createdDate,desc'

Returns the engagements list in sorted order. Returns records in in ascending order by engagement name by default.

Request body

SearchCriteriaInformation required— unresolved $ref

Response

OK

emptyboolean

The flag indicating empty search results.

firstboolean

The flag indicating first page of results.

lastboolean

The flag indicating last page of results.

numberinteger

The current page number of results.

numberOfElementsinteger

The count of elements in current page.

sizeinteger

The page size configuration for results.

totalElementsinteger

The total count across all pages.

totalPagesinteger

The total number of available pages.

redactedobject

Field names that should be redacted when user lacks advanced view access

pageableobject

The pagination configuration and metadata.

Example response

{
  "content": [
    {
      "name": "Microsoft Azure",
      "orgGroupId": "a83dac05-e170-4cbd-b0f1-c3591399f04e",
      "internalOwnerId": "20a61b02-482a-44b6-8bc3-be1d4c83331f",
      "externalContact": "Any external contact as its a text field",
      "startDate": "2020-10-12",
      "endDate": "2021-06-30",
      "scope": "License agreement for the IT business unit only",
      "engagementId": "41aa71ae-0ace-4073-8947-e6941714bcf1",
      "number": 12345,
      "internalOwnerUser": "John Smith",
      "internalOwnerEmail": "test@example.com",
      "vendor": {
        "id": "cd7f767c-c849-412c-abbb-b59845cd5476",
        "name": "Microsoft",
        "orgGroupId": "cd7f767c-c849-412c-abbb-b59845cd5476",
        "vendorType": {
          "id": "41aa71ae-0ace-4073-8947-e6941714bcf1",
          "value": "Technology",
          "valueKey": "VendorsTypeTechnology"
        }
      },
      "orgGroupName": "Corporate",
      "type": "VendorEngagement",
      "workflow": {
        "id": "8ac1bf26-fa0d-43d2-9a1b-81130673030c",
        "nameKey": "DefaultEngagementWorkflow",
        "name": "Default Engagement Workflow",
        "stageId": "c6ce7a8b-de4d-4707-924b-d283f273fe2c",
        "stageNameKey": "New",
        "stageName": "New",
        "stageBadgeColor": "blue"
      },
      "attributeValues": {
        "priority": [
          {
            "id": "c5c3167e-f8e2-4719-a0a1-491350507fee",
            "value": "High"
          }
        ],
        "department": [
          {
            "id": "d6d4278f-g9f3-5820-b1b2-592461608gff",
            "value": "IT"
          }
        ]
      },
      "riskLevel": "MEDIUM",
      "riskScore": 2.5,
      "inherentRiskLevel": "HIGH",
      "inherentRiskScore": 3.7,
      "targetRiskLevel": "LOW",
      "targetRiskScore": 1.2,
      "engagementStatus": "ACTIVE",
      "lastUpdatedDate": "2023-05-10T14:30:00Z",
      "createdDate": "2023-01-15T09:20:00Z",
      "createdBy": "8a732373-9713-4f93-98f6-cae431e61956",
      "createdByUser": "Admin User",
      "updatedBy": "8a732373-9713-4f93-98f6-cae431e61956",
      "updatedByUser": "Admin User",
      "doraB07010120IdentificationOfAlternativeThirdParty": "Alternative vendor identified: Oracle Cloud"
    }
  ],
  "numberOfElements": 1,
  "size": 20,
  "totalElements": 1,
  "totalPages": 1,
  "redacted": {
    "41aa71ae-0ace-4073-8947-e6941714bcf1": [
      "field1",
      "field2"
    ]
  },
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 20,
    "paged": true,
    "sort": [
      {
        "ascending": true,
        "descending": false,
        "direction": "ASC",
        "ignoreCase": false,
        "nullHandling": "NATIVE",
        "property": "name"
      }
    ],
    "unpaged": false
  }
}