APIPath#

class pyatlan.model.assets.APIPath(*, typeName: str = 'APIPath', attributes: APIPath.Attributes = None, businessAttributes: Dict[str, Any] | None = None, createdBy: str | None = None, createTime: int | None = None, deleteHandler: str | None = None, guid: str = '', isIncomplete: bool | None = True, labels: List[str] | None = None, relationshipAttributes: Dict[str, Any] | None = None, status: EntityStatus | None = None, updatedBy: str | None = None, updateTime: int | None = None, version: int | None = None, classifications: List[AtlanTag] | None = None, classificationNames: List[str] | None = None, displayText: str | None = None, entityStatus: str | None = None, relationshipGuid: str | None = None, relationshipStatus: str | None = None, relationshipType: str | None = None, meaningNames: List[str] | None = None, meanings: List[Meaning] | None = None, customAttributes: Dict[str, Any] | None = None, scrubbed: bool | None = None, pendingTasks: List[str] | None = None, uniqueAttributes: Dict[str, Any] | None = None, appendRelationshipAttributes: Dict[str, Any] | None = None, removeRelationshipAttributes: Dict[str, Any] | None = None, semantic: SaveSemantic | None = None, depth: int | None = None)[source]#

Description

API_PATH_AVAILABLE_OPERATIONS: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>#: List of the operations available on the endpoint.

API_PATH_AVAILABLE_RESPONSE_CODES: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>#: Response codes available on the path across all operations.

API_PATH_IS_INGRESS_EXPOSED: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>#: Whether the path is exposed as an ingress (true) or not (false).

API_PATH_IS_TEMPLATED: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>#: Whether the endpoint’s path contains replaceable parameters (true) or not (false).

API_PATH_RAW_URI: ClassVar[KeywordTextField] = <pyatlan.model.fields.atlan_fields.KeywordTextField object>#: Absolute path to an individual endpoint.

API_PATH_SUMMARY: ClassVar[TextField] = <pyatlan.model.fields.atlan_fields.TextField object>#: Descriptive summary intended to apply to all operations in this path.

API_SPEC: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>#: TBC