API de configuração do DevOps

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 12 min. de leitura

    • . Configuração do DevOps A API fornece endpoints para gerenciar suas aplicações.

    Esta API requer Configuração de DevOps e é fornecido em sn_devops_config namespace.

    Para operações DE EXCLUSÃO, PATCH e PÓS, o usuário chamador deve ter a função sn_devops_config.admin. Para operações GET, o usuário chamador deve ter a função sn_devops_config.viewer ou sn_devops_config.admin.

    Use Configuração do DevOps API 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 Configuração da Configuração do DevOps .

    DevOps Config - EXCLUA /devops_config/appid

    Exclui uma aplicação.

    Formato de URL

    URL com controle de versão: /api/sn_devops_config/

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

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de 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 acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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 CDM [sn_cdm_application]
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 3. Solicitar parâmetros do corpo (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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da 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 de 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 de erro. Este parâmetro só será retornado se a solicitação falhar.

    Tipo de dados: Objeto

    "error": {  
   "detail": "String",
   "message": "String"
}
    error.detail 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 do DevOps - OBTENHA /devops_config/appid

    Recupera uma aplicação.

    Formato de URL

    URL com controle de versão: /api/sn_devops_config/

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

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de 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 acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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 CDM [sn_cdm_application]
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 9. Solicitar parâmetros do corpo (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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da 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 de 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 de erro. Este parâmetro só será retornado se a solicitação falhar.

    Tipo de dados: Objeto

    "error": {  
   "detail": "String",
   "message": "String"
}
    error.detail 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
}
    result.data 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
    AppId.result.data.appId Sys_id da aplicação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Aplicação 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 de aplicação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de aplicação [cmdb_application_product_model]
    Result.data.appModelName Nome do modelo de 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 de aplicação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    Result.data.appModelOwnerName Nome do responsável pelo modelo de aplicação.

    Tipo de dados: Cadeia de caracteres
    Result.data.AppName Nome da aplicação.

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

    Tipo de dados: Cadeia de caracteres
    Result.data.sdlcType 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
    result.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" 
    } 
  } 
}

    DevOps Config - PATCH /devops_config/appid

    Atualiza uma aplicação.

    Formato de URL

    URL com controle de versão: /api/sn_devops_config/

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

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de 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 acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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 CDM [sn_cdm_application]
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 15. Solicitar parâmetros do corpo (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 chamador 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 de 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da 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. . messagepropriedade em resulto objeto contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON)

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

    Tipo de dados: Objeto

    "error": {  
   "detail": "String",
   "message": "String"
}
    error.detail 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"
}
    result.data Sys_id da aplicação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Aplicação 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 do DevOps - POST /devops_config/application

    Cria uma aplicação.

    Formato de 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 em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de 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 acessado. Por exemplo, v1 ou v2 . Especifique este valor somente 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. Solicitar parâmetros do corpo (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 chamador 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 appName, appModelName, appServiceName, appServiceIdou technicalServiceIdparâmetros.

    Tipo de dados: Cadeia de caracteres

    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 appName, appModelId, appServiceName, appServiceIdou technicalServiceIdparâmetros.

    Tipo de dados: Cadeia de caracteres

    Modelo de aplicação [cmdb_application_product_model]
    AppModelOwnerId Sys_id do proprietário do modelo de 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 appModelName, appModelId, appServiceName, appServiceIdou technicalServiceIdparâmetros.

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

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

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

    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. aplicação .

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

    Tipo de dados: Cadeia de caracteres

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

    Use este parâmetro somente quando type. infraestrutura .

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Grupo de IC dinâmico [cmdb_ci_query_based_service]
    tipo Obrigatório. O tipo de aplicação a ser criada.
    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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da 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. . messagepropriedade em resulto objeto contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON)

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

    Tipo de dados: Objeto

    "error": {  
   "detail": "String",
   "message": "String"
}
    error.detail 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"
}
    result.data Sys_id da aplicação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Aplicação 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" 
  } 
}