---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference
Release :
- xanadu
ft:locale :
- pt-BR
ft:publication_title :
- Referência de API do Xanadu
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# APICdmApplications
# APICdmApplications {#ariaid-title1}
* Versão de lançamento: Xanadu
*
* Atualizado 1 de ago. de 2024
*
*  72 min. de leitura
A CdmApplicationsApi fornece endpoints que permitem carregar dados de configuraçãozoominsoftware.io/utah- devops/ para as pastas de variável de componente, coleção, implantável e de componente encontradas na IU do espaço Configuração de DevOps. Ele também tem endpoints que permitem exportar dados de configuração implantáveis para o pipeline DevOps e gerenciar componentes e aplicações compartilhados.
Os endpoints de exportação e upload usam uma implementação de enfileiramento assíncrona. Com este tipo de implementação, você primeiro chama o endpoint de solicitação de exportação ou carregamento desejado. Esses endpoints enfileiram sua solicitação e retornam um identificador de solicitação. Em seguida, você usa este identificador de solicitação para chamar o endpoint de status apropriado, um para uploads e um diferente para exportações, para obter o status do upload/exportação. Para solicitações de exportação, quando a exportação estiver concluída, você também poderá solicitar o conteúdo da exportação.
Esta API não fornece endpoints que executam a recuperação simples de registros de aplicações. Para recuperar esses registros, use a API [de tabela](https://servicenow-prod.fluidtopics.net/4xLP4HFNgOVYWze_ozFdZw#c_TableAPI "A API da tabela fornece endpoints que permitem executar operações de criação, leitura, atualização e exclusão (CRUD) em tabelas existentes.").
Você deve ter uma das seguintes funções para acessar esta API:
* ACL de exibição do CDM REST de script (sn_cdm.cdm.viewer)
* ACL do Editor do CDM de REST de script (sn_cdm.cdm_editor)
Além disso, o plug-in Gestão de dados de configuração (CDM) deve ser ativado para que esta API esteja disponível em uma instância.
Para obter informações adicionais sobre Gestão de dados de configuração e a IU do espaço Configuração de DevOps, consulte [Como carregar seus dados de configuração](https://www.servicenow.com/docs/access?context=cdm-upload-process&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US).
Para obter informações adicionais sobre componentes compartilhados e bibliotecas compartilhadas, consulte [Compartilhamento de componentes entre aplicações --- Bibliotecas de componentes](https://www.servicenow.com/docs/access?context=cdm-component-libraries&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US).
## CdmApplicationsApi - DELETE /sn_cdm/applications/deployables {#ariaid-title2}
Exclui um implantável de Gestão de dados de configuração (CDM) especificado.
O solicitante deste endpoint deve ter a função de administrador do CDM.
### Formato da URL {#apps-DELETE-applications-deploys__section_tqf_h2n_qtb}
URL com controle de versões: /api/sn_cdm/{api_version}/applications/deployables
URL padrão: /api/sn_cdm/applications/deployables
### Parâmetros de solicitação compatíveis
{#apps-DELETE-applications-deploys__entry__2}{#apps-DELETE-applications-deploys__version-RESTAPI}
| 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 1. Parâmetros de caminho]
{#apps-DELETE-applications-deploys__entry__6}
| Nome | Descrição |
|-|-|
| appName | Obrigatório. Nome da aplicação de CDM à qual o implantável está associado. Localizado na tabela CDM implantável \[sn_cdm_deployable\]. Tipo de dados: cadeia de caracteres |
| nome | Nome do implantável a ser excluído. Localizado na tabela CDM implantável \[sn_cdm_deployable\]. Tipo de dados: cadeia de caracteres |
[Tabela 2. Parâmetros de consulta]
{#apps-DELETE-applications-deploys__entry__12}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 3. Parâmetros do corpo da solicitação]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-DELETE-applications-deploys__entry__16}{#apps-DELETE-applications-deploys__accept-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 4. Cabeçalhos da solicitação]
{#apps-DELETE-applications-deploys__entry__20}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 5. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-DELETE-applications-deploys__entry__24}{#apps-DELETE-applications-deploys__entry-200-status-code}{#apps-DELETE-applications-deploys__entry-400-status-code}{#apps-DELETE-applications-deploys__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 6. Códigos de status]
### Parâmetros do corpo da resposta
{#apps-DELETE-applications-deploys__entry__32}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[ ]
### Solicitação de cURL
O exemplo de código a seguir mostra como remover um implantável.
curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables?appName=testApp&name=Dep-1" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password1'
Para uma exclusão bem-sucedida do implantável, nenhuma resposta é retornada além do código de status HTTP.
None - results defined by the HTTP status code
## CdmApplicationsApi - DELETE /sn_cdm/applications/shared_components {#ariaid-title3}
Remove a referência de uso do componente compartilhado de uma aplicação Gestão de dados de configuração (CDM) especificada.
A função de administrador do CDM é necessária para acessar este endpoint.
### Formato da URL {#apps-DELETE-shared_components__section_lbh_bp1_fwb}
URL com controle de versão: /api/sn_cdm/{api_version}/applications/shared_components
URL padrão: /api/sn_cdm/applications/shared_components
### Parâmetros de solicitação compatíveis
{#apps-DELETE-shared_components__entry__2}{#apps-DELETE-shared_components__version-RESTAPI}
| 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 7. Parâmetros de caminho]
{#apps-DELETE-shared_components__entry__6}{#apps-DELETE-shared_components__changesetNumber-changeset-entry}
| Nome | Descrição |
|-|-|
| appName | Obrigatório. Nome da aplicação da qual a associação de componente compartilhado especificada será removida. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. A aplicação especificada deve ter o campo de tipo definido como "shared_library". Tipo de dados: cadeia de caracteres |
| changesetNumber | Obrigatório. Identificador exclusivo do changeset associado, como "Chset-10". Localizado na tabela CDMChangeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres |
| sharedComponentName | Obrigatório. Nome exclusivo do componente compartilhado a ser removido da aplicação especificada. Localizado na tabela Componente compartilhado do CDM \[sn_cdm_shared_component\]. Tipo de dados: cadeia de caracteres |
[Tabela 8. Parâmetros de consulta]
{#apps-DELETE-shared_components__entry__14}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 9. Parâmetros do corpo da solicitação]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-DELETE-shared_components__entry__18}{#apps-DELETE-shared_components__accept-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
[Tabela 10. Cabeçalhos da solicitação]
{#apps-DELETE-shared_components__entry__22}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 11. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-DELETE-shared_components__entry__26}{#apps-DELETE-shared_components__entry-200-status-code}{#apps-DELETE-shared_components__entry-400-status-code}{#apps-DELETE-shared_components__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 12. Códigos de status]
### Parâmetros do corpo da resposta
{#apps-DELETE-shared_components__entry__34}
| Nome | Descrição |
|-|-|
| resultado | Vazio. O código de status HTTP indica o resultado da chamada. |
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| status | Status de erro da solicitação. Valores possíveis: falha Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
O exemplo de código a seguir mostra como excluir o componente compartilhado "paymentService-V1.1" da aplicação "App1".
curl "https://instance-name.service-now.com/api/sn_cdm/applications/shared_components?appName=App1&sharedComponentName=paymentService-V1.1&changesetNumber=Chset-25" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'
Resposta:
""
## CdmApplicationsApi -- GET /sn_cdm/applications/deployables/exports/{export_id}/content {#ariaid-title4}
Retorna o conteúdo associado a uma solicitação de exportação de dados de configuração especificada.
Chame este endpoint somente depois de ter recebido uma resposta completa do endpoint [CdmApplicationsApi -- GET /sn_cdm/applications/deployables/exports/{export_id}/status](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-deploy-exports-status "Retorna o status atual da solicitação de exportação de dados de configuração especificada."). Se você chamar este endpoint antes que a exportação seja concluída, um erro de status 400 será retornado.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/applications/deployables/exports/{export_id}/content
URL padrão: /api/sn_cdm/applications/deployables/exports/{export_id}/content
### Parâmetros de solicitação compatíveis
{#apps-GET-deploy-exports-content__entry__2}{#apps-GET-deploy-exports-content__version-RESTAPI}
| 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 |
| export_id | Identificador exclusivo da solicitação de exportação cujos dados de configuração serão retornados. Este valor é retornado pelo endpoint [CdmApplicationsApi -- POST /sn_cdm/applications/deployables/exports](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-POST-deploy-exports "Envia uma solicitação para exportar o snapshot atual de uma aplicação especificada e um ou mais implantáveis para a tabela Cache do exportador do CDM [sn_cdm_exporter_cache]."). |
[Tabela 13. Parâmetros de caminho]
{#apps-GET-deploy-exports-content__entry__8}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 14. Parâmetros de consulta]
{#apps-GET-deploy-exports-content__entry__12}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-GET-deploy-exports-content__entry__16}{#apps-GET-deploy-exports-content__accept-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 16. Cabeçalhos da solicitação]
{#apps-GET-deploy-exports-content__entry__20}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 17. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-GET-deploy-exports-content__entry__24}{#apps-GET-deploy-exports-content__entry-200-status-code}{#apps-GET-deploy-exports-content__entry-400-status-code}{#apps-GET-deploy-exports-content__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 18. Códigos de status]
### Parâmetros do corpo da resposta (JSON ou XML)
{#apps-GET-deploy-exports-content__entry__32}
| Nome | Descrição |
|-|-|
| erros | Descrição dos erros encontrados durante a exportação. Tipo de dados: cadeia de caracteres |
| export_id | ID da solicitação de exportação. Igual ao passado para o endpoint. Tipo de dados: cadeia de caracteres |
| resultado_exportador | Conteúdo da exportação de dados de configuração especificada. Tipo de dados: * Objeto JSON: se a solicitação fosse para exportar dados no formato JSON. * Cadeia de caracteres: se a solicitação fosse para exportar dados em qualquer outro formato. {#apps-GET-deploy-exports-content__ul_xk1_2j1_psb} |
| request_id | ID da solicitação de exportação. Igual ao passado para o endpoint. Tipo de dados: cadeia de caracteres |
| estado | Estado atual da exportação especificada. Valor da coluna de estado na tabela Fila de solicitações do CDM \[sn_cdm_request_queue\]. Valores possíveis: * concluído * erro * em_andamento * novo * pronto Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
O exemplo a seguir solicita os dados de configuração de uma solicitação de exportação com o ID 3ab14a7d53b1301096edddeeff7b12f.
curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/exports/3ab14a7d53b1301096edddeeff7b12f/content" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Veja a seguir os resultados de retorno possíveis.
// Successful completion of the export request
{
"result": {
"export_id": "3ab14a7d53b1301096edddeeff7b12f"
"exporter_result": "DEP1.COMP.cdi_1=cdi-1-value"
}
}
// Response when an incorrect export_id is passed. Note: Status code is 200.
{
"result": {
"request_id": "3ab14a7d53b1301096edddeeff7b12e",
"state": "error",
"errors": "Invalid requestId '3ab14a7d53b1301096edddeeff7b12fe'",
"export_id": "3ab14a7d53b1301096edddeeff7b12e"
}
}
## CdmApplicationsApi -- GET /sn_cdm/applications/deployables/exports/{export_id}/status {#ariaid-title5}
Retorna o status atual da solicitação de exportação de dados de configuração especificada.
Use o endpoint [CdmApplicationsApi -- POST /sn_cdm/applications/deployables/exports](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-POST-deploy-exports "Envia uma solicitação para exportar o snapshot atual de uma aplicação especificada e um ou mais implantáveis para a tabela Cache do exportador do CDM [sn_cdm_exporter_cache].") para fazer uma solicitação de exportação.
### Formato da URL
URL com controle de versões: /api/sn_cdm/{api_version}/applications/deployables/exports/{export_id}/status
URL padrão: /api/sn_cdm/applications/deployables/exports/{export_id}/status
### Parâmetros de solicitação compatíveis
{#apps-GET-deploy-exports-status__entry__2}{#apps-GET-deploy-exports-status__version-RESTAPI}
| 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 |
| export_id | Sys_id da solicitação de exportação cujo status será retornado. Este valor é retornado pelo endpoint [CdmApplicationsApi -- POST /sn_cdm/applications/deployables/exports](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-POST-deploy-exports "Envia uma solicitação para exportar o snapshot atual de uma aplicação especificada e um ou mais implantáveis para a tabela Cache do exportador do CDM [sn_cdm_exporter_cache]."). |
[Tabela 19. Parâmetros de caminho]
{#apps-GET-deploy-exports-status__entry__8}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 20. Parâmetros de consulta]
{#apps-GET-deploy-exports-status__entry__12}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 21. Parâmetros do corpo da solicitação (XML ou JSON)]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-GET-deploy-exports-status__entry__16}{#apps-GET-deploy-exports-status__accept-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 22. Cabeçalhos da solicitação]
{#apps-GET-deploy-exports-status__entry__20}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 23. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-GET-deploy-exports-status__entry__24}{#apps-GET-deploy-exports-status__entry-200-status-code}{#apps-GET-deploy-exports-status__entry-400-status-code}{#apps-GET-deploy-exports-status__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 24. Códigos de status]
### Parâmetros do corpo da resposta (JSON ou XML)
{#apps-GET-deploy-exports-status__entry__32}
| Nome | Descrição |
|-|-|
| erros | Descrição dos erros encontrados durante a exportação. Tipo de dados: cadeia de caracteres |
| export_id | ID da solicitação de exportação. Igual ao passado para o endpoint. Tipo de dados: cadeia de caracteres |
| resultado_exportador | Detalhes sobre o erro associado. Tipo de dados: objeto |
| resultados_exportador.erros | Descrição dos erros encontrados durante a exportação. Tipo de dados: matriz |
| exportador_result.execution_id | Identificador exclusivo do registro de execução do exportador. Localizado na tabela sn_cdm_exporter_execution. Tipo de dados: cadeia de caracteres |
| resultado_exportador.estado | Estado atual da exportação especificada. Localizado na tabela sn_cdm_exporter_execution. Valores possíveis: * concluída * erro * em_andamento * novo {#apps-GET-deploy-exports-status__ul_k3z_32r_ssb} Tipo de dados: cadeia de caracteres |
| request_id | ID da solicitação de exportação. Igual ao passado para o endpoint. Tipo de dados: cadeia de caracteres |
| estado | Estado atual da exportação especificada. Valor da coluna de estado na tabela Fila de solicitações do CDM \[sn_cdm_request_queue\]. Valores possíveis: * concluído * erro * em_andamento * novo * pronto Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
O exemplo a seguir solicita o status de uma exportação com o ID 3ab14a7d53b1301096edddeeff7b12f.
curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/exports/3ab14a7d53b1301096edddeeff7b12f/status" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
A seguir estão os resultados de retorno possíveis.
// Successful completion of the export request
{
"result": {
"state": "completed",
"export_id": "3ab14a7d53b1301096edddeeff7b12f0"
}
}
// Response when an incorrect export_id is passed. Note: Status code is 200.
{
"result": {
"request_id": "3ac8e1b05311301096edddeeff7b123c",
"state": "error",
"errors": "Invalid requestId '3ac8e1b05311301096edddeeff7b123c'",
"export_id": "3ac8e1b05311301096edddeeff7b123c"
}
}
// Response when the export encounters an error. The exporter_result array contains the error information. Note: Status code is 200.
{
"result": {
"state": "completed",
"export_id": "24536c3353f9301096edddeeff7b12b1",
"exporter_result": {
"execution_id": "81536c3353f9301096edddeeff7b129e",
"state": "failure",
"errors": [
"Snapshot 'SNA-001-published-non_compliant' has not passed validation. All snapshots of deployable '/ApplicationA/deployables/DEP3' are required to pass validation"
]
}
}
}
## CdmApplicationsApi - GET /sn_cdm/applications/shared_components {#ariaid-title6}
Retorna a lista de componentes compartilhados usados por uma aplicação especificada. Você também pode especificar para retornar somente os componentes compartilhados que têm uma nova versão disponível.
A função de administrador do CDM é necessária para acessar este endpoint.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/applications/shared_components
URL padrão: /api/sn_cdm/applications/shared_components
### Parâmetros de solicitação compatíveis
{#apps-GET-shared_components__entry__2}{#apps-GET-shared_components__version-RESTAPI}
| 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 25. Parâmetros de caminho]
{#apps-GET-shared_components__entry__6}
| Nome | Descrição |
|-|-|
| appName | Obrigatório. Nome da aplicação cuja lista de componentes compartilhados você deseja retornar. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. O campo de tipo da aplicação deve ser definido como shared_library. Tipo de dados: cadeia de caracteres |
| withUpdatesOnly | Sinalizador que indica se somente os componentes compartilhados que têm uma nova versão atualizada disponível devem ser retornados. Valores válidos: * verdadeiro: retorna somente componentes compartilhados que têm uma nova versão atualizada disponível. * falso: retorna todos os componentes compartilhados usados pela aplicação especificada. Padrão: falso |
[Tabela 26. Parâmetros de consulta]
{#apps-GET-shared_components__entry__12}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 27. Parâmetros do corpo da solicitação (XML ou JSON)]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-GET-shared_components__entry__16}{#apps-GET-shared_components__accept-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
[Tabela 28. Cabeçalhos da solicitação]
{#apps-GET-shared_components__entry__20}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 29. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-GET-shared_components__entry__24}{#apps-GET-shared_components__entry-200-status-code}{#apps-GET-shared_components__entry-400-status-code}{#apps-GET-shared_components__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 30. Códigos de status]
### Parâmetros do corpo da resposta
{#apps-GET-shared_components__entry__32}
| Nome | Descrição |
|-|-|
| currentVersion | Versão atual da aplicação CDM. Tipo de dados: inteiro |
| currentVersionName | Nome da versão do componente compartilhado atualmente em uso. Tipo de dados: cadeia de caracteres |
| descrição | Descrição do componente compartilhado. Tipo de dados: cadeia de caracteres |
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| nome | Nome exclusivo do componente compartilhado. Tipo de dados: cadeia de caracteres |
| sharedLibraryName | Nome da biblioteca compartilhada à qual o componente compartilhado pertence. Tipo de dados: cadeia de caracteres |
| status | Status de erro da solicitação. Valores possíveis: falha Tipo de dados: cadeia de caracteres |
| updateVersionName | Nome da versão do componente compartilhado disponível para atualização. Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
O exemplo de código a seguir mostra como chamar este endpoint para recuperar os componentes compartilhados que têm uma nova versão usada por "App1".
curl "https://instance-name.service-now.com/api/sn_cdm/applications/shared_components?updatesOnly=true&appName=App1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Resposta:
{
"result": [
{
"name": "Component_Name",
"description": "",
"sharedLibraryName": "Shared Library",
"currentVersion": "2",
"currentVersionName": "Component_A-v2.shc",
"updateVersionName": "Component_A-v3.shc"
}
]
}
## CdmApplicationsApi -- GET /sn_cdm/applications/shared_libraries/components/applications {#ariaid-title7}
Retorna um mapa de componentes compartilhados e as aplicações que os usam e que estão em uma biblioteca especificada.
A função de administrador do CDM é necessária para acessar este endpoint.
### Formato da URL
URL com controle de versões: /api/sn_cdm/{api_version}/applications/shared_libraries/components/applications
URL padrão: /api/sn_cdm/applications/shared_libraries/components/applications
### Parâmetros de solicitação compatíveis
{#apps-GET-shared_libs-comp-apps__entry__2}{#apps-GET-shared_libs-comp-apps__version-RESTAPI}
| 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 31. Parâmetros de caminho]
{#apps-GET-shared_libs-comp-apps__entry__6}
| Nome | Descrição |
|-|-|
| sharedComponentName | Obrigatório. Nome do componente compartilhado a ser incluído no mapa. Localizado na tabela Componente compartilhado do CDM \[sn_cdm_shared_component\]. Tipo de dados: cadeia de caracteres |
| sharedLibraryName | Obrigatório. Nome da biblioteca compartilhada a ser incluída no mapa. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. A aplicação especificada deve ter o campo de tipo definido como "shared_library". Tipo de dados: cadeia de caracteres |
[Tabela 32. Parâmetros de consulta]
{#apps-GET-shared_libs-comp-apps__entry__12}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 33. Parâmetros do corpo da solicitação]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-GET-shared_libs-comp-apps__entry__16}{#apps-GET-shared_libs-comp-apps__accept-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
[Tabela 34. Cabeçalhos da solicitação]
{#apps-GET-shared_libs-comp-apps__entry__20}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 35. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-GET-shared_libs-comp-apps__entry__24}{#apps-GET-shared_libs-comp-apps__entry-200-status-code}{#apps-GET-shared_libs-comp-apps__entry-400-status-code}{#apps-GET-shared_libs-comp-apps__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 36. Códigos de status]
### Parâmetros do corpo da resposta
{#apps-GET-shared_libs-comp-apps__entry__32}
| Nome | Descrição |
|-|-|
| descrição | Descrição da aplicação usando o componente compartilhado Tipo de dados: cadeia de caracteres |
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| managed_by_group | Lista separada por vírgulas de sys_ids dos grupos que podem gerenciar a aplicação. Tipo de dados: cadeia de caracteres |
| nome | Nome exclusivo da aplicação que usa o componente. Tipo de dados: cadeia de caracteres |
| status | Status de erro da solicitação. Valores possíveis: falha Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da aplicação que utiliza o componente compartilhado. Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
O exemplo de código a seguir mostra como chamar este endpoint para recuperar o mapa que mostra as aplicações na biblioteca compartilhada "OracleG-Library-10" que usam o componente compartilhado "paymentService-V1.1".
curl "https://instance-name.service-now.com/api/sn_cdm/applications/shared_libraries/components/applications?sharedLibraryName=OracleG-Library-10&sharedComponentName=paymentService-V1.1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Resposta:
{
"result": {
"component_name": [
{
"name": "App Name",
"description": "desc",
"managed_by_group": null,
"sys_id": "4e7808bb1b371110636e0fe0604bcb08"
},
{
"name": "Config App",
"description": "desc",
"managed_by_group": null,
"sys_id": "55a75cfb1b771110636e0fe0604bcb5c"
},
{
"name": "Database App",
"description": "desc",
"managed_by_group": null,
"sys_id": "2eb7503f1b771110636e0fe0604bcb06"
}
]
}
}
## CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id} {#ariaid-title8}
Retorna o status atual da solicitação de carregamento de dados de configuração especificada.
### Formato da URL {#apps-GET-upload-status__section_isc_fy3_psb}
URL com controle de versões: /api/sn_cdm/{api_version}/applications/upload-status/{upload_id}
URL padrão: /api/sn_cdm/applications/upload-status/{upload_id}
### Parâmetros de solicitação compatíveis
{#apps-GET-upload-status__entry__2}{#apps-GET-upload-status__version-RESTAPI}
| 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 |
| upload_id | Sys_id da solicitação de upload cujo status será retornado. Este valor é retornado pelos vários endpoints de solicitação de carregamento de CdmApplications. |
[Tabela 37. Parâmetros de caminho]
{#apps-GET-upload-status__entry__8}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 38. Parâmetros de consulta]
{#apps-GET-upload-status__entry__12}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 39. Parâmetros do corpo da solicitação (XML ou JSON)]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-GET-upload-status__entry__16}{#apps-GET-upload-status__accept-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 40. Cabeçalhos da solicitação]
{#apps-GET-upload-status__entry__20}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 41. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-GET-upload-status__entry__24}{#apps-GET-upload-status__entry-200-status-code}{#apps-GET-upload-status__entry-400-status-code}{#apps-GET-upload-status__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 42. Códigos de status]
### Parâmetros do corpo da resposta (JSON ou XML)
{#apps-GET-upload-status__entry__32}
| Nome | Descrição |
|-|-|
| erros | Descrição dos erros encontrados durante o upload. Tipo de dados: cadeia de caracteres |
| saída | Descrição dos dados carregados ou, se ocorreu um erro durante o carregamento, uma mensagem de erro descrevendo o erro encontrado. Tipo de dados: matriz de cadeia de caracteres "output": { "auto_validate": "String", "cdm_application": "String", "committed_at": "String", "committed_by": "String", "description": "String", "last_conflict_detection_time": "String", "number": "String", "publish_option": "String", "snapshot_description": "String", "snapshot_name": "String", "state": "String", "sys_created_by": "String", "sys_id": "String", "title": "String" } |
| saída.auto_validate | Indica se a validação deve ser invocada após a confirmação. Tipo de dados: cadeia de caracteres |
| saída.cdm_aplicação | Nome da aplicação sob a qual o upload foi realizado. Tipo de dados: cadeia de caracteres |
| saída.comprometida_em | Data e hora em que o conteúdo carregado foi confirmado. Tipo de dados: cadeia de caracteres |
| saída.comprometida_por | Sys_id do registro da entidade que realizou a confirmação. Tipo de dados: cadeia de caracteres |
| saída.descrição | Não usado no momento. Tipo de dados: cadeia de caracteres |
| output.last_conflict_detection_time | Invocação de detecção de conflitos de data e hora. Tipo de dados: cadeia de caracteres |
| saída.número | Número exclusivo do changeset. Tipo de dados: cadeia de caracteres |
| saída.publish_option | Opção de publicação para os snapshots configurados associados. Valores válidos: * publicar_none: não publicar nenhum snapshot. * Public_valid: publique somente os snapshots aprovados na validação após a confirmação. Para obter informações adicionais sobre como publicar snapshots, consulte [Publicar ou cancelar a publicação de um snapshot](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres Padrão: publicar_none Nota: Esta opção só estará disponível se o valor do parâmetro autoCommit for verdadeiro. |
| output.snapshot_description | Descrição do snapshot associado. Tipo de dados: cadeia de caracteres |
| saída.snapshot_name | Nome do snapshot associado. Tipo de dados: cadeia de caracteres |
| saída.estado | Estado do conteúdo de carregamento. Valores possíveis: * bloqueado * verificação_para_conflito * confirmação_falha * confirmação_em_progresso * confirmado * em aberto {#apps-GET-upload-status__ul_qhn_w4p_psb} Tipo de dados: cadeia de caracteres |
| saída.sys_created_by | Sys_id da entidade que criou o registro. Tipo de dados: cadeia de caracteres |
| saída.sys_id | Sys_id do registro que contém o changeset. Tipo de dados: cadeia de caracteres |
| saída.título | Título do changeset criado como parte do upload. Tipo de dados: cadeia de caracteres |
| processando_estado | Estado de processamento atual da solicitação de upload. Valores possíveis: * NÃO_PROCESSADO * PROCESSADO {#apps-GET-upload-status__ul_gmt_2pp_psb} Tipo de dados: cadeia de caracteres |
| estado | Estado atual da solicitação de upload. Valores possíveis: * concluído * erro * em_andamento * novo * pronto {#apps-GET-upload-status__ul_ozn_bv5_xsb} |
| tipo | Tipo de solicitação de upload. Valores possíveis: * confirmar * exportar * carregar_e_confirmar {#apps-GET-upload-status__ul_l5m_x55_xsb} Tipo de dados: cadeia de caracteres |
| upload_id | Sys_id da solicitação de upload. Use este ID para chamar o endpoint [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-upload-status "Retorna o status atual da solicitação de carregamento de dados de configuração especificada.") para obter o status do carregamento. Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
O exemplo a seguir mostra a solicitação do status de um upload com o ID 5560a6895326301096edddeeff7b1230.
curl "http://instance.servicenow.com/api/sn_cdm/applications/upload-status/5560a6895326301096edddeeff7b1230" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
A seguir estão os resultados de retorno possíveis.
// Successful completion of the upload request
{
"result": {
"type": "upload_and_commit",
"state": "completed",
"output": {
"sys_id": "be681dc95362301096edddeeff7b12ba",
"number": "Chset-102",
"title": "admin2021-09-10 08:09:07",
"description": null,
"committed_at": "2021-09-10 20:23:37",
"committed_by": "6816f79cc0a8016401c5a33be04be441",
"sys_created_by": "admin",
"state": "committed",
"publish_option": "publish_none",
"auto_validate": false,
"snapshot_name": null,
"snapshot_description": null,
"cdm_application": "Demo_App1631126164773",
"last_conflict_detection_time": "1631305417894"
},
"processing_state": "PROCESSED",
"upload_id": "5560a6895326301096edddeeff7b1230"
}
}
// Response when an incorrect upload_id is passed. Note: Status code is 200.
{
"result": {
"state": "error",
"errors": "Invalid requestId '5560a6895326301096edddeeff7b1240'",
"upload_id": "5560a6895326301096edddeeff7b1240"
}
}
// Response when the upload encounters an error. The exporter_result array contains the error information. Note: Status code is 200.
{
"result": {
"type": "upload_and_commit",
"state": "error",
"output": "Error encountered during execution of request.\nError: Node 'dbSettings' of type 'sg_cdm_node_component' cannot create child 'dbSettings' of type 'sg_cdm_node_folder'",
"processing_state": "PROCESSED",
"upload_id": "272f8a415326301096edddeeff7b1232"
}
}
## CdmApplicationsApi -- POST /sn_cdm/applications/deployables {#ariaid-title9}
Cria um novo implantável e o conecta automaticamente a uma aplicação Gestão de dados de configuração (CDM) especificada.
Você pode criar um implantável para qualquer um dos três tipos de ambiente: Desenvolvimento, Teste ou Produção.
Para acessar este endpoint, o solicitante deve ter a função de administrador do CDM.
Se você precisar criar vários implantáveis, use o endpoint [CdmApplicationsApi -- POST /sn_cdm/applications/deployables/create](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-POST-deploy-create "Cria um ou mais novos implantáveis.").
### Formato da URL
URL com controle de versões: /api/sn_cdm/{api_version}/applications/deployables
URL padrão: /api/sn_cdm/applications/deployables
### Parâmetros de solicitação compatíveis
{#apps-POST-applications-deploys__entry__2}{#apps-POST-applications-deploys__version-RESTAPI}
| 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 43. Parâmetros de caminho]
{#apps-POST-applications-deploys__entry__6}{#apps-POST-applications-deploys__cdm_apps-envType-entry}{#apps-POST-applications-deploys__cdm_apps-returnFields-entry}
| Nome | Descrição |
|-|-|
| appName | Obrigatório. Nome de uma aplicação de CDM ativa existente a ser associada ao implantável. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. Tipo de dados: cadeia de caracteres |
| envType | Obrigatório. Tipo de ambiente para o implantável. Valores válidos (diferencia maiúsculas de minúsculas): * Desenvolvimento * Produção * Teste Nota: O tipo de ambiente implantável não pode ser alterado após a criação. Tipo de dados: cadeia de caracteres |
| nome | Obrigatório. Nome do implantável do CDM. Não deve ter mais de 255 caracteres. Os caracteres padrão permitidos são 0-9, AZ, az, _, -,., %, $, espaço em branco, :, #. Tipo de dados: cadeia de caracteres Tamanho máximo: 255 caracteres Caracteres permitidos: 0-9, AZ, az, _, -, ., %, $, espaço em branco, : e # |
| returnFields | Lista de campos a serem retornados como parte da resposta. Passe os nomes da coluna de registro, como sys_id, sys_updated_by ou state. Tipo de dados: matriz Padrão: todos os campos determinados pelo endpoint |
[Tabela 44. Parâmetros de consulta]
{#apps-POST-applications-deploys__entry__16}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 45. Parâmetros do corpo da solicitação]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-applications-deploys__entry__20}{#apps-POST-applications-deploys__accept-JSON-only-entry-RESTAPI}{#apps-POST-applications-deploys__content_type-JSON-only-entry-RESTAPI}
| 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 46. Cabeçalhos da solicitação]
{#apps-POST-applications-deploys__entry__26}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 47. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-applications-deploys__entry__30}{#apps-POST-applications-deploys__entry-200-status-code}{#apps-POST-applications-deploys__entry-400-status-code}{#apps-POST-applications-deploys__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 48. Códigos de status]
### Parâmetros do corpo da resposta
{#apps-POST-applications-deploys__id_dkr_tdn_qtb__entry__2}{#apps-POST-applications-deploys__cdm_app_link-app-entry}{#apps-POST-applications-deploys__cdm_app_value-app-entry}{#apps-POST-applications-deploys__cdm_apps-error-entry}{#apps-POST-applications-deploys__cdm_dep-sys_created_by-row}{#apps-POST-applications-deploys__cdm_deps-sys_created_on-row}{#apps-POST-applications-deploys__cdm_dep-sys_updated_by-row}{#apps-POST-applications-deploys__cdm_dep-sys_updated_on-row}
| Nome | Descrição |
|-|-|
| cdi_count | Número de itens de dados de configuração (CDIs) contidos na aplicação de CDM associada. Tipo de dados: inteiro |
| cdi_usage | Porcentagem dos CDIs usados pelo implantável. Tipo de dados: inteiro |
| cdm_app | Objeto de aplicação do CDM associado ao implantável. Tipo de dados: objeto "cdm_app": { "link": "String", "value": "String" } |
| cdm_app.link | Chamada para usar para acessar o registro da aplicação CDM usando a REST Table API. Tipo de dados: cadeia de caracteres |
| cdm_app.value | Sys_id do registro da aplicação CDM associado. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. Tipo de dados: cadeia de caracteres |
| cdm_ci | Objeto de serviço de aplicações associado ao implantável. Tipo de dados: objeto "cdm_ci": { "link": "String", "value": "String" } |
| cdm_ci.link | Chamada para usar para acessar o registro de serviço de aplicativos usando a REST Table API. Tipo de dados: cadeia de caracteres |
| cdm_ci.value | Sys_id do registro de serviço de aplicações associado. Localizado na tabela Item de configuração \[cmdb_ci\]. Tipo de dados: cadeia de caracteres |
| descrição | Descrição do implantável do CDM gerado. Tipo de dados: cadeia de caracteres |
| tipo_ambiente | Tipo de ambiente do implantável. Valores possíveis: * Desenvolvimento * Produção * Teste Tipo de dados: cadeia de caracteres |
| erro | Retornado somente se ocorreu um erro durante o processamento. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| nome | Nome do implantável do CDM. Tipo de dados: cadeia de caracteres |
| node | Detalhes sobre o nó implantável. Tipo de dados: objeto "node": { "link": "String", "value": "String" } |
| nó.link | Chamada para usar para acessar o registro de nó implantável usando a REST Table API. Tipo de dados: cadeia de caracteres |
| nó.valor | Sys_id do registro de nó implantável. Localizado na tabela CDM implantável \[sn_cdm_deployable\]. Tipo de dados: cadeia de caracteres |
| snapshot_version_counter | Número de snapshots criados para o implantável. Tipo de dados: inteiro |
| estado | Estado atual do implantável. Valores possíveis: * ativo * excluído Tipo de dados: cadeia de caracteres |
| sys_created_by | Nome de usuário do usuário que criou o implantável do CDM. Por exemplo, "able.tuter". Tipo de dados: cadeia de caracteres |
| sys_created_on | Data e hora em que o implantável do CDM foi criado. Formato: AAAA-mm-DD hh:mm:ss Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id do implantável criado. Localizado na tabela CDM implantável \[sn_cdm_deployable\]. Tipo de dados: cadeia de caracteres |
| sys_updated_by | Nome de usuário do usuário que atualizou pela última vez o implantável do CDM. Por exemplo, "able.tuter". Tipo de dados: cadeia de caracteres |
| sys_updated_on | Data e hora em que o implantável do CDM foi atualizado pela última vez. Formato: AAAA-mm-DD hh:mm:ss Tipo de dados: cadeia de caracteres |
[ ]
{#apps-POST-applications-deploys__id_dkr_tdn_qtb}
### solicitação cURL
O exemplo de código a seguir mostra como criar e associar um implantável a uma aplicação de CDM.
curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables?name=Dep-1&returnFields=name%2Csys_id%2Cstate&appName=testApp&envType=Test" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password1'
Retornar resultados:
{
"result": [
{
"cmdb_ci": {
"value": "f5b9e00b53901110a1d3ddeeff7b12b8",
"link": "http://192.168.0.233:8080/api/now/table/cmdb_ci_service_auto/f5b9e00b53901110a1d3ddeeff7b12b8"
},
"cdi_count": "0",
"snapshot_version_counter": "0",
"description": null,
"sys_updated_on": "2022-06-29 12:53:57",
"environment_type": "Test",
"node": {
"value": "7db9e00b53901110a1d3ddeeff7b12b6",
"link": "http://192.168.0.233:8080/api/now/table/sn_cdm_node/7db9e00b53901110a1d3ddeeff7b12b6"
},
"sys_id": "39b9e00b53901110a1d3ddeeff7b12b7",
"sys_updated_by": "admin",
"cdm_app": {
"value": "62b517a953b70110a1d3ddeeff7b128c",
"link": "http://192.168.0.233:8080/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c"
},
"sys_created_on": "2022-06-29 12:53:57",
"cdi_usage": "0",
"name": "Dep-2",
"state": "active",
"sys_created_by": "admin"
}
]
}
## CdmApplicationsApi -- POST /sn_cdm/applications/deployables/create {#ariaid-title10}
Cria um ou mais novos implantáveis.
Você pode criar um de dois tipos de implantáveis:
* Implantáveis que devem ser conectados manualmente a um modelo de aplicação (serviço de IC).
* Implantáveis que são conectados automaticamente a novos modelos de aplicação (serviços de IC) criados dinamicamente.
Você pode criar um implantável para qualquer um dos três tipos de ambiente: Desenvolvimento, Teste ou Produção. Ao criar vários implantáveis, os nomes gerados automaticamente dos implantáveis seguem o padrão: `DeployableType_Number`, em que `Number` é um número de sequência em execução com base na criação de um novo implantável. Por exemplo, se você criar três implantáveis do tipo `Teste` em uma chamada de endpoint, eles serão chamados de Test_1, Test_2 e Test_3. Se você chamar o endpoint novamente e criar um implantável de teste diferente, seu nome gerado automaticamente será Test_4. Esses números nunca são reutilizados, mesmo se um implantável for excluído.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/applications/deployables/create
URL padrão: /api/sn_cdm/applications/deployables/create
### Parâmetros de solicitação compatíveis
{#apps-POST-deploy-create__entry__2}{#apps-POST-deploy-create__version-RESTAPI}
| 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 49. Parâmetros de caminho]
{#apps-POST-deploy-create__entry__6}{#apps-POST-deploy-create__cdm_apps-envType-entry}
| Nome | Descrição |
|-|-|
| appSysId | Obrigatório. Sys_id de uma aplicação de CDM ativa a ser associada aos implantáveis. Tipo de dados: cadeia de caracteres |
| conexão automática | Obrigatório. Sinalizador que determina se os implantáveis recém-criados devem ser conectados automaticamente aos Modelos de aplicações gerados dinamicamente. Valores válidos: * verdadeiro: conecte os implantáveis recém-criados aos modelos de aplicações gerados dinamicamente. * falso: basta criar os implantáveis. Esses implantáveis devem ser mapeados manualmente para modelos de aplicação usando a IU. {#apps-POST-deploy-create__ul_gdp_vwr_xsb} Tipo de dados: booliano |
| envType | Obrigatório. Tipo de ambiente para o implantável. Valores válidos (diferencia maiúsculas de minúsculas): * Desenvolvimento * Produção * Teste Nota: O tipo de ambiente implantável não pode ser alterado após a criação. Tipo de dados: cadeia de caracteres |
| quantidade | Obrigatório. Número de implantáveis a serem criados. Tipo de dados: número |
[Tabela 50. Parâmetros de consulta]
{#apps-POST-deploy-create__entry__16}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 51. Parâmetros do corpo da solicitação (XML ou JSON)]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-deploy-create__entry__20}{#apps-POST-deploy-create__accept-JSON-only-entry-RESTAPI}{#apps-POST-deploy-create__content_type-JSON-only-entry-RESTAPI}
| 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 52. Cabeçalhos da solicitação]
{#apps-POST-deploy-create__entry__26}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 53. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-deploy-create__entry__30}{#apps-POST-deploy-create__entry-200-status-code}{#apps-POST-deploy-create__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 54. Códigos de status]
### Parâmetros do corpo da resposta
{#apps-POST-deploy-create__entry__36}
| Nome | Descrição |
|-|-|
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| resultado | Sys_ids dos implantáveis criados. Tipo de dados: matriz |
| status | Status de erro da solicitação. Valores possíveis: falha Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
O exemplo a seguir mostra como criar um único implantável e associá-lo a uma aplicação de CDM existente.
curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/create?envType=Production&appSysId=5e118055b712011054c1e5a6ce11a9d4&quantity=5&autoConnect=true" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user 'username':'password'
O seguinte mostra as possíveis respostas para esta chamada, tanto como um sucesso quanto um erro.
// Successful completion of the upload request
{
"result": [
"8ba43a3db7d6011054c1e5a6ce11a9a4",
"93a47a3db7d6011054c1e5a6ce11a90d",
"dba47a3db7d6011054c1e5a6ce11a91d",
"6fa47a3db7d6011054c1e5a6ce11a921",
"efa47a3db7d6011054c1e5a6ce11a925"
]
}
// Error response
{
"error": {
"message": "Error: CDM Application with SysID 5e118055b712011054c1e5a6ce11a9d1 was not found. (sys_script_include.8cf0fbf453626010a1d3ddeeff7b12fe.script; line 211)",
"detail": ""
},
"status": "failure"
}
## CdmApplicationsApi -- POST /sn_cdm/applications/deployables/exports {#ariaid-title11}
Envia uma solicitação para exportar o snapshot atual de uma aplicação especificada e um ou mais implantáveis para a tabela Cache do exportador do CDM \[sn_cdm_exporter_cache\].
Este endpoint retorna um identificador exclusivo para a solicitação, que você usa para chamar o endpoint [CdmApplicationsApi -- GET /sn_cdm/applications/deployables/exports/{export_id}/status](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-deploy-exports-status "Retorna o status atual da solicitação de exportação de dados de configuração especificada.") para recuperar o status da exportação. Quando a exportação estiver concluída, você poderá usar o endpoint [CdmApplicationsApi -- GET /sn_cdm/applications/deployables/exports/{export_id}/content](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-deploy-exports-content "Retorna o conteúdo associado a uma solicitação de exportação de dados de configuração especificada.") para recuperar os dados de configuração da aplicação associada.
Um snapshot é o modelo de dados completo de um implantável no momento em que uma mudança de configuração é confirmada. Isso inclui todos os componentes, coleções e variáveis incluídos, bem como variáveis e substituições específicas do implantável. Para obter informações adicionais sobre implantáveis, consulte [Criar e atualizar um implantável](https://www.servicenow.com/docs/access?context=cdm-deployable-define&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US).
Nota:
Os snapshots não podem exceder 10.000 itens de dados de configuração (CDIs) por implantável ou 100.000 CDIs por aplicação.
### Formato da URL
URL com controle de versões: /api/sn_cdm/{api_version}/applications/deployables/exports
URL padrão: /api/sn_cdm/applications/deployables/exports
### Parâmetros de solicitação compatíveis
{#apps-POST-deploy-exports__entry__2}{#apps-POST-deploy-exports__version-RESTAPI}
| 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 55. Parâmetros de caminho]
{#apps-POST-deploy-exports__entry__6}
| Nome | Descrição |
|-|-|
| adicionaisImplantáveis | Implantáveis não primários para exportar. Tipo de dados: matriz de objetos "additionalDeployables": [ { "app_name": "String", "deployable_name": "String" } ] Por exemplo: `[{'app_name':'TestApp', "deployable_name:'DEP-1'}]` Padrão: matriz vazia - \[\] |
| adicionaisImplantáveis.app_name | Obrigatório se a matriz additionalDeployables for especificada. Nome da aplicação associada ao implantável cujos dados de configuração você deseja exportar. Tipo de dados: cadeia de caracteres |
| implantáveis adicionais.nome_implantável | Obrigatório se a matriz additionalDeployables for especificada. Nome do implantável não primário cujos dados de configuração você deseja exportar. Tipo de dados: cadeia de caracteres |
| appName | Obrigatório. Nome da aplicação cujos dados de configuração você deseja exportar. Tipo de dados: cadeia de caracteres |
| args | Um objeto JSON que contém pares de chave-valor para argumentos personalizados. Tipo de dados: objeto |
| dataFormat | Formato de saída dos dados exportados. Valores válidos (diferencia maiúsculas de minúsculas): * ini * json * propriedades * bruto (os dados são retornados no formato de cadeia de caracteres) * xml * yaml Tipo de dados: cadeia de caracteres Padrão: json |
| implantávelNome | Obrigatório. Nome do implantável cujos dados de configuração você deseja exportar. Tipo de dados: cadeia de caracteres |
| exportName | Obrigatório. Nome do exportador a ser usado para exportar os dados do snapshot. Os exportadores são personalizados para o implementador. Para obter detalhes sobre como criar um exportador personalizado, consulte [Criação de um exportador personalizado](https://www.servicenow.com/docs/access?context=cdm-exporter-create-custom&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres |
| restringirExportação | Sinalizador que indica se o endpoint valida snapshots ao exportar os dados. Valores válidos: * verdadeiro: validar snapshots. * falso: não valida snapshots. Tipo de dados: booliano Padrão: falso |
| snapshotName | Nome do snapshot a ser exportado. Só pode ser um dos nomes de snapshot associados ao implantável, conforme especificado em deployableName ou additionalDeployables.deployable_name. Padrão: o endpoint exporta o snapshot publicado mais recente. Se não houver um snapshot publicado, o sistema emitirá o erro "Falha ao encontrar o snapshot publicado mais recente do implantável '{0}'" |
[Tabela 56. Parâmetros de consulta]
{#apps-POST-deploy-exports__entry__28}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 57. Parâmetros do corpo da solicitação (XML ou JSON)]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-deploy-exports__entry__32}{#apps-POST-deploy-exports__accept-JSON-only-entry-RESTAPI}{#apps-POST-deploy-exports__content_type-JSON-only-entry-RESTAPI}
| 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 58. Cabeçalhos da solicitação]
{#apps-POST-deploy-exports__entry__38}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 59. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-deploy-exports__entry__42}{#apps-POST-deploy-exports__entry-200-status-code}{#apps-POST-deploy-exports__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Possíveis mensagens de erro: * Erro: parâmetro obrigatório "appName" ausente * Erro: o usuário não tem a permissão necessária para criar a solicitação de exportação * Erro: valor booliano inválido (\ ). |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 60. Códigos de status]
### Parâmetros do corpo da resposta
{#apps-POST-deploy-exports__entry__50}{#apps-POST-deploy-exports__cdm_apps-stat-error}{#apps-POST-deploy-exports__cdm_apps-stat-error_detail-row}{#apps-POST-deploy-exports__cdm_apps-stat-error_messaage-row}
| Nome | Descrição |
|-|-|
| erro | Detalhes sobre o erro ocorrido. "error": { "detail": "String", "message": "String" } Tipo de dados: matriz |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| export_id | Identificador exclusivo da solicitação de exportação. Use este ID ao chamar o endpoint [CdmApplicationsApi -- GET /sn_cdm/applications/deployables/exports/{export_id}/status](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-deploy-exports-status "Retorna o status atual da solicitação de exportação de dados de configuração especificada.") para verificar o status atual da solicitação de exportação. Tipo de dados: cadeia de caracteres |
| status | Status de erro da solicitação. Valores possíveis: falha Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
O exemplo a seguir solicita a exportação dos dados de configuração para o seguinte: nome da aplicação = TestAppA, nome implantável = DEP, usando o exportador = exportador-1-primary_deployable.
curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/exports?appName=TestAppA&args=%7B%22arg_A_required%22%20%3A%20%22value%20A%22%7D&exporterName=exporter-1-primary_deployable&deployableName=DEP1" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user 'username':'password'
Retorna o identificador exclusivo da solicitação de exportação.
{
"result": {
"export_id": "64b5f79f5379301096edddeeff7b12eb"
}
}
## CdmApplicationsApi -- POST /sn_cdm/applications/shared_components {#ariaid-title12}
Associa o componente compartilhado especificado à aplicação em um changeset especificado.
A função de administrador do CDM é necessária para acessar este endpoint.
Nota:
O componente compartilhado especificado deve ter uma versão publicada associada (snapshot).
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/applications/shared_components
URL padrão: /api/sn_cdm/applications/shared_components
### Parâmetros de solicitação compatíveis
{#apps-POST-shared_components__entry__2}{#apps-POST-shared_components__version-RESTAPI}
| 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 61. Parâmetros de caminho]
{#apps-POST-shared_components__entry__6}{#apps-POST-shared_components__cdm_apps-returnFields-entry}
| Nome | Descrição |
|-|-|
| appName | Obrigatório. Nome da aplicação a ser associada ao componente compartilhado. Tipo de dados: cadeia de caracteres |
| changesetNumber | Obrigatório. Identificador exclusivo do changeset associado ao componente. Tipo de dados: cadeia de caracteres |
| returnFields | Lista de campos a serem retornados como parte da resposta. Passe os nomes da coluna de registro, como sys_id, sys_updated_by ou state. Tipo de dados: matriz Padrão: todos os campos determinados pelo endpoint |
| sharedComponentName | Obrigatório. Nome do componente compartilhado a ser associado à aplicação especificada. Localizado na tabela Componente compartilhado do CDM \[sn_cdm_shared_component\]. Tipo de dados: cadeia de caracteres |
| sharedLibraryName | Obrigatório. Nome da biblioteca compartilhada na qual o componente será criado. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. A biblioteca compartilhada deve ter os seguintes campos definidos da seguinte forma: * estado = ativo * disponível = verdadeiro * tipo = shared_library Tipo de dados: cadeia de caracteres |
[Tabela 62. Parâmetros de consulta]
{#apps-POST-shared_components__entry__18}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 63. Parâmetros do corpo da solicitação]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-shared_components__entry__22}{#apps-POST-shared_components__accept-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
[Tabela 64. Cabeçalhos da solicitação]
{#apps-POST-shared_components__entry__26}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 65. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-shared_components__entry__30}{#apps-POST-shared_components__entry-200-status-code}{#apps-POST-shared_components__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. O changeset aprovado não existe. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 66. Códigos de status]
### Parâmetros do corpo da resposta
Os campos de resposta dependem de quais campos foram especificados no parâmetro returnFields na solicitação. A seguir, descrevemos alguns dos campos mais importantes.
{#apps-POST-shared_components__entry__38}{#apps-POST-shared_components__changeset-node-editor-entry}{#apps-POST-shared_components__changeset_link-node-editor-entry}{#apps-POST-shared_components__changeset_value-node-editor-entry}{#apps-POST-shared_components__cdm_apps-error-entry}{#apps-POST-shared_components__cdm_apps-error_detail-entry}{#apps-POST-shared_components__cdm_apps-error_message-entry}{#apps-POST-shared_components__cdm_dep-sys_created_by-row}{#apps-POST-shared_components__cdm_deps-sys_created_on-row}{#apps-POST-shared_components__sys_id-node-editor-entry}{#apps-POST-shared_components__cdm_dep-sys_updated_by-row}{#apps-POST-shared_components__cdm_dep-sys_updated_on-row}
| Nome | Descrição |
|-|-|
| changeset_id | Detalhes do registro do changeset associado ao nó. Tipo de dados: objeto "changeset_id": { "link": "String", "value": "String" } |
| changeset_id.link | Sintaxe de chamada para consultar este registro de changeset usando a API REST de tabela. Tipo de dados: cadeia de caracteres |
| changeset_id.valor | Identificador exclusivo do registro do changeset. Localizado na tabela CDM Changeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres |
| descrição | Descrição do nó do CDM. Tipo de dados: cadeia de caracteres |
| erro | Retornado somente se ocorreu um erro durante o processamento. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Detalhes sobre o erro ocorrido. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem que fornece uma visão geral do erro. Tipo de dados: cadeia de caracteres |
| vinculado_a | ID do nó principal associado ao componente compartilhado. Tipo de dados: cadeia de caracteres |
| vinculado_a_versão | Detalhes do registro de snapshot do CDM associado ao nó. Tipo de dados: objeto "linked_to_version": { "link": "String", "value": "String" } |
| vinculado_a_versão.link | Sintaxe de chamada para consultar este registro de versão usando a API REST de tabela. Tipo de dados: cadeia de caracteres |
| vinculado_a_versão.valor | Sys_id do registro da versão. Tipo de dados: cadeia de caracteres |
| principal | Sinalizador que indica se o snapshot associado foi publicado. Valores válidos: * verdadeiro: o snapshot foi publicado. * falso: o snapshot não foi publicado. |
| main_id | ID exclusivo do nó principal recém-criado. Tipo de dados: cadeia de caracteres |
| main_id_encoded | ID codificado do nó principal recém-criado. Tipo de dados: cadeia de caracteres |
| nome | Nome do nó do CDM. Tipo de dados: cadeia de caracteres |
| node | Sys_id do nó do componente compartilhado. Tipo de dados: cadeia de caracteres |
| nó_caminho | Caminho para o novo nó vinculado criado ao adicionar o componente compartilhado. Tipo de dados: cadeia de caracteres |
| status | Status do nó. Valores possíveis: Novo Tipo de dados: cadeia de caracteres |
| sys_created_by | Nome de usuário do usuário que cria o nó do CDM. Por exemplo, "able.tuter". Tipo de dados: cadeia de caracteres |
| sys_created_on | Data e hora em que o nó do CDM foi criado. Formato: AAAA-mm-DD hh:mm:ss Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id do nó. Localizado na tabela Nó do CDM \[sn_cdm_node\]. Tipo de dados: cadeia de caracteres |
| sys_updated_by | Nome de usuário do usuário que atualizou o nó do CDM pela última vez. Por exemplo, "able.tuter". Tipo de dados: cadeia de caracteres |
| sys_updated_on | Data e hora em que o nó do CDM foi atualizado pela última vez. Formato: AAAA-mm-DD hh:mm:ss Tipo de dados: cadeia de caracteres |
| tipo | Tipo de nó. Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
O exemplo a seguir mostra como chamar este endpoint para associar a aplicação "App1" ao componente compartilhado "paymentService-V1.1" na biblioteca compartilhada "OracleG-Library-10" no changeset "Chset-20".
curl "https://instance.servicenow.com/api/sn_cdm/applications/shared_components?appName=App1&changesetNumber=Chset-20&sharedLibraryName=OracleG-Library-10&sharedComponentName=paymentService-V1.1" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'
Resposta:
{
"result": {
"changeset_id": {
"value": "74b7ff6fc33711100c257e2cc840dd6b",
"link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/74b7ff6fc33711100c257e2cc840dd6b"
},
"node_path": "!,0!,1!/D",
"description": null,
"sys_updated_on": "2022-12-22 17:07:29",
"type": "sn_cdm_node_linked_shared_component",
"sys_class_name": "sn_cdm_node",
"sys_id": "ff8b37ebc3b711100c257e2cc840ddba",
"sys_updated_by": "admin",
"previous_version": null,
"sys_created_on": "2022-12-22 17:07:29",
"value": null,
"effective_from": null,
"linked_to": "210",
"sys_created_by": "admin",
"restricted_to": null,
"linked_to_version": {
"value": "581fc3e9c3b311100c257e2cc840dd17",
"link": "http://instance.servicenow.com/api/now/table/sn_cdm_snapshot/581fc3e9c3b311100c257e2cc840dd17"
},
"level": "2",
"conflict_type": null,
"main_id": "483",
"effective_to": null,
"secure_value": null,
"node_classifier": "/application/components",
"main_id_encoded": "/D",
"name": "LIB2_C",
"position": null,
"reason_for_conflict": null,
"system_folder": false,
"status": "new",
"conflict": false
}
}
## CdmApplicationsApi -- POST /sn_cdm/applications/uploads/components {#ariaid-title13}
Envia uma solicitação para carregar os dados de configuração passados para um componente específico, dentro da pasta de componentes do sistema, para a aplicação especificada.
Este endpoint retorna o ID da solicitação de upload. Use este ID para chamar o endpoint [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-upload-status "Retorna o status atual da solicitação de carregamento de dados de configuração especificada.") para obter o status do carregamento.
Nota:
O tamanho máximo de conteúdo de carregamento padrão é de 2 MB. Você pode modificar este padrão atualizando a propriedade sn_cdm.max_allowed_upload_file_size.
A imagem a seguir mostra um exemplo de onde os dados de configuração do componente são carregados em referência à IU ServiceNow Configuração de DevOps. Supõe que o componente seja dbComponent e a aplicação sejapaymentSvc.
Nota:
Este método de carregamento não pode ser usado para modificar nós. Use o método alternativo para modificar nós.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/applications/uploads/components
URL padrão: /api/sn_cdm/applications/uploads/components
### Parâmetros de solicitação compatíveis
{#apps-POST-uploads-components__entry__2}{#apps-POST-uploads-components__version-RESTAPI}
| 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 67. Parâmetros de caminho]
{#apps-POST-uploads-components__id_plp_1vh_psb__entry__2}{#apps-POST-uploads-components__cdm_apps-appName-row}{#apps-POST-uploads-components__cdm_apps-autoCommit-row}{#apps-POST-uploads-components__cdm_apps-autoDelete-row}{#apps-POST-uploads-components__cdm_apps-autoValidate-row}{#apps-POST-uploads-components__cdm_apps-changesetNumber-row}{#apps-POST-uploads-components__cdm_apps-dataFormat-row}{#apps-POST-uploads-components__cdm_app-dataFormAtt-entry}{#apps-POST-uploads-components__cdm_app-dataFormAtt_containsHeaders-entry}{#apps-POST-uploads-components__cdm_app-dataFormAtt_delimeter-entry}{#apps-POST-uploads-components__cdm_app-dataFormAtt_headers-entry}{#apps-POST-uploads-components__cdm_app-dataFormAtt_securedHeaders-entry}{#apps-POST-uploads-components__cdm_apps-deleteRedundantOverrides-row}{#apps-POST-uploads-components__cdm_apps-fileName-row}{#apps-POST-uploads-components__cdm_apps-fileNodeName-row}{#apps-POST-uploads-components__cdm_apps-identifierKeys-row}{#apps-POST-uploads-components__cdm_apps-ignoreAttributes-row}{#apps-POST-uploads-components__cdm_apps-namePath-row}{#apps-POST-uploads-components__cdm_apps-sharedLibraryName-row}
| Nome | Descrição |
|-|-|
| appName | Nome da aplicação a ser associada aos dados de configuração. Esta aplicação deve estar no estado ativo. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. Tipo de dados: cadeia de caracteres |
| confirmação automática | Sinalizador que indica se o changeset identificado no parâmetro changesetNumber está confirmado no modelo de dados após o upload. Valores válidos: * verdadeiro: o changeset é confirmado após o upload. * falso: o changeset não é confirmado após o upload. Tipo de dados: booliano Padrão: falso |
| autoDelete | Sinalizador que indica se os nós existentes, que não fazem parte do conteúdo de carregamento, são excluídos após a conclusão do processamento. Valores válidos: * verdadeiro: exclui automaticamente os nós existentes. * falso: não exclui automaticamente os nós existentes. Tipo de dados: booliano Padrão: falso |
| autoValidate | Sinalizador que indica se os snapshots criados quando confirmados são validados. Valores válidos: * verdadeiro: valida os snapshots. * falso: não valida os snapshots. Nota: Esta opção só estará disponível se o parâmetro autoCommit for verdadeiro. Tipo de dados: booliano Padrão: falso |
| changesetNumber | Cadeia de caracteres que identifica exclusivamente o [changeset](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US) associado à aplicação, como Chset-102. Este changeset deve estar no estado "Aberto". Localizado na tabela CDM Changeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres Padrão: cria um changeset a ser usado. Os detalhes do conjunto de mudanças são retornados como parte dos resultados [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-upload-status "Retorna o status atual da solicitação de carregamento de dados de configuração especificada."). |
| dataFormat | Obrigatório. Formato dos dados de configuração. Valores válidos: * csv * ini * json * propriedades * bruto * xml * yaml Tipo de dados: cadeia de caracteres |
| dataFormatAttributes | Compatível somente quando o parâmetro dataFormat está definido como csv. Atributos que definem o formato de dados CSV. Para obter informações adicionais, confira [Parsing of CSV files in CDM](https://www.servicenow.com/docs/access?context=cdm-parsing-csv-file&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Tipo de dados: objeto "dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] } |
| dataFormatAttributes.containsHeaders | Sinalizador que indica se os dados contêm uma linha de cabeçalho. Valores válidos: * verdadeiro: os dados contêm uma linha de cabeçalho. A primeira linha nos dados é considerada a linha de cabeçalho. * falso: os dados não contêm uma linha de cabeçalho. Você deve passar as informações do cabeçalho no parâmetro dataFormatAttributes.headers. Tipo de dados: booliano Padrão: falso |
| dataFormatAttributes.delimeter | Caractere a ser usado para delinear campos nos dados. Tipo de dados: cadeia de caracteres Padrão: vírgula "," |
| dataFormatAttributes.cabeçalhos | Obrigatório se o parâmetro dataFormatAttributes.containsHeaders for falso. Campos nos dados que compõem o cabeçalho. Esses cabeçalhos são convertidos nos nomes de chave dos CDIs no formato JSON. O número de cabeçalhos deve corresponder ao número de campos de registro. Tipo de dados: matriz Padrão: matriz vazia |
| dataFormatAttributes.securedHeaders | Campos nos dados que são campos seguros e devem ser criptografados nos dados carregados para CDM. O nome dos cabeçalhos protegidos deve corresponder ao nome dos cabeçalhos no atributo de cabeçalhos ou no arquivo de dados. Esses campos são armazenados em uma coluna do tipo Senha (criptografada bidirecional). Nota: Você só pode proteger campos usando este atributo. Você não pode desproteger os campos protegidos. Tipo de dados: matriz Padrão: matriz vazia |
| deleteRedundantOverrides | Sinalizador que indica se uma substituição deve ser criada quando houver valores redundantes. Valores válidos: * verdadeiro: se houver valores redundantes, uma substituição não será criada. * falso: se houver valores redundantes, prossegue com uma substituição. Padrão: verdadeiro |
| NomeDoArquivo | Nome do arquivo a ser carregado. Este nome pode ser diferente do nome do arquivo real e conter a extensão do arquivo. Por exemplo, .txt/.scv/.jar. O valor fileName é aplicado ao baixar o arquivo. Tipo de dados: cadeia de caracteres |
| fileNodeName | Nome do nó do arquivo. Este nome de arquivo é usado nos dados de configuração ao exportá-los. Este nome não requer uma extensão de arquivo nem afeta o download. Tipo de dados: cadeia de caracteres |
| identificadoresChaves | Lista de nomes que indicam qual chave em uma matriz secundária usar para identificar o mesmo nó. Por exemplo, se você estiver carregando: [ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] no seguinte modelo existente: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ] e você definir identifierKeys como name, ele produzirá a seguinte saída: [ {"name" : "Karen, "city" : "Sydney"}, {"name" : "Allan, "city" : "Paris"} ] Caso contrário, ele produzirá a seguinte saída: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"}, {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] Tipo de dados: matriz de cadeias de caracteres |
| ignoreAttributes | Sinalizador que indica se o formato de dados fornecido é compatível com atributos (atualmente somente XML). Valores válidos: * verdadeiro: se o formato de dados fornecido for compatível com atributos, todos os atributos nos dados de entrada serão ignorados durante o carregamento. * falso: se o formato de dados fornecido for compatível com atributos, todos os atributos nos dados de entrada serão incluídos no carregamento. {#apps-POST-uploads-components__ul_egn_4q4_1yb} Tipo de dados: booliano Padrão: falso |
| namePath | Caminho do nó de destino sob o qual os dados de configuração devem ser carregados. Este caminho é relativo aos componentes, à coleção ou à pasta implantável (dependendo do endpoint que está sendo chamado). Você pode passar o caminho do nome em qualquer um dos formatos a seguir. Por exemplo, para definir o caminho do nome do nó `testApp/deployables/Development1/cdi1`: * Formato de barra invertida: testApp/deployables/Development1/cdi1 Nota: Se o nome do nó contiver uma barra invertida ("/"), você não poderá usar este formato. * Caminho do nome de back-end com caracteres de substituição: testAppdeployablesDevelopment1cdi1 * Matriz: \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-components__cdm_apps-namePath-ul} Nota: Se o componente especificado não existir no caminho especificado, o sistema criará automaticamente o componente no caminho especificado e carregará os dados. Tipo de dados: cadeia de caracteres |
| sharedLibraryName | Obrigatório. Nome da biblioteca compartilhada em que o componente a ser excluído está localizado. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. Tipo de dados: cadeia de caracteres |
[Tabela 68. Parâmetros de consulta]
{#apps-POST-uploads-components__id_plp_1vh_psb} {#apps-POST-uploads-components__id_lx4_bvh_psb__entry__2}{#apps-POST-uploads-components__cdm_apps-var_up_data-entry}
| Nome | Descrição |
|-|-|
| Dados de upload de variáveis | Dados de configuração a serem carregados. Pode ser qualquer dado no formato definido pelo parâmetro dataFormat dos parâmetros de consulta. |
[Tabela 69. Parâmetros do corpo da solicitação (XML ou JSON)]
{#apps-POST-uploads-components__id_lx4_bvh_psb}
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-uploads-components__id_trg_k25_2wb__entry__2}{#apps-POST-uploads-components__accept-JSON-only-entry-RESTAPI}
| 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. Tipos compatíveis: text/plain e application/x-www-form-urlencoded. Padrão: text/plain |
[Tabela 70. Cabeçalhos da solicitação]
{#apps-POST-uploads-components__id_trg_k25_2wb} {#apps-POST-uploads-components__entry__54}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 71. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-uploads-components__id_vvq_4wh_psb__entry__2}{#apps-POST-uploads-components__entry-200-status-code}{#apps-POST-uploads-components__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação incorreta. A solicitação de upload foi rejeitada. Possíveis problemas: * O tamanho da carga de configuração é maior que o máximo permitido - 2 MB por padrão. * Os parâmetros obrigatórios estão ausentes na chamada. {#apps-POST-uploads-components__ul_kmn_gkh_psb} |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 72. Códigos de status]
{#apps-POST-uploads-components__id_vvq_4wh_psb}
### Parâmetros do corpo da resposta (JSON ou XML)
{#apps-POST-uploads-components__id_b4z_nwh_psb__entry__2}{#apps-POST-uploads-components__cdm_apps-stat-error}{#apps-POST-uploads-components__cdm_apps-stat-error_detail-row}{#apps-POST-uploads-components__cdm_apps-stat-error_messaage-row}{#apps-POST-uploads-components__cdm_apps-stat-error_status-row}{#apps-POST-uploads-components__cdm_apps-upload_id-row}
| Nome | Descrição |
|-|-|
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| status | Status de erro da solicitação. Valores possíveis: falha Tipo de dados: cadeia de caracteres |
| upload_id | Sys_id da solicitação de upload. Use este ID para chamar o endpoint [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-upload-status "Retorna o status atual da solicitação de carregamento de dados de configuração especificada.") para obter o status do carregamento. Tipo de dados: cadeia de caracteres |
[ ]
{#apps-POST-uploads-components__id_b4z_nwh_psb}
### Solicitação de cURL
O exemplo a seguir mostra uma solicitação de carregamento para a aplicação Demo_App1631126164773.
curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/components?namePath=%2FSettings%2FdbSettings&dataFormat=json&appName=Demo_App1631126164773&changesetNumber=Chset-8&autoCommit=false&publishOption=publish_none&autoValidate=false&autoDelete=true" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:text/plain" \
--data "{
\"dbIPAddress\": \"10.10.10.110\",
\"dbPort\": \"8080\",
\"dbConnectionString\": \"admin:admin server1.xyz.com:8080 dbName_payments\",
\"dbConnectionStringBackup\": \"admin:admin server2.xyz.com dbName_payments_backup\
"}" \
--user 'username':'password'
Os resultados de retorno a seguir mostram uma resposta de sucesso e de erro para esta solicitação.
// Successful completion of the upload request
{
"result": {
"upload_id": "ec1f71f45322301096edddeeff7b12b3"
}
}
// Error response. Payload is too large.
{
"error": {
"message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)",
"detail": ""
},
"status": "failure"
}
## CdmApplicationsApi -- POST /sn_cdm/applications/uploads/components/vars {#ariaid-title14}
Envia uma solicitação para carregar os dados de configuração passados na pasta de variáveis, dentro da pasta de componentes do sistema, para a aplicação especificada.
A imagem a seguir mostra um exemplo de onde os dados de configuração de variáveis do componente são carregados em referência à IU do espaço ServiceNow Configuração de DevOps. Supõe que a aplicação sejapaymentSvc.
Nota:
O tamanho máximo de conteúdo de carregamento padrão é de 2 MB. Você pode modificar este padrão atualizando a propriedade sn_cdm.max_allowed_upload_file_size.
### Formato da URL {#apps-POST-uploads-components-var__section_xgv_syh_psb}
URL com controle de versão: /api/sn_cdm/{api_version}/applications/uploads/components/vars
URL padrão: /api/sn_cdm/applications/uploads/components/vars
### Parâmetros de solicitação compatíveis
{#apps-POST-uploads-components-var__entry__2}{#apps-POST-uploads-components-var__version-RESTAPI}
| 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 73. Parâmetros de caminho]
{#apps-POST-uploads-components-var__id_ey4_w13_psb__entry__2}{#apps-POST-uploads-components-var__cdm_apps-dataFormat-row}
| Nome | Descrição |
|-|-|
| appName | Nome da aplicação a ser associada aos dados de configuração. Esta aplicação deve estar no estado ativo. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. Tipo de dados: cadeia de caracteres |
| confirmação automática | Sinalizador que indica se o changeset identificado no parâmetro changesetNumber está confirmado no modelo de dados após o upload. Valores válidos: * verdadeiro: o changeset é confirmado após o upload. * falso: o changeset não é confirmado após o upload. Tipo de dados: booliano Padrão: falso |
| autoDelete | Sinalizador que indica se os nós existentes, que não fazem parte do conteúdo de carregamento, são excluídos após a conclusão do processamento. Valores válidos: * verdadeiro: exclui automaticamente os nós existentes. * falso: não exclui automaticamente os nós existentes. Tipo de dados: booliano Padrão: falso |
| autoValidate | Sinalizador que indica se os snapshots criados quando confirmados são validados. Valores válidos: * verdadeiro: valida os snapshots. * falso: não valida os snapshots. Nota: Esta opção só estará disponível se o parâmetro autoCommit for verdadeiro. Tipo de dados: booliano Padrão: falso |
| changesetNumber | Cadeia de caracteres que identifica exclusivamente o [changeset](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US) associado à aplicação, como Chset-102. Este changeset deve estar no estado "Aberto". Localizado na tabela CDM Changeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres Padrão: cria um changeset a ser usado. Os detalhes do conjunto de mudanças são retornados como parte dos resultados [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-upload-status "Retorna o status atual da solicitação de carregamento de dados de configuração especificada."). |
| dataFormat | Obrigatório. Formato dos dados de configuração. Valores válidos: * ini * json * propriedades * bruto * xml * yaml Tipo de dados: cadeia de caracteres |
| deleteRedundantOverrides | Sinalizador que indica se uma substituição deve ser criada quando houver valores redundantes. Valores válidos: * verdadeiro: se houver valores redundantes, uma substituição não será criada. * falso: se houver valores redundantes, prossegue com uma substituição. Padrão: verdadeiro |
| NomeDoArquivo | Nome do arquivo a ser carregado. Este nome pode ser diferente do nome do arquivo real e conter a extensão do arquivo. Por exemplo, .txt/.scv/.jar. O valor fileName é aplicado ao baixar o arquivo. Tipo de dados: cadeia de caracteres |
| fileNodeName | Nome do nó do arquivo. Este nome de arquivo é usado nos dados de configuração ao exportá-los. Este nome não requer uma extensão de arquivo nem afeta o download. Tipo de dados: cadeia de caracteres |
| identificadoresChaves | Lista de nomes que indicam qual chave em uma matriz secundária usar para identificar o mesmo nó. Por exemplo, se você estiver carregando: [ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] no seguinte modelo existente: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ] e você definir identifierKeys como name, ele produzirá a seguinte saída: [ {"name" : "Karen, "city" : "Sydney"}, {"name" : "Allan, "city" : "Paris"} ] Caso contrário, ele produzirá a seguinte saída: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"}, {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] Tipo de dados: matriz de cadeias de caracteres |
| ignoreAttributes | Sinalizador que indica se o formato de dados fornecido é compatível com atributos (atualmente somente XML). Valores válidos: * verdadeiro: se o formato de dados fornecido for compatível com atributos, todos os atributos nos dados de entrada serão ignorados durante o carregamento. * falso: se o formato de dados fornecido for compatível com atributos, todos os atributos nos dados de entrada serão incluídos no carregamento. {#apps-POST-uploads-components-var__ul_egn_4q4_1yb} Tipo de dados: booliano Padrão: falso |
| namePath | Caminho do nó de destino sob o qual os dados de configuração devem ser carregados. Este caminho é relativo aos componentes, à coleção ou à pasta implantável (dependendo do endpoint que está sendo chamado). Você pode passar o caminho do nome em qualquer um dos formatos a seguir. Por exemplo, para definir o caminho do nome do nó `testApp/deployables/Development1/cdi1`: * Formato de barra invertida: testApp/deployables/Development1/cdi1 Nota: Se o nome do nó contiver uma barra invertida ("/"), você não poderá usar este formato. * Caminho do nome de back-end com caracteres de substituição: testAppdeployablesDevelopment1cdi1 * Matriz: \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-components-var__cdm_apps-namePath-ul} Nota: Se o componente especificado não existir no caminho especificado, o sistema criará automaticamente o componente no caminho especificado e carregará os dados. Tipo de dados: cadeia de caracteres |
| sharedLibraryName | Obrigatório. Nome da biblioteca compartilhada em que o componente a ser excluído está localizado. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. Tipo de dados: cadeia de caracteres |
[Tabela 74. Parâmetros de consulta]
{#apps-POST-uploads-components-var__id_ey4_w13_psb} {#apps-POST-uploads-components-var__id_x4h_y13_psb__entry__2}{#apps-POST-uploads-components-var__cdm_apps-var_up_data-entry}
| Nome | Descrição |
|-|-|
| Dados de upload de variáveis | Dados de configuração a serem carregados. Pode ser qualquer dado no formato definido pelo parâmetro dataFormat dos parâmetros de consulta. |
[Tabela 75. Parâmetros do corpo da solicitação (XML ou JSON)]
{#apps-POST-uploads-components-var__id_x4h_y13_psb}
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-uploads-components-var__id_cvs_bmb_fwb__entry__2}{#apps-POST-uploads-components-var__accept-JSON-only-entry-RESTAPI}
| 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. Tipos compatíveis: text/plain e application/x-www-form-urlencoded. Padrão: text/plain |
[Tabela 76. Cabeçalhos da solicitação]
{#apps-POST-uploads-components-var__id_cvs_bmb_fwb} {#apps-POST-uploads-components-var__entry__44}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 77. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-uploads-components-var__id_dqr_z13_psb__entry__2}{#apps-POST-uploads-components-var__entry-200-status-code}{#apps-POST-uploads-components-var__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação incorreta. A solicitação de upload foi rejeitada. Possíveis problemas: * O tamanho da carga de configuração é maior que o máximo permitido - 2 MB por padrão. * Os parâmetros obrigatórios estão ausentes na chamada. {#apps-POST-uploads-components-var__ul_kmn_gkh_psb} |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 78. Códigos de status]
{#apps-POST-uploads-components-var__id_dqr_z13_psb}
### Parâmetros do corpo da resposta (JSON ou XML)
{#apps-POST-uploads-components-var__id_pcq_1b3_psb__entry__2}{#apps-POST-uploads-components-var__cdm_apps-stat-error}{#apps-POST-uploads-components-var__cdm_apps-stat-error_detail-row}{#apps-POST-uploads-components-var__cdm_apps-stat-error_messaage-row}{#apps-POST-uploads-components-var__cdm_apps-stat-error_status-row}{#apps-POST-uploads-components-var__cdm_apps-upload_id-row}
| Nome | Descrição |
|-|-|
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| status | Status de erro da solicitação. Valores possíveis: falha Tipo de dados: cadeia de caracteres |
| upload_id | Sys_id da solicitação de upload. Use este ID para chamar o endpoint [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-upload-status "Retorna o status atual da solicitação de carregamento de dados de configuração especificada.") para obter o status do carregamento. Tipo de dados: cadeia de caracteres |
[ ]
{#apps-POST-uploads-components-var__id_pcq_1b3_psb}
### Solicitação de cURL
O exemplo a seguir mostra uma solicitação de carregamento de variáveis para a aplicação Demo_App1631126164773.
curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/components/vars?changesetNumber=Chset-102&autoValidate=false&autoDelete=true&publishOption=publish_none&appName=Demo_App1631126164773&namePath=%2FSettings%2FdbSettings&autoCommit=false&dataFormat=json" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:text/plain" \
--data "{
\"dbSettings\": {
\"dbIPAddress\": \"10.10.10.110\",
\"dbPort\": \"8080\",
\"dbConnectionString\": \"username:password server1.xyz.com:8080 dbName_payments\",
\"dbConnectionStringBackup\": \"username:password server2.xyz.com dbName_payments_backup\"
}
}"
--user 'username':'password'
Os resultados de retorno a seguir mostram uma resposta de sucesso e de erro para esta solicitação.
// Successful completion of the upload request
{
"result": {
"upload_id": "d21f71f45322301096eccceaff7b1ce3"
}
}
// Error response. Payload is too large.
{
"error": {
"message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)",
"detail": ""
},
"status": "failure"
}
## CdmApplicationsApi -- POST /sn_cdm/applications/uploads/collections {#ariaid-title15}
Envia uma solicitação para carregar os dados de configuração passados para uma coleção específica, dentro da pasta de coleções do sistema, para a aplicação especificada.
Este endpoint retorna o ID da solicitação de upload. Use este ID para chamar o endpoint [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-upload-status "Retorna o status atual da solicitação de carregamento de dados de configuração especificada.") para obter o status do carregamento.
Nota:
O tamanho máximo de conteúdo de carregamento padrão é de 2 MB. Você pode modificar este padrão atualizando a propriedade sn_cdm.max_allowed_upload_file_size.
A imagem a seguir mostra um exemplo de onde os dados de configuração são carregados em referência à IU do espaço ServiceNow Configuração de DevOps. Supõe que a coleção seja db0Release1.0 e a aplicação sejapaymentSvc.
Nota:
Este método de carregamento não pode ser usado para modificar nós. Use o método alternativo para modificar nós.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/applications/uploads/collection
URL padrão: /api/sn_cdm/applications/uploads/collections
### Parâmetros de solicitação compatíveis
{#apps-POST-uploads-collections__entry__2}{#apps-POST-uploads-collections__version-RESTAPI}
| 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 79. Parâmetros de caminho]
{#apps-POST-uploads-collections__id_ycw_c33_psb__entry__2}{#apps-POST-uploads-collections__cdm_app-dataFormAtt-entry}{#apps-POST-uploads-collections__cdm_app-dataFormAtt_containsHeaders-entry}{#apps-POST-uploads-collections__cdm_app-dataFormAtt_delimeter-entry}{#apps-POST-uploads-collections__cdm_app-dataFormAtt_headers-entry}{#apps-POST-uploads-collections__cdm_app-dataFormAtt_securedHeaders-entry}
| Nome | Descrição |
|-|-|
| appName | Nome da aplicação a ser associada aos dados de configuração. Esta aplicação deve estar no estado ativo. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. Tipo de dados: cadeia de caracteres |
| confirmação automática | Sinalizador que indica se o changeset identificado no parâmetro changesetNumber está confirmado no modelo de dados após o upload. Valores válidos: * verdadeiro: o changeset é confirmado após o upload. * falso: o changeset não é confirmado após o upload. Tipo de dados: booliano Padrão: falso |
| autoDelete | Sinalizador que indica se os nós existentes, que não fazem parte do conteúdo de carregamento, são excluídos após a conclusão do processamento. Valores válidos: * verdadeiro: exclui automaticamente os nós existentes. * falso: não exclui automaticamente os nós existentes. Tipo de dados: booliano Padrão: falso |
| autoValidate | Sinalizador que indica se os snapshots criados quando confirmados são validados. Valores válidos: * verdadeiro: valida os snapshots. * falso: não valida os snapshots. Nota: Esta opção só estará disponível se o parâmetro autoCommit for verdadeiro. Tipo de dados: booliano Padrão: falso |
| changesetNumber | Cadeia de caracteres que identifica exclusivamente o [changeset](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US) associado à aplicação, como Chset-102. Este changeset deve estar no estado "Aberto". Localizado na tabela CDM Changeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres Padrão: cria um changeset a ser usado. Os detalhes do conjunto de mudanças são retornados como parte dos resultados [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-upload-status "Retorna o status atual da solicitação de carregamento de dados de configuração especificada."). |
| collectionName | Obrigatório. Nome da coleção sob a qual a carga carregada será armazenada. Nota: Se o namePath especificado não existir nesta coleção, o sistema criará automaticamente os componentes nesta coleção e carregará o conteúdo de configuração. Por exemplo, se você quiser carregar a coleção `collA`, com o caminho `compA/comp/compC`, os dados serão carregados em `/collA/collections/compa/compB/compC`. Se `compA` existir, mas não `compB` e `compC`, o endpoint criará esses componentes e carregará os dados em `compC`. Tipo de dados: cadeia de caracteres |
| dataFormat | Obrigatório. Formato dos dados de configuração. Valores válidos: * csv * ini * json * propriedades * bruto * xml * yaml Tipo de dados: cadeia de caracteres |
| dataFormatAttributes | Compatível somente quando o parâmetro dataFormat está definido como csv. Atributos que definem o formato de dados CSV. Para obter informações adicionais, confira [Parsing of CSV files in CDM](https://www.servicenow.com/docs/access?context=cdm-parsing-csv-file&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Tipo de dados: objeto "dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] } |
| dataFormatAttributes.containsHeaders | Sinalizador que indica se os dados contêm uma linha de cabeçalho. Valores válidos: * verdadeiro: os dados contêm uma linha de cabeçalho. A primeira linha nos dados é considerada a linha de cabeçalho. * falso: os dados não contêm uma linha de cabeçalho. Você deve passar as informações do cabeçalho no parâmetro dataFormatAttributes.headers. Tipo de dados: booliano Padrão: falso |
| dataFormatAttributes.delimeter | Caractere a ser usado para delinear campos nos dados. Tipo de dados: cadeia de caracteres Padrão: vírgula "," |
| dataFormatAttributes.cabeçalhos | Obrigatório se o parâmetro dataFormatAttributes.containsHeaders for falso. Campos nos dados que compõem o cabeçalho. Esses cabeçalhos são convertidos nos nomes de chave dos CDIs no formato JSON. O número de cabeçalhos deve corresponder ao número de campos de registro. Tipo de dados: matriz Padrão: matriz vazia |
| dataFormatAttributes.securedHeaders | Campos nos dados que são campos seguros e devem ser criptografados nos dados carregados para CDM. O nome dos cabeçalhos protegidos deve corresponder ao nome dos cabeçalhos no atributo de cabeçalhos ou no arquivo de dados. Esses campos são armazenados em uma coluna do tipo Senha (criptografada bidirecional). Nota: Você só pode proteger campos usando este atributo. Você não pode desproteger os campos protegidos. Tipo de dados: matriz Padrão: matriz vazia |
| deleteRedundantOverrides | Sinalizador que indica se uma substituição deve ser criada quando houver valores redundantes. Valores válidos: * verdadeiro: se houver valores redundantes, uma substituição não será criada. * falso: se houver valores redundantes, prossegue com uma substituição. Padrão: verdadeiro |
| ignoreAttributes | Sinalizador que indica se o formato de dados fornecido é compatível com atributos (atualmente somente XML). Valores válidos: * verdadeiro: se o formato de dados fornecido for compatível com atributos, todos os atributos nos dados de entrada serão ignorados durante o carregamento. * falso: se o formato de dados fornecido for compatível com atributos, todos os atributos nos dados de entrada serão incluídos no carregamento. {#apps-POST-uploads-collections__ul_egn_4q4_1yb} Tipo de dados: booliano Padrão: falso |
| namePath | Caminho do nó de destino sob o qual os dados de configuração devem ser carregados. Este caminho é relativo aos componentes, à coleção ou à pasta implantável (dependendo do endpoint que está sendo chamado). Você pode passar o caminho do nome em qualquer um dos formatos a seguir. Por exemplo, para definir o caminho do nome do nó `testApp/deployables/Development1/cdi1`: * Formato de barra invertida: testApp/deployables/Development1/cdi1 Nota: Se o nome do nó contiver uma barra invertida ("/"), você não poderá usar este formato. * Caminho do nome de back-end com caracteres de substituição: testAppdeployablesDevelopment1cdi1 * Matriz: \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-collections__cdm_apps-namePath-ul} Nota: Se o componente especificado não existir no caminho especificado, o sistema criará automaticamente o componente no caminho especificado e carregará os dados. Tipo de dados: cadeia de caracteres |
[Tabela 80. Parâmetros de consulta]
{#apps-POST-uploads-collections__id_ycw_c33_psb} {#apps-POST-uploads-collections__id_afd_233_psb__entry__2}{#apps-POST-uploads-collections__cdm_apps-var_up_data-entry}
| Nome | Descrição |
|-|-|
| Dados de upload de variáveis | Dados de configuração a serem carregados. Pode ser qualquer dado no formato definido pelo parâmetro dataFormat dos parâmetros de consulta. |
[Tabela 81. Parâmetros do corpo da solicitação (XML ou JSON)]
{#apps-POST-uploads-collections__id_afd_233_psb}
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-uploads-collections__id_h4r_fmb_fwb__entry__2}{#apps-POST-uploads-collections__accept-JSON-only-entry-RESTAPI}
| 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. Tipos compatíveis: text/plain e application/x-www-form-urlencoded. Padrão: text/plain |
[Tabela 82. Cabeçalhos da solicitação]
{#apps-POST-uploads-collections__id_h4r_fmb_fwb} {#apps-POST-uploads-collections__entry__48}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 83. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-uploads-collections__id_szz_f33_psb__entry__2}{#apps-POST-uploads-collections__entry-200-status-code}{#apps-POST-uploads-collections__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação incorreta. A solicitação de upload foi rejeitada. Possíveis problemas: * O tamanho da carga de configuração é maior que o máximo permitido - 2 MB por padrão. * Os parâmetros obrigatórios estão ausentes na chamada. {#apps-POST-uploads-collections__ul_kmn_gkh_psb} |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 84. Códigos de status]
{#apps-POST-uploads-collections__id_szz_f33_psb}
### Parâmetros do corpo da resposta (JSON ou XML)
{#apps-POST-uploads-collections__id_i55_g33_psb__entry__2}{#apps-POST-uploads-collections__cdm_apps-stat-error}{#apps-POST-uploads-collections__cdm_apps-stat-error_detail-row}{#apps-POST-uploads-collections__cdm_apps-stat-error_messaage-row}{#apps-POST-uploads-collections__cdm_apps-stat-error_status-row}{#apps-POST-uploads-collections__cdm_apps-upload_id-row}
| Nome | Descrição |
|-|-|
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| status | Status de erro da solicitação. Valores possíveis: falha Tipo de dados: cadeia de caracteres |
| upload_id | Sys_id da solicitação de upload. Use este ID para chamar o endpoint [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-upload-status "Retorna o status atual da solicitação de carregamento de dados de configuração especificada.") para obter o status do carregamento. Tipo de dados: cadeia de caracteres |
[ ]
{#apps-POST-uploads-collections__id_i55_g33_psb}
### Solicitação de cURL
Este exemplo mostra como carregar a data de configuração no formato JSON dbSettings na pasta de coleções da aplicação Demo_App1631126164773.
curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/collections?dataFormat=json&autoValidate=false&changesetNumber=Chset-102&appName=Demo_App1631126164773&autoDelete=true&namePath=%2FSettings%2FdbSettings&collectionName=release-1.0&autoCommit=false&publishOption=publish_none" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:text/plain" \
--data "{
\"dbSettings\": {
\"dbIPAddress\": \"10.10.10.110\",
\"dbPort\": \"8080\",
\"dbConnectionString\": \"admin:admin server1.xyz.com:8080 dbName_payments\",
\"dbConnectionStringBackup\": \"admin:admin server2.xyz.com dbName_payments_backup\"
}
}" \
--user 'username':'password'
O seguinte mostra as possíveis respostas para esta chamada, tanto como um sucesso quanto um erro.
// Successful completion of the upload request
{
"result": {
"upload_id": "ec1f71f45322301096edddeeff7b12b3"
}
}
// Error response. Payload is too large.
{
"error": {
"message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)",
"detail": ""
},
"status": "failure"
}
## CdmApplicationsApi -- POST /sn_cdm/applications/uploads/deployables {#ariaid-title16}
Envia uma solicitação para carregar o conteúdo de configuração de um implantável específico na pasta do sistema de implantáveis de uma aplicação especificada.
Este endpoint retorna o ID da solicitação de upload. Use este ID para chamar o endpoint [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-upload-status "Retorna o status atual da solicitação de carregamento de dados de configuração especificada.") para obter o status do carregamento.
Nota:
O tamanho máximo de conteúdo de carregamento padrão é de 2 MB. Você pode modificar este padrão atualizando a propriedade sn_cdm.max_allowed_upload_file_size.
A imagem a seguir mostra um exemplo de onde os dados de configuração implantáveis são carregados em referência à IU ServiceNow Configuração de DevOps. Supõe que o implantável seja Development_1 e a aplicação sejapaymentSvc.
Nota:
Este método de carregamento não pode ser usado para modificar nós. Use o método alternativo para modificar nós.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/applications/uploads/deployables
URL padrão: /api/sn_cdm/applications/uploads/deployables
### Parâmetros de solicitação compatíveis
{#apps-POST-uploads-deployables__entry__2}{#apps-POST-uploads-deployables__version-RESTAPI}
| 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 85. Parâmetros de caminho]
{#apps-POST-uploads-deployables__entry__6}{#apps-POST-uploads-deployables__cdm_app-dataFormAtt-entry}{#apps-POST-uploads-deployables__cdm_app-dataFormAtt_containsHeaders-entry}{#apps-POST-uploads-deployables__cdm_app-dataFormAtt_delimeter-entry}{#apps-POST-uploads-deployables__cdm_app-dataFormAtt_headers-entry}{#apps-POST-uploads-deployables__cdm_app-dataFormAtt_securedHeaders-entry}{#apps-POST-uploads-deployables__publish_option-changeset-entry}
| Nome | Descrição |
|-|-|
| appName | Nome da aplicação a ser associada aos dados de configuração. Esta aplicação deve estar no estado ativo. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. Tipo de dados: cadeia de caracteres |
| confirmação automática | Sinalizador que indica se o changeset identificado no parâmetro changesetNumber está confirmado no modelo de dados após o upload. Valores válidos: * verdadeiro: o changeset é confirmado após o upload. * falso: o changeset não é confirmado após o upload. Tipo de dados: booliano Padrão: falso |
| autoDelete | Sinalizador que indica se os nós existentes, que não fazem parte do conteúdo de carregamento, são excluídos após a conclusão do processamento. Valores válidos: * verdadeiro: exclui automaticamente os nós existentes. * falso: não exclui automaticamente os nós existentes. Tipo de dados: booliano Padrão: falso |
| autoValidate | Sinalizador que indica se os snapshots criados quando confirmados são validados. Valores válidos: * verdadeiro: valida os snapshots. * falso: não valida os snapshots. Nota: Esta opção só estará disponível se o parâmetro autoCommit for verdadeiro. Tipo de dados: booliano Padrão: falso |
| changesetNumber | Cadeia de caracteres que identifica exclusivamente o [changeset](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US) associado à aplicação, como Chset-102. Este changeset deve estar no estado "Aberto". Localizado na tabela CDM Changeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres Padrão: cria um changeset a ser usado. Os detalhes do conjunto de mudanças são retornados como parte dos resultados [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-upload-status "Retorna o status atual da solicitação de carregamento de dados de configuração especificada."). |
| dataFormat | Obrigatório. Formato dos dados de configuração. Valores válidos: * csv * ini * json * propriedades * bruto * xml * yaml Tipo de dados: cadeia de caracteres |
| dataFormatAttributes | Compatível somente quando o parâmetro dataFormat está definido como csv. Atributos que definem o formato de dados CSV. Para obter informações adicionais, confira [Parsing of CSV files in CDM](https://www.servicenow.com/docs/access?context=cdm-parsing-csv-file&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Tipo de dados: objeto "dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] } |
| dataFormatAttributes.containsHeaders | Sinalizador que indica se os dados contêm uma linha de cabeçalho. Valores válidos: * verdadeiro: os dados contêm uma linha de cabeçalho. A primeira linha nos dados é considerada a linha de cabeçalho. * falso: os dados não contêm uma linha de cabeçalho. Você deve passar as informações do cabeçalho no parâmetro dataFormatAttributes.headers. Tipo de dados: booliano Padrão: falso |
| dataFormatAttributes.delimeter | Caractere a ser usado para delinear campos nos dados. Tipo de dados: cadeia de caracteres Padrão: vírgula "," |
| dataFormatAttributes.cabeçalhos | Obrigatório se o parâmetro dataFormatAttributes.containsHeaders for falso. Campos nos dados que compõem o cabeçalho. Esses cabeçalhos são convertidos nos nomes de chave dos CDIs no formato JSON. O número de cabeçalhos deve corresponder ao número de campos de registro. Tipo de dados: matriz Padrão: matriz vazia |
| dataFormatAttributes.securedHeaders | Campos nos dados que são campos seguros e devem ser criptografados nos dados carregados para CDM. O nome dos cabeçalhos protegidos deve corresponder ao nome dos cabeçalhos no atributo de cabeçalhos ou no arquivo de dados. Esses campos são armazenados em uma coluna do tipo Senha (criptografada bidirecional). Nota: Você só pode proteger campos usando este atributo. Você não pode desproteger os campos protegidos. Tipo de dados: matriz Padrão: matriz vazia |
| deleteRedundantOverrides | Sinalizador que indica se uma substituição deve ser criada quando houver valores redundantes. Valores válidos: * verdadeiro: se houver valores redundantes, uma substituição não será criada. * falso: se houver valores redundantes, prossegue com uma substituição. Padrão: verdadeiro |
| implantávelNome | Obrigatório. Nome do implantável sob o qual a carga carregada será armazenada. Nota: Se o namePath especificado não existir neste implantável, o sistema criará automaticamente o(s) componente(s) neste implantável e carregará o conteúdo de configuração. |
| identificadoresChaves | Lista de nomes que indicam qual chave em uma matriz secundária usar para identificar o mesmo nó. Por exemplo, se você estiver carregando: [ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] no seguinte modelo existente: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ] e você definir identifierKeys como name, ele produzirá a seguinte saída: [ {"name" : "Karen, "city" : "Sydney"}, {"name" : "Allan, "city" : "Paris"} ] Caso contrário, ele produzirá a seguinte saída: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"}, {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] Tipo de dados: matriz de cadeias de caracteres |
| ignoreAttributes | Sinalizador que indica se o formato de dados fornecido é compatível com atributos (atualmente somente XML). Valores válidos: * verdadeiro: se o formato de dados fornecido for compatível com atributos, todos os atributos nos dados de entrada serão ignorados durante o carregamento. * falso: se o formato de dados fornecido for compatível com atributos, todos os atributos nos dados de entrada serão incluídos no carregamento. {#apps-POST-uploads-deployables__ul_egn_4q4_1yb} Tipo de dados: booliano Padrão: falso |
| namePath | Caminho do nó de destino sob o qual os dados de configuração devem ser carregados. Este caminho é relativo aos componentes, à coleção ou à pasta implantável (dependendo do endpoint que está sendo chamado). Você pode passar o caminho do nome em qualquer um dos formatos a seguir. Por exemplo, para definir o caminho do nome do nó `testApp/deployables/Development1/cdi1`: * Formato de barra invertida: testApp/deployables/Development1/cdi1 Nota: Se o nome do nó contiver uma barra invertida ("/"), você não poderá usar este formato. * Caminho do nome de back-end com caracteres de substituição: testAppdeployablesDevelopment1cdi1 * Matriz: \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-deployables__cdm_apps-namePath-ul} Nota: Se o componente especificado não existir no caminho especificado, o sistema criará automaticamente o componente no caminho especificado e carregará os dados. Tipo de dados: cadeia de caracteres |
| publicarOpção | Opção de publicação para os snapshots configurados associados. Valores válidos: * publicar_none: não publicar nenhum snapshot. * Public_valid: publique somente os snapshots aprovados na validação após a confirmação. Para obter informações adicionais sobre como publicar snapshots, consulte [Publicar ou cancelar a publicação de um snapshot](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres Padrão: publicar_none Nota: Esta opção só estará disponível se o valor do parâmetro autoCommit for verdadeiro. |
[Tabela 86. Parâmetros de consulta]
{#apps-POST-uploads-deployables__id_njw_zv3_psb__entry__2}{#apps-POST-uploads-deployables__cdm_apps-var_up_data-entry}
| Nome | Descrição |
|-|-|
| Dados de upload de variáveis | Dados de configuração a serem carregados. Pode ser qualquer dado no formato definido pelo parâmetro dataFormat dos parâmetros de consulta. |
[Tabela 87. Parâmetros do corpo da solicitação (XML ou JSON)]
{#apps-POST-uploads-deployables__id_njw_zv3_psb}
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-uploads-deployables__id_ilq_dmb_fwb__entry__2}{#apps-POST-uploads-deployables__accept-JSON-only-entry-RESTAPI}
| 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. Tipos compatíveis: text/plain e application/x-www-form-urlencoded. Padrão: text/plain |
[Tabela 88. Cabeçalhos da solicitação]
{#apps-POST-uploads-deployables__id_ilq_dmb_fwb} {#apps-POST-uploads-deployables__entry__52}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 89. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-POST-uploads-deployables__id_gty_cw3_psb__entry__2}{#apps-POST-uploads-deployables__entry-200-status-code}{#apps-POST-uploads-deployables__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação incorreta. A solicitação de upload foi rejeitada. Possíveis problemas: * O tamanho da carga de configuração é maior que o máximo permitido - 2 MB por padrão. * Os parâmetros obrigatórios estão ausentes na chamada. {#apps-POST-uploads-deployables__ul_kmn_gkh_psb} |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 90. Códigos de status]
{#apps-POST-uploads-deployables__id_gty_cw3_psb}
### Parâmetros do corpo da resposta (JSON ou XML)
{#apps-POST-uploads-deployables__id_gcv_2w3_psb__entry__2}{#apps-POST-uploads-deployables__cdm_apps-stat-error}{#apps-POST-uploads-deployables__cdm_apps-stat-error_detail-row}{#apps-POST-uploads-deployables__cdm_apps-stat-error_messaage-row}{#apps-POST-uploads-deployables__cdm_apps-stat-error_status-row}{#apps-POST-uploads-deployables__cdm_apps-upload_id-row}
| Nome | Descrição |
|-|-|
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem de erro gerada ao tentar processar a solicitação. Tipo de dados: cadeia de caracteres |
| status | Status de erro da solicitação. Valores possíveis: falha Tipo de dados: cadeia de caracteres |
| upload_id | Sys_id da solicitação de upload. Use este ID para chamar o endpoint [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/zYTyg0jH7TDuYETyOVJGyg#apps-GET-upload-status "Retorna o status atual da solicitação de carregamento de dados de configuração especificada.") para obter o status do carregamento. Tipo de dados: cadeia de caracteres |
[ ]
{#apps-POST-uploads-deployables__id_gcv_2w3_psb}
### Solicitação de cURL
O exemplo a seguir mostra uma solicitação de carregamento para a aplicação Demo_App1631126164773.
curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/deployables?deployableName=TST-1&autoValidate=false&dataFormat=json&autoDelete=false&changesetNumber=Chset-102&appName=Demo_App1631126164773&publishOption=publish_none&autoCommit=true&namePath=%2FSettings%2FdbSettings" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:text/plain" \
--data "{
\"dbIPAddress\": \"10.10.10.110\",
\"dbPort\": \"8080\",
\"dbConnectionString\": \"admin:admin server1.xyz.com:8080 dbName_payments\",
\"dbConnectionStringBackup\": \"admin:admin server2.xyz.com dbName_payments_backup\"
}" \
--user 'username':'password'
Os resultados de retorno a seguir mostram uma resposta de sucesso e de erro para esta solicitação.
// Successful completion of the upload request
{
"result": {
"upload_id": "ec1f71f45322301096edddeeff7b12b3"
}
}
// Error response. Payload is too large.
{
"error": {
"message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)",
"detail": ""
},
"status": "failure"
}
## CdmApplicationsApi -- PUT /sn_cdm/applications/deployables {#ariaid-title17}
Atualiza o componente compartilhado especificado em uma aplicação dentro de um changeset especificado.
Permite uma atualização nos seguintes campos:
* Nome
* Descrição
* Serviço de aplicações\\Grupo de ICs dinâmicos
* Identificador de implantável
{#apps-PUT-application_deployables__ul_dgk_lzh_qxb}
A função de administrador do CDM é necessária para acessar este endpoint.
### Formato da URL
URL com controle de versões: /api/sn_cdm/{api_version}/applications/deployables
URL padrão: /api/sn_cdm/applications/deployables
### Parâmetros de solicitação compatíveis
{#apps-PUT-application_deployables__entry__2}
| 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 91. Parâmetros de caminho]
{#apps-PUT-application_deployables__entry__6}
| Nome | Descrição |
|-|-|
| appName | Obrigatório. Nome da aplicação CDM. Tipo de dados: cadeia de caracteres |
| nome | Obrigatório. Nome do implantável do CDM. Tipo de dados: cadeia de caracteres |
| newDescription | Opcional. Uma descrição do implantável do CDM. Tipo de dados: cadeia de caracteres |
| newServiceId | Opcional. O ID do serviço de aplicações/grupo de ICs dinâmicos desejado. Na solicitação cURL, forneça `""` para desconectar o implantável do serviço. |
| newIdentifier | Opcional. O identificador do implantável. Tipo de dados: Opção (Desenvolvimento/Teste/Produção |
| novoNome | Opcional. O novo nome do implantável. Tipo de dados: cadeia de caracteres |
| returnFields | Opcional. Lista separada por vírgulas de campos a serem retornados como parte da resposta. |
[Tabela 92. Parâmetros de consulta]
{#apps-PUT-application_deployables__entry__22}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 93. Parâmetros do corpo da solicitação (XML ou JSON)]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-PUT-application_deployables__entry__26}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json |
[Tabela 94. Cabeçalhos da solicitação]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-PUT-application_deployables__entry__30}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 500 | Erro Interno do Servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 95. Códigos de status]
### Parâmetros do corpo da resposta (JSON ou XML)
{#apps-PUT-application_deployables__entry__38}
| Nome | Descrição |
|-|-|
| sys_id | sys_Id implantável do CDM. |
| nome | Nome do implantável do CDM. |
| node | Objeto de nó implantável. `{ 'valor': ' ', 'link': 'http://localhost:8081/api/now/table/*'}` |
| descrição | Descrição implantável do CDM. |
| identificador | Um identificador para o implantável. |
| cmdb_ci | O objeto de serviço de apps que está conectado a um implantável. `{ 'valor': ' ', 'link': 'http://localhost:8081/api/now/table/*'}` |
| cmdb_app | O objeto da aplicação CDM. `{ 'valor': ' ', 'link': 'http://localhost:8081/api/now/table/*'}` |
| snapshot_version_counter | A contagem de snapshots criados para um implantável. |
| cdi_count | O número de CDIs contidos neste CDM implantável. |
| cdi_usage | A porcentagem de uso do CDI. |
| tipo_ambiente | O tipo de ambiente. Valores possíveis: * desenvolvimento * produção * teste {#apps-PUT-application_deployables__ul_y2w_5c3_qxb} |
| estado | O estado ativo ou excluído . Valores possíveis: * ativo * excluído {#apps-PUT-application_deployables__ul_cth_wc3_qxb} |
| sys_created_by | CDM implantável criado por\ . |
| sys_created_on | Carimbo de data/hora de criação implantável do CDM no formato de\ . |
| sys_updated_by | CDM implantável atualizado por\ . |
| sys_updated_on | CDM implantável atualizado por carimbo de data/hora no formato de\ . |
[ ]
### Solicitação de cURL
curl "http://localhost:8080/api/sn_cdm/applications/deployables?appName=testApp&name=Dep-1" \
--request PUT\
--header "Accept:application/json" \
--user 'cdm_admin':'password1!'
Saída:
{
"result": {
"identifier": "identiy1",
"cmdb_ci": {
"value": "f5b9e00b53901110a1d3ddeeff7b12b8",
"link": "http://192.168.0.233:8080/api/now/table/cmdb_ci_service_auto/f5b9e00b53901110a1d3ddeeff7b12b8"
},
"cdi_count": "3",
"snapshot_version_counter": "1",
"description": "cdcds",
"sys_updated_on": "2022-07-27 13:40:13",
"environment_type": "Test",
"node": {
"value": "30c00d4053015110a1d3ddeeff7b12bf",
"link": "http://192.168.0.233:8080/api/now/table/sn_cdm_node/30c00d4053015110a1d3ddeeff7b12bf"
},
"sys_id": "39b9e00b53901110a1d3ddeeff7b12b7",
"sys_updated_by": "admin",
"cdm_app": {
"value": "62b517a953b70110a1d3ddeeff7b128c",
"link": "http://192.168.0.233:8080/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c"
},
"sys_created_on": "2022-06-29 12:53:57",
"cdi_usage": "0.03",
"name": "Dep-2",
"state": "active",
"sys_created_by": "admin"
}
}
## CdmApplicationsApi -- PUT /sn_cdm/applications/shared_components {#ariaid-title18}
Atualiza o componente compartilhado especificado em uma aplicação dentro de um changeset especificado.
A função de administrador do CDM é necessária para acessar este endpoint.
### Formato da URL
URL com controle de versão: /api/sn_cdm/{api_version}/applications/shared_components
URL padrão: /api/sn_cdm/applications/shared_components
### Parâmetros de solicitação compatíveis
{#apps-PUT-shared_components__entry__2}{#apps-PUT-shared_components__version-RESTAPI}
| 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 96. Parâmetros de caminho]
{#apps-PUT-shared_components__entry__6}{#apps-PUT-shared_components__cdm_apps-returnFields-entry}
| Nome | Descrição |
|-|-|
| changesetNumber | Obrigatório. Identificador exclusivo do changeset associado ao componente. Tipo de dados: cadeia de caracteres |
| returnFields | Lista de campos a serem retornados como parte da resposta. Passe os nomes da coluna de registro, como sys_id, sys_updated_by ou state. Tipo de dados: matriz Padrão: todos os campos determinados pelo endpoint |
| sharedComponentName | Obrigatório. Nome do componente compartilhado associado à aplicação especificada. Localizado na tabela Componente compartilhado do CDM \[sn_cdm_shared_component\]. Tipo de dados: cadeia de caracteres |
| sharedLibraryName | Obrigatório. Nome da biblioteca compartilhada na qual o componente reside. Localizado na tabela Aplicação de CDM \[sn_cdm_application\]. A biblioteca compartilhada deve ter os seguintes campos definidos da seguinte forma: * estado = ativo * disponível = verdadeiro * tipo = shared_library Tipo de dados: cadeia de caracteres |
| versão | Obrigatório. Nome da versão associada ao componente compartilhado. Localizado na tabela Snapshot do CDM \[sn_cdm_snapshot\]. Tipo de dados: cadeia de caracteres |
[Tabela 97. Parâmetros de consulta]
{#apps-PUT-shared_components__entry__18}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 98. Parâmetros do corpo da solicitação]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-PUT-shared_components__entry__22}{#apps-PUT-shared_components__accept-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
[Tabela 99. Cabeçalhos da solicitação]
{#apps-PUT-shared_components__entry__26}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 100. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#apps-PUT-shared_components__entry__30}{#apps-PUT-shared_components__entry-200-status-code}{#apps-PUT-shared_components__entry-500-status-code}
| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. O changeset aprovado não existe. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 101. Códigos de status]
### Parâmetros do corpo da resposta
Os campos de resposta dependem de quais campos foram especificados no parâmetro returnFields na solicitação. A seguir, descrevemos alguns dos campos mais importantes.
{#apps-PUT-shared_components__entry__38}{#apps-PUT-shared_components__changeset-node-editor-entry}{#apps-PUT-shared_components__changeset_link-node-editor-entry}{#apps-PUT-shared_components__changeset_value-node-editor-entry}{#apps-PUT-shared_components__cdm_apps-error-entry}{#apps-PUT-shared_components__cdm_apps-error_detail-entry}{#apps-PUT-shared_components__cdm_apps-error_message-entry}{#apps-PUT-shared_components__cdm_dep-sys_created_by-row}{#apps-PUT-shared_components__cdm_deps-sys_created_on-row}{#apps-PUT-shared_components__sys_id-node-editor-entry}{#apps-PUT-shared_components__cdm_dep-sys_updated_by-row}{#apps-PUT-shared_components__cdm_dep-sys_updated_on-row}
| Nome | Descrição |
|-|-|
| changeset_id | Detalhes do registro do changeset associado ao nó. Tipo de dados: objeto "changeset_id": { "link": "String", "value": "String" } |
| changeset_id.link | Sintaxe de chamada para consultar este registro de changeset usando a API REST de tabela. Tipo de dados: cadeia de caracteres |
| changeset_id.valor | Identificador exclusivo do registro do changeset. Localizado na tabela CDM Changeset \[sn_cdm_changeset\]. Tipo de dados: cadeia de caracteres |
| descrição | Descrição do nó do CDM. Tipo de dados: cadeia de caracteres |
| erro | Retornado somente se ocorreu um erro durante o processamento. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Detalhes sobre o erro ocorrido. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem que fornece uma visão geral do erro. Tipo de dados: cadeia de caracteres |
| vinculado_a | ID do nó principal associado ao componente compartilhado. Tipo de dados: cadeia de caracteres |
| vinculado_a_versão | Detalhes do registro de snapshot do CDM associado ao nó. Tipo de dados: objeto "linked_to_version": { "link": "String", "value": "String" } |
| vinculado_a_versão.link | Sintaxe de chamada para consultar este registro de versão usando a API REST de tabela. Tipo de dados: cadeia de caracteres |
| vinculado_a_versão.valor | Sys_id do registro da versão. Tipo de dados: cadeia de caracteres |
| principal | Sinalizador que indica se o snapshot associado foi publicado. Valores válidos: * verdadeiro: o snapshot foi publicado. * falso: o snapshot não foi publicado. |
| main_id | ID exclusivo do nó principal recém-criado. Tipo de dados: cadeia de caracteres |
| main_id_encoded | ID codificado do nó principal recém-criado. Tipo de dados: cadeia de caracteres |
| nome | Nome do nó do CDM. Tipo de dados: cadeia de caracteres |
| node | Sys_id do nó do componente compartilhado. Tipo de dados: cadeia de caracteres |
| nó_caminho | Caminho para o novo nó vinculado criado ao adicionar o componente compartilhado. Tipo de dados: cadeia de caracteres |
| status | Status do nó. Valores possíveis: Novo Tipo de dados: cadeia de caracteres |
| sys_created_by | Nome de usuário do usuário que cria o nó do CDM. Por exemplo, "able.tuter". Tipo de dados: cadeia de caracteres |
| sys_created_on | Data e hora em que o nó do CDM foi criado. Formato: AAAA-mm-DD hh:mm:ss Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id do nó. Localizado na tabela Nó do CDM \[sn_cdm_node\]. Tipo de dados: cadeia de caracteres |
| sys_updated_by | Nome de usuário do usuário que atualizou o nó do CDM pela última vez. Por exemplo, "able.tuter". Tipo de dados: cadeia de caracteres |
| sys_updated_on | Data e hora em que o nó do CDM foi atualizado pela última vez. Formato: AAAA-mm-DD hh:mm:ss Tipo de dados: cadeia de caracteres |
| tipo | Tipo de nó. Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
O exemplo a seguir mostra como chamar este endpoint para atualizar a aplicação "App1" com o componente compartilhado "paymentService-V1.1" na biblioteca compartilhada "OracleG-Library-10" no changeset "Chset-20".
"https://instance-name.service-now.com/api/sn_cdm/applications/shared_components?sharedComponentName=paymentService-V1.1&sharedLibraryName=OracleG-Library-10&changesetNumber=Chset-20&versionName=sComp3-v2.shc&appName=App1" \
--request PUT \
--header "Accept:application/json" \
--user 'username':'password'
Resposta:
"result": {
"changeset_id": {
"value": "7343d0f71b771110636e0fe0604bcb0b",
"link": "https://instance-name.service-now.com/api/now/table/sn_cdm_changeset/7343d0f71b771110636e0fe0604bcb0b"
},
"node_path": "!2!3!&`",
"description": null,
"sys_updated_on": "2022-12-22 18:52:38",
"type": "sn_cdm_node_linked_shared_component",
"sys_class_name": "sn_cdm_node",
"sys_id": "339314b71b771110636e0fe0604bcba3",
"sys_updated_by": "admin",
"previous_version": {
"value": "a9ce80bf1b371110636e0fe0604bcb10",
"link": "https://instance-name.service-now.com/api/now/table/sn_cdm_node/a9ce80bf1b371110636e0fe0604bcb10"
},
"sys_created_on": "2022-12-22 18:52:38",
"value": null,
"effective_from": null,
"linked_to": "146",
"sys_created_by": "admin",
"restricted_to": null,
"linked_to_version": {
"value": "54115c371b771110636e0fe0604bcb77",
"link": "https://instance-name.service-now.com/api/now/table/sn_cdm_snapshot/54115c371b771110636e0fe0604bcb77"
},
"level": "2",
"conflict_type": null,
"main_id": "166",
"effective_to": null,
"secure_value": null,
"node_classifier": "/application/components",
"main_id_encoded": "&`",
"name": "Component_A",
"position": null,
"reason_for_conflict": null,
"system_folder": false,
"status": "updated",
"conflict": false
}