Unlink Property Definition Collection from a Hub
In this topic, you will learn how to unlink a property definition collection from a hub using the UnlinkPropertyDefinitionCollection
mutation. Unlinking a property definition collection from a hub will prevent users from adding or editing existing properties, but they will still be able to view them. However, only the following fields will be available in the retrieved properties: ID
, name
, and propertyBehavior
. All other field values will be null. You can reconnect (link) the property definition collection back to the hub at any time to add or update existing properties.
Note: Unlinking a collection is only possible if you are an administrator of the hub.
You will use the following query in this topic:
Type | Operation | Description |
---|---|---|
mutation | unlinkPropertyDefinitionCollection | Unlinks a property definition collection from a hub. |
Step 1 - Unlink Property Definition Collection from Hub
The UnlinkPropertyDefinitionCollection mutation helps in unlinking property collection from hubs and returns UnlinkPropertyDefinitionCollectionPayload object.
- In Manufacturing Data Model Explorer, enter the following query in the Query Pane :
Query
mutation UnlinkPropertyDefinitionCollection($propertyDefinitionCollectionId: ID!, $hubId: ID!) { unlinkPropertyDefinitionCollection( input: {propertyDefinitionCollectionId: $propertyDefinitionCollectionId, hubId: $hubId} ) { propertyDefinitionCollectionId hub { id } } }
Show More - In the Query Variables Pane, enter the following query and values:
- propertyDefinitionCollectionId: Enter the value of
propertyDefinitionCollectionId
. To know how to obtainpropertyDefinitionCollectionId
, refer to Create Property Definition Collection topic. - hubId: Enter the value of the
hubId
. To know how to obtain thehubId
, refer to Retrieve Hubs.
Query Variables
{ "propertyDefinitionCollectionId": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5URVNUX0NQX0RPQw", "hubId": "a.YnVzaW5lc3M6YXV0b2Rlc2syMzk4" }
- propertyDefinitionCollectionId: Enter the value of
- Click Play. The response will show the details of the unlinking activity in between the collection and the hub. You should see a similar response as in the following code-block.
Response
{ "data": { "unlinkPropertyDefinitionCollection": { "propertyDefinitionCollectionId": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5URVNUX0NQX0RPQw", "hub": { "id": "a.YnVzaW5lc3M6YXV0b2Rlc2syMzk4" } } } }
Show More
Step 2 - Validate if the Property Definition Collection is Unlinked
To confirm whether a property definition collection has been successfully unlinked, you can fetch the unlinked property collection details by using the hub query. When you unlink a property definition collection from a hub, users can no longer add or edit properties. They can still view them, but only the ID, name, and propertyBehavior
fields will be available. All other field values will be null. To make changes, reconnect the property definition collection to the hub.
- Enter the following query in the Query Pane of the Manufacturing Data Model Explorer.
Query
query GetHub ($hubId: ID!) { hub (hubId: $hubId) { id name ...on Hub { id name propertyDefinitionCollections { results { id name } } } } }
Show More - In the Query Variables Pane, enter the value of the
hubId
. To know how to obtain thehubId
, refer to Retrieve Hubs.Query Variables
{ "hubId": "a.YnVzaW5lc3M6YXV0b2Rlc2syMzk4" }
- Click Play. The response will display null values for the properties that are unlinked from the collection.
Response
{ "data": { "hub": { "id": "a.YnVzaW5lc3M6YXV0b2Rlc2syMzk4", "name": "stg-hds-test-hub", "propertyDefinitionCollections": { "results": [ { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5URVNUX0NQX0RPQw", "name": "TEST_CP_DOC" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5jeG5jMjN4eDQxMQ", "name": "cxnc23xx411" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTY1NTE3Mzc0NTI", "name": "regression_pdc1716551737452" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTY1NTE4Njk1Mjk", "name": "regression_pdc1716551869529" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTY1NTM5MTA4NDU", "name": "regression_pdc1716553910845" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxNTkyNDg1NzQzMA", "name": "prop_def_col_1715924857430" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxNTg2Mjg3OTkzOA", "name": "prop_def_col_1715862879938" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxNTM0NDU5MDQwNw", "name": "prop_def_col_1715344590407" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxNDgzMzA1NzE3OQ", "name": "prop_def_col_1714833057179" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxNTg1MTk3NTMzNA", "name": "prop_def_col_1715851975334" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxNjI5MTE5MzU3NA", "name": "prop_def_col_1716291193574" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxNDgyNzY0MzAwNg", "name": "prop_def_col_1714827643006" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxNDc5OTA4NzI0OQ", "name": "prop_def_col_1714799087249" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfOTc1MQ", "name": "prop_def_col_9751" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxNDc5NzE1MzY2MQ", "name": "prop_def_col_1714797153661" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxNDc5ODgyMDU5MQ", "name": "prop_def_col_1714798820591" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTQ0NDQ", "name": "prop_def_col_14444" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxNTc3OTE5ODY1Mg", "name": "prop_def_col_1715779198652" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxNDc5NzM0MzM5Mw", "name": "prop_def_col_1714797343393" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfODM5NA", "name": "prop_def_col_8394" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTM0NDQwNzcyOTQ", "name": "regression_pdc1713444077294" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTM1MjE3MTc3OTU", "name": "regression_pdc1713521717795" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTMyNzIzNTk5MjY", "name": "regression_pdc1713272359926" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTMyNjkzMTEyNjk", "name": "regression_pdc1713269311269" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTMyNjk1MTM0MTE", "name": "regression_pdc1713269513411" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxNDc5OTI3MjIzNA", "name": "prop_def_col_1714799272234" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTMzNTI5NDI3ODM", "name": "regression_pdc1713352942783" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTMyNjkxNTQxNjI", "name": "regression_pdc1713269154162" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTMyNjg3ODY4Mzg", "name": "regression_pdc1713268786838" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfNzc5NzQ0MTI1NjM0", "name": "prop_def_col_779744125634" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTMxODQ0NzA4NTg", "name": "regression_pdc1713184470858" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTMxODUxODU4MTI", "name": "regression_pdc1713185185812" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTMxODM5MzY2NTM", "name": "regression_pdc1713183936653" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTMxODI3MTYyMDU", "name": "regression_pdc1713182716205" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn50c3RjMjM0", "name": "tstc234" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn50c3RfMjM0", "name": "tst_234" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTMxNzQ1NjY4NTc", "name": "regression_pdc1713174566857" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTMxODMwOTUwMzA", "name": "regression_pdc1713183095030" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTI3MzcwMTcwMDg", "name": "regression_pdc1712737017008" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTI3MzA2NDE1OTA", "name": "regression_pdc1712730641590" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3BkYzE3MTI3MzA0NTYxNTQ", "name": "regression_pdc1712730456154" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3Byb3BkZWZjb2xsMTcxMjI1MDU0NjgyNw", "name": "regression_propdefcoll1712250546827" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3Byb3BkZWZjb2xsMTcxMjIzMjg1MDc4Nw", "name": "regression_propdefcoll1712232850787" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3Byb3BkZWZjb2xsMTcxMjIzMjc3NTg1OQ", "name": "regression_propdefcoll1712232775859" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3Byb3BkZWZjb2xsMTcxMjIzMjY4MTA5Nw", "name": "regression_propdefcoll1712232681097" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3Byb3BkZWZjb2xsMTcxMjIzMjEzMTk5NQ", "name": "regression_propdefcoll1712232131995" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3Byb3BkZWZjb2xsMTcxMjIzMTAzNjAxNw", "name": "regression_propdefcoll1712231036017" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3Byb3BkZWZjb2xsMTcxMjIyNjQwNDQ0Mw", "name": "regression_propdefcoll1712226404443" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3Byb3BkZWZjb2xsMTcxMjIyNjMxNTQ2Mg", "name": "regression_propdefcoll1712226315462" }, { "id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5yZWdyZXNzaW9uX3Byb3BkZWZjb2xsMTcxMjIyNTU1Mjg4Ng", "name": "regression_propdefcoll1712225552886" } ] } } } }
Show More