generated: '2026-09-28'
method: derived
generator: derive-data-model.py
source:
- openapi/crawler-openapi.json
- openapi/dataset-openapi.json
- openapi/dynamic-engine-environments-openapi.json
- openapi/dynamic-engine-openapi.json
- openapi/dynamic-engine-openapi.yml
- openapi/execution-history-search-openapi.json
- openapi/ip-allowlist-openapi.json
- openapi/oauth-openapi.json
- openapi/observability-metrics-openapi.json
- openapi/scim-v2-openapi.json
- openapi/seats-and-subscription-openapi.json
- openapi/service-accounts-openapi.json
notation: has_one = property $ref; has_many = array of $ref; belongs_to = <entity>_id field
summary:
  entities: 150
  entities_in_spec: 150
  relationships: 134
entities:
- name: AddOperation
  fields: 0
- name: Address
  fields: 8
- name: AlreadyExist
  fields: 2
  description: A crawler already exists for this connection. You can only have one crawler per connection.
- name: AlreadyRunning
  fields: 2
  description: This entity indicates that the crawler is already running and provides the crawler ID.
- name: ApiError
  fields: 7
  description: Describe an API error
- name: Artifact
  fields: 5
  description: A deployable Talend artifact (JAR, ZIP, etc.)
- name: AttributeValue
  fields: 6
- name: AttributeValuePutRequest
  fields: 1
- name: Author
  fields: 2
- name: BulkSharingSetRequest
  fields: 1
- name: CertificationRequest
  fields: 1
- name: ColumnDescription
  fields: 2
- name: ColumnDescriptionUpdateRequest
  fields: 1
- name: CommandSuccess
  fields: 2
- name: ComponentFieldFilter
  fields: 3
- name: ComponentMetric
  fields: 11
- name: ComponentMetricPage
  fields: 4
- name: ComponentQueryRequest
  fields: 8
- name: Connection
  fields: 5
  description: A data source or destination connection configuration
- name: ConnectionCreate
  fields: 4
- name: ConnectionInfo
  fields: 6
- name: ConnectionScan
  fields: 3
  description: This object contains the information about the last scan of the connection. It allows the user to
    retrieve the objects found by the last scan.
- name: CrawledDataset
  fields: 9
  description: This object represents a datasets related to a crawler.
- name: CrawlerComplete
  fields: 13
  description: This object represents a crawler in the complete version.
- name: CrawlerLight
  fields: 5
  description: This object represents a crawler in the light version (only contain the status).
- name: CreateCrawlerRequest
  fields: 5
  description: Describe the crawler about to be created with the name, description, tables and views selection,
    user and group for the sharing policies.
- name: CreateCrawlerResponse
  fields: 1
  description: Contains the response following a crawler creation request. The object contains the ID of the crawler
    created.
- name: CreateDynamicEngineEnvironmentRequest
  fields: 6
- name: CreateDynamicEngineRequest
  fields: 2
  description: The request payload to create a dynamic-engine
- name: CustomAttributeCreateRequest
  fields: 6
- name: CustomAttributeCreateResponse
  fields: 1
- name: CustomAttributeDefinition
  fields: 10
- name: CustomAttributeUpdateRequest
  fields: 5
- name: CustomAttributeValueDatasetResponse
  fields: 2
- name: DEEnvironment
  fields: 14
  description: 'While providing all capacity related to Environments (see description), Dynamic Engine Environment
    also brings Dynamic Engine processing for all tasks or plans defined within. '
- name: DEEnvironmentPage
  fields: 4
- name: DatasetResponse
  fields: 23
- name: DownloadRequest
  fields: 6
- name: DynamicEngineDetailsResponse
  fields: 9
  description: Describe a dynamic-engine
- name: DynamicEngineReleaseNote
  fields: 2
  description: Describe a dynamic engine version release note
- name: DynamicEngineService
  fields: 4
  description: Describe a dynamic engine version service
- name: DynamicEngineVersion
  fields: 6
  description: Describe a dynamic engine version
- name: Eligibles
  fields: 2
  description: Description of a list of users and groups of users who are eligibles for the sharing of an entit.
- name: Email
  fields: 4
- name: EngineStatus
  fields: 2
  description: Information about engine status
- name: Entitlement
  fields: 4
- name: EntitlementsResponse
  fields: 2
- name: Environment
  fields: 5
  description: An execution environment in Talend Cloud
- name: EnvironmentCreate
  fields: 2
- name: Error
  fields: 2
  description: Object returned in case the operation of a service account fails.
- name: ErrorMessageBody
  fields: 6
- name: ErrorResponse
  fields: 4
- name: Execution
  fields: 49
- name: ExecutionComponentMetrics
  fields: 14
- name: ExecutionPage
  fields: 4
- name: FieldFilter
  fields: 3
- name: Flag
  fields: 2
- name: ForeignEntity
  fields: 2
- name: GenerateDeploymentOptions
  fields: 2
  description: Describe the supported options to generate a manifest for the infrastructure and all the environments
- name: GenericScimResource
  fields: 5
- name: Group
  fields: 4
- name: GroupResource
  fields: 6
- name: GroupSharingResponse
  fields: 5
- name: InstantMessagingAddress
  fields: 4
- name: IpAllowlist
  fields: 3
- name: IpAllowlistSettings
  fields: 1
- name: IpEntry
  fields: 2
- name: JsonNode
  fields: 0
- name: KubernetesEvent
  fields: 3
  description: Describe an engine event
- name: LevelRequest
  fields: 1
- name: LevelResponse
  fields: 3
  description: Description of a level access for an entity.
- name: ListResponseGenericScimResource
  fields: 8
- name: Member
  fields: 3
- name: Meta
  fields: 5
- name: Metadata_infos
  fields: 0
  description: This objects contains the metadata of an entity according to the context of the call.
- name: Name
  fields: 6
- name: NotAuthenticated
  fields: 2
  description: The user has not been authenticated.
- name: NotAuthorized
  fields: 2
  description: The user has been authenticated but doesn't have the entitlement for this service.
- name: NotFound
  fields: 3
  description: Generic response payload when an object hasn't been found. The entityType gives more information
    about the object.
- name: PaginatedResources_CrawledDataset
  fields: 4
  description: This objects contains the datasets related to a crawler in a paginated context.
- name: PaginatedResources_CrawlerModel
  fields: 4
  description: This object represents a whole crawler but in a paginated context.
- name: Paging
  fields: 3
- name: PatchCrawlerRequest
  fields: 2
  description: This object is used when the user wants to update the name and the description of the crawler.
- name: PatchGroupSharingRequest
  fields: 4
- name: PatchOperation
  fields: 2
- name: PatchRequest
  fields: 5
- name: PatchSharingSetRequest
  fields: 2
- name: PatchUserSharingRequest
  fields: 5
- name: Permission
  fields: 3
- name: PermissionDeleteResult
  fields: 3
- name: PermissionId
  fields: 2
- name: PermissionResult
  fields: 3
- name: PhoneNumber
  fields: 4
- name: Photo
  fields: 4
- name: Plan
  fields: 7
  description: An ordered sequence of tasks in Talend Cloud
- name: PlanCreate
  fields: 4
- name: PlanExecution
  fields: 6
  description: A plan execution instance
- name: PlanExecutionRequest
  fields: 3
- name: ProcessMetric
  fields: 5
- name: PutGroupSharingRequest
  fields: 4
- name: PutSharingSetRequest
  fields: 2
- name: PutUserSharingRequest
  fields: 5
- name: RatingInfo
  fields: 2
- name: RawComponentMetric
  fields: 23
- name: RawComponentMetricPage
  fields: 4
- name: RemoteEngine
  fields: 7
  description: A self-hosted Talend remote engine instance
- name: RemoteEngineCreate
  fields: 3
- name: RemoveOperation
  fields: 0
- name: ReplaceOperation
  fields: 0
- name: Role
  fields: 4
- name: RoleMapping
  fields: 2
- name: RoleResource
  fields: 6
- name: RunProfileCreate
  fields: 4
- name: ScannedDataset
  fields: 3
  description: This object contains the objects founded by the scan.
- name: Schedule
  fields: 5
  description: A time-based trigger for task or plan execution
- name: ScheduleCreate
  fields: 3
- name: ScimResource
  fields: 4
- name: SearchDynamicEngineEnvironmentsRequest
  fields: 7
- name: SearchRequest
  fields: 6
- name: Seat
  fields: 3
  description: Seat information
- name: ServerError
  fields: 2
  description: The server encountered an error during the processing of the request.
- name: ServiceAccount
  fields: 8
  description: A service account represents a non-human user entity which could be a service, a job, a third-party
    system or alike. This account uses access tokens to authenticate and must have been assigned appropr
- name: ServiceAccountCount
  fields: 2
  description: Number of existing Service Accounts for tenant
- name: ServiceDetails
  fields: 10
  description: Details of the installed service
- name: Sharing
  fields: 3
  description: This object indicate the sharing informations.
- name: SharingResponse
  fields: 9
- name: SharingSetKey
  fields: 2
- name: SharingSetResponse
  fields: 2
- name: SharingState
  fields: 2
- name: Status
  fields: 10
  description: This object contains informations about the crawler status
- name: StatusResponse
  fields: 6
  description: Describe the status
- name: Subscription
  fields: 8
  description: Contains information related to token consumption, engines statuses and seat usages
- name: TalendQuality
  fields: 4
- name: Task
  fields: 8
  description: A data integration task in Talend Cloud
- name: TaskCreate
  fields: 4
- name: TaskExecution
  fields: 8
  description: A task execution instance
- name: TaskExecutionRequest
  fields: 3
- name: TokenRequest
  fields: 2
  description: A token request is an object used to obtain an access token through the OAuth 2 Client Credentials
    Grant flow.
- name: TokenResponse
  fields: 3
  description: Access token is returned in this response.
- name: TokensStatus
  fields: 2
  description: Information about tokens
- name: TrustScoreAxis
  fields: 5
- name: UpdateCrawlerRequest
  fields: 3
  description: Describe the elements to update on the crawler as the name, description and the tables/views selection.
- name: UpdateDynamicEngineEnvironmentRequest
  fields: 4
- name: UpdateDynamicEngineRequest
  fields: 2
  description: The request payload to update a dynamic-engine
- name: User
  fields: 3
  description: Basic description of an user, with its id, first name and last name.
- name: UserResource
  fields: 25
- name: UserSharingResponse
  fields: 6
- name: Workspace
  fields: 6
  description: A logical grouping of tasks, plans, and connections in Talend Cloud
- name: WorkspaceCreate
  fields: 2
- name: X509Certificate
  fields: 4
relationships:
- from: CreateCrawlerRequest
  to: Connection
  type: belongs_to
  via: connectionId
- from: CreateCrawlerRequest
  to: Sharing
  type: has_many
  via: sharings
- from: AlreadyExist
  to: Connection
  type: belongs_to
  via: connectionId
- from: CrawlerComplete
  to: Connection
  type: belongs_to
  via: connectionId
- from: CrawlerComplete
  to: Sharing
  type: has_many
  via: sharings
- from: CrawlerComplete
  to: Status
  type: has_one
  via: status
- from: CrawlerLight
  to: Connection
  type: belongs_to
  via: connectionId
- from: PaginatedResources_CrawledDataset
  to: CrawledDataset
  type: has_many
  via: data
- from: CrawledDataset
  to: Metadata_infos
  type: has_one
  via: metadata
- from: ConnectionScan
  to: ScannedDataset
  type: has_many
  via: results
- from: ScannedDataset
  to: Metadata_infos
  type: has_one
  via: metadata
- from: CustomAttributeDefinition
  to: Author
  type: has_one
  via: createdBy
- from: CustomAttributeDefinition
  to: Author
  type: has_one
  via: updatedBy
- from: DatasetResponse
  to: ConnectionInfo
  type: has_one
  via: datastore
- from: DatasetResponse
  to: RatingInfo
  type: has_one
  via: rating
- from: DatasetResponse
  to: SharingState
  type: has_one
  via: sharing
- from: DatasetResponse
  to: TalendQuality
  type: has_one
  via: talendGlobalQuality
- from: DatasetResponse
  to: TrustScoreAxis
  type: has_many
  via: trustScoreAxes
- from: CustomAttributeValueDatasetResponse
  to: AttributeValue
  type: has_many
  via: data
- from: CustomAttributeValueDatasetResponse
  to: Paging
  type: has_one
  via: paging
- from: DEEnvironmentPage
  to: DEEnvironment
  type: has_many
  via: items
- from: StatusResponse
  to: ServiceDetails
  type: has_many
  via: services
- from: StatusResponse
  to: KubernetesEvent
  type: has_many
  via: failureEvents
- from: DynamicEngineService
  to: Flag
  type: has_one
  via: flag
- from: DynamicEngineVersion
  to: DynamicEngineReleaseNote
  type: has_one
  via: releaseNotes
- from: DynamicEngineVersion
  to: DynamicEngineService
  type: has_many
  via: services
- from: SearchRequest
  to: Environment
  type: belongs_to
  via: environmentId
- from: SearchRequest
  to: FieldFilter
  type: has_many
  via: filters
- from: Execution
  to: Environment
  type: belongs_to
  via: environmentId
- from: Execution
  to: Workspace
  type: belongs_to
  via: workspaceId
- from: Execution
  to: Task
  type: belongs_to
  via: taskId
- from: Execution
  to: PlanExecution
  type: belongs_to
  via: planExecutionId
- from: Execution
  to: Artifact
  type: belongs_to
  via: artifactId
- from: Execution
  to: Plan
  type: belongs_to
  via: planId
- from: ExecutionPage
  to: Execution
  type: has_many
  via: items
- from: DownloadRequest
  to: Environment
  type: belongs_to
  via: environmentId
- from: DownloadRequest
  to: FieldFilter
  type: has_many
  via: filters
- from: IpAllowlist
  to: IpEntry
  type: has_many
  via: ips
- from: ComponentQueryRequest
  to: Environment
  type: belongs_to
  via: environmentId
- from: ComponentQueryRequest
  to: ComponentFieldFilter
  type: has_many
  via: filters
- from: ExecutionComponentMetrics
  to: Workspace
  type: belongs_to
  via: workspace_id
- from: ExecutionComponentMetrics
  to: Task
  type: belongs_to
  via: task_id
- from: ExecutionComponentMetrics
  to: TaskExecution
  type: belongs_to
  via: task_execution_id
- from: ExecutionComponentMetrics
  to: Artifact
  type: belongs_to
  via: artifact_id
- from: ExecutionComponentMetrics
  to: ProcessMetric
  type: has_many
  via: processes
- from: ExecutionComponentMetrics
  to: ComponentMetricPage
  type: has_one
  via: metrics
- from: ComponentMetricPage
  to: ComponentMetric
  type: has_many
  via: items
- from: RawComponentMetricPage
  to: RawComponentMetric
  type: has_many
  via: items
- from: RawComponentMetric
  to: Workspace
  type: belongs_to
  via: workspace_id
- from: RawComponentMetric
  to: Task
  type: belongs_to
  via: task_id
- from: RawComponentMetric
  to: TaskExecution
  type: belongs_to
  via: task_execution_id
- from: UserResource
  to: Meta
  type: has_one
  via: meta
- from: UserResource
  to: Name
  type: has_one
  via: name
- from: UserResource
  to: Email
  type: has_many
  via: emails
- from: UserResource
  to: PhoneNumber
  type: has_many
  via: phoneNumbers
- from: UserResource
  to: InstantMessagingAddress
  type: has_many
  via: ims
- from: UserResource
  to: Photo
  type: has_many
  via: photos
- from: UserResource
  to: Address
  type: has_many
  via: addresses
- from: UserResource
  to: Group
  type: has_many
  via: groups
- from: UserResource
  to: Entitlement
  type: has_many
  via: entitlements
- from: UserResource
  to: Role
  type: has_many
  via: roles
- from: UserResource
  to: X509Certificate
  type: has_many
  via: x509Certificates
- from: GroupResource
  to: Meta
  type: has_one
  via: meta
- from: GroupResource
  to: Member
  type: has_many
  via: members
- from: RoleResource
  to: Meta
  type: has_one
  via: meta
- from: RoleResource
  to: Entitlement
  type: has_many
  via: entitlements
- from: GenericScimResource
  to: Meta
  type: has_one
  via: meta
- from: ListResponseGenericScimResource
  to: Meta
  type: has_one
  via: meta
- from: ListResponseGenericScimResource
  to: GenericScimResource
  type: has_many
  via: Resources
- from: AddOperation
  to: JsonNode
  type: has_one
  via: value
- from: RemoveOperation
  to: JsonNode
  type: has_one
  via: value
- from: PatchRequest
  to: AddOperation
  type: has_many
  via: Operations
- from: PatchRequest
  to: RemoveOperation
  type: has_many
  via: Operations
- from: PatchRequest
  to: ReplaceOperation
  type: has_many
  via: Operations
- from: PatchRequest
  to: Meta
  type: has_one
  via: meta
- from: ReplaceOperation
  to: JsonNode
  type: has_one
  via: value
- from: ScimResource
  to: Meta
  type: has_one
  via: meta
- from: Subscription
  to: TokensStatus
  type: has_one
  via: tokensStatus
- from: Subscription
  to: EngineStatus
  type: has_many
  via: enginesStatus
- from: Subscription
  to: Seat
  type: has_many
  via: seats
- from: Eligibles
  to: User
  type: has_many
  via: users
- from: Eligibles
  to: Group
  type: has_many
  via: groups
- from: SharingResponse
  to: User
  type: belongs_to
  via: userId
- from: SharingResponse
  to: UserSharingResponse
  type: has_many
  via: userOwners
- from: SharingResponse
  to: GroupSharingResponse
  type: has_many
  via: groupOwners
- from: UserSharingResponse
  to: User
  type: belongs_to
  via: userId
- from: UserSharingResponse
  to: LevelResponse
  type: has_one
  via: level
- from: UserSharingResponse
  to: ForeignEntity
  type: has_one
  via: foreignEntity
- from: GroupSharingResponse
  to: Group
  type: belongs_to
  via: groupId
- from: GroupSharingResponse
  to: LevelResponse
  type: has_one
  via: level
- from: GroupSharingResponse
  to: ForeignEntity
  type: has_one
  via: foreignEntity
- from: SharingSetResponse
  to: UserSharingResponse
  type: has_many
  via: users
- from: SharingSetResponse
  to: GroupSharingResponse
  type: has_many
  via: groups
- from: PutSharingSetRequest
  to: PutUserSharingRequest
  type: has_many
  via: users
- from: PutSharingSetRequest
  to: PutGroupSharingRequest
  type: has_many
  via: groups
- from: PutUserSharingRequest
  to: User
  type: belongs_to
  via: userId
- from: PutUserSharingRequest
  to: LevelRequest
  type: has_one
  via: level
- from: PutUserSharingRequest
  to: ForeignEntity
  type: has_one
  via: foreignEntity
- from: PutGroupSharingRequest
  to: Group
  type: belongs_to
  via: groupId
- from: PutGroupSharingRequest
  to: LevelRequest
  type: has_one
  via: level
- from: PutGroupSharingRequest
  to: ForeignEntity
  type: has_one
  via: foreignEntity
- from: PatchSharingSetRequest
  to: PatchUserSharingRequest
  type: has_many
  via: users
- from: PatchSharingSetRequest
  to: PatchGroupSharingRequest
  type: has_many
  via: groups
- from: PatchUserSharingRequest
  to: User
  type: belongs_to
  via: userId
- from: PatchUserSharingRequest
  to: LevelRequest
  type: has_one
  via: level
- from: PatchUserSharingRequest
  to: ForeignEntity
  type: has_one
  via: foreignEntity
- from: PatchGroupSharingRequest
  to: Group
  type: belongs_to
  via: groupId
- from: PatchGroupSharingRequest
  to: LevelRequest
  type: has_one
  via: level
- from: PatchGroupSharingRequest
  to: ForeignEntity
  type: has_one
  via: foreignEntity
- from: ConnectionCreate
  to: Workspace
  type: belongs_to
  via: workspaceId
- from: Connection
  to: Workspace
  type: belongs_to
  via: workspaceId
- from: PlanExecutionRequest
  to: Plan
  type: belongs_to
  via: planId
- from: PlanExecutionRequest
  to: Environment
  type: belongs_to
  via: environmentId
- from: PlanExecution
  to: Execution
  type: belongs_to
  via: executionId
- from: PlanExecution
  to: Plan
  type: belongs_to
  via: planId
- from: PlanCreate
  to: Workspace
  type: belongs_to
  via: workspaceId
- from: Plan
  to: Workspace
  type: belongs_to
  via: workspaceId
- from: RemoteEngine
  to: Workspace
  type: belongs_to
  via: workspaceId
- from: RemoteEngineCreate
  to: Workspace
  type: belongs_to
  via: workspaceId
- from: TaskExecution
  to: Execution
  type: belongs_to
  via: executionId
- from: TaskExecution
  to: Task
  type: belongs_to
  via: taskId
- from: TaskExecutionRequest
  to: Task
  type: belongs_to
  via: taskId
- from: TaskExecutionRequest
  to: Environment
  type: belongs_to
  via: environmentId
- from: TaskCreate
  to: Workspace
  type: belongs_to
  via: workspaceId
- from: TaskCreate
  to: Environment
  type: belongs_to
  via: environmentId
- from: Task
  to: Workspace
  type: belongs_to
  via: workspaceId
- from: Task
  to: Environment
  type: belongs_to
  via: environmentId
- from: Permission
  to: Workspace
  type: belongs_to
  via: workspaceId
- from: Permission
  to: User
  type: belongs_to
  via: userId
- from: PermissionDeleteResult
  to: PermissionId
  type: has_one
  via: permissionId
- from: PermissionDeleteResult
  to: Permission
  type: belongs_to
  via: permissionId
- from: PermissionId
  to: Workspace
  type: belongs_to
  via: workspaceId
- from: PermissionId
  to: User
  type: belongs_to
  via: userId
- from: PermissionResult
  to: Permission
  type: has_one
  via: permission