- URL:
- https://<knowledgegraphserviceadmin-url>/updateFeature
- Methods:
POST- Version Introduced:
- 11.1
Description
A knowledge graph service's update operation allows an administrative client to enable and disable features of the knowledge graph service. The update operation cannot update the capabilities of the knowledge graph service, such as Query or Editing. Only a single feature can be updated per request. The service definition is updated as a result of the update operation.
The update operation can update features for search, provenance, and editor tracking. The search feature is enabled by default when the service definition parameter schema is false and can only be updated when schema is true. Both provenance and editor tracking features can only be updated when schema is false. When enabling provenance or editor tracking features, provenance entity type information and editor tracking information can be provided during their respective update requests.
Request parameters
| Parameter | Details |
|---|---|
| The new service feature. |
| The response format. The default response format is Values: |
Example usage
The following is an sample request URL for a knowledge graph service named Supply :
https://organization.example.com/<context>/rest/admin/services/Hosted/SupplyChain/KnowledgeGraphServer/updateFeature?f=jsonExample 1
The following input example demonstrates how to enable search for a knowledge graph service:
POST /<context>/rest/admin/services/Hosted/SupplyChain/KnowledgeGraphServer/updateFeature
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
updateFeature={"supportsSearch": true}&f=pjsonExample 2
The following input example demonstrates how to enable provenance and optionally creating custom values for Provenance of a knowledge graph service, formatted for readability:
POST /<context>/rest/admin/services/Hosted/SupplyChain/KnowledgeGraphServer/updateFeature
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
updateFeature={
"supportsProvenance": true,
"provenanceEntityTypeInfo": {
"provenanceEntityTypeName": "Custom Provenance",
"provenanceSchema": {
"instanceIDPropertyName": "CustomID",
"sourceTypePropertyName": "CustomsourceTypePropertyName",
"sourceNamePropertyName": "CustomsourceNamePropertyName",
"sourcePropertyName": "CustomsourcePropertyName",
"commentPropertyName": "CusomcommentPropertyName",
"typeNamePropertyName": "CustomtypeNamePropertyName",
"propertyNamePropertyName": "CustompropertyNamePropertyName"
}
}
"provenanceSourceTypeValues": [
{
"value": "Str",
"behavior": "String"
},
{
"value": "website",
"behavior": "URL"
},
{
"value": "Doc",
"behavior": "Document"
}
]
}&f=pjsonExample 3
The following input example demonstrates how to enable editor tracking and optionally creating custom values for editor of a knowledge graph service, formatted for readability:
POST /<context>/rest/admin/services/Hosted/SupplyChain/KnowledgeGraphServer/updateFeature
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
updateFeature={
"supportsEditorTracking": true,
"editorTrackingInfo": {
"editorTrackingSchema": {
"creatorField": "custom_create_user",
"createDateField": "custom_create_date",
"editorField": "custom_last_edit_user",
"editDateField": "custom_last_edit_date",
"creatorFieldAlias": "custom_create_user_alias",
"createDateFieldAlias": "custom_create_date_alias",
"editorFieldAlias": "custom_last_edit_user_alias",
"editDateFieldAlias": "custom_last_edit_date_alias"
}
}
}&f=pjsonExample 4
The following input example demonstrated how to disable the provenance feature for a knowledge graph service.
POST /<context>/rest/admin/services/Hosted/SupplyChain/KnowledgeGraphServer/updateFeature
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
updateFeature={"supportsProvenance": false}&f=pjsonJSON Response syntax
{
"success": <true | false>
}JSON Response example
The following is an example response for all examples shown above:
{
"success": true
}