API model

Reference documentation

This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand how to manage API assets in Atlan. For that, we would suggest starting with the manage API assets pattern.

Base class for API assets.

classDiagram
    direction RL
    class API {
        <<abstract>>
    }
    link API "../api"
    class Catalog {
        <<abstract>>
    }
    link Catalog "../entities/catalog"
    Catalog <|-- API : extends
    class Asset {
        <<abstract>>
    }
    link Asset "../entities/asset"
    Asset <|-- Catalog : extends
    class Referenceable {
        <<abstract>>
    }
    link Referenceable "../entities/referenceable"
    Referenceable <|-- Asset : extends
    class APISpec
    link APISpec "../entities/apispec"
    API <|-- APISpec : extends
    class APIPath
    link APIPath "../entities/apipath"
    API <|-- APIPath : extends

Type-specific properties

Following are all the properties uniquely available on API assets in Atlan.

Java Python Raw REST API

apiExternalDocs

builder // (1)
    .apiExternalDoc("key1", "value1")
    .apiExternalDoc("key2", "value2");
aPI.getApiExternalDocs(); // (2)
client.assets.select().where(API.API_EXTERNAL_DOCS.eq("key1", "value1")); // (3)

1. Set the apiExternalDocs for a API.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the apiExternalDocs from a API.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their apiExternalDocs exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

apiIsAuthOptional

builder.apiIsAuthOptional(true); // (1)
aPI.getApiIsAuthOptional(); // (2)
client.assets.select().where(API.API_IS_AUTH_OPTIONAL.eq(true)); // (3)

1. Set the apiIsAuthOptional for a API.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the apiIsAuthOptional from a API.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their apiIsAuthOptional exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

apiSpecName

builder.apiSpecName("String0"); // (1)
aPI.getApiSpecName(); // (2)
client.assets.select().where(API.API_SPEC_NAME.eq("String0")); // (3)
client.assets.select().where(API.API_SPEC_NAME.match("String0")); // (4)

1. Set the apiSpecName for a API.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the apiSpecName from a API.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their apiSpecName exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

4. Find all assets in Atlan with their apiSpecName textually matching the provided value.

   For more details

   For more information, see the searching section on full text queries.

apiSpecQualifiedName

builder.apiSpecQualifiedName("String0"); // (1)
aPI.getApiSpecQualifiedName(); // (2)
client.assets.select().where(API.API_SPEC_QUALIFIED_NAME.eq("String0")); // (3)
client.assets.select().where(API.API_SPEC_QUALIFIED_NAME.match("String0")); // (4)

1. Set the apiSpecQualifiedName for a API.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the apiSpecQualifiedName from a API.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their apiSpecQualifiedName exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

4. Find all assets in Atlan with their apiSpecQualifiedName textually matching the provided value.

   For more details

   For more information, see the searching section on full text queries.

apiSpecType

builder.apiSpecType("String0"); // (1)
aPI.getApiSpecType(); // (2)
client.assets.select().where(API.API_SPEC_TYPE.eq("String0")); // (3)

1. Set the apiSpecType for a API.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the apiSpecType from a API.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their apiSpecType exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

apiSpecVersion

builder.apiSpecVersion("String0"); // (1)
aPI.getApiSpecVersion(); // (2)
client.assets.select().where(API.API_SPEC_VERSION.eq("String0")); // (3)

1. Set the apiSpecVersion for a API.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the apiSpecVersion from a API.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their apiSpecVersion exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

api_external_docs

builder.api_external_docs = {...}  # (1)
a_p_i.api_external_docs  # (2)
FluentSearch().where(FluentSearch.asset_type(API)).where(API.API_EXTERNAL_DOCS.eq("String0"))  # (3)

1. Set the api_external_docs for a API.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the api_external_docs from a API.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their api_external_docs exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

api_is_auth_optional

builder.api_is_auth_optional = ...  # (1)
a_p_i.api_is_auth_optional  # (2)
FluentSearch().where(FluentSearch.asset_type(API)).where(API.API_IS_AUTH_OPTIONAL.eq(True))  # (3)

1. Set the api_is_auth_optional for a API.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the api_is_auth_optional from a API.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their api_is_auth_optional exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

api_spec_name

builder.api_spec_name = ...  # (1)
a_p_i.api_spec_name  # (2)
FluentSearch().where(FluentSearch.asset_type(API)).where(API.API_SPEC_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(API)).where(API.API_SPEC_NAME.match("String0"))  # (4)

1. Set the api_spec_name for a API.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the api_spec_name from a API.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their api_spec_name exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

4. Find all assets in Atlan with their api_spec_name textually matching the provided value.

   For more details

   For more information, see the searching section on full text queries.

api_spec_qualified_name

builder.api_spec_qualified_name = ...  # (1)
a_p_i.api_spec_qualified_name  # (2)
FluentSearch().where(FluentSearch.asset_type(API)).where(API.API_SPEC_QUALIFIED_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(API)).where(API.API_SPEC_QUALIFIED_NAME.match("String0"))  # (4)

1. Set the api_spec_qualified_name for a API.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the api_spec_qualified_name from a API.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their api_spec_qualified_name exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

4. Find all assets in Atlan with their api_spec_qualified_name textually matching the provided value.

   For more details

   For more information, see the searching section on full text queries.

api_spec_type

builder.api_spec_type = ...  # (1)
a_p_i.api_spec_type  # (2)
FluentSearch().where(FluentSearch.asset_type(API)).where(API.API_SPEC_TYPE.eq("String0"))  # (3)

1. Set the api_spec_type for a API.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the api_spec_type from a API.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their api_spec_type exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

api_spec_version

builder.api_spec_version = ...  # (1)
a_p_i.api_spec_version  # (2)
FluentSearch().where(FluentSearch.asset_type(API)).where(API.API_SPEC_VERSION.eq("String0"))  # (3)

1. Set the api_spec_version for a API.

   For more details

   For more information, see the asset CRUD snippets on either creating or updating assets.

2. Retrieve the api_spec_version from a API.

   For more details

   For more information, see the asset CRUD snippets on retrieving assets.

3. Find all assets in Atlan with their api_spec_version exactly matching the provided value.

   For more details

   For more information, see the searching section on term queries.

apiExternalDocs

{
  "attributes": {
    "apiExternalDocs": [ // (1)
      {"key1", "value1"},
      {"key2", "value2"}
    ]
  }
}

1. Set the apiExternalDocs for a API.

   For more details

   For more information, see the asset CRUD snippets.

apiIsAuthOptional

{
  "attributes": {
    "apiIsAuthOptional": true // (1)
  }
}

1. Set the apiIsAuthOptional for a API.

   For more details

   For more information, see the asset CRUD snippets.

apiSpecName

{
  "attributes": {
    "apiSpecName": "String0" // (1)
  }
}

1. Set the apiSpecName for a API.

   For more details

   For more information, see the asset CRUD snippets.

apiSpecQualifiedName

{
  "attributes": {
    "apiSpecQualifiedName": "String0" // (1)
  }
}

1. Set the apiSpecQualifiedName for a API.

   For more details

   For more information, see the asset CRUD snippets.

apiSpecType

{
  "attributes": {
    "apiSpecType": "String0" // (1)
  }
}

1. Set the apiSpecType for a API.

   For more details

   For more information, see the asset CRUD snippets.

apiSpecVersion

{
  "attributes": {
    "apiSpecVersion": "String0" // (1)
  }
}

1. Set the apiSpecVersion for a API.

   For more details

   For more information, see the asset CRUD snippets.

Relationships

The following illustrates how the various API objects inter-relate with each other:

erDiagram
    Connection ||..o{ APISpec : ""
    APISpec ||--o{ APIPath : apiPaths