Skip to content
This repository has been archived by the owner on Oct 30, 2023. It is now read-only.

API LIST

Jump to bottom
80010ekta edited this page May 18, 2018 · 1 revision

Uploader API List

  • Uploader

    GET https://api.flowzdigital.com/uploader/uploader

    POST https://api.flowzdigital.com/uploader/uploader {"key":"pdm_uploader","masterJobStatus":"rejected","stepStatus":"upload_pending","subscriptionId":"ff45ec86-911b-42a3-b073-a50c25c08537","uploadType":"replace"}

    PATCH https://api.flowzdigital.com/uploader/uploader/:importTrackerId

    For eg - https://api.flowzdigital.com/uploader/uploader/ 3729c5dc-495c-4d0d-ad38-d0d9b1a74a2a

    • If the user is rejecting the job from the dashboard { 'masterJobStatus': 'rejected'}

    • If the user is aborting the import { 'stepStatus' : 'validation_completed', 'totalProduct' : 0, 'uploadProduct' : 0, abort': true }

    • When validation starts { 'stepStatus': 'validation_running' }

    • When validation gets completed { stepStatus: 'validation_completed' }

    • When a file gets uploaded ( suppose Product Price file) {"ProductPrice":{"id":"e9afaa14-6d7e-4cf1-889f-1c2b15272bdb","schemaId":"3cddfb44-6b3d-4917-a645-6420d0f22e14", "totalNoOfRecords": 99, "uploadStatus":"completed", "validateStatus":"pending"}}

    PUT https://api.flowzdigital.com/uploader/uploader/:importTrackerId

    For eg - https://api.flowzdigital.com/uploader/uploader/ 3729c5dc-495c-4d0d-ad38-d0d9b1a74a2a

    • When delete a uploaded file

      {"id":"3729c5dc-495c-4d0d-ad38-d0d9b1a74a2a","key":"pdm_uploader","masterJobStatus":"running","stepStatus":"upload_pending","subscriptionId":"ff45ec86-911b-42a3-b073-a50c25c08537","uploadType":"replace","user_id":"5a9fb7fb4135780015eb13d8","username": ”[email protected]”}

    • When abort from server side validation

      Existing obj = {"ProductInformation":{"currentRuleIndex":19,"id":"ea900959-a9e5-4fbc-8849-f04d67d02c98","ruleIndex":19,"schema_id":"","totalNoOfRecords":9,"uploadStatus":"completed","uploadedAt":"2018-03-08T07:11:36.372Z","validateStatus":"completed"},"createdAt":"2018-03-08T06:59:11.451Z","id":"3729c5dc-495c-4d0d-ad38-d0d9b1a74a2a","key":"pdm_uploader","masterJobStatus":"running","stepStatus":"validation_running","subscriptionId":"ff45ec86-911b-42a3-b073-a50c25c08537","uploadType":"replace","user_id":"5a9fb7fb4135780015eb13d8","username":[email protected]}

      New obj = {"ProductInformation":{"id":"ea900959-a9e5-4fbc-8849-f04d67d02c98","schema_id":"","totalNoOfRecords":9,"uploadStatus":"completed","uploadedAt":"2018-03-08T07:11:36.372Z","validateStatus":"pending"},"createdAt":"2018-03-08T06:59:11.451Z","id":"3729c5dc-495c-4d0d-ad38-d0d9b1a74a2a","key":"pdm_uploader","masterJobStatus":"running","stepStatus":"upload_pending","subscriptionId":"ff45ec86-911b-42a3-b073-a50c25c08537","uploadType":"replace","user_id":"5a9fb7fb4135780015eb13d8","username":[email protected]}

    • When abort from import step

      Existing obj = {"ProductInformation":{"currentRuleIndex":19,"id":"ea900959-a9e5-4fbc-8849-f04d67d02c98","ruleIndex":19,"schema_id":"","totalNoOfRecords":9,"uploadStatus":"completed","uploadedAt":"2018-03-08T07:11:36.372Z","validateStatus":"completed"},"createdAt":"2018-03-08T06:59:11.451Z","id":"3729c5dc-495c-4d0d-ad38-d0d9b1a74a2a","key":"pdm_uploader","masterJobStatus":"running","stepStatus":"validation_completed","subscriptionId":"ff45ec86-911b-42a3-b073-a50c25c08537","uploadType":"replace","user_id":"5a9fb7fb4135780015eb13d8","username":[email protected]}

      New obj = {"ProductInformation":{"id":"ea900959-a9e5-4fbc-8849-f04d67d02c98","schema_id":"","totalNoOfRecords":9,"uploadStatus":"completed","uploadedAt":"2018-03-08T07:11:36.372Z","validateStatus":"pending"},"createdAt":"2018-03-08T06:59:11.451Z","id":"3729c5dc-495c-4d0d-ad38-d0d9b1a74a2a","key":"pdm_uploader","masterJobStatus":"running","stepStatus":"upload_pending","subscriptionId":"ff45ec86-911b-42a3-b073-a50c25c08537","uploadType":"replace","user_id":"5a9fb7fb4135780015eb13d8","username":[email protected]}

  • Uploader-schema

    GET https://api.flowzdigital.com/uploader/uploader-schema

    POST https://api.flowzdigital.com/uploader/uploader-schema

    {"import_tracker_id":"3729c5dc-495c-4d0d-ad38-d0d9b1a74a2a","name":"Product Info", "schema":{"_id":{"allowedValues": [ ],"defaultValue":"","label":"_id","maxLength":"","optional":true,"regEx":"","type":"string"},"attr _colors":{"allowedValues": [ ],"defaultValue":"","label":"Attribute Color","maxLength":"","optional":false,"regEx":"","type":"string"}},

  • Uploader-csv-file-mapping

    GET https://api.flowzdigital.com/uploader/uploader-csv-file-mapping

    POST https://api.flowzdigital.com/uploader/uploader-csv-file-mapping

    {"fileTypeId":"Product Info","import_tracker_id":"3729c5dc-495c-4d0d-ad38-d0d9b1a74a2a","mapping":[{"csvHeader":"product_id","schemaObj":{"allowedValues":[],"defaultValue":"","label":"Product Id","maxLength":"","optional":true,"regEx":"","type":"string"},"sysHeader":"product_id","transform":"","transformMethod":""},{"csvHeader":"sku","schemaObj":{"allowedValues":[],"defaultValue":"","label":"SKU","maxLength":"","optional":false,"regEx":"","type":"string"},"sysHeader":"sku","transform":"","transformMethod":""}],"subscriptionId": "ff45ec86-911b-42a3-b073-a50c25c08537","username": "[email protected]"}

Clone this wiki locally