API de configuração de DevOps

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 12 min. de leitura

    • A API DevOps Config fornece endpoints para gerenciar suas aplicações.

    Esta API requer a aplicação Configuração de DevOps e é fornecida no namespace sn_devops_config.

    Para operações DELETE, PATCH e POST, o usuário de chamada deve ter a função sn_devops_config.admin. Para operações GET, o usuário de chamada deve ter a função sn_devops_config.viewer ou sn_devops_config.admin.

    Use a API DevOps Config para gestão do ciclo de vida da aplicação. Para obter mais informações sobre como gerenciar aplicações com Configuração de DevOps, consulte Como configurar o DevOps.

    Configuração de DevOps - DELETE /devops_config/application/{appid}

    Exclui uma aplicação.

    Formato da URL

    URL com controle de versão: /api/sn_devops_config/{api_version}/devops_config/application/{appid}

    URL padrão: /api/sn_devops_config/devops_config/application/{appid}

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    appid Sys_id da aplicação a ser excluída.

    Tipo de dados: cadeia de caracteres

    Tabela: aplicação de CDM [sn_cdm_application]
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 3. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação incorreta. ID da aplicação inválida.
    403 Proibido. O usuário não tem permissão para acessar a API.

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    erro Informações do erro. Este parâmetro só será retornado se a solicitação falhar.

    Tipo de dados: objeto

    "error": {  
   "detail": "String",
   "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o motivo da falha da solicitação.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que contém o motivo da falha na solicitação.

    Tipo de dados: cadeia de caracteres
    resultado Objeto de resultado que contém informações sobre a solicitação.

    Tipo de dados: objeto

    "result": { 
   "errors": [Array], 
   "success": [Array] 
}
    resultado.erros Matriz de erros da solicitação. A matriz está vazia para solicitações bem-sucedidas.

    Tipo de dados: matriz
    resultado.sucesso Mensagem de sucesso da solicitação. A matriz está vazia para solicitações com falha.

    Tipo de dados: matriz
    status Status da solicitação. Este parâmetro só será retornado se a solicitação falhar.

    Valor possível: falha

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Este exemplo exclui uma aplicação.

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Corpo da resposta.

    { 
  "result": { 
    "errors": [], 
    "success": [ 
      "CDM Application Demo Application 1234 has been deleted successfully." 
    ] 
  } 
}

    Solicitação de cURL

    Este exemplo mostra uma resposta de erro quando um usuário não tem permissão para acessar a API.

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Resposta de erro.

    { 
  "error": { 
    "message": "User Not Authorized", 
    "detail": "Failed API level ACL Validation" 
  }, 
  "status": "failure" 
}

    Configuração de DevOps - GET /devops_config/application/{appid}

    Recupera uma aplicação.

    Formato da URL

    URL com controle de versão: /api/sn_devops_config/{api_version}/devops_config/application/{appid}

    URL padrão: /api/sn_devops_config/devops_config/application/{appid}

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    appid Sys_id da aplicação a ser recuperada.

    Tipo de dados: cadeia de caracteres

    Tabela: aplicação de CDM [sn_cdm_application]
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 9. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 12. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação incorreta. ID da aplicação inválida.
    403 Proibido. O usuário não tem permissão para acessar a API.

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    erro Informações do erro. Este parâmetro só será retornado se a solicitação falhar.

    Tipo de dados: objeto

    "error": {  
   "detail": "String",
   "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o motivo da falha da solicitação.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que contém o motivo da falha na solicitação.

    Tipo de dados: cadeia de caracteres
    resultado Objeto de resultado que contém informações sobre a solicitação.

    Tipo de dados: objeto

    "result": { 
  "data": {Object},
  "message": "String",
  "status": Number
}
    resultado.dados Dados da aplicação.

    Tipo de dados: objeto

    "data": { 
  "appDescription": "String", 
  "appId": "String",
  "appManagedByGroups": [Array],
  "appManufacturerId": "String", 
  "appManufacturerName": "String", 
  "appModelId": "String", 
  "appModelName": "String", 
  "appModelOwnerId": "String", 
  "appModelOwnerName": "String", 
  "appName": "String", 
  "sdlcType": "String"
}
    result.data.appDescription Descrição da aplicação.

    Tipo de dados: cadeia de caracteres
    result.data.appId Sys_id da aplicação.

    Tipo de dados: cadeia de caracteres

    Tabela: aplicação de CDM [sn_cdm_application]
    result.data.appManagedByGroups Lista separada por vírgulas de sys_ids dos grupos que gerenciam a aplicação.

    Tipo de dados: cadeia de caracteres

    Tabela: Grupo [sys_user_group]
    result.data.appManufacturerId Sys_id do fabricante.

    Tipo de dados: cadeia de caracteres

    Tabela: Empresa [core_company]
    result.data.appManufacturerName Nome do fabricante.

    Tipo de dados: cadeia de caracteres
    result.data.appModelId Sys_id do modelo da aplicação.

    Tipo de dados: cadeia de caracteres

    Tabela: modelo de aplicação [cmdb_application_product_model]
    result.data.appModelName Nome do modelo da aplicação.

    Tipo de dados: cadeia de caracteres

    Tabela: modelo de aplicação [cmdb_application_product_model]
    result.data.appModelOwnerId Sys_id do proprietário do modelo da aplicação.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    result.data.appModelOwnerName Nome do proprietário do modelo da aplicação.

    Tipo de dados: cadeia de caracteres
    result.data.appName Nome da aplicação.

    Tipo de dados: cadeia de caracteres
    resultado.dados.erro Informações do erro. Este parâmetro só será retornado se a solicitação falhar.

    Tipo de dados: cadeia de caracteres
    resultado.dados.sdlcTipo Tipo de aplicação.
    Valores possíveis:
    • aplicação
    • infraestrutura

    Tipo de dados: cadeia de caracteres
    resultado.mensagem Informações sobre o resultado bem-sucedido ou malsucedido da solicitação.

    Tipo de dados: cadeia de caracteres
    resultado.status Código de status da solicitação.
    Valores possíveis:
    • 200
    • 400
    • 403

    Tipo de dados: número
    status Status da solicitação. Este parâmetro só será retornado se a solicitação falhar.

    Valor possível: falha

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Este exemplo recupera uma aplicação.

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Corpo da resposta.

    { 
  "result": { 
    "status": 200, 
    "message": "Success", 
    "data": { 
      "appName": "Demo Application 1234", 
      "appId": "38e17dc3473d111072566862736d43c7", 
      "appDescription": "Updated description of Demo Application created from REST API", 
      "sdlcType": "application", 
      "appModelId": "a4e13dc3473d111072566862736d4307", 
      "appModelName": "Demo Application 1234", 
      "appManufacturerId": "262702654725d950a34a3085d36d435e", 
      "appManufacturerName": "", 
      "appModelOwnerId": "6816f79cc0a8016401c5a33be04be441", 
      "appModelOwnerName": "System Administrator", 
      "appManagedByGroups": [] 
    } 
  } 
}

    Solicitação de cURL

    Este exemplo mostra uma resposta de erro quando um usuário fornece um ID de aplicação inválido.

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/18a17de3283d15107256686277777777" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    Resposta de erro.

    { 
  "result": { 
    "status": 400, 
    "message": "No valid Application", 
    "data": { 
      "error": "No valid Application" 
    } 
  } 
}

    Configuração de DevOps - PATCH /devops_config/application/{appid}

    Atualiza uma aplicação.

    Formato da URL

    URL com controle de versão: /api/sn_devops_config/{api_version}/devops_config/application/{appid}

    URL padrão: /api/sn_devops_config/devops_config/application/{appid}

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    appid Sys_id da aplicação a ser atualizada.

    Tipo de dados: cadeia de caracteres

    Tabela: aplicação de CDM [sn_cdm_application]
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 15. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    appDescription Descrição da aplicação.

    Tipo de dados: cadeia de caracteres
    appManagedByGroups Lista separada por vírgulas de sys_ids dos grupos que gerenciam a aplicação. O usuário de chamada deve pertencer a esses grupos.
    "appManagedByGroups": "sys_id, sys_id"

    Tipo de dados: cadeia de caracteres

    Tabela: Grupo [sys_user_group]
    appManufacturerId Sys_id do fabricante.

    Tipo de dados: cadeia de caracteres

    Tabela: Empresa [core_company]
    appModelOwnerId Sys_id do proprietário do modelo da aplicação.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 16. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.
    Tabela 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 18. Códigos de status
    Código do status Descrição
    200 Aplicação atualizada com sucesso.
    403 Proibido. O usuário não tem permissão para acessar a API.
    404 Aplicação não atualizada. A propriedade message no objeto result contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    erro Informações do erro. Este parâmetro só será retornado se a solicitação falhar.

    Tipo de dados: objeto

    "error": {  
   "detail": "String",
   "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o motivo da falha da solicitação.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que contém o motivo da falha na solicitação.

    Tipo de dados: cadeia de caracteres
    resultado Objeto de resultado que contém informações sobre a aplicação.

    Tipo de dados: objeto

    "result": { 
   "data": "String",
   "message": "String"
}
    resultado.dados Sys_id da aplicação.

    Tipo de dados: cadeia de caracteres

    Tabela: aplicação de CDM [sn_cdm_application]
    resultado.mensagem Informações sobre o resultado bem-sucedido ou malsucedido da solicitação.

    Tipo de dados: cadeia de caracteres
    status Status da solicitação. Este parâmetro só será retornado se a solicitação falhar.

    Valor possível: falha

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Este exemplo atualiza uma aplicação existente.

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \ 
--request PATCH \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{ 
  \"appDescription\": \"Updated description of Demo Application created from REST API\", 
  \"appManufacturerId\": \"262702654725d950a34a3085d36d435e\", 
  \"appModelOwnerId\": \"6816f79cc0a8016401c5a33be04be441\" 
}" \ 
--user 'username':'password'

    Corpo da resposta.

    { 
  "result": { 
    "message": "Application with name Demo Application 1234 updated successfully.", 
    "data": "38e17dc3473d111072566862736d43c7" 
  } 
}

    Configuração de DevOps - POST /devops_config/application

    Cria uma aplicação.

    Formato da URL

    URL com controle de versão: /api/sn_devops_config/{api_version}/devops_config/application

    URL padrão: /api/sn_devops_config/devops_config/application

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 21. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    appDescription Descrição da aplicação.

    Tipo de dados: cadeia de caracteres
    appManagedByGroups Lista separada por vírgulas de sys_ids dos grupos que gerenciam a aplicação. O usuário de chamada deve pertencer a esses grupos.
    "appManagedByGroups": "sys_id, sys_id"

    Tipo de dados: cadeia de caracteres

    Tabela: Grupo [sys_user_group]
    appManufacturerId Sys_id do fabricante.

    Tipo de dados: cadeia de caracteres

    Tabela: Empresa [core_company]
    appModelId Sys_id de um modelo de aplicação existente a ser usado para criar a aplicação.

    Se este parâmetro for fornecido, não forneça os parâmetros appName, appModelName, appServiceName, appServiceIdou technicalServiceId.

    Tipo de dados: cadeia de caracteres

    Tabela:Modelo de aplicação [cmdb_application_product_model]
    appModelName Nome de um modelo de aplicação existente a ser usado para criar a aplicação.

    Se este parâmetro for fornecido, não forneça os parâmetros appName, appModelId, appServiceName, appServiceIdou technicalServiceId.

    Tipo de dados: cadeia de caracteres

    Tabela:Modelo de aplicação [cmdb_application_product_model]
    appModelOwnerId Sys_id do proprietário do modelo da aplicação.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    appName Nome da aplicação.

    Não use o mesmo nome de qualquer aplicação existente.

    Se este parâmetro for fornecido, não forneça os parâmetros appModelName, appModelId, appServiceName, appServiceIdou technicalServiceId.

    Tipo de dados: cadeia de caracteres
    appServiceId Sys_id de um serviço de aplicativos existente a ser usado para criar a aplicação.

    Use este parâmetro somente quando type for uma aplicação.

    Se este parâmetro for fornecido, não forneça os parâmetros appName, appModelName, appModelId, appServiceNameou technicalServiceId.

    Tipo de dados: cadeia de caracteres

    Tabela: instância de serviço [cmdb_ci_service_auto]
    appServiceName Nome de um serviço de aplicativos existente a ser usado para criar a aplicação.

    Use este parâmetro somente quando type for uma aplicação.

    Se este parâmetro for fornecido, não forneça os parâmetros appName, appModelName, appModelId, appServiceIdou technicalServiceId.

    Tipo de dados: cadeia de caracteres

    Tabela: instância de serviço [cmdb_ci_service_auto]
    técnicoServiçoId Sys_id de um grupo de IC dinâmico existente a ser usado para criar a aplicação.

    Use este parâmetro somente quando o type for infraestrutura.

    Se este parâmetro for fornecido, não forneça os parâmetros appName, appModelName, appModelId, appServiceNameou appServiceId.

    Tipo de dados: cadeia de caracteres

    Tabela: grupo de ICs dinâmicos [cmdb_ci_query_based_service]
    tipo Obrigatório. O tipo de aplicação a ser criado.
    Valores válidos:
    • aplicação
    • infraestrutura

    Tipo de dados: cadeia de caracteres

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 22. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.
    Tabela 23. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 24. Códigos de status
    Código do status Descrição
    201 Aplicação criada com sucesso.
    403 Proibido. O usuário não tem permissão para acessar a API.
    404 Aplicação não criada. A propriedade message no objeto result contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON)

    Nome Descrição
    erro Informações do erro. Este parâmetro só será retornado se a solicitação falhar.

    Tipo de dados: objeto

    "error": {  
   "detail": "String",
   "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o motivo da falha da solicitação.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que contém o motivo da falha na solicitação.

    Tipo de dados: cadeia de caracteres
    resultado Objeto de resultado que contém informações sobre a aplicação.

    Tipo de dados: objeto

    "result": { 
   "data": "String",
   "message": "String"
}
    resultado.dados Sys_id da aplicação.

    Tipo de dados: cadeia de caracteres

    Tabela: aplicação de CDM [sn_cdm_application]
    resultado.mensagem Informações sobre o resultado bem-sucedido ou malsucedido da solicitação.

    Tipo de dados: cadeia de caracteres
    status Status da solicitação. Este parâmetro só será retornado se a solicitação falhar.

    Valor possível: falha

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Este exemplo mostra como criar uma nova aplicação.

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{ 
  \"type\": \"application\", 
  \"appName\": \"Demo Application 1234\", 
  \"appDescription\": \"Description of Demo Application created from REST API\", 
  \"appManufacturerId\": \"262702654725d950a34a3085d36d435e\", 
  \"appModelOwnerId\": \"6816f79cc0a8016401c5a33be04be441\" 
}" \ 
--user 'username':'password'

    Corpo da resposta.

    { 
  "result": { 
    "message": "Application with name Demo Application 1234 created successfully.", 
    "data": "38e17dc3473d111072566862736d43c7" 
  } 
}