Item DB API class

class cdb.common.db.api.itemDbApi.ItemDbApi

DB APIs that allow updates to entities related to items.

addAllowedChildEntityType(*args, **kwargs)

Add an allowed child entity type record

Parameters:
  • parentEntityTypeName –
  • childEntityTypeName –
  • kwargs –
Returns:

(CdbObject) newly added record.
addAllowedEntityTypeDomain(*args, **kwargs)

Add an allowed entity type for a domain record.

Parameters:
  • domainName –
  • entityTypeName –
  • kwargs –
Returns:

(CdbObject) newly added record.
addDomain(*args, **kwargs)

Add an item domain record.

Parameters:
  • name –
  • description –
  • kwargs –
Returns:

(CdbObject) newly added record.
addEntityType(*args, **kwargs)

Add an entity type record.

Parameters:
  • name –
  • description –
  • kwargs –
Returns:

(CdbObject) newly added record.
addItem(*args, **kwargs)

Add an item record.

Parameters:
  • domainName –
  • name –
  • derivedFromItemId –
  • itemIdentifier1 –
  • itemIdentifier2 –
  • entityTypeName –
  • qrId –
  • description –
  • createdByUserId –
  • ownerUserId –
  • ownerGroupId –
  • isGroupWriteable –
  • createdOnDataTime –
  • lastModifiedOnDateTime –
  • kwargs –
Returns:

(CdbObject) newly added record.
addItemCategory(*args, **kwargs)

Add an item category

items in particular domain could have different categories.

Parameters:
  • name –
  • description –
  • domainName –
  • kwargs –
Returns:

(CdbObject) newly added record.
addItemElement(*args, **kwargs)

Add an item element record.

Parameters:
  • name –
  • parentItemId –
  • containedItemId –
  • isRequired –
  • description –
  • createdByUserId –
  • ownerUserId –
  • ownerGroupId –
  • isGroupWriteable –
  • createdOnDataTime –
  • lastModifiedOnDateTime –
  • kwargs –
Returns:

(CdbObject) newly added record.
addItemElementLog(*args, **kwargs)

Add a log to a particular item element.

NOTE: items have logs through their ‘self element’.

Parameters:
  • itemElementId –
  • text –
  • enteredByUserId –
  • effectiveFromDateTime –
  • effectiveToDateTime –
  • logTopicName –
  • enteredOnDateTime –
  • systemLogLevelName –
  • kwargs –
Returns:

(CdbObject) newly added record.
addItemElementProperty(*args, **kwargs)

Add a property to a particular item element.

NOTE: items have properties through their ‘self element’.

Parameters:
  • itemElementId –
  • propertyTypeName –
  • tag –
  • value –
  • units –
  • description –
  • enteredByUserId –
  • isUserWriteable –
  • isDynamic –
  • displayValue –
  • targetValue –
  • enteredOnDateTime –
  • kwargs –
Returns:

(CdbObject) newly added record.
addItemElementRelationship(*args, **kwargs)

Add an item element relationship.

Parameters:
  • firstItemElementId –
  • secondItemElementId –
  • firstItemConnectorId –
  • secondItemConnectorId –
  • linkItemElementId –
  • relationshipTypeName –
  • relationshipDetails –
  • resourceTypeName –
  • label –
  • description –
  • kwargs –
Returns:

(CdbObject) newly added record.
addItemItemCategory(*args, **kwargs)

Assign an item category to a particular item.

Parameters:
  • itemId –
  • categoryName –
  • kwargs –
Returns:

(CdbObject) newly added record.
addItemItemProject(*args, **kwargs)

Assign an item to a particular project.

Parameters:
  • itemId –
  • itemProjectName –
  • kwargs –
Returns:

(CdbObject) newly added record.
addItemItemType(*args, **kwargs)

Assign an item type to a particular item.

Parameters:
  • itemId –
  • typeName –
  • kwargs –
Returns:

(CdbObject) newly added record.
addItemProject(*args, **kwargs)

Add an item project.

Items are assigned to projects.

Parameters:
  • itemProjectName –
  • description –
  • kwargs –
Returns:

(CdbObject) newly added record.
addItemSource(*args, **kwargs)

Add an item source record.

Parameters:
  • itemId –
  • sourceName –
  • partNumber –
  • cost –
  • description –
  • isVendor –
  • isManufacturer –
  • contactInfo –
  • url –
  • kwargs –
Returns:

(CdbObject) newly added record.
addItemType(*args, **kwargs)

Add an item type record.

items in particular domain could have different types.

Parameters:
  • name –
  • description –
  • domainName –
  • kwargs –
Returns:

(CdbObject) newly added record.
addRelationshipType(*args, **kwargs)

Add an item relationship type record.

Parameters:
  • name –
  • description –
  • relationshipTypeHandlerName –
  • kwargs –
Returns:

(CdbObject) newly added record.
addRelationshipTypeHandler(*args, **kwargs)

Add an item relationship type handler.

Parameters:
  • name –
  • description –
  • kwargs –
Returns:

(CdbObject) newly added record.
addSource(*args, **kwargs)

Add a source record.

Sources are various vendors that various items could be obtained from.

Parameters:
  • sourceName –
  • description –
  • contactInfo –
  • url –
  • kwargs –
Returns:

(CdbObject) newly added record.
getDomainByName(*args, **kwargs)

Get an item Domain by its name.

Parameters:
  • name – name of item domain
  • kwargs –
Returns:

(CdbObject) resulting record.
getEntityTypeByName(*args, **kwargs)

Get an entity type record by its name.

Parameters:
  • name – entity type name.
  • kwargs –
Returns:

(CdbObject) resulting record.
getItemById(*args, **kwargs)

Get an item record by its id.

Parameters:
  • itemId –
  • kwargs –
Returns:

(CdbObject) resulting record.
getItemByUniqueAttributes(*args, **kwargs)

Get an item record based on its unique attributes.

Parameters:
  • domainId –
  • name –
  • itemIdentifier1 –
  • itemIdentifier2 –
  • derivedFromItemId –
  • kwargs –
Returns:

(CdbObject) resulting record.
getItemCategory(*args, **kwargs)

Get an item category by its name.

Parameters:
  • name –
  • kwargs –
Returns:

(CdbObject) resulting record.
getItemElementById(*args, **kwargs)

Get an item element by its id.

Parameters:
  • itemElementId –
  • kwargs –
Returns:

(CdbObject) resulting record.
getItemElementsByItemId(*args, **kwargs)

Get a list of item elements for a particular item.

Parameters:
  • itemId –
  • kwargs –
Returns:

CdbObject List of item elements of a particular item.
getItemProjects(*args, **kwargs)

Get all item project records in the db.

Parameters:kwargs –
Returns:CDBObject List of item projects.
getItemType(*args, **kwargs)

Get an item type by its name and domain name.

Parameters:
  • name –
  • domainName –
  • kwargs –
Returns:

(CdbObject) resulting record.
getItemsWithPropertyType(*args, **kwargs)

Fetches items that have a particular property type.

Parameters:
  • propertyTypeName –
  • itemDomainName –
  • itemDerivedFromItemId –
  • propertyValueMatch –
  • kwargs –
Returns:

(CdbObject) resulting record.
getRelationshipTypeByName(*args, **kwargs)

Get an item relationship type record by its name.

Parameters:
  • name –
  • kwargs –
Returns:

(CdbObject) resulting record.
getRelationshipTypeHandlerByName(*args, **kwargs)

Get an item relationship type handler by its name.

Parameters:
  • name –
  • kwargs –
Returns:

(CdbObject) resulting record.
getSelfElementByItemId(*args, **kwargs)

Get an item self element by the id of the item.

Parameters:
  • itemId –
  • kwargs –
Returns:

(CdbObject) resulting record.
getSources(*args, **kwargs)

Get all records of sources.

Parameters:kwargs –
Returns:CDbObject List of sources in the db.