ApiPortalProperties interface
Datová část vlastností portálu API
Vlastnosti
api |
Označuje, jestli je funkce try-out rozhraní API povolená nebo zakázaná. Pokud je tato možnost povolená, můžou si uživatelé rozhraní API vyzkoušet odesíláním požadavků a zobrazením odpovědí na portálu ROZHRANÍ API. Pokud je toto rozhraní API zakázané, uživatelé si ho nemůžou vyzkoušet. |
gateway |
Pole ID prostředků brány pro integraci s portálem ROZHRANÍ API. |
https |
Uveďte, jestli je povolený jenom https. |
instances | Kolekce instancí patří na portál ROZHRANÍ API. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server. |
provisioning |
Stav portálu ROZHRANÍ API. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server. |
public | Označuje, jestli portál ROZHRANÍ API zveřejňuje koncový bod. |
resource |
Požadované množství prostředků pro požadovaný procesor a paměť. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server. |
source |
Kolekce zdrojových adres URL OpenAPI. |
sso |
Konfigurace související s jednotným přihlašováním |
url | Adresa URL portálu ROZHRANÍ API, která se zobrazí, když je hodnota public (public) pravdivá. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server. |
Podrobnosti vlastnosti
apiTryOutEnabledState
Označuje, jestli je funkce try-out rozhraní API povolená nebo zakázaná. Pokud je tato možnost povolená, můžou si uživatelé rozhraní API vyzkoušet odesíláním požadavků a zobrazením odpovědí na portálu ROZHRANÍ API. Pokud je toto rozhraní API zakázané, uživatelé si ho nemůžou vyzkoušet.
apiTryOutEnabledState?: string
Hodnota vlastnosti
string
gatewayIds
Pole ID prostředků brány pro integraci s portálem ROZHRANÍ API.
gatewayIds?: string[]
Hodnota vlastnosti
string[]
httpsOnly
Uveďte, jestli je povolený jenom https.
httpsOnly?: boolean
Hodnota vlastnosti
boolean
instances
Kolekce instancí patří na portál ROZHRANÍ API. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.
instances?: ApiPortalInstance[]
Hodnota vlastnosti
provisioningState
Stav portálu ROZHRANÍ API. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.
provisioningState?: string
Hodnota vlastnosti
string
public
Označuje, jestli portál ROZHRANÍ API zveřejňuje koncový bod.
public?: boolean
Hodnota vlastnosti
boolean
resourceRequests
Požadované množství prostředků pro požadovaný procesor a paměť. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.
resourceRequests?: ApiPortalResourceRequests
Hodnota vlastnosti
sourceUrls
Kolekce zdrojových adres URL OpenAPI.
sourceUrls?: string[]
Hodnota vlastnosti
string[]
ssoProperties
Konfigurace související s jednotným přihlašováním
ssoProperties?: SsoProperties
Hodnota vlastnosti
url
Adresa URL portálu ROZHRANÍ API, která se zobrazí, když je hodnota public (public) pravdivá. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.
url?: string
Hodnota vlastnosti
string