Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
NESTA PÁGINA
 

OBTER/ajuda/endpoints/{endpoint_id}

Recupera um único objeto de documentação de endpoint.

Recupera um único objeto de documentação de endpoint.

Tabela 1: OBTER /help/endpoints/{endpoint_id} Detalhes dos recursos

Tipo MIME

aplicativo/json

Tabela 2: GET /help/endpoints/{endpoint_id} Solicitar detalhes do parâmetro

Parâmetro

Tipo

Opcionalidade

Tipo de dados

Tipo MIME

Descrição

endpoint_id

Caminho

Necessário

Número (Inteiro)

texto/simples

A identificação de endpoint.

Campos

Consulta

Opcional

String

texto/simples

Opcional - Use este parâmetro para especificar quais campos você gostaria de receber de volta na resposta. Os campos que não forem nomeados estão excluídos. Especifique os subcampos em suportes e vários campos no mesmo objeto são separados por vírgulas.
Tabela 3: códigos de resposta GET/help/endpoints/{endpoint_id}

Código de resposta http

Código exclusivo

Descrição

200

  

O objeto da documentação do endpoint foi recuperado.

404

1002

Nenhum objeto de documentação de endpoint foi encontrado para o id de endpoint fornecido.

500

1020

Ocorreu um erro inesperado.

Descrição da resposta

Um objeto de documentação de endpoint. Um objeto de documentação de endpoint contém os seguintes campos:

  • id - Número - O ID da documentação do endpoint. Este ID não é permanente. Pode mudar sempre que os serviços forem reiniciados.

  • resumo - String - Um breve resumo do endpoint.

  • depreciado - Boolean - Retorna verdadeiro se o endpoint for preterido. Devoluções falsas de outra forma.

  • http_method - String - O tipo de solicitação HTTP. UMA DAS OPÇÕES, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT, PATCH.

  • error_responses - Matriz de Objetos - Uma lista de possíveis respostas de erro deste endpoint.

  • error_responses(response_code) - Número - O código HTTP para esta resposta a erro.

  • error_responses(descrição) - String - A descrição desta resposta a erro.

  • error_responses(unique_code) - Número - O código exclusivo para esta resposta a erros.

  • error_responses(response_code_description) - String - A descrição da resposta.

  • response_description - String - A descrição da resposta.

  • versão - String - A versão deste endpoint.

  • success_responses - Array of Objects - Uma lista de possíveis respostas de sucesso para este endpoint.

  • success_responses(response_code) - Número - O código HTTP para esta resposta.

  • success_responses(descrição) - String - A descrição desta resposta.

  • success_responses(response_code_description) - String - O nome para o código de resposta da RFC 2616.

  • descrição - String - Uma descrição deste endpoint.

  • caminho - String - O caminho deste endpoint.

  • response_mime_types - Matriz de Objetos - Uma lista de possíveis tipos de MIME de resposta para este endpoint.

  • response_mime_types(mime_type) - String - O valor do tipo MIME, por exemplo, TEXT_PLAIN

  • response_mime_types(media_type) - String - O tipo de mídia estilo RFC, por exemplo, texto/simples Este valor é adequado para uso em solicitações de HTTP.

  • response_mime_types(amostra) - String - A amostra deste tipo de MIME de resposta.

  • parâmetros - Array of Objects - Uma lista de parâmetros de usuário para este endpoint.

  • parâmetros(descrição) - String - Uma descrição deste parâmetro.

  • parâmetros (default_value) - String - O valor padrão deste parâmetro. Nulo se não houver valor padrão para este parâmetro. Esta é sempre uma String, independentemente do tipo de dados subjacente do parâmetro.

  • parâmetros(tipo) - String - O tipo de parâmetro, um de CONSULTA, CABEÇALHO, CAMINHO, CORPO.

  • parâmetros(parameter_name) - String - O nome deste parâmetro.

  • parâmetros(mime_types) - Matriz de objetos - Uma lista de possíveis mime_types para este parâmetro.

  • parâmetros (mime_types(data_type)) - String - Uma descrição do tipo de dados deste parâmetro.

  • parâmetros (mime_types(mime_type)) - String - O tipo MIME do parâmetro.

  • parâmetros (mime_types(amostra)) - String - A amostra para este parâmetro.

  • resource_id - Número - O ID do recurso associado.

  • last_modified_version - String - A versão de API deste endpoint foi modificada pela última vez. Ela será menor ou igual à versão do campo de versão.

  • caller_has_access - Boolean - Retorna verdadeiro se o usuário tiver os recursos necessários para chamar este endpoint. Devoluções falsas de outra forma.

Amostra de resposta

Documentação relacionada