Integrations REST APIs - Collaboration Area

Following are some sample Integrations REST APIs for the Collaboration Area.

  • POST: Perform add operation on entries (item or category) in the collaboration area, based on the step name and collaboration name.

    • {
    "entryInfoList": [
        {
            "primaryKey": "1002",
            "attributeList": [
                {
                    "path": "productSpec/productName",
                    "value": "Test"
                }
            ],
            "categoryList": [
                {
                    "categoryFullPath": "Product Hierarchy/Parent Category"
                }
            ]
        }
    ]
}

    • {
    "entries": [
        {
            "primaryKey": "1002",
            "message": "Successfully added item",
            "errors": []
        }
    ]
}
  • PUT: Update the existing item entry in the collaboration area step based on the collaboration area and step name.

    • {
    "entryInfoList": [
        {
            "primaryKey": "Bucket",
            "attributeList ": [
                {
                    "path": "Product_Catalog_Spec/Item_Name",
                    "value": "Bucket"
                }
            ],
            "categoryList": [
	     {
                    "categoryFullPath": "Product Hierarchy/Home Accessories",
                    "action": "ADD"
                }
            ]
        }
    ]
}{
    "entryInfoList": [
        {
            "primaryKey": "Bucket",
            "attributeList ": [
                {
                    "path": "Product_Catalog_Spec/Item_Name",
                    "value": "Bucket"
                }
            ],
            "categoryList": [
	     {
                    "categoryFullPath": "Product Hierarchy/Home Accessories",
                    "action": "ADD"
                }
            ]
        }
    ]
}

    • {
    "entries": [
        {
            "primaryKey": " Bucket ",
            "message": " Successfully updated item ",
            "errors": []
        }
    ]
}
  • PUT: If entries are not reserved, and you want to move them across different steps.

    • {
      
        "entriesToReserve":["N1"]

}


    • {
    "entries": [
        {
            "primaryKey": "N1",
            "message": "Entry reserve successfully",
            "errors": null
        }
    ]
}
  • PUT: Move entries across different steps.

    • {
         "exitValue":"FIXIT",
        "entriesToMove":["Q888","Q999"]

}


    • {
    "entries": [
        {
            "primaryKey": "Q999",
            "message": "Entry moved successfully",
            "errors": null
        },
        {
            "primaryKey": "Q888",
            "message": "Entry moved successfully",
            "errors": null
        }
    ]
}