Create

Create makes one-to-many new entities in TIBCO Product and Service Inventory. For items only, you can also use this operation to create orders, associated characteristics, and relationships, as well as a link to other items; this is item specific, and cannot be done for parties. Referential integrity is assured for an item-to-item relationship.

This operation also provides the option of locking the newly created entity using a defined lock key.

Users must have one of the following permissions for the respective action (create item or party) to call this operation:

  • PERM_CREATE_ITEM
  • PERM_CREATE_PARTY

The following table describes the performance implications of using this operation:

Activity Impact Description
Creating multiple entities in a single operation call Low The more entities that are created in a single call, the longer the operation takes to complete. Creating multiple entities in a single call is still be less time than creating each entity individually when using separate operation calls.
Creating items with large numbers of characteristics, orders, and relationships Medium The more characteristics, orders, and relationships that are created with an item results in a longer processing time.

Create Request

This message is sent by the client application to the TIBCO Product and Service Inventory system.

Create Item Request Payload

Create Party Request Payload

Element Type Cardinality Description
batchId String Optional This is the batch this item creation belongs to.
entity CreateItemType Mandatory This is the item create type and the list of entities to create.
entity/ref String Optional This is the reference of the entity being created.
entity/name String Optional This is the name of the entity being created.
entity/type String Mandatory This is the type of entity being created.
entity/subType String Optional This is the subtype of the entity being created.
entity/status String Mandatory This is the status of the entity being created.
entity/id String Optional This is the unique identifier for the entity to be created.

If entityId was specified in the request or was created successfully, this is populated.

If entityId was omitted from the request and the entity was not successfully created, this is not returned.

entity/characteristic CharacteristicCreateType Optional This defines the characteristics of the entity being created, such as ID, name, and value.
entity/lock String Optional This is the key of the immediate lock to apply to the created entity.
entity/ownedBy String Optional This defines who owns the entity. This defaults to the current user if it is omitted.
characteristic/id String Optional This is the identifier of the characteristic within the entity. If this is empty, an identifier is created.
characteristic/name String Mandatory This is the name of the characteristic.
characteristic/value String Mandatory This is the value of the characteristic.
Create Request Body Details for Item Only
Element Type Cardinality Description
entity/productid String Optional This is the ID of the product represented by the item.
entity/productVersion String Optional This is the product version number of the product being created.
entity/partyId String Optional This item field represents the party of the item it belongs to. It may or may not represent a valid party ID.
entity/order OrderType Optional This is the order or orders related to this item. See the Create Sub Elements topic for details on the order of sub-elements.
entity/relationship RelationshipType Optional This is the relationship for the item (no referential integrity). See the Create Sub Elements topic for details on the relationship sub-elements.
entity/startDate dateTime Mandatory This is the start date for the entity being created.
entity/endDate dateTime Optional This is the end date for the entity being created.

Create Response

This message is sent by the TIBCO Product and Service Inventory system to the requesting application to return the results of the operation invocation.

Create Item Response Payload

Create Party Response Payload

Create Response Body Details for Item and Party
Element Type Cardinality Description
resultStatus ResultStatusType Mandatory This is the result status type and the operation invocation status.
batchId String Optional This is the unique identifier for the batch that the request was included in. This is only be returned if it is included in the request.
entity BaseEntityResultType Optional This is the entity type returning the individual result status.

If none of the entities could be created due to a system error, this set is empty.

If any of the entities could be created, there is one entity for each requested create entity.

entity/id String Optional This is the unique identifier for the created entity.

If entityId is specified in the request or is created successfully, this is to be populated.

If entityId was omitted from the request and the entity was not successfully created, this is not returned.

entity/parentPartyId String Optional This is the ID of the parent party of this party. It may or may not be the ID of an existing party.