Start Batch

You can use the start batch operation to start batches.

Users must have one of the following permissions to call this operation:

  • PERM_START_BATCH
  • PERM_READ_BATCH

startBatch Request

This message is sent by the client application to the TIBCO Product and Service Inventory system. The startBatch request has the following payload:

Element Type Cardinality Description
id String Optional The ID of the batch to start must be unique. If it is absent, the system starts a batch with a random ID and return it.

startBatch 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. The startBatch response has the following payload:

Element Type Cardinality Description
resultStatus ResultStatusType Mandatory This is the result of the operation.
entity BaseEntityResultType Mandatory This is the specific result of the requested IDs.
entity/id String Mandatory This is the unique identifier for the created entity.

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.