openapi: 3.2.0 info: title: Third-Party Management - Third-Party Risk Management… version: '1.0' contact: name: OneTrust Support url: https://my.onetrust.com/s/contactsupport license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 description: The Third-Party Risk Management APIs provide comprehensive functionality for managing vendor relationships, engagements, and contracts within the GRC ecosystem, enabling organizations to assess, monitor, and control third-party risks through engagement lifecycle management, contract administration, and customizable attribute schemas. servers: - url: https://{hostname} variables: hostname: default: hostname description: The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com. tags: - name: Engagements description: The Engagements APIs are used to manage vendor engagement operations including creating, retrieving, updating, and searching engagements with comprehensive attribute management, status control, workflow integration, and schema configuration capabilities. externalDocs: description: OpenAPI 3.1.0 - Download Definition url: https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json paths: /api/vendor/v1/engagement-schemas: get: operationId: getEngagementSchemaUsingGET summary: Get Engagement Schema description: Use this API to retrieve the schema for engagement attributes. The response will include details such as the attribute name, ID, and associated options. tags: - Engagements x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json parameters: - name: activeStatus in: query description: The flag to indicate if only 'Active' status attributes need to be returned or not. required: false schema: type: boolean example: true default: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/AttributeInformation' example: - id: c782f1f1-a2eb-4c0e-b2eb-702fb60561f6 name: Aggregate Risk Level nameKey: Engagement.AggregateRiskLevel description: Overall risk level associated with the engagement descriptionKey: Engagement.AggregateRiskLevel.Description fieldName: aggregateRiskLevel mappedFieldName: aggregateRiskLevel enabled: true required: false readOnly: true encrypted: false allowOther: false baseAttribute: true responseType: SingleSelect formula: null optionType: none optionAllowed: true schemaId: f724dce6-4918-46c9-a21e-b012306af158 schemaName: EngagementSchema responseMaxLength: null source: null responseSubType: null multiSelectMaxOptionValues: null hidden: false '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '429': description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)." headers: Retry-After: schema: description: The number of seconds after which requests will be allowed again. format: int32 ot-period: schema: description: The unit of time for which the rate limit applies enum: - HOUR - MINUTE ot-ratelimit-event-id: schema: description: The unique identifier for the rate-limiting event. format: uuid ot-request-made: schema: description: The number of requests made within the specified period. format: int32 ot-requests-allowed: schema: description: The number of requests allowed within the specified period. format: int32 '500': description: Internal Server Error security: - OAUTH2: - GENERIC - VRM - VRM_READ /api/vendor/v1/engagements/{engagementId}: get: operationId: loadEngagementByEngagementIdUsingGet summary: Get Engagement description: Use this API to retrieve a single engagement by its unique identifier along with the associated vendor, workflow, and attributes. tags: - Engagements x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json parameters: - name: engagementId in: path description: The unique identifier of an engagement. The value can be obtained using the [Get Engagements](/onetrust/reference/loadengagementusingget) API. required: true schema: type: string format: uuid example: 41aa71ae-0ace-4073-8947-e6941714bcf1 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EngagementDetailInformation' example: engagementId: 5ab7eef6-997c-4e30-a628-1d30305f744f name: Microsoft Azure orgGroupName: Corporate orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 type: VendorEngagement startDate: '2023-05-10' endDate: '2023-05-11' internalOwnerId: 8a732373-9713-4f93-98f6-cae431e61956 internalOwnerUser: tyler internalOwnerEmail: tyler@msft.com externalContact: External contact for Microsoft Office notes: This engagement is for Microsoft Office scope: License agreement for the IT business unit only schemaId: bfb03ce4-e214-4c99-84a0-87a253269495 vendor: id: 97e8d8d7-e05c-4e0a-beec-ef1458ea1ebc name: Microsoft orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 orgGroupName: Corporate workflow: id: 8ac1bf26-fa0d-43d2-9a1b-81130673030c nameKey: DefaultEngagementWorkflow name: Default Engagement Workflow stageId: c6ce7a8b-de4d-4707-924b-d283f273fe2c stageNameKey: New stageName: New stageBadgeColor: New attributeValues: attributeSingleSelectValue.value21: - id: c5c3167e-f8e2-4719-a0a1-491350507fee value: Azure Documentation valueKey: OneTrustApp.VRM.Engagement.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99 viewOnly: false riskLevel: MEDIUM riskScore: 2 inherentRiskLevel: MEDIUM inherentRiskScore: 2 targetRiskLevel: HIGH targetRiskScore: 2 engagementStatus: ACTIVE lastUpdatedDate: '2023-05-10' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '429': description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)." headers: Retry-After: schema: description: The number of seconds after which requests will be allowed again. format: int32 ot-period: schema: description: The unit of time for which the rate limit applies enum: - HOUR - MINUTE ot-ratelimit-event-id: schema: description: The unique identifier for the rate-limiting event. format: uuid ot-request-made: schema: description: The number of requests made within the specified period. format: int32 ot-requests-allowed: schema: description: The number of requests allowed within the specified period. format: int32 '500': description: Internal Server Error security: - OAUTH2: - GENERIC - VRM_READ put: operationId: updateEngagementUsingPUT summary: Update Engagement description: 'Use this API to update an existing engagement. > 🗒 Things to Know > > - For date and time attributes, the formatting should follow the `YYYY-MM-DDTHH:MM:SSZ` format. > - An engagement''s workflow or stage cannot be updated using this API. > - If the `orgGroupId` parameter is not passed in the request, the engagement will be created with the same organization assigned to the engagement''s vendor. If the `orgGroupId` parameter value is invalid, then an invalid organization error will be sent. > - The name of the engagement must be 500 characters or less.' tags: - Engagements x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json parameters: - name: engagementId in: path description: The unique identifier of an engagement. The value can be obtained using the [Get Engagements](/onetrust/reference/loadengagementusingget) API. required: true schema: type: string format: uuid example: fbf7843d-bc3c-4ad7-86c7-f6c9a94e873e requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExternalEngagementUpdateRequest' example: notes: This engagement is for Microsoft Office endDate: '2023-05-11' orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 internalOwnerEmail: tyler@msft.com scope: License agreement for the IT business unit only. name: Microsoft Azure attributeValues: attributeSingleSelectValue.value21: - id: c5c3167e-f8e2-4719-a0a1-491350507fee valueKey: OneTrustApp.VRM.Engagement.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99 value: Azure Documentation externalContact: External contact for Microsoft Office type: VendorEngagement startDate: '2023-05-10' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EngagementDetailInformation' example: engagementId: 5ab7eef6-997c-4e30-a628-1d30305f744f name: Microsoft Azure orgGroupName: Corporate orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 type: VendorEngagement startDate: '2023-05-10' endDate: '2023-05-11' internalOwnerId: 8a732373-9713-4f93-98f6-cae431e61956 internalOwnerUser: tyler@msft.com externalContact: External contact for Microsoft Office notes: This engagement is for Microsoft Office scope: License agreement for the IT business unit only schemaId: bfb03ce4-e214-4c99-84a0-87a253269495 vendor: id: 97e8d8d7-e05c-4e0a-beec-ef1458ea1ebc name: Microsoft orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 orgGroupName: Corporate workflow: id: 8ac1bf26-fa0d-43d2-9a1b-81130673030c nameKey: DefaultEngagementWorkflow name: Default Engagement Workflow stageId: c6ce7a8b-de4d-4707-924b-d283f273fe2c stageNameKey: New stageName: New stageBadgeColor: New attributeValues: attributeSingleSelectValue.value21: - id: c5c3167e-f8e2-4719-a0a1-491350507fee value: Azure Documentation valueKey: OneTrustApp.VRM.Engagement.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99 viewOnly: false riskLevel: MEDIUM riskScore: 2 inherentRiskLevel: MEDIUM inherentRiskScore: 2 targetRiskLevel: HIGH targetRiskScore: 2 engagementStatus: ACTIVE lastUpdatedDate: '2023-05-10' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '429': description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)." headers: Retry-After: schema: description: The number of seconds after which requests will be allowed again. format: int32 ot-period: schema: description: The unit of time for which the rate limit applies enum: - HOUR - MINUTE ot-ratelimit-event-id: schema: description: The unique identifier for the rate-limiting event. format: uuid ot-request-made: schema: description: The number of requests made within the specified period. format: int32 ot-requests-allowed: schema: description: The number of requests allowed within the specified period. format: int32 '500': description: Internal Server Error security: - OAUTH2: - GENERIC - VRM delete: operationId: removeEngagementUsingDELETE summary: Delete Engagement description: Use this API to delete an existing engagement. tags: - Engagements x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json parameters: - name: engagementId in: path description: The unique identifier of the engagement. required: true schema: type: string format: uuid example: 41aa71ae-0ace-4073-8947-e6941714bcf1 responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '429': description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)." headers: Retry-After: schema: description: The number of seconds after which requests will be allowed again. format: int32 ot-period: schema: description: The unit of time for which the rate limit applies enum: - HOUR - MINUTE ot-ratelimit-event-id: schema: description: The unique identifier for the rate-limiting event. format: uuid ot-request-made: schema: description: The number of requests made within the specified period. format: int32 ot-requests-allowed: schema: description: The number of requests allowed within the specified period. format: int32 '500': description: Internal Server Error security: - OAUTH2: - GENERIC - VRM patch: operationId: updateEngagementUsingPATCH summary: Modify Engagement description: 'Use this API to partially update an existing engagement. > 🗒 Things to Know > > - For date and time attributes, the formatting should follow the `YYYY-MM-DDTHH:MM:SSZ` format. > - The name of the engagement must be 500 characters or less.' tags: - Engagements x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json parameters: - name: engagementId in: path description: The unique identifier of the engagement. required: true schema: type: string format: uuid example: fbf7843d-bc3c-4ad7-86c7-f6c9a94e873e requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExternalEngagementPatchUpdateRequest' example: notes: This engagement is for Microsoft Office endDate: '2023-05-11' orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 internalOwnerEmail: tyler@msft.com scope: License agreement for the IT business unit only. name: Microsoft Azure attributeValues: attributeSingleSelectValue.value21: - id: c5c3167e-f8e2-4719-a0a1-491350507fee value: Azure Documentation externalContact: External contact for Microsoft Office type: VendorEngagement startDate: '2023-05-10' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EngagementDetailInformation' example: engagementId: 5ab7eef6-997c-4e30-a628-1d30305f744f name: Microsoft Azure orgGroupName: Corporate orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 type: VendorEngagement startDate: '2023-05-10' endDate: '2023-05-11' internalOwnerUser: tyler@msft.com externalContact: External contact for Microsoft Office notes: This engagement is for Microsoft Office scope: License agreement for the IT business unit only schemaId: bfb03ce4-e214-4c99-84a0-87a253269495 vendor: id: 97e8d8d7-e05c-4e0a-beec-ef1458ea1ebc name: Microsoft orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 orgGroupName: Corporate workflow: id: 8ac1bf26-fa0d-43d2-9a1b-81130673030c nameKey: DefaultEngagementWorkflow name: Default Engagement Workflow stageId: c6ce7a8b-de4d-4707-924b-d283f273fe2c stageNameKey: New stageName: New stageBadgeColor: New attributeValues: attributeSingleSelectValue.value21: - id: c5c3167e-f8e2-4719-a0a1-491350507fee value: Azure Documentation valueKey: OneTrustApp.VRM.Engagement.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99 viewOnly: false riskLevel: MEDIUM riskScore: 2 inherentRiskLevel: MEDIUM inherentRiskScore: 2 targetRiskLevel: HIGH targetRiskScore: 2 engagementStatus: ACTIVE lastUpdatedDate: '2023-05-10' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '429': description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)." headers: Retry-After: schema: description: The number of seconds after which requests will be allowed again. format: int32 ot-period: schema: description: The unit of time for which the rate limit applies enum: - HOUR - MINUTE ot-ratelimit-event-id: schema: description: The unique identifier for the rate-limiting event. format: uuid ot-request-made: schema: description: The number of requests made within the specified period. format: int32 ot-requests-allowed: schema: description: The number of requests allowed within the specified period. format: int32 '500': description: Internal Server Error security: - OAUTH2: - GENERIC - VRM /api/vendor/v1/engagements/{engagementId}/status: put: operationId: updateEngagementStatus summary: Update Engagement Status description: Use this API to update the status of an existing engagement. tags: - Engagements x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json parameters: - name: engagementId in: path description: The unique identifier of an engagement. The value can be obtained using the [Get Engagements](/onetrust/reference/loadengagementusingget) API. required: true schema: type: string format: uuid example: 41aa71ae-0ace-4073-8947-e6941714bcf1 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExternalEngagementStatusUpdateRequest' example: status: ACTIVE responses: '200': description: OK '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '429': description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)." headers: Retry-After: schema: description: The number of seconds after which requests will be allowed again. format: int32 ot-period: schema: description: The unit of time for which the rate limit applies enum: - HOUR - MINUTE ot-ratelimit-event-id: schema: description: The unique identifier for the rate-limiting event. format: uuid ot-request-made: schema: description: The number of requests made within the specified period. format: int32 ot-requests-allowed: schema: description: The number of requests allowed within the specified period. format: int32 '500': description: Internal Server Error security: - OAUTH2: - GENERIC - VRM /api/vendor/v1/engagements-search: post: operationId: loadEngagementUsingGET summary: Search Engagements description: Use this API to search for engagements associated with a specific vendor by key terms and filters. tags: - Engagements x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json parameters: - name: page in: query description: Page number of the results list (0…N). schema: type: integer default: 0 - name: size in: query description: Number of records per page (1…N). schema: type: integer default: 20 maximum: 2000 minimum: 1 - name: sort in: query description: Returns the engagements list in sorted order. Returns records in in ascending order by engagement name by default. schema: type: string default: name,asc enum: - name,asc - name,desc - createdDate,asc - createdDate,desc requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchCriteriaInformation' example: filters: - field: workflowName operator: EQUAL_TO value: - Default Engagement Workflow fullText: Microsoft Azure responses: '200': description: OK content: application/json: schema: type: object $ref: '#/components/schemas/PageEngagementListViewInformation' example: content: - attributeValues: attributeSingleSelectValue.value21: - id: c5c3167e-f8e2-4719-a0a1-491350507fee value: Azure Documentation valueKey: OneTrustApp.VRM.Engagement.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99 endDate: '2023-05-11' engagementId: 5ab7eef6-997c-4e30-a628-1d30305f744f engagementStatus: ACTIVE externalContact: External contact for Microsoft Office inherentRiskLevel: MEDIUM inherentRiskScore: 2 internalOwnerEmail: tyler@msft.com internalOwnerId: 8a732373-9713-4f93-98f6-cae431e61956 internalOwnerUser: tyler lastUpdatedDate: '2023-05-10' name: Microsoft Azure notes: This engagement is for Microsoft Office orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 orgGroupName: Corporate riskLevel: MEDIUM riskScore: 2 schemaId: bfb03ce4-e214-4c99-84a0-87a253269495 scope: License agreement for the IT business unit only startDate: '2023-05-10' targetRiskLevel: HIGH targetRiskScore: 2 type: VendorEngagement vendor: id: 97e8d8d7-e05c-4e0a-beec-ef1458ea1ebc name: Microsoft orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 orgGroupName: Corporate workflow: id: 8ac1bf26-fa0d-43d2-9a1b-81130673030c nameKey: DefaultEngagementWorkflow name: Default Engagement Workflow stageId: c6ce7a8b-de4d-4707-924b-d283f273fe2c stageNameKey: New stageName: New stageBadgeColor: New pageable: sort: - direction: ASC property: name ignoreCase: false nullHandling: NATIVE ascending: true descending: false offset: 0 pageNumber: 0 pageSize: 20 paged: true unpaged: false totalPages: 1 last: true totalElements: 1 size: 20 number: 0 sort: - direction: ASC property: name ignoreCase: false nullHandling: NATIVE ascending: true descending: false first: true numberOfElements: 1 empty: false '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '429': description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)." headers: Retry-After: schema: description: The number of seconds after which requests will be allowed again. format: int32 ot-period: schema: description: The unit of time for which the rate limit applies enum: - HOUR - MINUTE ot-ratelimit-event-id: schema: description: The unique identifier for the rate-limiting event. format: uuid ot-request-made: schema: description: The number of requests made within the specified period. format: int32 ot-requests-allowed: schema: description: The number of requests allowed within the specified period. format: int32 '500': description: Internal Server Error security: - OAUTH2: - GENERIC - VRM - VRM_READ /api/vendor/v1/vendor-engagements: post: operationId: createEngagementUsingPOST summary: Create Engagement description: 'Use this API to create a new engagement. > 🗒 Things to Know > > - For date and time attributes, the formatting should follow the `YYYY-MM-DDTHH:MM:SSZ` format. > - If the `orgGroupId` parameter is not passed in the request, the engagement will be created with the same organization assigned to the engagement''s vendor. If the `orgGroupId` parameter value is invalid, then an invalid organization error will be sent. > - The name of the engagement must be 500 characters or less.' tags: - Engagements x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/third-party-management-third-party-risk-management.json requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExternalEngagementCreateRequest' example: notes: This engagement is for Microsoft Office endDate: '2023-05-11' orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 internalOwnerEmail: tyler@msft.com vendor: orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 name: Microsoft id: 97e8d8d7-e05c-4e0a-beec-ef1458ea1ebc label: Microsoft scope: License agreement for the IT business unit only. name: MicrosoftAzure attributeValues: attributeSingleSelectValue.value21: - id: c5c3167e-f8e2-4719-a0a1-491350507fee valueKey: OneTrustApp.VRM.Engagement.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99 value: Azure Documentation externalContact: External contact for Microsoft Office type: VendorEngagement startDate: '2023-05-10' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/EngagementDetailInformation' example: engagementId: 5ab7eef6-997c-4e30-a628-1d30305f744f name: Microsoft Azure orgGroupName: Corporate orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 type: VendorEngagement startDate: '2023-05-10' endDate: '2023-05-11' internalOwnerId: 8a732373-9713-4f93-98f6-cae431e61956 internalOwnerUser: tyler@msft.com externalContact: External contact for Microsoft Office notes: This engagement is for Microsoft Office scope: License agreement for the IT business unit only schemaId: bfb03ce4-e214-4c99-84a0-87a253269495 vendor: id: 97e8d8d7-e05c-4e0a-beec-ef1458ea1ebc name: Microsoft orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 orgGroupName: Corporate workflow: id: 8ac1bf26-fa0d-43d2-9a1b-81130673030c nameKey: DefaultEngagementWorkflow name: DefaultEngagementWorkflow stageId: c6ce7a8b-de4d-4707-924b-d283f273fe2c stageNameKey: New stageName: New stageBadgeColor: New attributeValues: attributeSingleSelectValue.value21: - id: c5c3167e-f8e2-4719-a0a1-491350507fee value: AzureDocumentation valueKey: OneTrustApp.VRM.Engagement.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99 viewOnly: false riskLevel: null riskScore: null inherentRiskLevel: null inherentRiskScore: null targetRiskLevel: null targetRiskScore: null engagementStatus: ACTIVE lastUpdatedDate: '2023-05-10' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '429': description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)." headers: Retry-After: schema: description: The number of seconds after which requests will be allowed again. format: int32 ot-period: schema: description: The unit of time for which the rate limit applies enum: - HOUR - MINUTE ot-ratelimit-event-id: schema: description: The unique identifier for the rate-limiting event. format: uuid ot-request-made: schema: description: The number of requests made within the specified period. format: int32 ot-requests-allowed: schema: description: The number of requests allowed within the specified period. format: int32 '500': description: Internal Server Error security: - OAUTH2: - GENERIC - VRM components: schemas: AttributeInformation: type: object properties: id: description: The unique identifier of the schema attribute. type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 name: description: The name of the schema attribute. type: string example: Type of the Record maxLength: 255 minLength: 1 nameKey: description: The translation key for schema attribute. type: string example: IM.Name maxLength: 255 description: description: The description of the schema attribute. type: string example: Gather Type for the record - provide some value related to nature of record maxLength: 1000 descriptionKey: description: The translation key for schema description. type: string example: IM.Name.Description maxLength: 255 fieldName: description: The field name of the schema attribute. type: string example: nameOfRecord maxLength: 100 minLength: 1 mappedFieldName: description: The mapped field name for schema sorting. type: string example: name maxLength: 100 enabled: description: The enabled flag for schema attribute. type: boolean example: true default: 'true' required: description: The required flag for schema attribute. type: boolean example: false default: 'false' readOnly: description: The read-only flag for schema attribute. type: boolean example: false default: 'false' encrypted: description: The encryption flag for schema attribute. type: boolean example: false default: 'false' allowOther: description: The user-defined options flag for schema. type: boolean example: false default: 'false' baseAttribute: description: The core entity flag for schema attribute. type: boolean example: false default: 'false' responseType: description: The response type for schema attribute. type: string example: Text enum: - Text - SingleSelect - MultiSelect - Date - Formula - Score - Level - Range formula: description: The formula for schema attribute. type: string example: Default:Field4 + Default:Field3 + 100 + avg(CrossSchema:Field4 + Default:Field3) maxLength: 4000 optionType: description: The option source type for schema. type: string example: None enum: - None - Static - Dynamic optionAllowed: description: The options allowed flag for schema. type: boolean example: false default: 'false' schemaId: description: The schema identifier for attribute. type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 schemaName: description: The schema name for attribute. type: string example: vendors maxLength: 100 options: description: The options collection for schema attribute. type: array items: $ref: '#/components/schemas/AttributeOptionInformation' referenceCategories: description: The reference categories for schema. type: array items: $ref: '#/components/schemas/CategoryInformation' responseMaxLength: description: The max response length for schema. type: integer format: int32 example: 4000 default: '4000' maximum: 4000 minimum: 1 responseSubType: description: The response subtype for schema. type: string example: STANDARD enum: - STANDARD - FORMULA - MATRIX associatedAttributeInformation: description: The associated attributes for schema. type: array items: $ref: '#/components/schemas/AssociatedAttributeInformation' multiSelectMaxOptionValues: description: The maximum multi-select options for schema. type: integer format: int32 example: 10 maximum: 100 minimum: 1 hidden: description: The hidden flag for schema attribute. type: boolean example: false default: 'false' optionUrl: description: The option URL for schema attribute. type: string example: /api/risk-v2/risk-categories maxLength: 255 intakeQuestion: description: The intake question for schema attribute. $ref: '#/components/schemas/IntakeQuestion' deleteMarker: description: The deletion marker for schema attribute. type: string example: MARKED_FOR_DELETE enum: - MARKED_FOR_DELETE - DELETING - DELETED optionMetadata: description: The option metadata for schema attribute. $ref: '#/components/schemas/AttributeOptionMetadataInformation' validationRuleId: description: The validation rule for schema attribute. type: string example: email abacBasicAssignmentInfo: description: Contains the id, name and ObjectType of the linked assignment type: array items: $ref: '#/components/schemas/AbacBasicAssignmentInfo' optionsByDomain: description: Override options by Domain type: object additionalProperties: type: array items: $ref: '#/components/schemas/AttributeDomainOptionOverrideInformation' formulaByDomain: description: Formula by Domain type: object additionalProperties: $ref: '#/components/schemas/AttributeFormulaDetail' displayResponseType: description: Display response type for UI - System attributes are displayed as SingleSelect or MultiSelect based on multiSelectMaxOptionValues type: string example: SingleSelect enum: - Text - SingleSelect - MultiSelect - Date - DateTime - NumericalText - NumericalSingleSelect - RadioButton - TextArea - Formula - Level - Range - Score - System associatedAttributeFieldName: description: The associated field name for schema. type: string required: - enabled - fieldName - name FilterInformation: type: object properties: field: description: The field name for engagement filter. type: string example: contractTypeName maxLength: 255 minLength: 1 operator: description: The operator for engagement filter. type: string example: EQUAL_TO enum: - EQUAL_TO - NOT_EQUAL_TO - GREATER_THAN - LESS_THAN - GREATER_THAN_EQUAL - LESS_THAN_EQUAL - LIKE - NOT_LIKE - IN - NOT_IN - IS_NULL - IS_NOT_NULL - BETWEEN value: description: The value for engagement filter. type: object oneOf: - type: string format: uuid - type: string format: date - type: string format: date-time - type: string - type: number toValue: description: The end value for engagement range filter. type: object oneOf: - type: string format: date - type: string format: date-time example: - field: contractTypeName operator: EQUAL_TO value: - Privacy Policy - field: status operator: NOT_EQUAL_TO value: EXPIRED required: - field AssociatedAttributeInformation: type: object properties: id: description: Associated Attribute GUID type: string format: uuid name: description: Name type: string example: Count of members minLength: 1 nameKey: description: Name key type: string example: IM.CountOfMembersName description: description: Description type: string example: Provide details about count associated with this attribute descriptionKey: description: Description Key type: string example: IM.CountOfMembersDesc schemaId: description: Attribute Schema GUID type: string format: uuid schemaName: description: Attribute Schema Name type: string example: risk fieldName: description: Attribute field name type: string example: countOfMembers minLength: 1 mappedFieldName: description: Mapped Attribute field name. Should be used for sorting type: string example: count enabled: description: Indicator for attribute enabled/disabled type: boolean responseType: description: Response Type type: string enum: - Text - SingleSelect - MultiSelect - Date - DateTime - NumericalText - NumericalSingleSelect - RadioButton - TextArea - Formula - Level - Range - Score - System responseSubType: description: Response sub type type: string enum: - Standard - Formula - Matrix - RollUp formula: description: Formula for attribute type: string example: sum(1, 3) options: description: Attribute options type: array items: $ref: '#/components/schemas/AttributeOptionInformation' optionsByDomain: description: Override options by Domain type: object additionalProperties: type: array items: $ref: '#/components/schemas/AttributeDomainOptionOverrideInformation' required: - enabled - fieldName - id - responseType AttributeOptionMetadata: type: object properties: hint: description: The associated option hint. type: string hintKey: description: The associated option hint key. type: string ExternalEngagementStatusUpdateRequest: type: object properties: status: description: The new status for the engagement. type: string example: ACTIVE enum: - ACTIVE - PENDING - ARCHIVED minLength: 1 example: status: ACTIVE required: - status PageEngagementListViewInformation: type: object properties: content: description: The array of engagement search results. items: $ref: '#/components/schemas/EngagementListViewInformation' type: array empty: description: The flag indicating empty search results. type: boolean first: description: The flag indicating first page of results. type: boolean last: description: The flag indicating last page of results. type: boolean number: description: The current page number of results. type: integer format: int32 numberOfElements: description: The count of elements in current page. type: integer format: int32 example: 1 size: description: The page size configuration for results. type: integer format: int32 example: 20 totalElements: description: The total count across all pages. type: integer format: int64 example: 1 totalPages: description: The total number of available pages. type: integer format: int32 example: 1 redacted: description: Field names that should be redacted when user lacks advanced view access type: object example: 41aa71ae-0ace-4073-8947-e6941714bcf1: - field1 - field2 additionalProperties: type: array items: type: string uniqueItems: true sort: description: The sorting configuration for results. $ref: '#/components/schemas/SortObject' pageable: description: The pagination configuration and metadata. type: object example: offset: 0 pageNumber: 0 pageSize: 20 paged: true sort: - ascending: true descending: false direction: ASC ignoreCase: false nullHandling: NATIVE property: name unpaged: false IntakeQuestion: type: object properties: nameKey: description: The question name key for schema. type: string maxLength: 100 minLength: 0 name: description: The question name for schema. type: string maxLength: 500 minLength: 0 descriptionKey: description: The question description key for schema. type: string maxLength: 100 minLength: 0 description: description: The question description for schema. type: string maxLength: 500 minLength: 0 AttributeOptionInformation: type: object properties: id: description: Option GUID type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 option: description: Option name type: string example: TypeA maxLength: 255 minLength: 1 optionKey: description: Option Key which can be used for translation type: string example: IM.TypeA maxLength: 255 colorCode: description: Color code for the option type: string example: '#FF5733' maxLength: 7 sequence: description: Option sequence for ordering type: integer format: int32 example: 1 maximum: 32767 minimum: 1 enabled: description: Indicates if the option is enabled or disabled type: boolean example: true default: 'true' metadata: description: Additional metadata for the attribute option $ref: '#/components/schemas/AttributeOptionMetadata' required: - option ExternalEngagementCreateRequest: type: object properties: name: description: The name for new engagement creation. type: string example: Microsoft Azure Cloud Services 2025 maxLength: 500 minLength: 1 vendor: description: The vendor for new engagement creation. example: id: 97e8d8d7-e05c-4e0a-beec-ef1458ea1ebc name: Microsoft orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 label: Microsoft $ref: '#/components/schemas/Key' orgGroupId: description: The organization identifier for new engagement. type: string format: uuid example: a41972ae-2050-4126-b314-1a58d08ea116 type: description: The type for new engagement creation. type: string example: VendorEngagement enum: - VendorEngagement - ProductEngagement - ServiceEngagement internalOwnerEmail: description: The internal owner email for new engagement. type: string format: email example: john.doe@company.com maxLength: 255 externalContact: description: The external contact for new engagement. type: string example: Jane Smith (jane.smith@microsoft.com, +1-555-123-4567) maxLength: 500 notes: description: The notes for new engagement creation. type: string example: This engagement covers all Microsoft Azure cloud services used by our IT department. Includes premium support package and training services. maxLength: 4000 startDate: description: The start date for new engagement. type: string format: date example: '2025-01-15' endDate: description: The end date for new engagement. type: string format: date example: '2026-01-14' scope: description: The scope for new engagement creation. type: string example: License agreement for Azure cloud services covering the IT business unit only. Includes 24/7 technical support and quarterly service reviews. maxLength: 2000 attributeValues: description: The custom attributes for new engagement. type: object example: priority: - id: c5c3167e-f8e2-4719-a0a1-491350507fee value: High department: - id: d6d4278f-g9f3-5820-b1b2-592461608gff value: IT additionalProperties: type: array items: $ref: '#/components/schemas/AttributeValueInformation' required: - name - vendor AttributeValueInformation: type: object properties: id: description: The attribute identifier for new engagement. type: string format: uuid example: a34ccec7-1ec0-4d65-9075-bdd0d923f1d1 value: description: The attribute value for new engagement. type: string example: Text Value valueKey: description: The translation key for new engagement. type: string example: attribute.option.valueKey colorCode: description: The color code for new engagement. type: string example: red optionSelectionValue: description: The selection value for new engagement. type: string example: '3.5' displayLabel: description: The display label for new engagement. type: string example: United State | San Francisco associatedAttributeValueInformation: description: The associated info for new engagement. type: array items: $ref: '#/components/schemas/AssociatedAttributeValueInformation' disabled: description: The disabled flag for new engagement. type: boolean example: false default: 'false' required: - value ExternalEngagementUpdateRequest: type: object properties: name: description: The updated name of the engagement. type: string example: Microsoft Azure Cloud Services 2025 - Enterprise Agreement maxLength: 500 minLength: 1 orgGroupId: description: The organization identifier for engagement. type: string format: uuid example: a41972ae-2050-4126-b314-1a58d08ea116 internalOwnerEmail: description: The email of internal owner for engagement. type: string format: email example: john.doe@company.com maxLength: 255 externalContact: description: The external contact for the engagement. type: string example: Jane Smith (jane.smith@microsoft.com, +1-555-123-4567) maxLength: 500 notes: description: The notes about the engagement. type: string example: This engagement covers all Microsoft Azure cloud services used by our IT department. Updated to include new security features and compliance requirements. maxLength: 4000 startDate: description: The start date of the engagement. type: string format: date example: '2025-01-15' endDate: description: The end date of the engagement. type: string format: date example: '2026-01-14' scope: description: The scope of the engagement. type: string example: License agreement for Azure cloud services covering the IT business unit only. Updated to include additional data centers and expanded support services. maxLength: 2000 attributeValues: description: The custom attributes for the engagement. type: object example: priority: - id: c5c3167e-f8e2-4719-a0a1-491350507fee value: High department: - id: d6d4278f-g9f3-5820-b1b2-592461608gff value: IT complianceLevel: - id: e7e5389g-h0g4-6931-c2c3-603572719hgg value: Enterprise additionalProperties: type: array items: $ref: '#/components/schemas/AttributeValueInformation' required: - name AttributeDomainOptionOverrideInformation: type: object properties: id: description: Override Option GUID type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 attributeDomainOptionId: description: Domain Option GUID type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440001 targetAttributeId: description: Target Attribute GUID type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440002 targetOptionId: description: Target Option GUID type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440003 option: description: Option name type: string example: TypeA optionKey: description: Option name key type: string example: TypeB optionSelectionValue: description: Option selection value type: string example: 10 colorCode: description: Color code for the option type: string example: '#FF5733' maxLength: 7 sequence: description: Option sequence for ordering type: integer format: int32 example: 1 maximum: 32767 minimum: 1 enabled: description: Indicates if the option is enabled or disabled type: boolean example: true default: 'true' metadata: description: Additional metadata for the attribute option $ref: '#/components/schemas/AttributeOptionMetadata' optionSelectionValueAsDouble: type: number format: double optionAsDouble: type: number format: double AbacBasicAssignmentInfo: type: object properties: assignmentId: description: GUID of the linked assignment type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 assignmentName: description: Name of the linked assignment type: string example: Assignment1 policyStatus: description: Policy status of the linked assignment type: string example: ACTIVE enum: - INACTIVE - ACTIVE - PROCESSING - FAILED EngagementDetailInformation: type: object properties: engagementId: description: The engagement identifier for created response. type: string format: uuid example: 41aa71ae-0ace-4073-8947-e6941714bcf1 number: description: The sequential number of created engagement. type: integer format: int64 example: 12345 minimum: 1 name: description: The name of created engagement. type: string example: Microsoft Azure maxLength: 500 minLength: 1 orgGroupName: description: The organization name of created engagement. type: string example: Corporate maxLength: 100 minLength: 1 orgGroupId: description: The organization identifier of created engagement. type: string format: uuid example: a41972ae-2050-4126-b314-1a58d08ea116 type: description: The type of created engagement. type: string example: VendorEngagement enum: - VendorEngagement - ProductEngagement - ServiceEngagement startDate: description: The start date of created engagement. type: string format: date example: '2020-10-12' endDate: description: The end date of created engagement. type: string format: date example: '2021-06-30' internalOwnerId: description: The internal owner identifier of created engagement. type: string format: uuid example: 20a61b02-482a-44b6-8bc3-be1d4c83331f internalOwnerUser: description: The internal owner name of created engagement. type: string example: John Smith maxLength: 100 minLength: 1 internalOwnerEmail: description: The internal owner email of created engagement. type: string format: email example: test@example.com maxLength: 255 externalContact: description: The external contact of created engagement. type: string example: Jane Doe (jane.doe@vendor.com) maxLength: 500 notes: description: The notes of created engagement. type: string example: This engagement is for Microsoft Office. maxLength: 4000 scope: description: The scope of created engagement. type: string example: License agreement for the IT business unit only. maxLength: 2000 schemaId: description: The schema identifier of created engagement. type: string format: uuid example: 36e2d4a1-379f-4263-8e05-6e3a3207a834 vendor: description: The vendor of created engagement. example: id: 97e8d8d7-e05c-4e0a-beec-ef1458ea1ebc name: Microsoft orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 label: Microsoft $ref: '#/components/schemas/Key' workflow: description: The workflow of created engagement. example: id: 8ac1bf26-fa0d-43d2-9a1b-81130673030c nameKey: DefaultEngagementWorkflow name: Default Engagement Workflow stageId: c6ce7a8b-de4d-4707-924b-d283f273fe2c stageNameKey: New stageName: New stageBadgeColor: New $ref: '#/components/schemas/EngagementWorkflowInformation' attributeValues: description: The custom attributes of created engagement. type: object example: priority: - id: c5c3167e-f8e2-4719-a0a1-491350507fee value: High department: - id: d6d4278f-g9f3-5820-b1b2-592461608gff value: IT additionalProperties: type: array items: $ref: '#/components/schemas/AttributeValueInformation' viewOnly: description: The view access flag of created engagement. type: boolean example: false forceAbac: description: The organizational context flag of created engagement. type: boolean example: false riskLevel: description: The risk level of created engagement. type: string example: MEDIUM enum: - LOW - MEDIUM - HIGH - CRITICAL riskScore: description: The risk score of created engagement. type: number example: 2.5 maximum: 5 minimum: 0 inherentRiskLevel: description: The inherent risk level of created engagement. type: string example: HIGH enum: - LOW - MEDIUM - HIGH - CRITICAL inherentRiskScore: description: The inherent risk score of created engagement. type: number example: 3.7 maximum: 5 minimum: 0 targetRiskLevel: description: The target risk level of created engagement. type: string example: LOW enum: - LOW - MEDIUM - HIGH - CRITICAL targetRiskScore: description: The target risk score of created engagement. type: number example: 1.2 maximum: 5 minimum: 0 engagementStatus: description: The status of created engagement. type: string example: ACTIVE enum: - ACTIVE - PENDING - ARCHIVED lastUpdatedDate: description: The last update date of created engagement. type: string format: date-time example: '2023-05-10T14:30:00Z' createdDate: description: The creation date of created engagement. type: string format: date-time example: '2023-01-15T09:20:00Z' createdBy: description: The creator identifier of created engagement. type: string format: uuid example: 8a732373-9713-4f93-98f6-cae431e61956 createdByUser: description: The creator name of created engagement. type: string example: Admin User maxLength: 100 updatedBy: description: The updater identifier of created engagement. type: string format: uuid example: 8a732373-9713-4f93-98f6-cae431e61956 updatedByUser: description: The updater name of created engagement. type: string example: Admin User maxLength: 100 label: description: The display label of created engagement. type: string example: (Microsoft) Azure Cloud Services | Corporate maxLength: 500 SearchCriteriaInformation: type: object properties: filters: description: The filter criteria for engagement search. type: array items: $ref: '#/components/schemas/FilterInformation' example: - field: contractTypeName operator: EQUAL_TO value: - Privacy Policy - field: status operator: NOT_EQUAL_TO value: EXPIRED uniqueItems: true fullText: description: The text string for engagement search. type: string example: Microsoft Contract maxLength: 255 minLength: 1 fullTextField: description: The field for engagement text search. type: string example: name maxLength: 100 minLength: 1 EngagementWorkflowInformation: type: object properties: id: description: The workflow identifier in results. type: string format: uuid example: 8ac1bf26-fa0d-43d2-9a1b-81130673030c nameKey: description: The workflow translation key in results. type: string example: DefaultEngagementWorkflow maxLength: 100 minLength: 1 name: description: The workflow name in results. type: string example: Default Engagement Workflow maxLength: 100 minLength: 1 stageId: description: The workflow stage identifier in results. type: string format: uuid example: c6ce7a8b-de4d-4707-924b-d283f273fe2c stageNameKey: description: The workflow stage key in results. type: string example: New maxLength: 100 minLength: 1 stageName: description: The workflow stage name in results. type: string example: New maxLength: 100 minLength: 1 stageBadgeColor: description: The workflow stage color in results. type: string example: blue maxLength: 50 minLength: 1 InventoryValue: type: object properties: id: description: The GUID of the Inventory Type. type: string format: uuid example: 41aa71ae-0ace-4073-8947-e6941714bcf1 value: description: The Value of the Inventory Type. type: string example: Technology valueKey: description: Translation key used for localizing the value type: string example: VendorsTypeTechnology SortObject: type: object properties: empty: description: The flag indicating no sorting applied. type: boolean sorted: description: The flag indicating sorted results. type: boolean unsorted: description: The flag indicating unsorted results. type: boolean AttributeFormulaDetail: type: object properties: formula: type: string formulaType: type: string ExternalEngagementPatchUpdateRequest: type: object example: name: Microsoft Azure Cloud Services 2025 notes: Updated service agreement startDate: '2025-01-15' endDate: '2026-01-14' AttributeOptionMetadataInformation: type: object properties: entityTypeName: description: The entity type for schema options. type: string example: Location basicServiceContextPath: description: The service path for schema options. type: string example: /api/location optionUrl: description: The option URL for schema options. type: string example: /api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details/pages optionListUrl: description: Api URL for the Drop Down Api. Complete List of entities type: string example: /api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details viewType: description: The view type for schema options. type: string optionType: description: Option Type type: string example: BusinessLocations permissions: description: Permissions type: array items: type: string example: '[features.core-constructs.view]' applicationUrl: description: Application Url type: string example: /settings/location-management/location/Location Key: type: object properties: id: description: The vendor identifier in results. type: string format: uuid example: cd7f767c-c849-412c-abbb-b59845cd5476 name: description: The vendor name in results. type: string example: Microsoft orgGroupId: description: The vendor organization in results. type: string format: uuid example: cd7f767c-c849-412c-abbb-b59845cd5476 orgGroupName: description: The vendor organization name in results. type: string readOnly: true vendorType: description: Type of the Vendor. $ref: '#/components/schemas/InventoryValue' required: - name - orgGroupId AssociatedAttributeValueInformation: type: object properties: id: description: The associated identifier for new engagement. type: string format: uuid example: a34ccec7-1ec0-4d65-9075-bdd0d923f1d1 value: description: The associated value for new engagement. type: string example: Text Value valueKey: description: The associated key for new engagement. type: string example: attribute.option.valueKey colorCode: description: The associated color for new engagement. type: string example: red required: - value CategoryInformation: type: object properties: id: description: Category unique identifier type: string format: uuid name: description: Category name type: string example: Financial Category nameKey: description: Category nameKey for localization support type: string example: IM.FinancialCategoryName EngagementListViewInformation: type: object properties: name: description: The Engagement name. type: string example: Microsoft Azure minLength: 1 orgGroupId: description: The GUID of the Engagement organization. type: string format: uuid example: a83dac05-e170-4cbd-b0f1-c3591399f04e internalOwnerId: description: The user ID of the Engagement internal owner. type: string format: uuid example: 20a61b02-482a-44b6-8bc3-be1d4c83331f externalContact: description: The engagement's external contact information. type: string example: Any external contact as its a text field notes: description: Notes type: string startDate: description: Engagement Start Date. type: string format: date-time example: '2020-10-12' endDate: description: Engagement End Date. type: string format: date-time example: '2021-06-30' scope: description: Engagement Scope. type: string example: License agreement for the IT business unit only engagementId: description: The GUID of the Engagement. Can also be found via the engagement details page. type: string format: uuid example: 41aa71ae-0ace-4073-8947-e6941714bcf1 number: description: This field contains a unique identifier of a particular engagement record. type: integer format: int64 example: 12345 minimum: 1 internalOwnerUser: description: The user full name of the Engagement's Internal owner. type: string example: John Smith maxLength: 100 minLength: 1 internalOwnerEmail: description: The user email of the Engagement's Internal owner. type: string format: email example: test@example.com maxLength: 255 vendor: description: Vendor for which Engagement is being created example: id: 97e8d8d7-e05c-4e0a-beec-ef1458ea1ebc name: Microsoft orgGroupId: a41972ae-2050-4126-b314-1a58d08ea116 label: Microsoft $ref: '#/components/schemas/Key' orgGroupName: description: The engagement's Organization Name. type: string example: Corporate maxLength: 100 minLength: 1 type: description: Engagement Type. type: string example: VendorEngagement enum: - VendorEngagement - ProductEngagement - ServiceEngagement viewOnly: description: The parameter to check if the user has view only access or not. type: boolean example: false forceAbac: description: Parameter to check if the engagement record is according to the org context or not. type: boolean example: false workflow: description: Workflow assigned to Engagement example: id: 8ac1bf26-fa0d-43d2-9a1b-81130673030c nameKey: DefaultEngagementWorkflow name: Default Engagement Workflow stageId: c6ce7a8b-de4d-4707-924b-d283f273fe2c stageNameKey: New stageName: New stageBadgeColor: New $ref: '#/components/schemas/EngagementWorkflowInformation' vendorViewOnly: description: Vendor view only access type: boolean example: false attributeValues: description: Engagement custom attribute values. type: object example: priority: - id: c5c3167e-f8e2-4719-a0a1-491350507fee value: High department: - id: d6d4278f-g9f3-5820-b1b2-592461608gff value: IT additionalProperties: type: array items: $ref: '#/components/schemas/AttributeValueInformation' riskLevel: description: Engagement's Risk Level. type: string example: MEDIUM enum: - LOW - MEDIUM - HIGH - CRITICAL riskScore: description: Engagement's Risk Score. type: number example: 2.5 maximum: 5 minimum: 0 inherentRiskLevel: description: Engagement's Inherent Risk Level. type: string example: HIGH enum: - LOW - MEDIUM - HIGH - CRITICAL inherentRiskScore: description: Engagement's Inherent Risk Score. type: number example: 3.7 maximum: 5 minimum: 0 targetRiskLevel: description: Engagement's Target Risk Level. type: string example: LOW enum: - LOW - MEDIUM - HIGH - CRITICAL targetRiskScore: description: Engagement's Target Risk Score. type: number example: 1.2 maximum: 5 minimum: 0 engagementStatus: description: Status of Engagement. type: string example: ACTIVE enum: - ACTIVE - PENDING - ARCHIVED lastUpdatedDate: description: LastUpdatedDate type: string format: date-time example: '2023-05-10T14:30:00Z' createdDate: description: Created Date type: string format: date-time example: '2023-01-15T09:20:00Z' createdBy: description: Created By type: string format: uuid example: 8a732373-9713-4f93-98f6-cae431e61956 createdByUser: description: Engagement created by user name type: string example: Admin User maxLength: 100 updatedBy: description: Updated By type: string format: uuid example: 8a732373-9713-4f93-98f6-cae431e61956 updatedByUser: description: Engagement updated by user name type: string example: Admin User maxLength: 100 doraB07010120IdentificationOfAlternativeThirdParty: description: Dora Identification Of Alternative ThirdParty type: string example: 'Alternative vendor identified: Oracle Cloud' maxLength: 500 doraB02020100NoticePeriodFinancialEntity: description: Dora Notice Period Financial Entity type: string example: 90 maxLength: 100 doraB02020110NoticePeriodThirdParty: description: Dora Notice Period ThirdParty type: string example: 60 maxLength: 100 securitySchemes: OAUTH2: type: oauth2 flows: clientCredentials: tokenUrl: https://{hostname}/api/access/v1/oauth/token scopes: VRM_READ: Third Party Risk Management read scope to view details of TPRM components VRM: Third Party Risk Management scope for read/write operations on TPRM components. x-onetrust: spec-label: OpenAPI 3.1.0 links: - '{''Third-Party Risk Management Knowledge Base'': ''https://my.onetrust.com/s/topic/0TO1Q000000ItS2WAK/thirdparty-risk-management''}' x-readme: explorer-enabled: false proxy-enabled: false metrics-enabled: false