ApiCreateOrUpdateParameter interface
Parâmetros de Criação ou Atualização da API.
Propriedades
| api |
Descreve a revisão da API. Se não for fornecido nenhum valor, é criada a revisão predefinida 1 |
| api |
Descrição da Revisão da API. |
| api |
Tipo de API. |
| api |
Indica o identificador de versão da API se a API tiver uma versão |
| api |
Descrição da Versão da API. |
| api |
Detalhes do conjunto de versões |
| api |
Um identificador de recursos para o ApiVersionSet relacionado. |
| authentication |
Coleção de definições de autenticação incluídas nesta API. |
| contact | Informações de contacto da API. |
| description | Descrição da API. Pode incluir etiquetas de formatação HTML. |
| display |
Nome da API. Tem de ter entre 1 e 300 carateres. |
| format | Formato do Conteúdo no qual a API está a ser importada. |
| is |
Indica se a revisão da API é a revisão atual da API. |
| is |
Indica se a revisão da API está acessível através do gateway. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor. |
| license | Informações de licença para a API. |
| path | O URL relativo identifica exclusivamente esta API e todos os respetivos caminhos de recursos na instância do serviço Gestão de API. É anexado ao URL base do ponto final da API especificado durante a criação da instância de serviço para formar um URL público para esta API. |
| protocols | Descreve os protocolos que as operações nesta API podem ser invocadas. |
| service |
URL absoluto do serviço de back-end que implementa esta API. Não pode ter mais de 2000 carateres. |
| soap |
Tipo de API a criar.
|
| source |
Identificador de API da API de origem. |
| subscription |
Protocolos sobre os quais a API é disponibilizada. |
| subscription |
Especifica se é necessária uma subscrição de API ou Produto para aceder à API. |
| terms |
Um URL para os Termos de Serviço da API. TEM de estar no formato de um URL. |
| translate |
Estratégia de tradução dos parâmetros de consulta necessários para os modelos. Por predefinição, tem o valor "modelo". Valores possíveis: "modelo", "consulta" |
| value | Valor do conteúdo ao Importar uma API. |
| wsdl |
Critérios para limitar a importação de WSDL para um subconjunto do documento. |
Detalhes de Propriedade
apiRevision
Descreve a revisão da API. Se não for fornecido nenhum valor, é criada a revisão predefinida 1
apiRevision?: stringValor de Propriedade
string
apiRevisionDescription
Descrição da Revisão da API.
apiRevisionDescription?: stringValor de Propriedade
string
apiType
Tipo de API.
apiType?: stringValor de Propriedade
string
apiVersion
Indica o identificador de versão da API se a API tiver uma versão
apiVersion?: stringValor de Propriedade
string
apiVersionDescription
Descrição da Versão da API.
apiVersionDescription?: stringValor de Propriedade
string
apiVersionSet
Detalhes do conjunto de versões
apiVersionSet?: ApiVersionSetContractDetailsValor de Propriedade
apiVersionSetId
Um identificador de recursos para o ApiVersionSet relacionado.
apiVersionSetId?: stringValor de Propriedade
string
authenticationSettings
Coleção de definições de autenticação incluídas nesta API.
authenticationSettings?: AuthenticationSettingsContractValor de Propriedade
contact
Informações de contacto da API.
contact?: ApiContactInformationValor de Propriedade
description
Descrição da API. Pode incluir etiquetas de formatação HTML.
description?: stringValor de Propriedade
string
displayName
Nome da API. Tem de ter entre 1 e 300 carateres.
displayName?: stringValor de Propriedade
string
format
Formato do Conteúdo no qual a API está a ser importada.
format?: stringValor de Propriedade
string
isCurrent
Indica se a revisão da API é a revisão atual da API.
isCurrent?: booleanValor de Propriedade
boolean
isOnline
Indica se a revisão da API está acessível através do gateway. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
isOnline?: booleanValor de Propriedade
boolean
license
Informações de licença para a API.
license?: ApiLicenseInformationValor de Propriedade
path
O URL relativo identifica exclusivamente esta API e todos os respetivos caminhos de recursos na instância do serviço Gestão de API. É anexado ao URL base do ponto final da API especificado durante a criação da instância de serviço para formar um URL público para esta API.
path?: stringValor de Propriedade
string
protocols
Descreve os protocolos que as operações nesta API podem ser invocadas.
protocols?: string[]Valor de Propriedade
string[]
serviceUrl
URL absoluto do serviço de back-end que implementa esta API. Não pode ter mais de 2000 carateres.
serviceUrl?: stringValor de Propriedade
string
soapApiType
Tipo de API a criar.
-
httpcria uma API REST -
soapcria uma API pass-through SOAP -
websocketcria a API websocket -
graphqlcria a API GraphQL.
soapApiType?: stringValor de Propriedade
string
sourceApiId
Identificador de API da API de origem.
sourceApiId?: stringValor de Propriedade
string
subscriptionKeyParameterNames
Protocolos sobre os quais a API é disponibilizada.
subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContractValor de Propriedade
subscriptionRequired
Especifica se é necessária uma subscrição de API ou Produto para aceder à API.
subscriptionRequired?: booleanValor de Propriedade
boolean
termsOfServiceUrl
Um URL para os Termos de Serviço da API. TEM de estar no formato de um URL.
termsOfServiceUrl?: stringValor de Propriedade
string
translateRequiredQueryParametersConduct
Estratégia de tradução dos parâmetros de consulta necessários para os modelos. Por predefinição, tem o valor "modelo". Valores possíveis: "modelo", "consulta"
translateRequiredQueryParametersConduct?: stringValor de Propriedade
string
value
Valor do conteúdo ao Importar uma API.
value?: stringValor de Propriedade
string
wsdlSelector
Critérios para limitar a importação de WSDL para um subconjunto do documento.
wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector