Page Comparison

...

Roles Required: Project Management

1. Service endpoint to Post to.Determine Post for Service endpoint

   1. Validate file and return statistics of the changes the the import would have made:

      1. https://xxx.studytrax.com/api/v1/customers/yyy/projects/zzz/subjects/import

      to import

      1. ?analysisOnly=true

   2. Import the file and :

      1. https://xxx.studytrax.com/api/v1/customers/yyy/projects/zzz/subjects/import

      ?analysisOnly=true to validate and return statistics of the changes the import would have made.

   3. Customize the URL

      1. Change "xxx" to the prefix of the server you are targeting (e.g., "my" if target is https://my.studtraxstudytrax.com).

      2. Change "yyy" to the customer id.

      3. Change "zzz" with the project id.

   4. Enter the URL into the request URL field

2. Add an authentication Authentication token to the header: Authentication

   Add the file and JSON with the import options to the request body.

   The context type needs to be set as “form-data”

3. Select Body

4. Select the form-data option to allow both the file and JSON to be sent

   .

5. Add the file to the body as File Content

   .

   1. In Postman, to add a file

      ,

      in the body section,

      you need to

      hover over the field for

      “Key”.

      Key

   2. A

      pull

      drop down will become visible

      allowing you to select Text or File - select File.

      Add the options JSON to the body.

   3. Select File in the drop down

   4. Click Select Files and select the data file to import

6. Add the JSON with the import options to the request body

   1. Enter the JSON in the Value field

      1. The options are the same as those on the subject data import page in the Studytrax application

      .

      2. Example options JSON: {"addMedicationsToProject": false, "allowSubjectsToExist": false, "changeReason": "test reason", "includeDuplicateSubjectMedications": false, "performDetailedValidation": false, "treatBlankAsDelete": false}

   2. In Postman, the content type needs to be

      "

      application/json

      ".Image Removed

      1. If the Content Type column is not displayed, click … and check the box for Content Type

      2. Start typing in the Content Type field and select application/json

7. Post the request .by clicking Send

   1. The result returned will be JSON that contains any errors or warnings and the statistics for the records modified, or, if the query string “analysisOnly=true” was added to the URL, the statistics represents records that would have been modified.

...