mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-10-07 06:46:35 +00:00
28 lines
1.5 KiB
Markdown
28 lines
1.5 KiB
Markdown
|
---
|
||
|
|
title: createApiService
|
||
|
|
slug: /main-concepts/metadata-standard/schemas/api/services/createapiservice
|
||
|
|
---
|
||
|
|
|
||
|
|
# CreateApiServiceRequest
|
||
|
|
|
||
|
|
*Create API Service entity request*
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
- **`name`**: Name that identifies the this entity instance uniquely. Refer to *../../type/basic.json#/definitions/entityName*.
|
||
|
|
- **`displayName`** *(string)*: Display Name that identifies this API service. It could be title or label from the source services.
|
||
|
|
- **`description`**: Description of API service entity. Refer to *../../type/basic.json#/definitions/markdown*.
|
||
|
|
- **`serviceType`**: Refer to *../../entity/services/apiService.json#/definitions/apiServiceType*.
|
||
|
|
- **`connection`**: Refer to *../../entity/services/apiService.json#/definitions/apiConnection*.
|
||
|
|
- **`tags`** *(array)*: Tags for this API Service. Default: `None`.
|
||
|
|
- **Items**: Refer to *../../type/tagLabel.json*.
|
||
|
|
- **`owners`**: Owners of this API service. Refer to *../../type/entityReferenceList.json*. Default: `None`.
|
||
|
|
- **`dataProducts`** *(array)*: List of fully qualified names of data products this entity is part of.
|
||
|
|
- **Items**: Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
|
||
|
|
- **`domains`** *(array)*: Fully qualified names of the domains the API Service belongs to.
|
||
|
|
- **Items** *(string)*
|
||
|
|
- **`ingestionRunner`**: The ingestion agent responsible for executing the ingestion pipeline. Refer to *../../type/entityReference.json*.
|
||
|
|
|
||
|
|
|
||
|
|
Documentation file automatically generated at 2025-08-12 05:39:47.683420+00:00.
|