Get

Get retrieves items from TIBCO Fulfillment Subscriber Inventory by a primary key. The amount of information included in the returned data can be controlled by setting flags on the request message. For performance reasons, it is best practice to retrieve as little information as required as part of a Get operation invocation.

This operation also provides the option of locking the retrieved item by using a defined lock key.
Users must have one of the following permissions for the respective action (get item or party) to call this operation:
  • PERM_READ_ITEM
  • PERM_READ_PARTY
The following table describes performance implications of using this operation:
Activity Impact Description
Retrieving multiple entities in a single operation call Low The more entities that are retrieved in a single call, the longer the operation will take to complete. Retrieving multiple items in a single call still takes less time than retrieving each item individually using separate operation calls.
Including party name High Including party names requires a query against the database.
Including parent party High Including parent parties requires a query against the database.
Including parent party name Low Including parent party is only relevant if the parent parties are included. Setting this flag has a low incremental impact over the high impact of including the parent party because the names are retrieved at the same time during the same query.
Including characteristics or characteristic names Low Including characteristics or characteristic names increases the size of the response message.
Including orders, orderIds, or orderRefs Low Including orders, order IDs, or orderRefs increases the size of the response message.
Including relationships or relationship types Low Including relationships. relationship types, or reverse relationships increases the size of the response message.
Including reverse relationships High Including reverse relationships requires a query against the database.
Returning deleted entities Low Returning deleted entities increases the number of records in the response message.
Locking entities Medium Locking any entity on a request requires a multi-step process rather than a simple data retrieve. This causes the operation to take longer to return.

Get Request

This message is sent by the client application to the TIBCO Fulfillment Subscriber Inventory system.

Get Item Request Payload
Get Party Request Payload
Get Request Body Details for Item and Party
Element Type Cardinality Description
entity ItemEntityGetType

or

PartyEntityGettype

Mandatory This is the entity definition retrieved.
entity/Id String Mandatory This is the unique identifier for the item to retrieve.
entity/returnDeleted Boolean Optional

If this element is true and an item has been logically deleted, it will be returned.

If this element is false or omitted and an item has been logically deleted, it will not be returned.

If an item has been physically deleted using the Purge operation, it will never be returned.

entity/lock LockType Optional This is the lock request type. If this is omitted, no lock attempt will occur.
entity/lock/key String Mandatory This is the key for the lock.
entity/lock/immediate Boolean Choice This indicates an immediate lock request.
entity/lock/priority int Choice / Optional default=5 (from 1 to 10) This is the priority of the lock request.
entity/lock/timeout int Choice / Optional default=no timeout This is the timeout of the lock request in seconds.
entity/include ItemIncludeType

or

PartyIncludeType

Optional This is the include type and the definition of what to include on the response.
entity/characteristicName String Choice This is the list of characteristics to return.
entity/includeCharacteristics Boolean Choice This indicates if all or no characteristics should be returned.
includeParentPartyName Boolean Optional This indicates if the parent party name should be searched.
Get Request Body Details for Item Only
Element Type Cardinality Description
include/includePartyName Boolean Optional This indicates if the party name should be returned.
include/includeParentParty Boolean Optional This indicates if the parent party should be returned.
include/includeOrders Boolean Optional This indicates if all or no orders should be returned.
include/orderId String Choice This is to search for specific order IDs.
include/orderRef String Choice This is to search for specific order references.
includeRelationships Boolean Choice This indicates if all or no characteristics should be returned.
relationshipType String Choice This indicates the array of relationship types to return.
includeReverseRelationships Boolean Optional This indicates if the reverse relationships should be returned.
Get Request Body Details for Party Only
Element Type Cardinality Description
includeChildParties Boolean Choice This indicates if child parties should be returned.
includeChildPartyNames Boolean Choice This indicates if the child party names should be returned.

Get Response

This message is sent by the TIBCO Fulfillment Subscriber Inventory system to the requesting application to return the results of the operation invocation.

Get Item Response Payload

Get Party Response Payload

Get 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.
entity ItemWithStatusType

or

PartyWithStatusType

Mandatory This is the entity type returning the individual result status.

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

If any of the entities could be retrieved, there is one entity for each requested item. The returned entity order is the same as the original requested item order.

entity/Id String Optional This is the unique identifier for the retrieved entity.
entity/entity ItemType

or

PartyType

Optional This is the entity type of the retrieved entity. If the entity was not found, this will be omitted.
entity/entity/ref entity/entity/ref String This is the reference of the retrieved entity.
entity/entity/name String Optional This is the name of the retrieved entity.
entity/entity/type String Optional This is the type of the retrieved entity.
entity/entity/subType String Optional This the sub type of the retrieved entity.
entity/entity/status String Optional This is the status of the retrieved entity.
entity/entity/id String Optional This is the unique identifier for the retrieved entity.
entity/entity/characteristic CharacteristicType Optional This defines the characteristics of the retrieved entity, such as ID, name, and value.
entity/entity/ownedBy String Optional This defines who owns the retrieved entity.
entity/entity/createdBy String Optional This defines who created the retrieved entity.
entity/entity/createdDate dateTime Optional This is the date the retrieved entity was created.
entity/entity/lastUpdatedBy String Optional This defines who last updated the retrieved entity.
entity/entity/lastUpdatedDate dateTime Optional This is the date the retrieved entity was last updated.
entity/entity/version Long Optional This is the version of the retrieved entity.
entity/entity/batchId String Optional This is the batch ID associated with the retrieved entity.
entity/entity/lock LockInformation Optional This is the lock information for the retrieved entity. See the "Lock Information" section in Get Sub Elements for more details on the sub elements of this element.
entity/entity/deleted Boolean Optional This indicates if the retrieved entity is logically deleted.
entity/entity/parentParty PartyReference Optional This defines the parent party of the retrieved entity.
Get Response Body Details for Item Only
Element Type Cardinality Description
entity/entity/productId String Optional This is the product ID associated with the retrieved item.
entity/entity/productVersion String Optional This is the product version associated with the retrieved item.
entity/entity/party PartyReference Optional This is the party reference associated with the retrieved item.
entity/entity/order OrderType Optional This is the order type associated with the retrieved item. See the "Get Order" section in Get Sub Elements for more details on the sub elements of this element.
entity/entity/relationship RetrievedRelationshipType Optional This is the relationship type associated with the retrieved item.
entity/entity/startDate dateTime Optional This is the start date of the retrieved item.
entity/entity/endDate dateTime Optional This is the end type of the retrieved item.
entity/entity/parentParty PartyReference Optional This is the parent party reference associated with the retrieved item.
relationship/reverse Boolean Optional Set this to true to indicate a reverse relationship. It is set to false by default (meaning forward relationship). This is used to differentiate forward and reverse relationships when relationships are fetched. Reverse relationship/id will contain the originator item.
Get Response Body Details for Party Only
Element Type Cardinality Description
entity/entity/childParty PartyReference Optional This is the child party reference associated with the retrieved party.
parentParty/id String Optional This is the parent party ID associated with the retrieved party.
parentParty/name String Optional This is the parent party name associated with the retrieved party.
childParty/id String Optional This is the child party ID associated with the retrieved party.
childParty/name String Optional This is the child party name associated with the retrieved party.