Copy Inventory

post

https://{hostname}/api/inventory/v2/inventories/{schemaName}/{id}/copy

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

Path Params

schemaName

string

enum

required

The name property of the schema.

Allowed:

uuid

required

The unique identifier of the inventory record to copy.

Query Params

inheritFromMaster

boolean

Defaults to true

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

copyRelated

boolean

Defaults to false

Flag to indicate if related records should also be copied.

copyAsChild

boolean

Defaults to false

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

Body Params

uuid

Unique identifier of the inventory item

organization

object

Organization reference to which the inventory belongs

canViewDetails

boolean

Flag indicating if the current user can view inventory details

name

string

Name of the inventory

riskLevel

string

enum

Risk level of the inventory

Allowed:

riskScore

number

Risk score of the inventory

status

object

Status of the inventory

externalId

string

External identifier of the inventory

createdDate

date-time

Date and time when the inventory was created

createdBy

object

Reference to the user who created the inventory

updatedDate

date-time

Date and time when the inventory was last updated

updatedBy

object

Reference to the user who last updated the inventory

selectFields

object

Map of select fields with their values

textFields

object

Map of text fields with their values

number

int64

Sequence number of the inventory

isParent

boolean

Flag indicating if this inventory is a parent

inheritFromMaster

boolean

Flag indicating if this inventory inherits from master

parentInventoryId

uuid

ID of the parent inventory

masterRecord

string

Reference to the master record

workflow

object

Reference to the workflow associated with this inventory

workflowStage

object

Current workflow stage of the inventory

inherentRiskLevel

string

enum

Inherent risk level of the inventory

Allowed:

inherentRiskScore

number

Inherent risk score of the inventory

targetRiskLevel

string

enum

Target risk level of the inventory

Allowed:

targetRiskScore

number

Target risk score of the inventory

totalHierarchyRiskLevel

string

enum

Total hierarchy risk level of the inventory

Allowed:

totalHierarchyRiskScore

number

Total hierarchy risk score of the inventory

totalHierarchyInherentRiskLevel

string

enum

Total hierarchy inherent risk level of the inventory

Allowed:

totalHierarchyInherentRiskScore

number

Total hierarchy inherent risk score of the inventory

totalHierarchyTargetRiskLevel

string

enum

Total hierarchy target risk level of the inventory

Allowed:

totalHierarchyTargetRiskScore

number

Total hierarchy target risk score of the inventory

inventoryDeleteType

string

enum

Type of deletion for the inventory

Allowed:

deletedReason

string

Reason for deletion of the inventory

deletedBy

uuid

ID of the user who deleted the inventory

deletedDate

date-time

Date and time when the inventory was deleted

isGlobalAttributeConfigurationEnabled

boolean

Flag indicating if global attribute configuration is enabled

sourceId

uuid

ID of the source inventory

integrationWorkflowId

string

ID of the integration workflow

sourceType

string

Type of the source inventory

reviewType

string

Type of review for the inventory

similarRecord

object

Similar record detail for the inventory

deletable

boolean

editable

boolean

Responses

200

OK - Inventory successfully copied.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

429Too Many Requests. For more information, see API Rate Limits.