Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

catissuecore/rest/ng/specimen/print-rules/name={ruleName}

or

catissuecore/rest/ng/specimen/print-rules/{id}

Use this resource to update print rule in the caTissue application. Use HTTP PATCH method to call this API by passing the below details in JSON format.

 

Below are the attributes which need to be sent in the request body:

Parameter

Definition

specimenClass[Optional]

Class of the specimen. By default it will be 'Any'
Permissible Values: Molecular, Fluid, Cell, Tissue

dataOnLabel

Information that needs to be included in the label based on the specimen class/type and label type

workstationIP [Optional]

IP address of the machine from where the print request will come and this decides to which printer the request has to be forwarded to. By default it will be 'Any'

It can be specified in wild card format like grouping

e.g

all IPs starting with 128 will have same rule

all IPs starting with 128.3. will have same rule

ruleNameName of the Print Rule. Should be unique in system

printerName

Name of the printer where the request has to be forwarded to.

labelType

This could be Cap+Slide or Side. This parameter and the specimen type define the information that needs to go in the label. This will help user to configure based on label physical dimensions.

specimenType [Optional]

Type of the specimen . By default it will be 'Any'
Permissible Values: 'Any' or any specimen type of the class specified in same row


http[s]:<host>:<port>/catissuecore/rest/ng/specimen/print-rules/name={ruleName}

or

catissuecore/rest/ng/specimen/print-rules/{id}

Use this URL to patch print rule in caTissue application.


Result:

The response of this request will contains the details of the patched print rule.

Below is the example of the patch print rule:

URL

http://<host>:<port>/catissuecore/rest/ng/specimen/print-rules/name={ruleName}

or

catissuecore/rest/ng/specimen/print-rules/{ruleId}

MethodPATCH
Requestapplication/json
json

{

    "labelType" : "Cap+Slide"

}

Response

{

    "id" : 1,

    "name":"My PrintRule",

    "specimenClass" : "Fluid",

    "specimenType" : "Any",

    "labelType" : "Cap+Slide",

    "dataOnLabel" : "Specimen Label, Specimen type,CP title,Created On",

    "printerName" : "TB2",

    "workstationIP" : "127.0.0.1"    

}

 

Error Cases :

code
Applies to
Status Message
200All resourcesPrint rule has been updated successfully
400All requestsInvalid parameters, e.g  duplicate Print rule name, blank Print rule name etc
401All requestsAuthorization failed, User doesn’t have Authority
404All requestsPrint rule not found, Print rule with given details not present in the system
500All requestsInternal server error, Encountered server error while performing operations