ApiCreateOrUpdateParameter interface
Créer ou mettre à jour des paramètres d’API.
Propriétés
api |
Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision par défaut 1 est créée |
api |
Description de la révision de l’API. |
api |
Type d’API. |
api |
Indique l’identificateur de version de l’API si l’API est avec version |
api |
Description de la version de l’API. |
api |
Détails du jeu de versions |
api |
Identificateur de ressource pour l’ApiVersionSet associé. |
authentication |
Collection de paramètres d’authentification inclus dans cette API. |
contact | Informations de contact pour l’API. |
description | Description de l’API. Peut comporter des balises de mise en forme. |
display |
Nom de l’API. Doit comporter entre 1 et 300 caractères. |
format | Format du contenu dans lequel l’API est importée. |
is |
Indique si la révision de l’API est la révision actuelle de l’API. |
is |
Indique si la révision de l’API est accessible via la passerelle. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur. |
license | Informations de licence pour l’API. |
path | URL relative identifiant exclusivement cette API et tous les chemins d’accès à ses ressources au sein de l’instance de service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée lors de la création de l’instance de service pour former l’URL publique de cette API. |
protocols | Indique sur quels protocoles les opérations dans cette API peuvent être appelées. |
service |
URL absolue du service principal qui implémente cette API. Ne peut pas avoir plus de 2 000 caractères. |
soap |
Type d’API à créer.
|
source |
Identificateur d’API de l’API source. |
subscription |
Protocoles sur lesquels l’API est mise à disposition. |
subscription |
Spécifie si un abonnement d’API ou de produit est requis pour accéder à l’API. |
terms |
URL des conditions d’utilisation de l’API. DOIT être au format d’une URL. |
translate |
Stratégie de traduction des paramètres de requête requis en modèles. Par défaut, a la valeur « template ». Valeurs possibles : 'template', 'query' |
value | Valeur de contenu lors de l’importation d’une API. |
wsdl |
Critères pour limiter l’importation de WSDL à un sous-ensemble du document. |
Détails de la propriété
apiRevision
Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision par défaut 1 est créée
apiRevision?: string
Valeur de propriété
string
apiRevisionDescription
Description de la révision de l’API.
apiRevisionDescription?: string
Valeur de propriété
string
apiType
Type d’API.
apiType?: string
Valeur de propriété
string
apiVersion
Indique l’identificateur de version de l’API si l’API est avec version
apiVersion?: string
Valeur de propriété
string
apiVersionDescription
Description de la version de l’API.
apiVersionDescription?: string
Valeur de propriété
string
apiVersionSet
Détails du jeu de versions
apiVersionSet?: ApiVersionSetContractDetails
Valeur de propriété
apiVersionSetId
Identificateur de ressource pour l’ApiVersionSet associé.
apiVersionSetId?: string
Valeur de propriété
string
authenticationSettings
Collection de paramètres d’authentification inclus dans cette API.
authenticationSettings?: AuthenticationSettingsContract
Valeur de propriété
contact
Informations de contact pour l’API.
contact?: ApiContactInformation
Valeur de propriété
description
Description de l’API. Peut comporter des balises de mise en forme.
description?: string
Valeur de propriété
string
displayName
Nom de l’API. Doit comporter entre 1 et 300 caractères.
displayName?: string
Valeur de propriété
string
format
Format du contenu dans lequel l’API est importée.
format?: string
Valeur de propriété
string
isCurrent
Indique si la révision de l’API est la révision actuelle de l’API.
isCurrent?: boolean
Valeur de propriété
boolean
isOnline
Indique si la révision de l’API est accessible via la passerelle. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
isOnline?: boolean
Valeur de propriété
boolean
license
Informations de licence pour l’API.
license?: ApiLicenseInformation
Valeur de propriété
path
URL relative identifiant exclusivement cette API et tous les chemins d’accès à ses ressources au sein de l’instance de service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée lors de la création de l’instance de service pour former l’URL publique de cette API.
path?: string
Valeur de propriété
string
protocols
Indique sur quels protocoles les opérations dans cette API peuvent être appelées.
protocols?: string[]
Valeur de propriété
string[]
serviceUrl
URL absolue du service principal qui implémente cette API. Ne peut pas avoir plus de 2 000 caractères.
serviceUrl?: string
Valeur de propriété
string
soapApiType
Type d’API à créer.
-
http
crée une API REST -
soap
crée une API directe SOAP -
websocket
crée l’API websocket -
graphql
crée GraphQL API.
soapApiType?: string
Valeur de propriété
string
sourceApiId
Identificateur d’API de l’API source.
sourceApiId?: string
Valeur de propriété
string
subscriptionKeyParameterNames
Protocoles sur lesquels l’API est mise à disposition.
subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract
Valeur de propriété
subscriptionRequired
Spécifie si un abonnement d’API ou de produit est requis pour accéder à l’API.
subscriptionRequired?: boolean
Valeur de propriété
boolean
termsOfServiceUrl
URL des conditions d’utilisation de l’API. DOIT être au format d’une URL.
termsOfServiceUrl?: string
Valeur de propriété
string
translateRequiredQueryParametersConduct
Stratégie de traduction des paramètres de requête requis en modèles. Par défaut, a la valeur « template ». Valeurs possibles : 'template', 'query'
translateRequiredQueryParametersConduct?: string
Valeur de propriété
string
value
Valeur de contenu lors de l’importation d’une API.
value?: string
Valeur de propriété
string
wsdlSelector
Critères pour limiter l’importation de WSDL à un sous-ensemble du document.
wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector