Start an analysis

startAnalysis

URL

/api/v1/startAnalysis

Description

Used by the IonReporterUploader plugin to start an analysis for the setId that is entered. Returns a JSON object with status and message.

Method

POST

Request query parameters

  • setId

    String. Mandatory.

    setId column value of the sample in the MG_SPECIMENUPLOADERDETAIL table when the sample is uploaded through the IonReporterUploader plugin.

  • containerName

    String. Mandatory.

    User-specified unique name for the analysis that is shown in Ion Reporter™ Software.

Example request 

https://user1.XYZ.com/api/v1/startAnalysis

Request headers

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

Authorization:API Token

Returns 

{ "status":true, "message":"success"}

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://<server name>/api/v1/startAnalysis -H "Authorization:NDliYmU0OWE4MzA3YmE2MWVmMjhlZTlhOTEyMmE5ODM0NzU3NjQ4OGM5NzVjODU3YjdlMWM4Mjk3OGYzODE4Yw" -d "setId=4__f535ccde-5c6a-490d-a1d2-7b81352e6830_2016-6-17_1_13_24&containerName=New_Analysis_Name"