public final class RelationshipBaseClient extends Object
Modifier and Type | Method and Description |
---|---|
DynamicRequest |
create()
Create a new relationship between entities.
|
DynamicRequest |
delete(String guid)
Delete a relationship between entities by its GUID.
|
DynamicRequest |
get(String guid)
Get relationship information between entities by its GUID.
|
DynamicRequest |
invoke()
Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
|
DynamicRequest |
update()
Update an existing relationship between entities.
|
public DynamicRequest create()
Request Body Schema
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
createTime: Float
createdBy: String
end1: {
guid: String
typeName: String
uniqueAttributes: {
String: Object
}
}
end2: (recursive schema, see end2 above)
guid: String
homeId: String
label: String
provenanceType: Float
status: String(ACTIVE/DELETED)
updateTime: Float
updatedBy: String
version: Float
}
Response Body Schema
(recursive schema, see above)
public DynamicRequest update()
Request Body Schema
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
createTime: Float
createdBy: String
end1: {
guid: String
typeName: String
uniqueAttributes: {
String: Object
}
}
end2: (recursive schema, see end2 above)
guid: String
homeId: String
label: String
provenanceType: Float
status: String(ACTIVE/DELETED)
updateTime: Float
updatedBy: String
version: Float
}
Response Body Schema
(recursive schema, see above)
public DynamicRequest get(String guid)
Optional Query Parameters
Name | Type | Description |
---|---|---|
extendedInfo | Boolean | Limits whether includes extended information. |
Response Body Schema
{
referredEntities: {
String: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
classificationNames: [
String
]
classifications: [
{
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
entityGuid: String
entityStatus: String(ACTIVE/DELETED)
removePropagationsOnEntityDelete: Boolean
validityPeriods: [
{
endTime: String
startTime: String
timeZone: String
}
]
source: String
sourceDetails: {
String: Object
}
}
]
displayText: String
guid: String
meaningNames: [
String
]
meanings: [
{
confidence: Integer
createdBy: String
description: String
displayText: String
expression: String
relationGuid: String
source: String
status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)
steward: String
termGuid: String
}
]
status: String(ACTIVE/DELETED)
}
}
relationship: {
attributes: {
String: Object
}
typeName: String
lastModifiedTS: String
createTime: Float
createdBy: String
end1: {
guid: String
typeName: String
uniqueAttributes: {
String: Object
}
}
end2: (recursive schema, see end2 above)
guid: String
homeId: String
label: String
provenanceType: Float
status: String(ACTIVE/DELETED)
updateTime: Float
updatedBy: String
version: Float
}
}
guid
- The globally unique identifier of the relationship.public DynamicRequest delete(String guid)
guid
- The globally unique identifier of the relationship.public DynamicRequest invoke()
Copyright © 2021. All rights reserved.