OpenAPI definition (YAML)
paths:
/catalog/v1/entity:
put:
description: '[](#section/Versioning/API-Lifecycle-Policy)
Partially update an entity attribute.'
operationId: partialEntityUpdate
requestBody:
description: The entity to update
content:
application/json:
schema:
type: object
properties:
referredEntities:
type: object
description: The referred entities
additionalProperties:
type: object
description: The entity
properties:
typeName:
type: string
description: The type name
attributes:
type: object
description: The type attributes
guid:
type: string
description: The internal guid
homeId:
type: string
description: The home id
isProxy:
type: boolean
description: Whether is a proxy
writeOnly: true
isIncomplete:
type: boolean
description: Whether is incomplete
provenanceType:
type: integer
description: The provenance type
format: int32
status:
type: string
description: The status
enum:
- ACTIVE
- DELETED
- PURGED
createdBy:
type: string
description: The creator
updatedBy:
type: string
description: The updater
createTime:
type: integer
description: The create time
format: int64
updateTime:
type: integer
description: The update time
format: int64
version:
type: integer
description: The version
format: int32
relationshipAttributes:
type: object
description: The relationship attributes
classifications:
type: array
description: The classifications (tags)
items:
type: object
properties:
typeName:
type: string
description: The tag name
attributes:
type: object
description: The tag attributes
additionalProperties:
type: object
entityGuid:
type: string
description: The internal entity guid
entityStatus:
type: string
description: The entity status
enum:
- ACTIVE
- DELETED
- PURGED
propagate:
type: boolean
description: Whether to propagate the tag
validityPeriods:
type: array
description: The validity periods
items:
type: object
properties:
startTime:
type: string
description: The start time of format yyyy/MM/dd HH:mm:ss
endTime:
type: string
description: The end time of format yyyy/MM/dd HH:mm:ss
timeZone:
type: string
description: The time zone (see java.util.TimeZone)
title: TimeBoundary
removePropagationsOnEntityDelete:
type: boolean
description: Whether to remove propagations on entity delete
title: Classification
meanings:
type: array
description: The meanings
items:
type: object
properties:
termGuid:
type: string
description: The term guid
relationGuid:
type: string
description: The relation guid
description:
type: string
description: The description
displayText:
type: string
description: The display text
expression:
type: string
description: The expression
createdBy:
type: string
description: The creator
steward:
type: string
description: The steward
source:
type: string
description: The source
confidence:
type: integer
description: The confidence
format: int32
status:
type: string
description: The status
enum:
- DISCOVERED
- PROPOSED
- IMPORTED
- VALIDATED
- DEPRECATED
- OBSOLETE
- OTHER
title: TermAssignmentHeader
customAttributes:
type: object
description: The custom attributes
additionalProperties:
type: string
businessAttributes:
type: object
description: The business attributes
additionalProperties:
type: object
labels:
uniqueItems: true
type: array
description: The labels
items:
type: string
proxy:
type: boolean
description: Whether is a proxy
title: Entity
entity:
type: object
description: The entity
properties:
typeName:
type: string
description: The type name
attributes:
type: object
description: The type attributes
guid:
type: string
description: The internal guid
homeId:
type: string
description: The home id
isProxy:
type: boolean
description: Whether is a proxy
writeOnly: true
isIncomplete:
type: boolean
description: Whether is incomplete
provenanceType:
type: integer
description: The provenance type
format: int32
status:
type: string
description: The status
enum:
- ACTIVE
- DELETED
- PURGED
createdBy:
type: string
description: The creator
updatedBy:
type: string
description: The updater
createTime:
type: integer
description: The create time
format: int64
updateTime:
type: integer
description: The update time
format: int64
version:
type: integer
description: The version
format: int32
relationshipAttributes:
type: object
description: The relationship attributes
classifications:
type: array
description: The classifications (tags)
items:
type: object
properties:
typeName:
type: string
description: The tag name
attributes:
type: object
description: The tag attributes
additionalProperties:
type: object
entityGuid:
type: string
description: The internal entity guid
entityStatus:
type: string
description: The entity status
enum:
- ACTIVE
- DELETED
- PURGED
propagate:
type: boolean
description: Whether to propagate the tag
validityPeriods:
type: array
description: The validity periods
items:
type: object
properties:
startTime:
type: string
description: The start time of format yyyy/MM/dd HH:mm:ss
endTime:
type: string
description: The end time of format yyyy/MM/dd HH:mm:ss
timeZone:
type: string
description: The time zone (see java.util.TimeZone)
title: TimeBoundary
removePropagationsOnEntityDelete:
type: boolean
description: Whether to remove propagations on entity delete
title: Classification
meanings:
type: array
description: The meanings
items:
type: object
properties:
termGuid:
type: string
description: The term guid
relationGuid:
type: string
description: The relation guid
description:
type: string
description: The description
displayText:
type: string
description: The display text
expression:
type: string
description: The expression
createdBy:
type: string
description: The creator
steward:
type: string
description: The steward
source:
type: string
description: The source
confidence:
type: integer
description: The confidence
format: int32
status:
type: string
description: The status
enum:
- DISCOVERED
- PROPOSED
- IMPORTED
- VALIDATED
- DEPRECATED
- OBSOLETE
- OTHER
title: TermAssignmentHeader
customAttributes:
type: object
description: The custom attributes
additionalProperties:
type: string
businessAttributes:
type: object
description: The business attributes
additionalProperties:
type: object
labels:
uniqueItems: true
type: array
description: The labels
items:
type: string
proxy:
type: boolean
description: Whether is a proxy
title: Entity
title: EntityWithExtInfo
tags:
- Entity (v1)
responses:
'200':
description: The updated entity
content:
application/json:
schema:
type: object
properties:
mutatedEntities:
type: object
properties:
UPDATE:
type: array
description: The updated entities.
items:
type: object
properties:
typeName:
type: string
description: The type name
attributes:
type: object
description: The attributes
guid:
type: string
description: The internal guid
status:
type: string
description: The status
enum:
- ACTIVE
- DELETED
- PURGED
classificationNames:
type: array
description: The classification (tag) names
items:
type: string
classifications:
type: array
description: The classifications (tags)
items:
type: object
properties:
typeName:
type: string
description: The tag name
entityGuid:
type: string
description: The internal entity guid
entityStatus:
type: string
description: The entity status
enum:
- ACTIVE
- DELETED
- PURGED
propagate:
type: boolean
description: Whether to propagate the tag
removePropagationsOnEntityDelete:
type: boolean
description: Whether to remove propagations on entity delete
title: ClassificationHeader
isIncomplete:
type: boolean
description: Whether is incomplete
title: PartialUpdateParams
description: The updated entities.
title: EntityPartialUpdate
description: The type name
title: EntityPartialUpdateResponse
'400':
description: Bad Request
'404':
description: Entity not found
'429':
description: Rate Limit Error
'500':
description: Internal Server Error
servers:
- url: https://psrc-00000.region.provider.confluent.cloud
description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud
jsonRequestBodyExample:
referredEntities: {}
entity:
typeName: string
attributes: {}
guid: string
homeId: string
isProxy: true
isIncomplete: true
provenanceType: 0
status: ACTIVE
createdBy: string
updatedBy: string
createTime: 0
updateTime: 0
version: 0
relationshipAttributes: {}
classifications:
- typeName: string
attributes: {}
entityGuid: string
entityStatus: ACTIVE
propagate: true
validityPeriods:
- startTime: string
endTime: string
timeZone: string
removePropagationsOnEntityDelete: true
meanings:
- termGuid: string
relationGuid: string
description: string
displayText: string
expression: string
createdBy: string
steward: string
source: string
confidence: 0
status: DISCOVERED
customAttributes: {}
businessAttributes: {}
labels:
- string
proxy: true