Guidelines > Advanced Guidelines > Multilingual Declaration Features


The following steps represent the normal workflow for creating, updating, and deleting the declaration features in a multilingual context.

Obviously, these guidelines cannot contain all the features. The features with similar characteristics will have similar behavior.

💡 See the isTranslatable, isCustom, and isMultiple flags, the possibleValues, and the possibleUnits in PropertyDetailsLookup to know the features that can be similar to the features presented in these guidelines.

Services Used

Step 1 Creation

Which actions will be performed

  • Create a declaration with
    • Locale : en (⚠️ It's highly recommanded that you create your entity in English first ("locale": "en"). The majority of users use this language and it's used as fallback language.)
    • External id : Connect_Declaration_Multilingual_01_External_Id
    • Name : Connect Declaration Multilingual 01
    • Declaration Number : c-d-ml-01 (Document Number, Document ID ...)
    • URL : http://connect.tld/c-d-ml-01
    • Standard : Declare℠ (code Declare™) (⚠️ The Declare code use the Trademark symbol ™ and the Declare name use the Servicemark symbol ℠)
    • Self Reported
    • Add custom features
      • 3 Custom Text Attribute (code CUSTOM_TEXT_ATTRIBUTE)
        1. Named Mineral density with value Diamond
        2. Named A with value X
        3. Named A with value Y
    • Add property features
      • Life Expectancy (code LIFEEXPECTANCY) with value 25 and the unit years (code YEAR)
      • Final Assembly Location (code ASSEMBLYLOCATION) with value Italy
      • Status (code DECLARE_STATUS) with value Declared (code Declared)
  • Publish the declaration on Origin (channel name : ORIGIN)

📝 Note 1 All custom feature names are translatable.

⚠️ Note 2 For now, only the property feature with the code ASSEMBLYLOCATION, and the custom features with the code CUSTOM_TEXT_ATTRIBUTE have a value that can be translated. For the other features, if an update is done in one language, the update will be applied on all languages.

💡 Note 3 See the isTranslatable flag in PropertyDetailsLookup to know the features that can be translated.

Request URI

/connect/v2/declarations/create

Sample DeclarationsCreate Request

{
    "declarations": [
        {
            "locale": "en",
            "externalId": "Connect_Declaration_Multilingual_01_External_Id",
            "declarationNumber": "c-d-ml-01",
            "url": "http://connect.tld/c-d-ml-01",
            "reportingBody": {
                "selfReported": "true"
            },
            "standard": {
                "code": "Declare™"
            },
            "channels": [
                {
                    "name": "ORIGIN"
                }
            ],
            "featuresCustoms": [
                {
                    "name": "Mineral density",
                    "code": "CUSTOM_TEXT_ATTRIBUTE",
                    "value": {
                        "content": "Diamond"
                    }
                },
                {
                    "name": "A",
                    "code": "CUSTOM_TEXT_ATTRIBUTE",
                    "value": {
                        "content": "X"
                    }
                },
                {
                    "name": "A",
                    "code": "CUSTOM_TEXT_ATTRIBUTE",
                    "value": {
                        "content": "Y"
                    }
                }
            ],
            "featuresProperties": [
                {
                    "code": "LIFEEXPECTANCY",
                    "value": {
                        "content": "25"
                    },
                    "unit": {
                        "code": "YEAR"
                    }
                },
                {
                    "code": "ASSEMBLYLOCATION",
                    "value": {
                        "content": "Italy"
                    }
                },
                {
                    "code": "DECLARE_STATUS",
                    "value": {
                        "code": "Declared"
                    }
                }
            ]
        }
    ]
}

Sample DeclarationsCreate Response

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "DECLARATION",
        "correlations": [
            {
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "originId": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa"
            }
        ]
    },
    "connectRequest": {
        "declarations": [
            {
                "locale": "en",
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "declarationNumber": "c-d-ml-01",
                "url": "http://connect.tld/c-d-ml-01",
                "reportingBody": {
                    "selfReported": "true"
                },
                "standard": {
                    "code": "Declare™"
                },
                "channels": [
                    {
                        "name": "ORIGIN"
                    }
                ],
                "featuresCustoms": [
                    {
                        "name": "Mineral density",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Diamond"
                        }
                    },
                    {
                        "name": "A",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "X"
                        }
                    },
                    {
                        "name": "A",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Y"
                        }
                    }
                ],
                "featuresProperties": [
                    {
                        "code": "LIFEEXPECTANCY",
                        "value": {
                            "content": "25"
                        },
                        "unit": {
                            "code": "YEAR"
                        }
                    },
                    {
                        "code": "ASSEMBLYLOCATION",
                        "value": {
                            "content": "Italy"
                        }
                    },
                    {
                        "code": "DECLARE_STATUS",
                        "value": {
                            "code": "Declared"
                        }
                    }
                ]
            }
        ]
    }
}

📝 Note The DeclarationsCreate Response return a correlations array that contains a pair of externalId and originId.

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "DECLARATION",
        "correlations": [
            {
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "originId": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa"
            }
        ]
    },
    "connectRequest": { ... }
}

You can store the originId on your side, so you can use it in future calls.

Both can be used to make the calls, ⚠️ but externalId is not unique unlike originId.

Both are used in these guidelines.

Step 2 Creation Validation (Optional)

Which actions will be performed

  • Validate the certification creation in English
  • Validate the certification creation in French

Request URI

/connect/v2/declarations/search

Sample DeclarationsSearch Request in English

{
    "locale": "en",
    "pageNumber": "1",
    "pageSize": "100",
    "searchCriteria": [
        {
            "name": "ORIGINID",
            "value": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa"
        }
    ]
}

Sample DeclarationsSearch Response in English after creation

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "DECLARATION",
        "searchInfo": {
            "numberOfElements": "1",
            "numberOfPages": "1"
        },
        "data": [
            {
                "locale": "en",
                "originId": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa",
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "declarationNumber": "c-d-ml-01",
                "url": "http://connect.tld/c-d-ml-01",
                "reportingBody": {
                    "selfReported": "true"
                },
                "standard": {
                    "name": "Declare℠",
                    "code": "Declare™",
                    "isCustom": "false"
                },
                "featuresCustoms": [
                    {
                        "originId": "30377e52-5c7c-4b33-8ae9-dbac743cd812",
                        "name": "Mineral density",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Diamond"
                        }
                    },
                    {
                        "originId": "1741ce18-7c87-46d6-b0c6-2ec5e452d302",
                        "name": "A",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "X"
                        }
                    },
                    {
                        "originId": "0e869881-e588-4771-813f-35a23c10298e",
                        "name": "A",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Y"
                        }
                    }
                ],
                "featuresProperties": [
                    {
                        "originId": "ca5951fa-8eac-4d9d-982e-03b0a5172a09",
                        "name": "Life Expectancy",
                        "code": "LIFEEXPECTANCY",
                        "value": {
                            "content": "25"
                        },
                        "unit": {
                            "code": "YEAR",
                            "name": "Years"
                        }
                    },
                    {
                        "originId": "9dab7d54-de3a-4dbe-b15f-0546f9a0030b",
                        "name": "Final Assembly Location",
                        "code": "ASSEMBLYLOCATION",
                        "value": {
                            "content": "Italy"
                        }
                    },
                    {
                        "originId": "df5705ac-7010-410f-a7be-8a1f9e123efa",
                        "name": "Status",
                        "code": "DECLARE_STATUS",
                        "value": {
                            "code": "Declared",
                            "content": "Declared"
                        }
                    }
                ]
            }
        ]
    },
    "connectRequest": {
        "locale": "en",
        "pageNumber": "1",
        "pageSize": "100",
        "searchCriteria": [
            {
                "name": "ORIGINID",
                "value": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa"
            }
        ]
    }
}

📝 Note 1 All features have been created correctly, and each one has an originId. This originId can be use to update or remove the feature.

📝 Note 2 The other fields have been created correctly.

Sample DeclarationsSearch Request in French

{
    "locale": "fr",
    "pageNumber": "1",
    "pageSize": "100",
    "searchCriteria": [
        {
            "name": "ORIGINID",
            "value": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa"
        }
    ]
}

Sample DeclarationsSearch Response in French after creation

{
    "status": {
        "state": "SUCCESS",
    },
    "result": {
        "entityType": "DECLARATION",
        "searchInfo": {
            "numberOfElements": "1",
            "numberOfPages": "1"
        },
        "data": [
            {
                "locale": "fr",
                "originId": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa",
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "declarationNumber": "c-d-ml-01",
                "url": "http://connect.tld/c-d-ml-01",
                "reportingBody": {
                    "selfReported": "true"
                },
                "standard": {
                    "name": "Declare℠",
                    "code": "Declare™",
                    "isCustom": "false"
                },
                "featuresCustoms": [
                    {
                        "originId": "30377e52-5c7c-4b33-8ae9-dbac743cd812",
                        "name": "Mineral density",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Diamond"
                        }
                    },
                    {
                        "originId": "1741ce18-7c87-46d6-b0c6-2ec5e452d302",
                        "name": "A",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "X"
                        }
                    },
                    {
                        "originId": "0e869881-e588-4771-813f-35a23c10298e",
                        "name": "A",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Y"
                        }
                    }
                ],
                "featuresProperties": [
                    {
                        "originId": "ca5951fa-8eac-4d9d-982e-03b0a5172a09",
                        "name": "Durée de vie",
                        "code": "LIFEEXPECTANCY",
                        "value": {
                            "content": "25"
                        },
                        "unit": {
                            "code": "YEAR",
                            "name": "Années"
                        }
                    },
                    {
                        "originId": "9dab7d54-de3a-4dbe-b15f-0546f9a0030b",
                        "name": "Lieu final d'assemblage",
                        "code": "ASSEMBLYLOCATION",
                        "value": {
                            "content": "Italy"
                        }
                    },
                    {
                        "originId": "df5705ac-7010-410f-a7be-8a1f9e123efa",
                        "name": "Statut",
                        "code": "DECLARE_STATUS",
                        "value": {
                            "code": "Declared",
                            "content": "Declared"
                        }
                    }
                ]
            }
        ]
    },
    "connectRequest": {
        "locale": "fr",
        "pageNumber": "1",
        "pageSize": "100",
        "searchCriteria": [
            {
                "name": "ORIGINID",
                "value": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa"
            }
        ]
    }
}

📝 Note 1 On custom features, the translatable feature names fall back on the English translation.

📝 Note 2 On custom features, the translatable feature values fall back on the English translation.

📝 Note 3 On property features, the translatable feature values fall back on the English translation.

📝 Note 4 On property features, the not translatable feature names, values* and units** are displayed in French.

⚠️ Note 5 The other values are displayed as is.

📝 Note 6 The standard.name is displayed in French (in this case, the French translation is the same as the English translation).

*If they are related to possibleValues 💡 See the possibleValues in PropertyDetailsLookup

**If they are related to possibleUnits 💡 See the possibleUnits in PropertyDetailsLookup

Step 3 Update in English

Which actions will be performed

  • Update the declaration in English
    • Locale : en (⚠️ It's highly recommanded that you update your entity in English first ("locale": "en"). The majority of users use this language and it's used as fallback language.)
    • External id : Connect_Declaration_Multilingual_01_External_Id (No change)
    • Add custom features
      • Custom Text Attribute (code CUSTOM_TEXT_ATTRIBUTE) named Rock Category with value Metamorphic
    • Update custom features
      • Update the feature Mineral density with value Diamond to Mineral density_UPDATED with value Diamond_UPDATED (The name and the value will be updated only in English)
      • Update the feature A with value X to A_UPDATED with value X_UPDATED (The name and the value will be updated only in English)
    • Add property features
      • End of Life (code ENDOFLIFE) with value 100 % recyclable
      • CDPH Standard Method v1.1 Compliant (code CDPH_STDCOMPLIANT_V11) with value Yes (code YES)
    • Update property features
      • Update the feature Life Expectancy with value 25 and the unit years (code YEAR) to Life Expectancy with value 24 and the unit months (code MONTH) (The value and the unit will be updated on all language)
      • Update the feature Final Assembly Location with value Italy to Final Assembly Location with value Italy_UPDATED (The value will be updated only in English)
      • Update the feature Status with value Declared (code Declared) to Status with value LBC Compliant (code LBC Compliant) (The value will be updated on all language)

📝 Note 1 All custom feature names are translatable.

⚠️ Note 2 Now, only the property feature with the code ASSEMBLYLOCATION, the property feature with the code ENDOFLIFE, and the custom features with the code CUSTOM_TEXT_ATTRIBUTE. For the other features, if an update is done in one language, the update will be applied on all languages.

💡 Note 3 See the isTranslatable flag in PropertyDetailsLookup to know the features that can be translated.

Request URI

/connect/v2/declarations/update

Sample DeclarationsUpdate Request

{
    "declarations": [
        {
            "locale": "en",
            "externalId": "Connect_Declaration_Multilingual_01_External_Id",
            "featuresCustoms": [
                {
                    "collectionBehavior": "ADD",
                    "originId": "30377e52-5c7c-4b33-8ae9-dbac743cd812",
                    "name": "Mineral density_UPDATED",
                    "code": "CUSTOM_TEXT_ATTRIBUTE",
                    "value": {
                        "content": "Diamond_UPDATED"
                    }
                },
                {
                    "collectionBehavior": "ADD",
                    "name": "Rock Category",
                    "code": "CUSTOM_TEXT_ATTRIBUTE",
                    "value": {
                        "content": "Metamorphic"
                    }
                },
                {
                    "collectionBehavior": "ADD",
                    "originId": "1741ce18-7c87-46d6-b0c6-2ec5e452d302",
                    "name": "A_UPDATED",
                    "code": "CUSTOM_TEXT_ATTRIBUTE",
                    "value": {
                        "content": "X_UPDATED"
                    }
                }
            ],
            "featuresProperties": [
                {
                    "collectionBehavior": "ADD",
                    "originId": "ca5951fa-8eac-4d9d-982e-03b0a5172a09",
                    "code": "LIFEEXPECTANCY",
                    "value": {
                        "content": "24"
                    },
                    "unit": {
                        "code": "MONTH"
                    }
                },
                {
                    "collectionBehavior": "ADD",
                    "originId": "9dab7d54-de3a-4dbe-b15f-0546f9a0030b",
                    "code": "ASSEMBLYLOCATION",
                    "value": {
                        "content": "Italy_UPDATED"
                    }
                },
                {
                    "collectionBehavior": "ADD",
                    "code": "ENDOFLIFE",
                    "value": {
                        "content": "100 % recyclable"
                    }
                },
                {
                    "collectionBehavior": "ADD",
                    "originId": "df5705ac-7010-410f-a7be-8a1f9e123efa",
                    "code": "DECLARE_STATUS",
                    "value": {
                        "code": "LBC Compliant"
                    }
                },
                {
                    "collectionBehavior": "ADD",
                    "code": "CDPH_STDCOMPLIANT_V11",
                    "value": {
                        "code": "YES"
                    }
                }
            ]
        }
    ]
}

Sample DeclarationsUpdate Response

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "DECLARATION",
        "result": "Update completed."
    },
    "connectRequest": {
        "declarations": [
            {
                "locale": "en",
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "featuresCustoms": [
                    {
                        "collectionBehavior": "ADD",
                        "originId": "30377e52-5c7c-4b33-8ae9-dbac743cd812",
                        "name": "Mineral density_UPDATED",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Diamond_UPDATED"
                        }
                    },
                    {
                        "collectionBehavior": "ADD",
                        "name": "Rock Category",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Metamorphic"
                        }
                    },
                    {
                        "collectionBehavior": "ADD",
                        "originId": "1741ce18-7c87-46d6-b0c6-2ec5e452d302",
                        "name": "A_UPDATED",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "X_UPDATED"
                        }
                    }
                ],
                "featuresProperties": [
                    {
                        "collectionBehavior": "ADD",
                        "originId": "ca5951fa-8eac-4d9d-982e-03b0a5172a09",
                        "code": "LIFEEXPECTANCY",
                        "value": {
                            "content": "24"
                        },
                        "unit": {
                            "code": "MONTH"
                        }
                    },
                    {
                        "collectionBehavior": "ADD",
                        "originId": "9dab7d54-de3a-4dbe-b15f-0546f9a0030b",
                        "code": "ASSEMBLYLOCATION",
                        "value": {
                            "content": "Italy_UPDATED"
                        }
                    },
                    {
                        "collectionBehavior": "ADD",
                        "code": "ENDOFLIFE",
                        "value": {
                            "content": "100 % recyclable"
                        }
                    },
                    {
                        "collectionBehavior": "ADD",
                        "originId": "df5705ac-7010-410f-a7be-8a1f9e123efa",
                        "code": "DECLARE_STATUS",
                        "value": {
                            "code": "LBC Compliant"
                        }
                    },
                    {
                        "collectionBehavior": "ADD",
                        "code": "CDPH_STDCOMPLIANT_V11",
                        "value": {
                            "code": "YES"
                        }
                    }
                ]
            }
        ]
    }
}

Step 4 Update in English Validation (Optional)

Which actions will be performed

  • Validate the English updates in English
  • Validate the English updates in French

Request URI

/connect/v2/declarations/search

See Step 2 Sample DeclarationsSearch Request in English for the DeclarationsSearch Request.

Sample DeclarationsSearch Response in English after update in English

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "DECLARATION",
        "searchInfo": {
            "numberOfElements": "1",
            "numberOfPages": "1"
        },
        "data": [
            {
                "locale": "en",
                "originId": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa",
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "declarationNumber": "c-d-ml-01",
                "url": "http://connect.tld/c-d-ml-01",
                "reportingBody": {
                    "selfReported": "true"
                },
                "standard": {
                    "name": "Declare℠",
                    "code": "Declare™",
                    "isCustom": "false"
                },
                "featuresCustoms": [
                    {
                        "originId": "30377e52-5c7c-4b33-8ae9-dbac743cd812",
                        "name": "Mineral density_UPDATED",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Diamond_UPDATED"
                        }
                    },
                    {
                        "originId": "1741ce18-7c87-46d6-b0c6-2ec5e452d302",
                        "name": "A_UPDATED",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "X_UPDATED"
                        }
                    },
                    {
                        "originId": "0e869881-e588-4771-813f-35a23c10298e",
                        "name": "A",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Y"
                        }
                    },
                    {
                        "originId": "d9f0db71-24eb-4022-9c49-c4f2a1de1d30",
                        "name": "Rock Category",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Metamorphic"
                        }
                    }
                ],
                "featuresProperties": [
                    {
                        "originId": "ca5951fa-8eac-4d9d-982e-03b0a5172a09",
                        "name": "Life Expectancy",
                        "code": "LIFEEXPECTANCY",
                        "value": {
                            "content": "24"
                        },
                        "unit": {
                            "code": "MONTH",
                            "name": "Months"
                        }
                    },
                    {
                        "originId": "9dab7d54-de3a-4dbe-b15f-0546f9a0030b",
                        "name": "Final Assembly Location",
                        "code": "ASSEMBLYLOCATION",
                        "value": {
                            "content": "Italy_UPDATED"
                        }
                    },
                    {
                        "originId": "df5705ac-7010-410f-a7be-8a1f9e123efa",
                        "name": "Status",
                        "code": "DECLARE_STATUS",
                        "value": {
                            "code": "LBC Compliant",
                            "content": "LBC Compliant"
                        }
                    },
                    {
                        "originId": "2a17f925-2fcd-4b6f-bb3e-a941af8109b9",
                        "name": "End of Life",
                        "code": "ENDOFLIFE",
                        "value": {
                            "content": "100 % recyclable"
                        }
                    },
                    {
                        "originId": "ecd035a5-eaa8-4c3a-9685-bf67c81da72d",
                        "name": "CDPH Standard Method v1.1 Compliant",
                        "code": "CDPH_STDCOMPLIANT_V11",
                        "value": {
                            "code": "YES",
                            "content": "Yes"
                        }
                    }
                ]
            }
        ]
    },
    "connectRequest": {
        "locale": "en",
        "pageNumber": "1",
        "pageSize": "100",
        "searchCriteria": [
            {
                "name": "ORIGINID",
                "value": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa"
            }
        ]
    }
}

📝 Note 1 All features have been created correctly, and each one has an originId. This originId can be use to update or remove the feature.

📝 Note 2 On custom features, the English translations, for the translatable feature names, have been updated correctly.

📝 Note 3 On custom features, the English translations, for the translatable feature values, have been updated correctly.

📝 Note 4 On property features, the English translations, for the translatable feature values, have been updated correctly.

📝 Note 5 On property features, the not translatable feature names, values* and units** are displayed in English.

⚠️ Note 6 The other values have been updated correctly and their updates will be applied on all languages.

*If they are related to possibleValues 💡 See the possibleValues in PropertyDetailsLookup

**If they are related to possibleUnits 💡 See the possibleUnits in PropertyDetailsLookup


See Step 2 Sample DeclarationsSearch Request in French for the DeclarationsSearch Request.

Sample DeclarationsSearch Response in French after update in English

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "DECLARATION",
        "searchInfo": {
            "numberOfElements": "1",
            "numberOfPages": "1"
        },
        "data": [
            {
                "locale": "fr",
                "originId": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa",
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "declarationNumber": "c-d-ml-01",
                "url": "http://connect.tld/c-d-ml-01",
                "reportingBody": {
                    "selfReported": "true"
                },
                "standard": {
                    "name": "Declare℠",
                    "code": "Declare™",
                    "isCustom": "false"
                },
                "featuresCustoms": [
                    {
                        "originId": "30377e52-5c7c-4b33-8ae9-dbac743cd812",
                        "name": "Mineral density_UPDATED",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Diamond_UPDATED"
                        }
                    },
                    {
                        "originId": "1741ce18-7c87-46d6-b0c6-2ec5e452d302",
                        "name": "A_UPDATED",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "X_UPDATED"
                        }
                    },
                    {
                        "originId": "0e869881-e588-4771-813f-35a23c10298e",
                        "name": "A",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Y"
                        }
                    },
                    {
                        "originId": "d9f0db71-24eb-4022-9c49-c4f2a1de1d30",
                        "name": "Rock Category",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Metamorphic"
                        }
                    }
                ],
                "featuresProperties": [
                    {
                        "originId": "ca5951fa-8eac-4d9d-982e-03b0a5172a09",
                        "name": "Durée de vie",
                        "code": "LIFEEXPECTANCY",
                        "value": {
                            "content": "24"
                        },
                        "unit": {
                            "code": "MONTH",
                            "name": "Mois"
                        }
                    },
                    {
                        "originId": "9dab7d54-de3a-4dbe-b15f-0546f9a0030b",
                        "name": "Lieu final d'assemblage",
                        "code": "ASSEMBLYLOCATION",
                        "value": {
                            "content": "Italy_UPDATED"
                        }
                    },
                    {
                        "originId": "df5705ac-7010-410f-a7be-8a1f9e123efa",
                        "name": "Statut",
                        "code": "DECLARE_STATUS",
                        "value": {
                            "code": "LBC Compliant",
                            "content": "LBC Compliant"
                        }
                    },
                    {
                        "originId": "2a17f925-2fcd-4b6f-bb3e-a941af8109b9",
                        "name": "Fin de vie",
                        "code": "ENDOFLIFE",
                        "value": {
                            "content": "100 % recyclable"
                        }
                    },
                    {
                        "originId": "ecd035a5-eaa8-4c3a-9685-bf67c81da72d",
                        "name": "Conformité à CDPH Standard Method v1.1",
                        "code": "CDPH_STDCOMPLIANT_V11",
                        "value": {
                            "code": "YES",
                            "content": "Oui"
                        }
                    }
                ]
            }
        ]
    },
    "connectRequest": {
        "locale": "fr",
        "pageNumber": "1",
        "pageSize": "100",
        "searchCriteria": [
            {
                "name": "ORIGINID",
                "value": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa"
            }
        ]
    }
}

📝 Note 1 On custom features, the translatable feature names fall back on the English translation.

📝 Note 2 On custom features, the translatable feature values fall back on the English translation.

📝 Note 3 On property features, the translatable feature values fall back on the English translation.

📝 Note 4 On property features, the not translatable feature names, values* and units** are displayed in French.

⚠️ Note 5 The other values are displayed as is.

*If they are related to possibleValues 💡 See the possibleValues in PropertyDetailsLookup

**If they are related to possibleUnits 💡 See the possibleUnits in PropertyDetailsLookup

Step 5 Update in French

Which actions will be performed

  • Update the declaration in French
    • Locale : fr
    • External id : Connect_Declaration_Multilingual_01_External_Id (No change)
    • Update custom features
      • Update the feature Mineral density_UPDATED with value Diamond_UPDATED to Densité minérale with value Diamant (The name and the value will be updated only in French)
      • Update the feature A_UPDATED with value X_UPDATED to A_MIS_À_JOUR with value X_MIS_À_JOUR (The name and the value will be updated only in French)
    • Update property features
      • Update the feature Life Expectancy with value 24 and the unit months (code MONTH) to Life Expectancy with value 2 and the unit years (code YEAR) (The value and the unit will be updated on all language)
      • Update the feature Final Assembly Location with value Italy_UPDATED to Final Assembly Location with value Italie_MIS_À_JOUR (The value will be updated only in French)
      • Update the feature Status with value LBC Compliant (code LBC Compliant) to Status with value Red List Free (code Red List Free) (The value will be updated on all language)

Request URI

/connect/v2/declarations/update

Sample DeclarationsUpdate Request

{
    "declarations": [
        {
            "locale": "fr",
            "externalId": "Connect_Declaration_Multilingual_01_External_Id",
            "featuresCustoms": [
                {
                    "collectionBehavior": "ADD",
                    "originId": "30377e52-5c7c-4b33-8ae9-dbac743cd812",
                    "name": "Densité minérale",
                    "code": "CUSTOM_TEXT_ATTRIBUTE",
                    "value": {
                        "content": "Diamant"
                    }
                },
                {
                    "collectionBehavior": "ADD",
                    "originId": "1741ce18-7c87-46d6-b0c6-2ec5e452d302",
                    "name": "A_MIS_À_JOUR",
                    "code": "CUSTOM_TEXT_ATTRIBUTE",
                    "value": {
                        "content": "X_MIS_À_JOUR"
                    }
                }
            ],
            "featuresProperties": [
                {
                    "collectionBehavior": "ADD",
                    "originId": "ca5951fa-8eac-4d9d-982e-03b0a5172a09",
                    "code": "LIFEEXPECTANCY",
                    "value": {
                        "content": "2"
                    },
                    "unit": {
                        "code": "YEAR"
                    }
                },
                {
                    "collectionBehavior": "ADD",
                    "originId": "9dab7d54-de3a-4dbe-b15f-0546f9a0030b",
                    "code": "ASSEMBLYLOCATION",
                    "value": {
                        "content": "Italie_MIS_À_JOUR"
                    }
                },
                {
                    "collectionBehavior": "ADD",
                    "originId": "df5705ac-7010-410f-a7be-8a1f9e123efa",
                    "code": "DECLARE_STATUS",
                    "value": {
                        "code": "Red List Free"
                    }
                }
            ]
        }
    ]
}

Sample DeclarationsUpdate Response

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "DECLARATION",
        "result": "Update completed."
    },
    "connectRequest": {
        "declarations": [
            {
                "locale": "fr",
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "featuresCustoms": [
                    {
                        "collectionBehavior": "ADD",
                        "originId": "30377e52-5c7c-4b33-8ae9-dbac743cd812",
                        "name": "Densité minérale",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Diamant"
                        }
                    },
                    {
                        "collectionBehavior": "ADD",
                        "originId": "1741ce18-7c87-46d6-b0c6-2ec5e452d302",
                        "name": "A_MIS_À_JOUR",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "X_MIS_À_JOUR"
                        }
                    }
                ],
                "featuresProperties": [
                    {
                        "collectionBehavior": "ADD",
                        "originId": "ca5951fa-8eac-4d9d-982e-03b0a5172a09",
                        "code": "LIFEEXPECTANCY",
                        "value": {
                            "content": "2"
                        },
                        "unit": {
                            "code": "YEAR"
                        }
                    },
                    {
                        "collectionBehavior": "ADD",
                        "originId": "9dab7d54-de3a-4dbe-b15f-0546f9a0030b",
                        "code": "ASSEMBLYLOCATION",
                        "value": {
                            "content": "Italie_MIS_À_JOUR"
                        }
                    },
                    {
                        "collectionBehavior": "ADD",
                        "originId": "df5705ac-7010-410f-a7be-8a1f9e123efa",
                        "code": "DECLARE_STATUS",
                        "value": {
                            "code": "Red List Free"
                        }
                    }
                ]
            }
        ]
    }
}

Step 6 Update in French Validation (Optional)

Which actions will be performed

  • Validate the French updates in English
  • Validate the French updates in French

Request URI

/connect/v2/declarations/search

See Step 2 Sample DeclarationsSearch Request in English for the DeclarationsSearch Request.

Sample DeclarationsSearch Response in English after update in French

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "DECLARATION",
        "searchInfo": {
            "numberOfElements": "1",
            "numberOfPages": "1"
        },
        "data": [
            {
                "locale": "en",
                "originId": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa",
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "declarationNumber": "c-d-ml-01",
                "url": "http://connect.tld/c-d-ml-01",
                "reportingBody": {
                    "selfReported": "true"
                },
                "standard": {
                    "name": "Declare℠",
                    "code": "Declare™",
                    "isCustom": "false"
                },
                "featuresCustoms": [
                    {
                        "originId": "30377e52-5c7c-4b33-8ae9-dbac743cd812",
                        "name": "Mineral density_UPDATED",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Diamond_UPDATED"
                        }
                    },
                    {
                        "originId": "1741ce18-7c87-46d6-b0c6-2ec5e452d302",
                        "name": "A_UPDATED",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "X_UPDATED"
                        }
                    },
                    {
                        "originId": "0e869881-e588-4771-813f-35a23c10298e",
                        "name": "A",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Y"
                        }
                    },
                    {
                        "originId": "d9f0db71-24eb-4022-9c49-c4f2a1de1d30",
                        "name": "Rock Category",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Metamorphic"
                        }
                    }
                ],
                "featuresProperties": [
                    {
                        "originId": "ca5951fa-8eac-4d9d-982e-03b0a5172a09",
                        "name": "Life Expectancy",
                        "code": "LIFEEXPECTANCY",
                        "value": {
                            "content": "2"
                        },
                        "unit": {
                            "code": "YEAR",
                            "name": "Years"
                        }
                    },
                    {
                        "originId": "9dab7d54-de3a-4dbe-b15f-0546f9a0030b",
                        "name": "Final Assembly Location",
                        "code": "ASSEMBLYLOCATION",
                        "value": {
                            "content": "Italy_UPDATED"
                        }
                    },
                    {
                        "originId": "df5705ac-7010-410f-a7be-8a1f9e123efa",
                        "name": "Status",
                        "code": "DECLARE_STATUS",
                        "value": {
                            "code": "Red List Free",
                            "content": "Red List Free"
                        }
                    },
                    {
                        "originId": "2a17f925-2fcd-4b6f-bb3e-a941af8109b9",
                        "name": "End of Life",
                        "code": "ENDOFLIFE",
                        "value": {
                            "content": "100 % recyclable"
                        }
                    },
                    {
                        "originId": "ecd035a5-eaa8-4c3a-9685-bf67c81da72d",
                        "name": "CDPH Standard Method v1.1 Compliant",
                        "code": "CDPH_STDCOMPLIANT_V11",
                        "value": {
                            "code": "YES",
                            "content": "Yes"
                        }
                    }
                ]
            }
        ]
    },
    "connectRequest": {
        "locale": "en",
        "pageNumber": "1",
        "pageSize": "100",
        "searchCriteria": [
            {
                "name": "ORIGINID",
                "value": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa"
            }
        ]
    }
}

📝 Note 1 The feature name Mineral density_UPDATED and the feature value Diamond_UPDATED are not updated here, because the update is applied only on the French translations.

📝 Note 2 The feature name A_UPDATED and the feature value X_UPDATED are not updated here, because the update is applied only on the French translations.

⚠️ Note 3 The Life Expectancy value and unit are updated.

📝 Note 4 The Final Assembly Location value Italy_UPDATED is not updated here, because the update is applied only on the French translation.

⚠️ Note 5 The Status value is updated.


See Step 2 Sample DeclarationsSearch Request in French for the DeclarationsSearch Request.

Sample DeclarationsSearch Response in French after update in French

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "DECLARATION",
        "searchInfo": {
            "numberOfElements": "1",
            "numberOfPages": "1"
        },
        "data": [
            {
                "locale": "fr",
                "originId": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa",
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "declarationNumber": "c-d-ml-01",
                "url": "http://connect.tld/c-d-ml-01",
                "reportingBody": {
                    "selfReported": "true"
                },
                "standard": {
                    "name": "Declare℠",
                    "code": "Declare™",
                    "isCustom": "false"
                },
                "featuresCustoms": [
                    {
                        "originId": "30377e52-5c7c-4b33-8ae9-dbac743cd812",
                        "name": "Densité minérale",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Diamant"
                        }
                    },
                    {
                        "originId": "1741ce18-7c87-46d6-b0c6-2ec5e452d302",
                        "name": "A_MIS_À_JOUR",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "X_MIS_À_JOUR"
                        }
                    },
                    {
                        "originId": "0e869881-e588-4771-813f-35a23c10298e",
                        "name": "A",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Y"
                        }
                    },
                    {
                        "originId": "d9f0db71-24eb-4022-9c49-c4f2a1de1d30",
                        "name": "Rock Category",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Metamorphic"
                        }
                    }
                ],
                "featuresProperties": [
                    {
                        "originId": "ca5951fa-8eac-4d9d-982e-03b0a5172a09",
                        "name": "Durée de vie",
                        "code": "LIFEEXPECTANCY",
                        "value": {
                            "content": "2"
                        },
                        "unit": {
                            "code": "YEAR",
                            "name": "Années"
                        }
                    },
                    {
                        "originId": "9dab7d54-de3a-4dbe-b15f-0546f9a0030b",
                        "name": "Lieu final d'assemblage",
                        "code": "ASSEMBLYLOCATION",
                        "value": {
                            "content": "Italie_MIS_À_JOUR"
                        }
                    },
                    {
                        "originId": "df5705ac-7010-410f-a7be-8a1f9e123efa",
                        "name": "Statut",
                        "code": "DECLARE_STATUS",
                        "value": {
                            "code": "Red List Free",
                            "content": "Red List Free"
                        }
                    },
                    {
                        "originId": "2a17f925-2fcd-4b6f-bb3e-a941af8109b9",
                        "name": "Fin de vie",
                        "code": "ENDOFLIFE",
                        "value": {
                            "content": "100 % recyclable"
                        }
                    },
                    {
                        "originId": "ecd035a5-eaa8-4c3a-9685-bf67c81da72d",
                        "name": "Conformité à CDPH Standard Method v1.1",
                        "code": "CDPH_STDCOMPLIANT_V11",
                        "value": {
                            "code": "YES",
                            "content": "Oui"
                        }
                    }
                ]
            }
        ]
    },
    "connectRequest": {
        "locale": "fr",
        "pageNumber": "1",
        "pageSize": "100",
        "searchCriteria": [
            {
                "name": "ORIGINID",
                "value": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa"
            }
        ]
    }
}

📝 Note 1 The feature name Densité minérale and the feature value Diamant are updated here, because the update is applied only on the French translations.

📝 Note 2 The feature name A_MIS_À_JOUR and the feature value X_MIS_À_JOUR are updated here, because the update is applied only on the French translations.

📝 Note 3 The Life Expectancy value and unit are updated.

📝 Note 4 The Final Assembly Location value Italie_MIS_À_JOUR is updated here, because the update is applied only on the French translation.

📝 Note 5 The Status value is updated.

Step 7 Update (remove features) in English

Which actions will be performed

  • Update the declaration in English
    • Locale : en (⚠️ It's highly recommanded that you update your entity in English first ("locale": "en"). The majority of users use this language and it's used as fallback language.)
    • External id : Connect_Declaration_Multilingual_01_External_Id (No change)
    • Remove custom features
      • Custom Text Attribute (code CUSTOM_TEXT_ATTRIBUTE) named Rock Category with value Metamorphic
      • Custom Text Attribute (code CUSTOM_TEXT_ATTRIBUTE) named A with value Y
    • Remove property features
      • End of Life (code ENDOFLIFE) with value 100 % recyclable
      • CDPH Standard Method v1.1 Compliant (code CDPH_STDCOMPLIANT_V11) with value Yes (code YES)

Request URI

/connect/v2/declarations/update

Sample DeclarationsUpdate Request

{
    "declarations": [
        {
            "locale": "en",
            "externalId": "Connect_Declaration_Multilingual_01_External_Id",
            "featuresCustoms": [
                {
                    "collectionBehavior": "REMOVE",
                    "originId": "d9f0db71-24eb-4022-9c49-c4f2a1de1d30",
                    "name": "Rock Category",
                    "code": "CUSTOM_TEXT_ATTRIBUTE",
                    "value": {
                        "content": "Metamorphic"
                    }
                },
                {
                    "collectionBehavior": "REMOVE",
                    "originId": "0e869881-e588-4771-813f-35a23c10298e",
                    "name": "A",
                    "code": "CUSTOM_TEXT_ATTRIBUTE",
                    "value": {
                        "content": "Y"
                    }
                }
            ],
            "featuresProperties": [
                {
                    "collectionBehavior": "REMOVE",
                    "originId": "2a17f925-2fcd-4b6f-bb3e-a941af8109b9",
                    "code": "ENDOFLIFE",
                    "value": {
                        "content": "100 % recyclable"
                    }
                },
                {
                    "collectionBehavior": "REMOVE",
                    "originId": "ecd035a5-eaa8-4c3a-9685-bf67c81da72d",
                    "code": "CDPH_STDCOMPLIANT_V11",
                    "value": {
                        "code": "YES"
                    }
                }
            ]
        }
    ]
}

Sample DeclarationsUpdate Response

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "DECLARATION",
        "result": "Update completed."
    },
    "connectRequest": {
        "declarations": [
            {
                "locale": "en",
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "featuresCustoms": [
                    {
                        "collectionBehavior": "REMOVE",
                        "originId": "d9f0db71-24eb-4022-9c49-c4f2a1de1d30",
                        "name": "Rock Category",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Metamorphic"
                        }
                    },
                    {
                        "collectionBehavior": "REMOVE",
                        "originId": "0e869881-e588-4771-813f-35a23c10298e",
                        "name": "A",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Y"
                        }
                    }
                ],
                "featuresProperties": [
                    {
                        "collectionBehavior": "REMOVE",
                        "originId": "2a17f925-2fcd-4b6f-bb3e-a941af8109b9",
                        "code": "ENDOFLIFE",
                        "value": {
                            "content": "100 % recyclable"
                        }
                    },
                    {
                        "collectionBehavior": "REMOVE",
                        "originId": "ecd035a5-eaa8-4c3a-9685-bf67c81da72d",
                        "code": "CDPH_STDCOMPLIANT_V11",
                        "value": {
                            "code": "YES"
                        }
                    }
                ]
            }
        ]
    }
}

Step 8 Update (remove features) in English Validation (Optional)

Which actions will be performed

  • Validate the English updates in English
  • Validate the English updates in French

Request URI

/connect/v2/declarations/search

See Step 2 Sample DeclarationsSearch Request in English for the DeclarationsSearch Request.

Sample DeclarationsSearch Response in English after update (remove features) in English

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "DECLARATION",
        "searchInfo": {
            "numberOfElements": "1",
            "numberOfPages": "1"
        },
        "data": [
            {
                "locale": "en",
                "originId": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa",
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "declarationNumber": "c-d-ml-01",
                "url": "http://connect.tld/c-d-ml-01",
                "reportingBody": {
                    "selfReported": "true"
                },
                "standard": {
                    "name": "Declare℠",
                    "code": "Declare™",
                    "isCustom": "false"
                },
                "featuresCustoms": [
                    {
                        "originId": "30377e52-5c7c-4b33-8ae9-dbac743cd812",
                        "name": "Mineral density_UPDATED",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Diamond_UPDATED"
                        }
                    },
                    {
                        "originId": "1741ce18-7c87-46d6-b0c6-2ec5e452d302",
                        "name": "A_UPDATED",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "X_UPDATED"
                        }
                    }
                ],
                "featuresProperties": [
                    {
                        "originId": "ca5951fa-8eac-4d9d-982e-03b0a5172a09",
                        "name": "Life Expectancy",
                        "code": "LIFEEXPECTANCY",
                        "value": {
                            "content": "2"
                        },
                        "unit": {
                            "code": "YEAR",
                            "name": "Years"
                        }
                    },
                    {
                        "originId": "9dab7d54-de3a-4dbe-b15f-0546f9a0030b",
                        "name": "Final Assembly Location",
                        "code": "ASSEMBLYLOCATION",
                        "value": {
                            "content": "Italy_UPDATED"
                        }
                    },
                    {
                        "originId": "df5705ac-7010-410f-a7be-8a1f9e123efa",
                        "name": "Status",
                        "code": "DECLARE_STATUS",
                        "value": {
                            "code": "Red List Free",
                            "content": "Red List Free"
                        }
                    }
                ]
            }
        ]
    },
    "connectRequest": {
        "locale": "en",
        "pageNumber": "1",
        "pageSize": "100",
        "searchCriteria": [
            {
                "name": "ORIGINID",
                "value": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa"
            }
        ]
    }
}

📝 Note All features with the collectionBehavior set to REMOVE have been removed.


See Step 2 Sample DeclarationsSearch Request in French for the DeclarationsSearch Request.

Sample DeclarationsSearch Response in French after update (remove features) in English

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "DECLARATION",
        "searchInfo": {
            "numberOfElements": "1",
            "numberOfPages": "1"
        },
        "data": [
            {
                "locale": "fr",
                "originId": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa",
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "declarationNumber": "c-d-ml-01",
                "url": "http://connect.tld/c-d-ml-01",
                "reportingBody": {
                    "selfReported": "true"
                },
                "standard": {
                    "name": "Declare℠",
                    "code": "Declare™",
                    "isCustom": "false"
                },
                "featuresCustoms": [
                    {
                        "originId": "30377e52-5c7c-4b33-8ae9-dbac743cd812",
                        "name": "Densité minérale",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Diamant"
                        }
                    },
                    {
                        "originId": "1741ce18-7c87-46d6-b0c6-2ec5e452d302",
                        "name": "A_MIS_À_JOUR",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "X_MIS_À_JOUR"
                        }
                    }
                ],
                "featuresProperties": [
                    {
                        "originId": "ca5951fa-8eac-4d9d-982e-03b0a5172a09",
                        "name": "Durée de vie",
                        "code": "LIFEEXPECTANCY",
                        "value": {
                            "content": "2"
                        },
                        "unit": {
                            "code": "YEAR",
                            "name": "Années"
                        }
                    },
                    {
                        "originId": "9dab7d54-de3a-4dbe-b15f-0546f9a0030b",
                        "name": "Lieu final d'assemblage",
                        "code": "ASSEMBLYLOCATION",
                        "value": {
                            "content": "Italie_MIS_À_JOUR"
                        }
                    },
                    {
                        "originId": "df5705ac-7010-410f-a7be-8a1f9e123efa",
                        "name": "Statut",
                        "code": "DECLARE_STATUS",
                        "value": {
                            "code": "Red List Free",
                            "content": "Red List Free"
                        }
                    }
                ]
            }
        ]
    },
    "connectRequest": {
        "locale": "fr",
        "pageNumber": "1",
        "pageSize": "100",
        "searchCriteria": [
            {
                "name": "ORIGINID",
                "value": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa"
            }
        ]
    }
}

📝 Note All features with the collectionBehavior set to REMOVE have been removed.

Step 9 Update (remove features) in French

Which actions will be performed

  • Update the declaration in French
    • Locale : fr
    • External id : Connect_Declaration_Multilingual_01_External_Id
    • Remove custom features
      • Remove the feature Densité minérale with value Diamant
      • Remove the feature A_MIS_À_JOUR with value X_MIS_À_JOUR
    • Update property features
      • Remove the feature Life Expectancy with value 2 and the unit years (code YEAR)
      • Remove the feature Final Assembly Location with value Italie_MIS_À_JOUR
      • Remove the feature Status with value Red List Free (code Red List Free)

Request URI

/connect/v2/declarations/update

Sample DeclarationsUpdate Request

{
    "declarations": [
        {
            "locale": "fr",
            "externalId": "Connect_Declaration_Multilingual_01_External_Id",
            "featuresCustoms": [
                {
                    "collectionBehavior": "REMOVE",
                    "originId": "30377e52-5c7c-4b33-8ae9-dbac743cd812",
                    "name": "Densité minérale",
                    "code": "CUSTOM_TEXT_ATTRIBUTE",
                    "value": {
                        "content": "Diamant"
                    }
                },
                {
                    "collectionBehavior": "REMOVE",
                    "originId": "1741ce18-7c87-46d6-b0c6-2ec5e452d302",
                    "name": "A_MIS_À_JOUR",
                    "code": "CUSTOM_TEXT_ATTRIBUTE",
                    "value": {
                        "content": "X_MIS_À_JOUR"
                    }
                }
            ],
            "featuresProperties": [
                {
                    "collectionBehavior": "REMOVE",
                    "originId": "ca5951fa-8eac-4d9d-982e-03b0a5172a09",
                    "code": "LIFEEXPECTANCY",
                    "value": {
                        "content": "2"
                    },
                    "unit": {
                        "code": "YEAR"
                    }
                },
                {
                    "collectionBehavior": "REMOVE",
                    "originId": "9dab7d54-de3a-4dbe-b15f-0546f9a0030b",
                    "code": "ASSEMBLYLOCATION",
                    "value": {
                        "content": "Italie_MIS_À_JOUR"
                    }
                },
                {
                    "collectionBehavior": "REMOVE",
                    "originId": "df5705ac-7010-410f-a7be-8a1f9e123efa",
                    "code": "DECLARE_STATUS",
                    "value": {
                        "code": "Red List Free"
                    }
                }
            ]
        }
    ]
}

Sample DeclarationsUpdate Response

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "DECLARATION",
        "result": "Update completed."
    },
    "connectRequest": {
        "declarations": [
            {
                "locale": "fr",
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "featuresCustoms": [
                    {
                        "collectionBehavior": "REMOVE",
                        "originId": "30377e52-5c7c-4b33-8ae9-dbac743cd812",
                        "name": "Densité minérale",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "Diamant"
                        }
                    },
                    {
                        "collectionBehavior": "REMOVE",
                        "originId": "1741ce18-7c87-46d6-b0c6-2ec5e452d302",
                        "name": "A_MIS_À_JOUR",
                        "code": "CUSTOM_TEXT_ATTRIBUTE",
                        "value": {
                            "content": "X_MIS_À_JOUR"
                        }
                    }
                ],
                "featuresProperties": [
                    {
                        "collectionBehavior": "REMOVE",
                        "originId": "ca5951fa-8eac-4d9d-982e-03b0a5172a09",
                        "code": "LIFEEXPECTANCY",
                        "value": {
                            "content": "2"
                        },
                        "unit": {
                            "code": "YEAR"
                        }
                    },
                    {
                        "collectionBehavior": "REMOVE",
                        "originId": "9dab7d54-de3a-4dbe-b15f-0546f9a0030b",
                        "code": "ASSEMBLYLOCATION",
                        "value": {
                            "content": "Italie_MIS_À_JOUR"
                        }
                    },
                    {
                        "collectionBehavior": "REMOVE",
                        "originId": "df5705ac-7010-410f-a7be-8a1f9e123efa",
                        "code": "DECLARE_STATUS",
                        "value": {
                            "code": "Red List Free"
                        }
                    }
                ]
            }
        ]
    }
}

Step 10 Update (remove features) in French Validation (Optional)

Which actions will be performed

  • Validate the French updates in English
  • Validate the French updates in French

Request URI

/connect/v2/declarations/search

See Step 2 Sample DeclarationsSearch Request in English for the DeclarationsSearch Request.

Sample DeclarationsSearch Response in English after update (remove features) in French

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "DECLARATION",
        "searchInfo": {
            "numberOfElements": "1",
            "numberOfPages": "1"
        },
        "data": [
            {
                "locale": "en",
                "originId": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa",
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "declarationNumber": "c-d-ml-01",
                "url": "http://connect.tld/c-d-ml-01",
                "reportingBody": {
                    "selfReported": "true"
                },
                "standard": {
                    "name": "Declare℠",
                    "code": "Declare™",
                    "isCustom": "false"
                }
            }
        ]
    },
    "connectRequest": {
        "locale": "en",
        "pageNumber": "1",
        "pageSize": "100",
        "searchCriteria": [
            {
                "name": "ORIGINID",
                "value": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa"
            }
        ]
    }
}

📝 Note All features with the collectionBehavior set to REMOVE have been removed.


See Step 2 Sample DeclarationsSearch Request in French for the DeclarationsSearch Request.

Sample DeclarationsSearch Response in French after update in (remove features) French

{
    "status": {
        "state": "SUCCESS"
    },
    "result": {
        "entityType": "DECLARATION",
        "searchInfo": {
            "numberOfElements": "1",
            "numberOfPages": "1"
        },
        "data": [
            {
                "locale": "fr",
                "originId": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa",
                "externalId": "Connect_Declaration_Multilingual_01_External_Id",
                "declarationNumber": "c-d-ml-01",
                "url": "http://connect.tld/c-d-ml-01",
                "reportingBody": {
                    "selfReported": "true"
                },
                "standard": {
                    "name": "Declare℠",
                    "code": "Declare™",
                    "isCustom": "false"
                }
            }
        ]
    },
    "connectRequest": {
        "locale": "fr",
        "pageNumber": "1",
        "pageSize": "100",
        "searchCriteria": [
            {
                "name": "ORIGINID",
                "value": "374c4343-62f0-4ac9-b25e-cf0b1ede75aa"
            }
        ]
    }
}

📝 Note All features with the collectionBehavior set to REMOVE have been removed.

results matching ""

    No results matching ""