CdmSharedLibraryApi
. CdmSharedLibraryApi fornece endpoints que permitem criar e gerenciar bibliotecas compartilhadas e componentes compartilhados. Ele também tem endpoints que permitem carregar e exportar os dados de configuração de um componente compartilhado.
- Função do Editor do CDM
- Função de administrador do CDM
Para obter informações adicionais sobre bibliotecas compartilhadas e componentes compartilhados, consulte Compartilhamento de componentes entre aplicações - bibliotecas de componentes .
CdmSharedLibraryApi - EXCLUI /sn_cdm/shared_librarics
Exclui a biblioteca compartilhada com o nome especificado.
A função de administrador do CDM é necessária para acessar este endpoint.
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Tipo de dados: Cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| nome | Obrigatório. Nome da biblioteca compartilhada a ser excluída. Tipo de dados: Cadeia de caracteres Tabela: Aplicação CDM [sn_cdm_application] |
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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis:
Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: Objeto |
| error.detail | 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 a biblioteca compartilhada "javalib".
curl "http://instance.servicenow.com/sn_cdm/shared_libraries?name='javalib'\
--request DELETE\
--header "Accept:application/json" \
--user 'username':'password'Resposta:
""CdmSharedLibraryApi - EXCLUI /sn_cdm/shared_librarics/components
Exclui o componente compartilhado especificado da biblioteca especificada.
A função Editor do CDM é necessária para acessar este endpoint.
Formato de URL
URL com controle de versão: /api/sn_cdm/
URL padrão: /api/sn_cdm/shared_librches/components
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Tipo de dados: Cadeia de caracteres |
| Nome | Descrição |
|---|---|
| changesetNumber | Obrigatório. Número do conjunto de mudanças associado ao componente. Tipo de dados: Cadeia de caracteres Tabela: Conjunto de mudanças do CDM [sn_cdm_changeset] |
| nome | Obrigatório. Nome do componente compartilhado a ser excluído. Tipo de dados: Cadeia de caracteres Tabela: Componente compartilhado do CDM [sn_cdm_shared_component] |
| sharedLibraryName | Obrigatório. Nome da biblioteca compartilhada em que o componente a ser excluído está localizado. Tipo de dados: Cadeia de caracteres Tabela: Aplicação CDM [sn_cdm_application] |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis:
Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Possíveis problemas: |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta
| Nome | Descrição |
|---|---|
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: Objeto |
| error.detail | 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 "TestComponent" na biblioteca compartilhada "javalib".
curl "http://instance.servicenow.com/sn_cdm/shared_libraries/components?sharedLibraryName='javalib&changesetNumber='chset-8'&name='TestComponent'\
--request DELETE\
--header "Accept:application/json" \
--user 'username':'password' Resposta:
""CdmSharedLibraryApi - OBTÉM /sn_cdm/shared_librbibliotecas/upload-status/
Retorna o status atual da solicitação de carregamento da biblioteca compartilhada especificada.
Formato de URL
URL com controle de versão: /api/sn_cdm/
URL padrão: /api/sn_cdm/shared_librches/upload-status/
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Tipo de dados: Cadeia de caracteres |
| id do upload | Sys_id da solicitação de carregamento cujo status será retornado. Este valor é retornado por vários endpoints de solicitação de carregamento do CdmSharedLibrary. Tipo de dados: Cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis:
Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| erros | Descrição dos erros encontrados durante o carregamento. 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 | Indica se a validação deve ser invocada após a confirmação. Tipo de dados: Cadeia de caracteres |
| output.cdm_application | Nome da aplicação na qual o carregamento foi realizado. Tipo de dados: Cadeia de caracteres |
| output.committed_at | Data e hora em que o conteúdo carregado foi confirmado. Tipo de dados: Cadeia de caracteres |
| output.committed_by | Sys_id do registro da entidade que executou a confirmação. Tipo de dados: Cadeia de caracteres |
| output.description | Atualmente não usado. Tipo de dados: Cadeia de caracteres |
| output.last_conflict_detection_time | Invocação de detecção de conflito de data e hora. Tipo de dados: Cadeia de caracteres |
| output.number | Valor de identificação do conjunto de mudanças exclusivo, como Chset-124. Tipo de dados: Cadeia de caracteres |
| output.publish_option | Valor da opção de publicação aprovada na chamada de carregamento associada. Para obter informações adicionais sobre como publicar snapshots, consulte Publicar ou cancelar a publicação de um snapshot . Tipo de dados: Cadeia de caracteres |
| Output.sharedLibraryName | Nome da biblioteca compartilhada conforme passado na chamada de carregamento original. Tipo de dados: Cadeia de caracteres |
| output.snapshot_description | Descrição do snapshot associado. Tipo de dados: Cadeia de caracteres |
| output.snapshot_name | Nome do snapshot associado. Tipo de dados: Cadeia de caracteres |
| output.state | Estado do carregamento. Valores possíveis:
Tipo de dados: Cadeia de caracteres |
| output.sys_created_by | Sys_id da entidade que criou o registro. Tipo de dados: Cadeia de caracteres |
| output.sys_id | Sys_id do registro que contém o conjunto de mudanças. Tipo de dados: Cadeia de caracteres |
| output.title | Título do conjunto de mudanças criado como parte do carregamento. Tipo de dados: Cadeia de caracteres |
| processing_state | Estado de processamento atual da solicitação de carregamento. Valores possíveis: PROCESSADO Tipo de dados: Cadeia de caracteres |
| estado | Estado atual da solicitação de carregamento. Valores possíveis:
|
| tipo | Tipo de solicitação de carregamento. Valores possíveis: Upload_and_commit Tipo de dados: Cadeia de caracteres |
| upload_id | Sys_id do registro que contém a carga de configuração carregada. Tipo de dados: Cadeia de caracteres |
Solicitação de curl
Este exemplo de código mostra como solicitar o status do ID de upload 0d91d9891b2b19109524cae0604bcbe6.
curl "http://instance.servicenow.com/api/sn_cdm/shared_libraries/upload-status/0d91d9891b2b19109524cae0604bcbe6" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'Resposta:
// Successful response
{
"result": {
"type": "upload_and_commit",
"state": "completed",
"output": {
"sys_id": "0002ea107768a1109ac0cf0bbb5a9963",
"number": "Chset-457",
"title": "admin8802ea107768a1109ac0cf0bbb5a9962",
"description": null,
"committed_at": "",
"committed_by": null,
"sys_created_by": "admin",
"state": "open",
"publish_option": "publish_none",
"auto_validate": false,
"snapshot_name": null,
"snapshot_description": null,
"cdm_application": "OracleG-Library-15",
"last_conflict_detection_time": null
},
"processing_state": "PROCESSED",
"upload_id": "00b226547768a1109ac0cf0bbb5a99f2"
}
}
// Error response
{
"result": {
"type": "upload_and_commit",
"state": "error",
"output": "Error: Application with sys_id 87fb1ecb1be3111050fc21b0604bcb95 is in State Deleted. No data can be modified on deleted applications",
"processing_state": "PROCESSED",
"upload_id": "fcdfaf7f1b88211050fc21b0604bcb79"
}
}CdmSharedLibraryApi - POST /sn_cdm/shared_librarics
Cria uma nova biblioteca compartilhada com o nome especificado.
A função de administrador do CDM é necessária para acessar este endpoint.
Formato de URL
URL com controle de versão: /api/sn_cdm/
URL padrão: /api/sn_cdm/shared_librches
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Tipo de dados: Cadeia de caracteres |
| Nome | Descrição |
|---|---|
| descrição | Descrição da biblioteca compartilhada. Tipo de dados: Cadeia de caracteres Vazio |
| nome | Obrigatório. Nome da biblioteca compartilhada a ser criada. Este nome deve ser exclusivo em todas as aplicações e bibliotecas do CDM. Tipo de dados: Cadeia de caracteres |
| returnFields | Lista separada por vírgulas de campos a serem retornados como parte da resposta. Tipo de dados: Cadeia de caracteres Padrão: Todos os campos que não são do sistema são retornados. Tabela: Aplicação CDM [sn_cdm_application] |
| UserGroupIds | Lista separada por vírgulas de sys_ids dos grupos de usuários que podem editar a biblioteca compartilhada associada. Todos os usuários com as funções apropriadas podem exibir a biblioteca compartilhada. Tipo de dados: Cadeia de caracteres Padrão: Todos os usuários com a função de Editor do CDM podem editar dados na biblioteca compartilhada. Tabela: Grupo [sys_user_group] |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis:
Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta
| Nome | Descrição |
|---|---|
| <fields> | Campos solicitados. Tipo de dados: Variável Tabela: Aplicação CDM [sn_cdm_application] |
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: Objeto |
| error.detail | 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 chamar este endpoint para criar a biblioteca compartilhada Java11Lib com todos os grupos de usuários capazes de acessar a biblioteca.
curl "http://instance.servicenow.com/api/sn_cdm/shared_libraries?name=Java11Lib&description=The%20new%20java%20library" \
--request POST \
--header "Accept:application/json" \
--user 'userName':'passwordResposta:
{
"result": {
"sdlc_component": null,
"cdi_count": "0",
"available": false,
"description": "Description of LibraryA",
"managed_by_group": null,
"sys_updated_on": "2023-01-18 11:34:43",
"type": "shared_library",
"node": {
"value": "d852b15877a4a1109ac0cf0bbb5a99aa",
"link": "http://instance.servicenow.com/api/now/table/sn_cdm_node/d852b15877a4a1109ac0cf0bbb5a99aa"
},
"sys_id": "185235dc77a4a1109ac0cf0bbb5a994e",
"sys_updated_by": "admin",
"node_main": {
"value": "1852b15877a4a1109ac0cf0bbb5a99aa",
"link": "http://instance.servicenow.com/api/now/table/sn_cdm_node_main/1852b15877a4a1109ac0cf0bbb5a99aa"
},
"sys_created_on": "2023-01-18 11:34:43",
"cdi_usage": "0",
"name": "LibraryA",
"last_committed_changeset": {
"value": "9052b15877a4a1109ac0cf0bbb5a99aa",
"link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/9052b15877a4a1109ac0cf0bbb5a99aa"
},
"state": "active",
"sys_created_by": "admin"
}
}CdmSharedLibraryApi - POST /sn_cdm/shared_librarics/components
Cria o componente compartilhado especificado na biblioteca especificada.
A função Editor do CDM é necessária para acessar este endpoint.
Formato de URL
URL com controle de versão: /api/sn_cdm/
URL padrão: /api/sn_cdm/shared_librches/components
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Tipo de dados: Cadeia de caracteres |
| Nome | Descrição |
|---|---|
| changesetNumber | Obrigatório. |
| descrição | Descrição do componente compartilhado. Tipo de dados: Cadeia de caracteres |
| nome | Obrigatório. Nome do componente compartilhado a ser criado na biblioteca compartilhada. Este nome deve ser exclusivo. Tipo de dados: Cadeia de caracteres |
| returnFields | Lista separada por vírgulas de campos na tabela Nó do CDM [sn_cdm_node] para retornar como parte da resposta. Tipo de dados: Cadeia de caracteres Padrão: Todos os campos não internos são retornados. |
| sharedLibraryName | Obrigatório. Nome da biblioteca compartilhada na qual o componente será criado. Esta biblioteca já deve existir e estar no estado ativo. Tipo de dados: Cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis:
Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta
| Nome | Descrição |
|---|---|
| <requested fields> | Campos solicitados. Tipo de dados: Vários Tabela: Nó do CDM [sn_cdm_node] |
| erro | Retornado somente se ocorreu um erro durante o processamento. Tipo de dados: Objeto |
| error.detail | 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 |
| 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 armazena o componente chamado "SharedComponent" na biblioteca compartilhada "javalib".
curl "http://instance.servicenow.com/sn_cdm/shared_libraries/components/?sharedLibraryName=javalib&changeSetNumber='Chset-9'&name='SharedComponent'\
--request POST\
--header "Accept:application/json" \
--user 'username':'password'Resposta:
{
"result": {
"changeset_id": {
"value": "ca7e6a501b202110636e0fe0604bcb71",
"link": "https://instance.servicenow.com/api/now/table/sn_cdm_changeset/ca7e6a501b202110636e0fe0604bcb71"
},
"node_path": "!2!3!:",
"description": null,
"sys_updated_on": "2023-01-18 16:04:52",
"type": "sn_cdm_node_shared_component",
"sys_class_name": "sn_cdm_node",
"sys_id": "6d2072901b602110636e0fe0604bcbec",
"sys_updated_by": "admin",
"previous_version": null,
"sys_created_on": "2023-01-18 16:04:52",
"value": null,
"effective_from": null,
"linked_to": null,
"sys_created_by": "admin",
"restricted_to": null,
"linked_to_version": null,
"level": "2",
"conflict_type": null,
"main_id": "19",
"effective_to": null,
"secure_value": null,
"node_classifier": "/shared_library/shared_components",
"main_id_encoded": ":",
"name": "testSharedComponent",
"position": null,
"reason_for_conflict": null,
"system_folder": false,
"status": "new",
"conflict": false
}
}CdmSharedLibraryApi - POST /sn_cdm/shared_librarics/uploads/components
Permite que você crie e gerencie bibliotecas compartilhadas e componentes compartilhados. Este endpoint cria um nó de componente compartilhado na tabela Nó do CDM [sn_cdm_node] e um registro de componente compartilhado na tabela Componente compartilhado do CDM [sn_cdm_shared_component].
A função Editor do CDM é necessária para acessar este endpoint.
Formato de URL
URL com controle de versão: /api/sn_cdm//shared_librches/uploads/components
URL padrão: /api/sn_cdm/shared_librches/uploads/components
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Tipo de dados: Cadeia de caracteres |
| Nome | Descrição |
|---|---|
| AutoCOMMIT | Sinalizador que indica se o conjunto de mudanças foi identificado no changesetNumbero parâmetro é confirmado com o modelo de dados após o carregamento. Valores válidos:
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:
Tipo de dados: Booliano Padrão: falso |
| changesetNumber | Obrigatório. Cadeia de caracteres que identifica exclusivamente o conjunto de mudanças associado à aplicação, como Chset-102. Este conjunto de mudanças deve estar no estado "Aberto". Tipo de dados: Cadeia de caracteres Tabela: Conjunto de mudanças do CDM [sn_cdm_changeset] |
| DataFormat | Obrigatório. Formato dos dados de configuração. Valores válidos:
Tipo de dados: Cadeia de caracteres |
| DeleteRedundandandadOverrides | Sinalizador que indica se uma substituição deve ser criada quando valores redundantes estão presentes. Valores válidos:
Padrão: verdadeiro |
| IdentifierKeys | Lista de nomes que indicam qual chave em uma matriz secundária usar para identificar o mesmo nó. Por exemplo, se você estiver carregando: no seguinte modelo existente: e você definiu identifierKeys. nome produz a seguinte saída: Caso contrário, ele produz a seguinte saída: Tipo de dados: Matriz de cadeias de caracteres |
| IgnoreAtributos | Sinalizador que indica se o formato de dados fornecido oferece suporte a atributos (atualmente, somente XML). Valores válidos: Tipo de dados: Booliano Padrão: falso |
| namePath | Caminho do nó de destino no 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). 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 |
| PublichOption | Opção de publicação para os snapshots configurados associados. Valores válidos:
Para obter informações adicionais sobre como publicar snapshots, consulte Publicar ou cancelar a publicação de um snapshot . Tipo de dados: Cadeia de caracteres Padrão: Publish_none |
| sharedLibraryName | Obrigatório. Nome da biblioteca compartilhada a ser criada ou gerenciada. Tipo de dados: Cadeia de caracteres Tabela: Aplicação CDM [sn_cdm_application] |
| Nome | Descrição |
|---|---|
| Dados de carregamento de variáveis | Dados de configuração a serem carregados. Quaisquer dados no formato definido pelo dataFormatparâmetro dos parâmetros de consulta. |
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 .
| 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/plaine. application/x-www-form-urlencoded. Padrão: text/plain |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. A solicitação de carregamento foi rejeitada. Possíveis problemas:
|
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta
| Nome | Descrição |
|---|---|
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: Objeto |
| error.detail | 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 |
| upload_id | Sys_id da solicitação de carregamento. Use este ID para chamar o endpoint para obter o status do carregamento. 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 mostra como carregar a biblioteca compartilhada chamada Demo_App1631126164773 com os dados de configuração em texto sem formatação.
curl "http://instance.servicenow.com/api/sn_cdm/sharedlibrary/component/upload?namePath=%2FSettings%2FdbSettings&dataFormat=json&appName=Demo_App1631126164773&changesetNumber=Chset-8&autoCommit=false&publishOption=publish_none&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 bem-sucedida e uma resposta de erro para esta solicitação.
// Successful response
{
"result": {
"upload_id": "ec1f71f45322301096edddeeff7b12b3"
}
}
// Error response
{
"error": {
"message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)",
"detail": ""
},
"status": "failure"
} CdmSharedLibraryApi - POST /sn_cdm/shared_librches/uploads/components/file
Carrega arquivos como parte do Configuration Data Model (CDM) na pasta Componentes em uma biblioteca compartilhada.
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Tipo de dados: Cadeia de caracteres |
| AutoCOMMIT | Sinalizador que indica se o conjunto de mudanças foi identificado no changesetNumbero parâmetro é confirmado com o modelo de dados após o carregamento. Valores válidos:
Tipo de dados: Booliano Padrão: falso |
| Validar automaticamente | Sinalizador que indica se os snapshots criados quando confirmados são validados. Valores válidos:
Nota: Esta opção só estará disponível se autoCommito parâmetro é verdadeiro . Tipo de dados: Booliano Padrão: falso |
| changesetNumber | Cadeia de caracteres que identifica exclusivamente o. conjunto de mudanças Associado à aplicação, como Chset-102. Este conjunto de mudanças deve estar no estado "Aberto". Tipo de dados: Cadeia de caracteres Padrão: Cria um conjunto de mudanças a ser usado. Os detalhes do conjunto de mudanças são retornados como parte do CdmApplicationsApi - OBTER /sn_cdm/applications/upload-status/ resultados. Tabela: Conjunto de mudanças do CDM [sn_cdm_changeset] |
| nomeArquivo | 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 do nome do arquivo é 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á-lo. Este nome não requer uma extensão de arquivo nem afeta o download. Tipo de dados: Cadeia de caracteres |
| namePath | Caminho do nó de destino no 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). 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. Tipo de dados: Cadeia de caracteres Tabela: Aplicação CDM [sn_cdm_application] |
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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Padrão: application/json |
| Tipo de conteúdo | Tipo de conteúdo do arquivo a ser carregado. Exemplos: Application/zip, text/plain, application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Solicitação de curl
A chamada a seguir demonstra como carregar um arquivo de texto sem formatação para a pasta Componentes na Biblioteca compartilhada.
curl "http://instance.servicenow.com/api/sn_cdm/shared_libraries/uploads/components/file?autoValidate=true&sharedLibraryName=sharedLibA &namePath=testComponent%2FfilesFolder&fileName=testFileNodeName.txt&publishOption=publish_valid&changesetNumber=Chset-108&autoCommit=true&fileNodeName=testFile.txt" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:text/plain" \
--data "This is sample content that will be uploaded to a plain text file."\
--user 'username':'password' Os resultados de retorno a seguir mostram uma resposta bem-sucedida e uma resposta de erro para esta solicitação.
// Successful completion of the upload request
{
"result": {
"upload_id": "ec1f71f45322301096edddeeff7b12b3"
}
}
// Error response. Payload is too large.
{
"error": {
"message": "Could not find active application with name: ‘testApp’ of type application",
"detail": ""
},
"status": "failure"
}CdmSharedLibraryApi - PUT /sn_cdm/shared_librries
Atualiza as informações da biblioteca compartilhada. Use este endpoint para atualizar o nome, a descrição, o estado de uma biblioteca compartilhada e os grupos de usuários que podem acessar a biblioteca.
A função de administrador do CDM é necessária para acessar este endpoint.
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Tipo de dados: Cadeia de caracteres |
| Nome | Descrição |
|---|---|
| nome | Obrigatório. Nome da biblioteca compartilhada a ser atualizada. Tipo de dados: Cadeia de caracteres Tabela: Aplicação CDM [sn_cdm_application] |
| NoAvailableState | Sinalizador que indica o estado da biblioteca compartilhada. Valores válidos:
Padrão: verdadeiro |
| NovoDescrição | Descrição atualizada da biblioteca compartilhada. Tipo de dados: Cadeia de caracteres |
| Novo nome | Novo nome da biblioteca compartilhada. Tipo de dados: Cadeia de caracteres |
| NoUserGroupIds | Lista separada por vírgulas de sys_ids dos grupos de usuários que podem acessar a biblioteca compartilhada associada. Tipo de dados: Cadeia de caracteres Tabela: Grupo [sys_user_group] |
| returnFields | Lista separada por vírgulas de campos na tabela Aplicação CDM [sn_cdm_application] para retornar como parte da resposta. Tipo de dados: Cadeia de caracteres Padrão: Todos os campos que não são do sistema são retornados. |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis:
Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta
| Nome | Descrição |
|---|---|
| <fields> | Campos solicitados. Tipo de dados: Variável Tabela: Aplicação CDM [sn_cdm_application] |
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: Objeto |
| error.detail | 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 chamar este endpoint para a biblioteca compartilhada Java11Lib e atualizar o nome e a descrição da biblioteca.
curl "http://instance.servicenow.com/sn_cdm/shared_libraries?name=' javalib'&newName=’NewLibraryName’&newDescription=’new%20description%20of%20library’\
--request PUT\
--header "Accept:application/json" \
--user 'username':'password' Resposta:
{
"result": {
"sdlc_component": null,
"cdi_count": "0",
"available": true,
"description": "Set new description",
"managed_by_group": null,
"sys_updated_on": "2023-01-18 11:51:14",
"type": "shared_library",
"node": {
"value": "021635dc77a4a1109ac0cf0bbb5a9952",
"link": "http://192.168.0.129:8080/api/now/table/sn_cdm_node/021635dc77a4a1109ac0cf0bbb5a9952"
},
"sys_id": "185235dc77a4a1109ac0cf0bbb5a994e",
"sys_updated_by": "admin",
"node_main": {
"value": "1852b15877a4a1109ac0cf0bbb5a99aa",
"link": "http://192.168.0.129:8080/api/now/table/sn_cdm_node_main/1852b15877a4a1109ac0cf0bbb5a99aa"
},
"sys_created_on": "2023-01-18 11:34:43",
"cdi_usage": "0",
"name": "LibraryA",
"last_committed_changeset": {
"value": "4a1635dc77a4a1109ac0cf0bbb5a9951",
"link": "http://192.168.0.129:8080/api/now/table/sn_cdm_changeset/4a1635dc77a4a1109ac0cf0bbb5a9951"
},
"state": "active",
"sys_created_by": "admin"
}
}CdmSharedLibraryApi - PUT /sn_cdm/shared_librarics/components
Atualiza o nome e a descrição do componente compartilhado especificado.
A função Editor do CDM é necessária para acessar este endpoint.
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Tipo de dados: Cadeia de caracteres |
| Nome | Descrição |
|---|---|
| changesetNumber | Obrigatório. Nome do conjunto de mudanças associado. Tipo de dados: Cadeia de caracteres Tabela:conjunto de mudanças do CDM [sn_cdm_changeset] |
| nome | Obrigatório. Nome do componente compartilhado a ser atualizado. Tipo de dados: Cadeia de caracteres Tabela: Componente compartilhado do CDM [sn_cdm_shared_component] |
| Novo nome | Obrigatório. Nome atualizado do componente compartilhado. Tipo de dados: Cadeia de caracteres |
| NovoDescrição | Descrição atualizada do componente compartilhado. Tipo de dados: Cadeia de caracteres Vazio |
| returnFields | Lista separada por vírgulas de campos na tabela Componente compartilhado do CDM [sn_cdm_shared_component] para retornar como parte da resposta. Tipo de dados: Cadeia de caracteres Padrão: Todos os campos que não são do sistema são retornados. |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis:
Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta
| Nome | Descrição |
|---|---|
| <fields> | Campos solicitados da tabela Componente compartilhado do CDM [sn_cdm_shared_component]. Tipo de dados: Variável |
| erro | Se ocorreu um erro durante o processamento, os detalhes sobre o erro. Tipo de dados: Objeto |
| error.detail | 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 atualizar a descrição do componente SharedComponentTest.
curl "http://instance.servicenow.com/sn_cdm/shared_libraries/components/?sharedLibraryName=javalib&changeSetNumber='chset-9'&name='SharedComponentTest'&newDescription='The shared component description'\
--request POST\
--header "Accept:application/json" \
--user 'username':'passwordResposta:
{
"result": {
"changeset_id": {
"value": "5c33311077e4a1109ac0cf0bbb5a9902",
"link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/5c33311077e4a1109ac0cf0bbb5a9902"
},
"node_path": "!(1!(2!(3",
"description": "Changing the description only",
"sys_updated_on": "2023-01-18 12:09:05",
"type": "sn_cdm_node_shared_component",
"sys_class_name": "sn_cdm_node",
"sys_id": "9953f99077a4a1109ac0cf0bbb5a99ec",
"sys_updated_by": "admin",
"previous_version": null,
"sys_created_on": "2023-01-18 11:39:09",
"value": null,
"effective_from": null,
"linked_to": null,
"sys_created_by": "admin",
"restricted_to": null,
"linked_to_version": null,
"level": "2",
"conflict_type": null,
"main_id": "183",
"effective_to": null,
"secure_value": null,
"node_classifier": "/shared_library/shared_components",
"main_id_encoded": "(3",
"name": "sharedComponentName",
"position": null,
"reason_for_conflict": null,
"system_folder": false,
"status": "new",
"conflict": false
}
}