Check if a sample exists

isSampleExists

URL

/api/v1/isSampleExists

Description

IonReporterUploader plugin checks whether there is an existing sample that uses the sample that is given in the call.

Method

POST

Request query parameters

sampleName

String. Mandatory.

Valid sample name.

Example request

https://ionreporter.thermofisher.com/api/v1/isSampleExists

Request headers

Content-Type:application/x-www-form-urlencoded

Authorization:API Token

Returns

true if sample with given name already exists in the organization given the API token for the user in headers.

false if the sample does not exist.

Response fields

Status code

Response message

200

Successful response

400

Bad request

404

Not found

401

User is not authenticated

500

Error occurred

Curl command

curl -X POST -k https://<your server name>/api/v1/isSampleExists -H "Content-Type:application/x-www-form-urlencoded" -H "Authorization:NDliYmU0OWE4MzA3YmE2MWVmMjhlZTlhOTEyMmE5ODM0NzU3NjQ4OGM5NzVjODU3YjdlMWM4Mjk3OGYzODE4Yw" -d "sampleName=Poo_C03-740_DNA_009_think3_IRUCLI"