tFLOW API changes in v7

tFLOW
API Changes in v7
 
 

Most changes are non breaking, but minor number of the API version has been changed to reflect addition of new data members and methods.

 

 

(breaking change) The tFLOW API version returned by “Get API Version” method is now 2.3.0

 

 

 


Job info object which is returned by “Get List of Jobs” and “Get Job object” now contains several additional members:

 

 
  • finishing_profile_id - integer, an ID of finishing profile if it is different from set via product
  • proof_profile_id - integer, an ID of proofing profile if it is different from set via product
  • production_profile_id - integer, an ID of production profile if it is different from set via product
  • assignments.instance_user_ids - an array of instance user IDs assigned to the job
  • assignments.non_instance_user_ids - an array of non-instance user IDs assigned to the job

 

 

 


 

“Create new Job” method now expects three additional non-mandatory parameters:

 
  • finishing_profile_id - integer, an ID of finishing profile. If not specified, the finishing profile from the product will be used
  • proof_profile_id - integer, an ID of proofing profile. If not specified, the proofing profile from the product will be used
  • production_profile_id - integer, an ID of production profile. If not specified, the production profile from the product will be used

 


 

“Update Job” method now expects three additional non-mandatory parameters:

 
  • finishing_profile_id - integer, an ID of finishing profile. If null, the finishing profile from the product will be used. If not specified, then the finishing profile for the job will not be changed.
  • proof_profile_id - integer, an ID of proofing profile. If null, the proofing profile from the product will be used. If not specified, the proofing profile for the job will not be changed.
  • production_profile_id - integer, an ID of production profile. If null , the production profile from the product will be used. If not specified, the production profile for the job will not be changed.

 


 

Order info object which is returned by “Get list of Orders” and “Get Order object” now contains several additional members:

 
  • finishing_profile_id - integer, an ID of finishing profile if it is different from set via product
  • proof_profile_id - integer, an ID of proofing profile if it is different from set via product
  • production_profile_id - integer, an ID of production profile if it is different from set via product
  • assignments.instance_user_ids - an array of instance user IDs assigned to the order
  • assignments.non_instance_user_ids - an array of non-instance user IDs assigned to the order

 


 

“Create new Order” method now expects three additional non-mandatory parameters:

 
  • finishing_profile_id - integer, an ID of finishing profile. If not specified, the finishing profile from the product will be used
  • proof_profile_id - integer, an ID of proofing profile. If not specified, the proofing profile from the product will be used
  • production_profile_id - integer, an ID of production profile. If not specified, the production profile from the product will be used

 


 

“Update order” method now expects three additional non-mandatory parameters:

 
  • finishing_profile_id - integer, an ID of finishing profile. If null, the finishing profile from the product will be used. If not specified, then the finishing profile for the order will not be changed.
  • proof_profile_id - integer, an ID of proofing profile. If null, the proofing profile from the product will be used. If not specified, the proofing profile for the order will not be changed.
  • production_profile_id - integer, an ID of production profile. If null , the production profile from the product will be used. If not specified, the production profile for the order will not be changed.

 


 

“Get list of Tflow queues” method now returns list sorted by tflow_name and queue_name. Previously there was no sorting.

 


 

Added “Get List of Profiles” method which allows to get list of profiles installed in the instance, apart with their types (production, proofing, or finishing).