v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Inventory

Copy Inventory

Use this API to create a copy of an existing inventory.

post/api/inventory/v2/inventories/{schemaName}/{id}/copy

Path parameters

schemaName'processing-activities' | 'vendors' | 'assets' | 'entities' required

The name property of the schema.

idstring uuid required

The unique identifier of the inventory record to copy.

Query parameters

inheritFromMasterboolean

Flag to indicate if the copy should inherit attributes from the master inventory.

copyRelatedboolean

Flag to indicate if related records should also be copied.

copyAsChildboolean

Flag to indicate if the copy should be created as a child of the original inventory.

Request body

idstring uuid

Unique identifier of the inventory item

canViewDetailsboolean

Flag indicating if the current user can view inventory details

namestring

Name of the inventory

riskLevel'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH'

Risk level of the inventory

riskScorenumber

Risk score of the inventory

externalIdstring

External identifier of the inventory

createdDatestring date-time

Date and time when the inventory was created

updatedDatestring date-time

Date and time when the inventory was last updated

selectFieldsobject

Map of select fields with their values

textFieldsobject

Map of text fields with their values

numberinteger

Sequence number of the inventory

isParentboolean

Flag indicating if this inventory is a parent

inheritFromMasterboolean

Flag indicating if this inventory inherits from master

parentInventoryIdstring uuid

ID of the parent inventory

masterRecordstring

Reference to the master record

inherentRiskLevel'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH'

Inherent risk level of the inventory

inherentRiskScorenumber

Inherent risk score of the inventory

targetRiskLevel'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH'

Target risk level of the inventory

targetRiskScorenumber

Target risk score of the inventory

totalHierarchyRiskLevel'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH'

Total hierarchy risk level of the inventory

totalHierarchyRiskScorenumber

Total hierarchy risk score of the inventory

totalHierarchyInherentRiskLevel'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH'

Total hierarchy inherent risk level of the inventory

totalHierarchyInherentRiskScorenumber

Total hierarchy inherent risk score of the inventory

totalHierarchyTargetRiskLevel'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH'

Total hierarchy target risk level of the inventory

totalHierarchyTargetRiskScorenumber

Total hierarchy target risk score of the inventory

inventoryDeleteType'HARD' | 'SOFT' | 'NONE'

Type of deletion for the inventory

deletedReasonstring

Reason for deletion of the inventory

deletedBystring uuid

ID of the user who deleted the inventory

deletedDatestring date-time

Date and time when the inventory was deleted

isGlobalAttributeConfigurationEnabledboolean

Flag indicating if global attribute configuration is enabled

sourceIdstring uuid

ID of the source inventory

integrationWorkflowIdstring

ID of the integration workflow

sourceTypestring

Type of the source inventory

reviewTypestring

Type of review for the inventory

deletableboolean

editableboolean

Example request

{
  "id": "96214230-ffbb-4870-b6c4-0f30c3bfec60",
  "canViewDetails": true,
  "name": "Vendor XYZ",
  "riskLevel": "HIGH",
  "riskScore": 8.5,
  "status": {
    "key": "active",
    "name": "Active"
  },
  "externalId": "EXT-12345",
  "createdDate": "2023-01-15T10:30:45.123Z",
  "updatedDate": "2023-02-20T14:15:30.456Z",
  "selectFields": {
    "data-residency": [
      {
        "key": "us",
        "value": "US"
      }
    ]
  },
  "textFields": {
    "description": "Sample description"
  },
  "number": 123,
  "isParent": true,
  "inheritFromMaster": true,
  "parentInventoryId": "96214230-ffbb-4870-b6c4-0f30c3bfec60",
  "masterRecord": "MASTER-001",
  "workflowStage": {
    "badgeColor": "#4CAF50"
  },
  "inherentRiskLevel": "MEDIUM",
  "inherentRiskScore": 6.5,
  "targetRiskLevel": "LOW",
  "targetRiskScore": 3,
  "totalHierarchyRiskLevel": "HIGH",
  "totalHierarchyRiskScore": 8,
  "totalHierarchyInherentRiskLevel": "MEDIUM",
  "totalHierarchyInherentRiskScore": 6,
  "totalHierarchyTargetRiskLevel": "LOW",
  "totalHierarchyTargetRiskScore": 3,
  "inventoryDeleteType": "SOFT",
  "deletedReason": "No longer required",
  "deletedBy": "ab0b11d9-8ba2-46f3-b845-2ca50bef4efc",
  "deletedDate": "2023-03-01T12:00:00.000Z",
  "isGlobalAttributeConfigurationEnabled": true,
  "sourceId": "c79fb1a9-9406-4e9b-bff7-c72e635ee82b",
  "integrationWorkflowId": "wf-123",
  "sourceType": "API_INTEGRATION",
  "reviewType": "ANNUAL"
}

Response

OK - Inventory successfully copied.