v2 > Services > DeclarationsUpdate

Update one or more declarations in Origin.

• URL

  /connect/v2/declarations/update

  /connect/v2/async/declarations/update

• Method:

  POST

• URL Params

  none

• Request :

• Sample Request (Update of declarations attributes):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "url":"https://public.facing.url/declaration.pdf",
      "declarationNumber":"123456",
      "issueDate":"2008-09-15T15:53:00",
      "expiryDate":"2010-09-15T15:53:00"
    }
  ]
}

• Sample Request (Update of standard):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "standard":{
        "code":"EPD"
      }
    }
  ]
}

• Sample Request (Update of reporting body):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "reportingBody":{
        "name":"Veritas"
      }
    }
  ]
}

• Sample Request (Update the declaration by ADDING a brand):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "brands":[
        {
          "collectionBehavior":"ADD",
          "name":"ACME Inc.",
          "website":"www.acmexyz.com"
        }
      ]
    }
  ]
}

• Sample Request (Update the declaration by UPDATING a brand website):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
       "brands":[
        {
          "collectionBehavior":"ADD",
          "name":"ACME Inc.",
          "website":"www.acmexyz-2000.com"
        }
      ]
    }
  ]
}

• Sample Request (Update the declaration by REMOVING a brand.):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "brands":[
        {
          "collectionBehavior":"REMOVE",
          "name":"ACME Inc."
        }
      ]
    }
  ]
}

• Sample Request (Update the declaration by ADDING a contact):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "contacts":[
        {
          "collectionBehavior":"ADD",
          "externalId":"JOHNSMITHVENDOR1",
          "type":"VENDOR",
          "companyName":"ACME Inc.",
          "name":"John Smith",
          "website":"https://www.acme.com/",
          "postalAddress":"2500 Street Avenue P.O. Box 999 Manchester, PA 1234",
          "phone":"1-999-123-1234",
          "email":"salesrep@acme.com"
        }
      ]
    }
  ]
}

• Sample Request (Update the declaration by UPDATING a contact website):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "contacts":[
        {
          "collectionBehavior":"ADD",
          "externalId":"JOHNSMITHVENDOR1",
          "website":"https://www.acme-2000.com/"
        }
      ]
    }
  ]
}

• Sample Request (Update the declaration by REMOVING a contact):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "contacts":[
        {
          "collectionBehavior":"REMOVE",
          "externalId":"JOHNSMITHVENDOR1"
        }
      ]
    }
  ]
}

• Sample Request (Update the declaration by ADDING a document):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "additionalsDocuments":[
        {
          "collectionBehavior":"ADD",
          "originalUrl":"https://public.facing.url/image.jpg"
        }
      ]
    }
  ]
}

• Sample Request (Update the declaration by REMOVING a document):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "additionalsDocuments":[
        {
          "collectionBehavior":"REMOVE",
          "originalUrl":"https://public.facing.url/image.jpg"
        }
      ]
    }
  ]
}

• Sample Request (Update the declaration visibility. ADD channel = PUBLISH on that channel):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "channels":[
        {
          "collectionBehavior":"ADD",
          "name":"ORIGIN"
        }
      ]
    }
  ]
}

• Sample Request (Update the declaration visibility. REMOVE channel = UNPUBLISH from that channel):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "channels":[
        {
          "collectionBehavior":"REMOVE",
          "name":"ORIGIN"
        }
      ]
    }
  ]
}

• Sample Request (Update the declaration by ADDING a regulatory standard compliance):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "regulatoryStandardCompliances":[
        {
          "collectionBehavior":"ADD",
          "code":"ISO 9001"
        }
      ]
    }
  ]
}

• Sample Request (Update the declaration by REMOVING a regulatory standard compliance):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "regulatoryStandardCompliances":[
        {
          "collectionBehavior":"REMOVE",
          "code":"ISO 9001"
        }
      ]
    }
  ]
}

• Sample Request (Update the declaration by ADDING a custom feature):

Note : If the feature already exist, nothing happen.

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresCustoms":[
            {
               "collectionBehavior":"ADD",
               "code":"CUSTOM_TEXT_ATTRIBUTE",
               "name":"Highest supported temperature",
               "value":{
                  "content":"1500C"
               }
            }
         ]
      }
   ]
}

• Sample Request (Update the declaration by UPDATING a custom feature) New and Recommanded way with originId:

Note : To update a custom feature, the custom feature code and originId must be identical to those returned by the DeclarationsSearch to be updated

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresCustoms":[
            {
               "collectionBehavior":"ADD",
               "originId":"93a7e4f2-3443-4cd9-befa-d54cb8760357",
               "code":"CUSTOM_TEXT_ATTRIBUTE",
               "name":"Highest supported temperature",
               "value":{
                  "content":"2000C"
               }
            }
         ]
      }
   ]
}

• Sample Request (Update the declaration by UPDATING a custom feature) Old and Not Recommanded way:

Note : To update a custom feature, you must delete the old custom feature and add the new custom feature. The old custom feature payload must be identical to the payload returned by the DeclarationsSearch to be removed

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresCustoms":[
            {
               "collectionBehavior":"REMOVE",
               "code":"CUSTOM_TEXT_ATTRIBUTE",
               "name":"Highest supported temperature",
               "value":{
                  "content":"1500C"
               }
            },
            {
               "collectionBehavior":"ADD",
               "code":"CUSTOM_TEXT_ATTRIBUTE",
               "name":"Highest supported temperature",
               "value":{
                  "content":"2000C"
               }
            }
         ]
      }
   ]
}

• Sample Request (Update the declaration by REMOVING a custom feature.) New and Recommanded way with originId:

Note : If the feature does not exist, nothing happen. The custom feature code and originId must be identical to those returned by the DeclarationsSearch to be removed

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresCustoms":[
            {
               "collectionBehavior":"REMOVE",
               "originId":"93a7e4f2-3443-4cd9-befa-d54cb8760357",
               "code":"CUSTOM_TEXT_ATTRIBUTE",
               "name":"Highest supported temperature",
               "value":{
                  "content":"1500C"
               }
            }
         ]
      }
   ]
}

• Sample Request (Update the declaration by REMOVING a custom feature.) Old and Not Recommanded way:

Note : If the feature does not exist, nothing happen. The custom feature payload must be identical to the payload returned by the DeclarationsSearch to be removed

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresCustoms":[
            {
               "collectionBehavior":"REMOVE",
               "code":"CUSTOM_TEXT_ATTRIBUTE",
               "name":"Highest supported temperature",
               "value":{
                  "content":"1500C"
               }
            }
         ]
      }
   ]
}

• Sample Request (Update the declaration by ADDING a property feature):

Note : If the feature already exist, nothing happen.

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresProperties":[
            {
               "collectionBehavior":"ADD",
               "code":"LIFEEXPECTANCY",
               "value":{
                  "content":"3"
               },
               "unit":{
                  "code":"YEAR"
               }
            }
         ]
      }
   ]
}

• Sample Request (Update the declaration by UPDATING a property feature) New and Recommanded way with originId:

Note : To update a property feature, the property feature code and originId must be identical to those returned by the DeclarationsSearch to be updated.

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresProperties":[
            {
               "collectionBehavior":"ADD",
               "originId":"2c3b80e3-c1de-4a93-b2db-a7143962fdea",
               "code":"LIFEEXPECTANCY",
               "value":{
                  "content":"24"
               },
               "unit":{
                  "code":"MONTH"
               }
            }
         ]
      }
   ]
}

• Sample Request (Update the declaration by UPDATING a property feature) Old and Not Recommanded way:

Note : To update a property feature, you must delete the old property feature and add the new property feature. The old property feature payload must be identical to the payload returned by the DeclarationsSearch to be removed.

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresProperties":[
            {
               "collectionBehavior":"REMOVE",
               "code":"LIFEEXPECTANCY",
               "value":{
                  "content":"3"
               },
               "unit":{
                  "code":"YEAR"
               }
            },
            {
               "collectionBehavior":"ADD",
               "code":"LIFEEXPECTANCY",
               "value":{
                  "content":"24"
               },
               "unit":{
                  "code":"MONTH"
               }
            }
         ]
      }
   ]
}

• Sample Request (Update the declaration by REMOVING a property feature.) New and Recommanded way with originId:

Note : If the feature does not exist, nothing happen. The property feature code and originId must be identical to those returned by the DeclarationsSearch to be removed

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresProperties":[
            {
               "collectionBehavior":"REMOVE",
               "originId":"2c3b80e3-c1de-4a93-b2db-a7143962fdea",
               "code":"LIFEEXPECTANCY",
               "value":{
                  "content":"3"
               },
               "unit":{
                  "code":"YEAR"
               }
            }
         ]
      }
   ]
}

• Sample Request (Update the declaration by REMOVING a property feature.) Old and Not Recommanded way:

Note : If the feature does not exist, nothing happen. The property feature payload must be identical to the payload returned by the DeclarationsSearch to be removed.

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "featuresProperties":[
            {
               "collectionBehavior":"REMOVE",
               "code":"LIFEEXPECTANCY",
               "value":{
                  "content":"3"
               },
               "unit":{
                  "code":"YEAR"
               }
            }
         ]
      }
   ]
}

For more sample requests related to features, please see the Advanced Guidelines Multilingual Declaration Features

• Sample Request (Update the declaration voc content by UPDATING its attributes.):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "densityLimitGL":"40",
          "densityUnit": {
            "code": "EM_UGM3"
          },  
          "containsAddedMCPCE":"true"
        }
      }
    }
  ]
}

• Sample Request (Update the declaration voc content by ADDING a regulatory standard compliance.):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "regulatoryStandardCompliances":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"Hong Kong Air Pollution Control (VOC) regulation"
              },
              "productTypeCode":"Graphic arts (sign) coatings"
            }
          ]
        }
      }
    }
  ]
}

• Sample Request (Update the declaration voc content by REMOVING a regulatory standard compliance.):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "regulatoryStandardCompliances":[
            {
              "collectionBehavior":"REMOVE",
              "standard":{
                "code":"Hong Kong Air Pollution Control (VOC) regulation"
              },
              "productTypeCode":"Graphic arts (sign) coatings"
            }
          ]
        }
      }
    }
  ]
}

• Sample Request (Update the declaration voc content by ADDING a custom standard compliance.):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "regulatoryStandardCustoms":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"A CUSTOM CODE"
              }
            }
          ]
        }
      }
    }
  ]
}

• Sample Request (Update the declaration voc content by REMOVING a custom standard compliance.):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "regulatoryStandardCustoms":[
            {
              "collectionBehavior":"REMOVE",
              "standard":{
                "code":"A CUSTOM CODE"
              }
            }
          ]
        }
      }
    }
  ]
}

• Sample Request (Update the declaration voc content by ADDING a test method.):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "testMethods":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"ASTM Methods D2369"
              }
            }
          ]
        }
      }
    }
  ]
}

• Sample Request (Update the declaration voc content by REMOVING a test method.):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "testMethods":[
            {
              "collectionBehavior":"REMOVE",
              "standard":{
                "code":"ASTM Methods D2369"
              }
            }
          ]
        }
      }
    }
  ]
}

• Sample Request (Update the declaration voc content by ADDING an exempt compound.):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "exemptCompounds":[
            {
              "collectionBehavior":"ADD",
              "CAS":"109-99-9",
              "name":"Tetrahydrofuran",
              "percentByWeight":"1"
            }
          ]
        }
      }
    }
  ]
}

• Sample Request (Update the declaration voc content by UPDATING an exempt compound attributes.):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "exemptCompounds":[
            {
              "collectionBehavior":"ADD",
              "CAS":"109-99-9",
              "name":"Tetrahydrofuran",
              "percentByWeight":"1.5"
            }
          ]
        }
      }
    }
  ]
}

• Sample Request (Update the declaration voc content by REMOVING an exempt compound.):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "exemptCompounds":[
            {
              "collectionBehavior":"REMOVE",
              "CAS":"109-99-9"
            }
          ]
        }
      }
    }
  ]
}

• Sample Request (Update the declaration voc emission by UPDATING its attributes.):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"fe61dc5b-4c5c-4331-8ca8-45ce264f68f3",
      "voc":{
        "emission":{
          "densityMinGL":"250",
          "densityMaxGL":"500",
          "densityUnit": {
            "code": "EM_MGM2H"
          },          
        }
      }
    }
  ]
}

• Sample Request (Update the declaration voc emission by ADDING a regulatory standard compliance.):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"fe61dc5b-4c5c-4331-8ca8-45ce264f68f3",
      "voc":{
        "emission":{
          "regulatoryStandardCompliances":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"CDPH Standard Method 2010 v1.1"
              }
            }
          ]
        }
      }
    }
  ]
}

• Sample Request (Update the declaration voc emission by REMOVING a regulatory standard compliance.):

{
  "declarations":[
    {
      "locale":"en",
      "originId":"fe61dc5b-4c5c-4331-8ca8-45ce264f68f3",
      "voc":{
        "emission":{
          "densityMinGL":"250",
          "densityMaxGL":"500",
          "densityUnit": {
            "code": "EM_MGM2H"
          },  
          "regulatoryStandardCompliances":[
            {
              "collectionBehavior":"REMOVE",
              "standard":{
                "code":"CDPH Standard Method 2010 v1.1"
              }
            }
          ]
        }
      }
    }
  ]
}

• Sample Request (All fields):

{
   "declarations":[
      {
         "locale":"en",
         "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
         "declarationNumber":"ABC-123-000001",
         "url":"https://public.facing.url/declaration.pdf",
         "issueDate":"2008-09-15T15:53:00",
         "expiryDate":"2010-09-15T15:53:00",
         "additionalsDocuments":[
            {
               "collectionBehavior":"ADD",
               "originalUrl":"https://public.facing.url/image.jpg"
            }
         ],
         "regulatoryStandardCompliances":[
            {
               "code":"ISO 9001"
            }
         ],
         "reportingBody":{
            "name":"Veritas"
         },
         "standard":{
            "code":"EPD"
         },
         "brands":[
            {
               "collectionBehavior":"ADD",
               "name":"ACME Inc.",
               "website":"www.acmexyz.com"
            }
         ],
         "contacts":[
            {
               "collectionBehavior":"ADD",
               "externalId":"JOHNSMITHVENDOR1",
               "type":"VENDOR",
               "companyName":"ACME Inc.",
               "name":"John Smith",
               "website":"https://www.acme.com/",
               "postalAddress":"2500 Street Avenue P.O. Box 999 Manchester, PA 1234",
               "phone":"1-999-123-1234",
               "email":"salesrep@acme.com"
            }
         ],
         "channels":[
            {
               "collectionBehavior":"ADD",
               "name":"ORIGIN"
            }
         ],
         "featuresCustoms":[
            {
               "collectionBehavior":"ADD",
               "code":"CUSTOM_TEXT_ATTRIBUTE",
               "name":"Highest supported temperature",
               "value":{
                  "content":"1500C"
               }
            }
         ],
         "featuresProperties":[
            {
               "collectionBehavior":"ADD",
               "code":"LIFEEXPECTANCY",
               "value":{
                  "content":"3"
               },
               "unit":{
                  "code":"YEAR"
               }
            },
            {
               "collectionBehavior":"ADD",
               "code":"FSC_LABEL_TYPE",
               "value":{
                  "code":"FSC 100%"
               }
            }
         ],
         "voc":{
            "content":{
               "densityLimitGL":"10",
               "densityUnit": {
                  "code": "EM_GL"
                },  
               "containsAddedMCPCE":"true",
               "regulatoryStandardCompliances":[
                  {
                     "collectionBehavior":"ADD",
                     "standard":{
                        "code":"CARB SCM (2007)"
                     },
                     "productTypeCode":"Specialty Coatings - Bituminous Roof Coatings"
                  }
               ],
               "regulatoryStandardCustoms":[
                  {
                     "collectionBehavior":"ADD",
                     "standard":{
                        "code":"A CUSTOM CODE"
                     }
                  }
               ],
               "testMethods":[
                  {
                     "collectionBehavior":"ADD",
                     "standard":{
                        "code":"ASTM Methods D2369"
                     }
                  }
               ],
               "exemptCompounds":[
                  {
                     "collectionBehavior":"ADD",
                     "CAS":"142731-63-32",
                     "name":"TRANS-3-HEPTENE",
                     "percentByWeight":"1.9"
                  }
               ]
            },
            "emission":{
               "densityMin":"250",
               "densityMax":"500",
               "densityUnit": {
                  "code": "EM_MGM2H"
                },  
               "regulatoryStandardCompliances":[
                  {
                     "collectionBehavior":"ADD",
                     "standard":{
                        "code":"Blue Angel Elastic Floorings"
                     }
                  }
               ]
            }
         }
      }
   ]
}

• Response (sync mode) :

• Sample Response (Success in sync mode):

  HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "entityType":"DECLARATION",
    "result":"Update completed."
  },
  "connectRequest":{
    "declarations":[
      {
        "locale":"en",
        "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
        "url":"https://public.facing.url/declaration.pdf"
      }
    ]
  }
}

• Response (async mode):

• Sample Response (Success in async mode):

  HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "poolingCallback":"https://origin.build/equinox/connect/v2/result/declarations_update/batch/1c8a06b6-45be-4e68-9e2d-5c1f075e6ca2"
  },
  "connectRequest":{
    "declarations":[
      {
        "locale":"en",
        "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
        "url":"https://public.facing.url/declaration.pdf"
      }
    ]
  }
}

• Sample Response (Error):

  HTTP Code : 400, 500

{
  "status":{
    "state":"ERROR",
    "code":"CE00001 - Connect request failed validation. Refer to provided messages for details.",
    "messages":[
      "declarations[1] require one locale.",
      "declarations[1] require one originId or externalId.",
      "declarations[1] has invalid value ''ADD ITEM'' for field contact[1].collectionBehavior. Allowed value(s) : [ADD,REMOVE]",
      "declarations[1] require one externalId"
    ]
  },
  "connectRequest":{
    "declarations":[
      {
        "url":"https://public.facing.url/declaration.pdf",
        "contacts":{
          "collectionBehavior":"ADD ITEM",
          "name":"Jack Smith"
        }
      }
    ]
  }
}