Versions Compared

Key

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

openspecimen/rest/ng/print-rules

or

openspecimen/rest/ng/print-rules?maxResults={maxResults}

Use this resource to get print rules. This API returns all the print-rules present in the openSpecimen application. User can also specify the search string which will be used to match the values.

Use HTTP GET 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
Details
maxResultsmaximum number of records to fetch. By default it will be 1000


http[s]:<host>:<port>/openspecimen/rest/ng/print-rules

or

http[s]:<host>:<port>/openspecimen/rest/ng/print-rules?maxResults={maxResults}


Use this URL to get print-rules in openSpecimen application.

Result:

The response of this request will contains the details of the print-rules.

Below is the example of the get print rules:

URLhttp://<host>:<port>/openspecimen/rest/ng/print-rules
MethodGET
Requestapplication/json

Response

[{

id3
name"My PrintRule"
specimenClass"Fluid"
specimenType"Any"
labelType"Cap+Slide"
workstationIP"127.0.0.1"
dataOnLabel
[
0:  "Specimen type"
1:  "Specimen Label"]
printerName"TB2"
cpShortTitle"SCS_CP"
loginName
{
loginName"admin@admin.com"
domainName"catissue"
}, {
id: 4
name"My PrintRule1"
specimenClass"Any"
specimenType"Any"
labelType"Cap+Slide"
workstationIP"127.0.0.1"
dataOnLabel
[
0:  "Specimen type"
1:  "Specimen Label"]
printerName"TB2"
cpShortTitle"SCS_CP"
loginName
{
loginName"admin@admin.com"
domainName"catissue"
}
}

]

 

 

Error Cases :

code
Applies to
Status Message
200All resourcesPrint rules got successfully
401All requestsAuthorization failed, user doesn’t have Authority
500All requestsInternal server error, encountered server error while performing operations