CdmSharedLibraryApi

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 29 min. de leitura
  • A 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.

    Esta API requer que o plug-in Configuration Data Management (CDM) seja ativado para que essas APIs estejam disponíveis na instância. Além disso, você deve ter uma das seguintes funções para acessar esta API:
    • Função de 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 - DELETE /sn_cdm/shared_library

    Exclui a 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ões: /api/sn_cdm/{api_version}/shared_libraries

    URL padrão: /api/sn_cdm/shared_libraries

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres

    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    nome Obrigatório. Nome da biblioteca compartilhada a ser excluída. Localizado na tabela Aplicação do CDM [sn_cdm_application].

    Tipo de dados: cadeia de caracteres

    Cabeçalhos

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

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta.

    Tipos compatíveis:

    • application/json
    • application/xml
    • text/xml

    Padrão: application/json

    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 6. Códigos de status
    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.

    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": "String",
      "message": "String"
    }
    erro.detalhe Informações adicionais sobre o erro.

    Tipo de dados: cadeia de caracteres

    erro.mensagem 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 - DELETE /sn_cdm/shared_library/components

    Exclui o componente compartilhado especificado da biblioteca especificada.

    A função de Editor do CDM é necessária para acessar este endpoint.

    Nota:
    Você só poderá excluir um componente se ele não estiver sendo usado no momento. Além disso, você não pode excluir um componente se a biblioteca compartilhada associada não estiver ativa.

    Formato de URL

    URL com controle de versões: /api/sn_cdm/{api_version}/shared_libraries/components

    URL padrão: /api/sn_cdm/shared_libraries/components

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres

    Tabela 8. Parâmetros de consulta
    Nome Descrição
    changesetNumber Obrigatório. Número do changeset associado ao componente. Localizado na tabela Changeset do CDM [sn_cdm_changeset]

    Tipo de dados: cadeia de caracteres

    nome Obrigatório. Nome do componente compartilhado a ser excluído. Localizado na tabela Componente compartilhado do CDM [sn_cdm_shared_component].

    Tipo de dados: cadeia de caracteres

    sharedLibraryName Obrigatório. Nome da biblioteca compartilhada onde o componente a ser excluído está localizado. Localizado na tabela Aplicação do CDM [sn_cdm_application].

    Tipo de dados: cadeia de caracteres

    Tabela 9. Parâmetros do corpo da solicitação
    Nome Descrição
    Nenhum

    Cabeçalhos

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

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta.

    Tipos compatíveis:

    • application/json
    • application/xml
    • text/xml

    Padrão: application/json

    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 12. Códigos de status
    Código de status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta.
    Possíveis problemas:
    • A biblioteca compartilhada não existe.
    • A biblioteca compartilhada não está ativa.
    • O componente compartilhado está em uso. Não é possível excluí-lo.
    • O usuário tem restrição para excluir o componente compartilhado.
    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": "String",
      "message": "String"
    }
    erro.detalhe Informações adicionais sobre o erro.

    Tipo de dados: cadeia de caracteres

    erro.mensagem 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 - GET /sn_cdm/shared_libraries/upload-status/{upload-id}

    Retorna o status atual da solicitação de carregamento da biblioteca compartilhada especificada.

    Formato de URL

    URL com controle de versões: /api/sn_cdm/{api_version}/shared_libraries/upload-status/{upload-id}

    URL padrão: /api/sn_cdm/shared_libraries/upload-status/{upload-id}

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente 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 por vários endpoints de solicitação de upload de CdmSharedLibrary.

    Tipo de dados: cadeia de caracteres

    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 15. Parâmetros do corpo da solicitação
    Nome Descrição
    Nenhum

    Cabeçalhos

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

    Tabela 16. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta.

    Tipos compatíveis:

    • application/json
    • application/xml
    • text/xml

    Padrão: application/json

    Tabela 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 18. Códigos de status
    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.

    Parâmetros do corpo da resposta (JSON ou XML)

    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 upload, 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",
      "sharedLibraryName": "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_application Nome da aplicação na qual o upload 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

    saída.confirmado_por Sys_id do registro da entidade que realizou a confirmação.

    Tipo de dados: cadeia de caracteres

    output.description Não usado no momento.

    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

    número.saída Valor de identificação do conjunto de mudanças exclusivo, como Chset-124.

    Tipo de dados: cadeia de caracteres

    saída.publicar_opção Valor da opção de publicação passado na chamada de upload 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 upload original.

    Tipo de dados: cadeia de caracteres

    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

    estado.saída Estado do upload.
    Valores possíveis:
    • CONCLUÍDO: o carregamento foi concluído.
    • EXPIREDERROR: erro ao processar a solicitação de upload. O trabalho foi executado por mais de 15 minutos e foi encerrado pelo sistema.
    • IN_PROGRESS: o carregamento está em andamento.
    • NOVO: o processamento ainda não foi iniciado.
    • READY: a solicitação foi enfileirada.

    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

    output.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: PROCESSADO

    Tipo de dados: cadeia de caracteres

    state Estado atual da solicitação de upload.
    Valores possíveis:
    • concluída
    • Erro
    tipo Tipo de solicitação de upload.

    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 upload-id 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_library

    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ões: /api/sn_cdm/{api_version}/shared_libraries

    URL padrão: /api/sn_cdm/shared_libraries

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres

    Tabela 20. Parâmetros de consulta
    Nome Descrição
    description Descrição da biblioteca compartilhada.

    Tipo de dados: cadeia de caracteres

    Padrão: 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. Localizado na tabela Aplicação do CDM [sn_cdm_application].

    Tipo de dados: cadeia de caracteres

    Padrão: todos os campos que não sejam do sistema são retornados.

    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. Localizado na tabela Grupo [sys_user_group].

    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 21. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum

    Cabeçalhos

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

    Tabela 22. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta.

    Tipos compatíveis:

    • application/json
    • application/xml
    • text/xml

    Padrão: application/json

    Tabela 23. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 24. Códigos de status
    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.

    Parâmetros do corpo da resposta

    Nome Descrição
    <fields> Campos solicitados da tabela da aplicação do CDM [sn_cdm_application].

    Tipo de dados: variável

    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

    erro.mensagem 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':'password

    Resposta:

    {
      "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_library/components

    Cria o componente compartilhado especificado na biblioteca especificada.

    A função de Editor do CDM é necessária para acessar este endpoint.

    Formato de URL

    URL com controle de versões: /api/sn_cdm/{api_version}/shared_libraries/components

    URL padrão: /api/sn_cdm/shared_libraries/components

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres

    Tabela 26. Parâmetros de consulta
    Nome Descrição
    changesetNumber Obrigatório.
    Identificador exclusivo do changeset associado, como "Chset-10". Localizado na tabela CDMChangeset [sn_cdm_changeset].

    Tipo de dados: cadeia de caracteres

    description 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] a serem retornados 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

    Tabela 27. Parâmetros do corpo da solicitação
    Nome Descrição
    Nenhum

    Cabeçalhos

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

    Tabela 28. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta.

    Tipos compatíveis:

    • application/json
    • application/xml
    • text/xml

    Padrão: application/json

    Tabela 29. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 30. Códigos de status
    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.

    Parâmetros do corpo da resposta

    Nome Descrição
    <requested fields> Campos solicitados da tabela Nó do CDM [sn_cdm_node].
    Erro Retornado somente se ocorrer 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

    erro.mensagem 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_libraries/uploads/components

    Permite criar e gerenciar 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 de Editor do CDM é necessária para acessar este endpoint.

    Nota:
    Por padrão, o tamanho máximo de carregamento de conteúdo é de 2 MB. Você pode modificar este padrão atualizando a propriedade sn_cdm.max_allowed_upload_file_size.
    Nota:
    Este método de upload não pode ser usado para modificar nós. Use o método CdmSharedLibraryApi - POST /sn_cdm/shared_libraries/uploads/components/file alternativo para modificar nós.

    Formato de URL

    URL com controle de versões: /api/sn_cdm/{api_version}/shared_libraries/uploads/components

    URL padrão: /api/sn_cdm/shared_libraries/uploads/components

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres

    Tabela 32. Parâmetros de consulta
    Nome Descrição
    confirmação automática Sinalizador que indica se o changeset identificado no parâmetro changesetNumber foi confirmado para o modelo de dados após o upload.
    Valores válidos:
    • verdadeiro: o changeset é confirmado após o upload.
    • false: 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 upload, são excluídos após a conclusão do processamento.
    Valores válidos:
    • verdadeiro: exclua automaticamente os nós existentes.
    • falso: não exclua automaticamente os nós existentes.

    Tipo de dados: booliano

    Padrão: falso

    changesetNumber Obrigatório. Cadeia de caracteres que identifica exclusivamente o changeset associado à aplicação, como Chset-102. Localizado na tabela Changeset do CDM [sn_cdm_changeset]. Este changeset deve estar no estado "Aberto".

    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

    deleteRedundantOverrides Sinalizador que indica se uma substituição deve ser criada quando há valores redundantes.
    Valores válidos:
    • verdadeiro: se houver valores redundantes, uma substituição não será criada.
    • falso: se houver valores redundantes, prosseguirá com uma substituição.

    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:

    [
      {"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 oferece suporte a atributos (atualmente somente XML).
    Valores válidos:
    • verdadeiro: se o formato de dados fornecido oferecer suporte a atributos, todos os atributos nos dados de entrada serão ignorados durante o carregamento.
    • falso: se o formato de dados fornecido oferecer suporte a atributos, todos os atributos nos dados de entrada serão incluídos no carregamento.

    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).
    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: testApp​deployables​​Development1​​cdi1
    • Matriz: ['testApp','deployables','Development1','cdi1']
    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_new_and_unpublish_old: publique o novo snapshot criado após a confirmação e cancele a publicação do snapshot existente.
    • publicar_none: não publicar snapshots.

    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: publicar_none

    sharedLibraryName Obrigatório. Nome da biblioteca compartilhada a ser criada ou gerenciada. Localizado na tabela Aplicação do CDM [sn_cdm_application].

    Tipo de dados: cadeia de caracteres

    Tabela 33. Parâmetros do corpo da solicitação
    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.

    Cabeçalhos

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

    Tabela 34. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: text/plain e application/x-www-form-urlencoded.

    Padrão: text/plain

    Tabela 35. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 36. Códigos de status
    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.
    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": "String",
      "message": "String"
    }
    erro.detalhe Informações adicionais sobre o erro.

    Tipo de dados: cadeia de caracteres

    erro.mensagem Mensagem de erro gerada ao tentar processar a solicitação.

    Tipo de dados: cadeia de caracteres

    upload_id Sys_id da solicitação de upload. Use este ID para chamar o endpoint para obter o status do upload.

    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 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_libraries/uploads/components/file

    Carrega arquivos como parte do modelo de dados de configuração (CDM) na pasta de componentes em uma biblioteca compartilhada.

    Formato de URL

    URL com controle de versões: /api/sn_cdm/{api_version}shared_libraries/uploads/components/file

    URL padrão: /api/sn_cdm/shared_libraries/uploads/components/file

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres

    Tabela 38. Parâmetros de consulta
    confirmação automática Sinalizador que indica se o changeset identificado no parâmetro changesetNumber foi confirmado para o modelo de dados após o upload.
    Valores válidos:
    • verdadeiro: o changeset é confirmado após o upload.
    • false: o changeset não é confirmado após o upload.

    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 valide 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 associado à aplicação, como Chset-102. Este changeset deve estar no estado "Aberto". Localizado na tabela Changeset do CDM [sn_cdm_changeset].

    Tipo de dados: cadeia de caracteres

    Padrão: cria um conjunto de mudanças a ser usado. Os detalhes do changeset são retornados como parte dos resultados CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}.

    fileName Nome do arquivo a ser carregado. Este nome pode ser diferente do nome real do arquivo 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á-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).
    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: testApp​deployables​​Development1​​cdi1
    • Matriz: ['testApp','deployables','Development1','cdi1']
    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 onde o componente a ser excluído está localizado. Localizado na tabela Aplicação do CDM [sn_cdm_application].

    Tipo de dados: cadeia de caracteres

    Tabela 39. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Dados de upload de variáveis Dados de configuração a serem carregados. Por padrão, os carregamentos de tamanho de arquivo são limitados a 5 MB. Para obter informações sobre como ajustar os tamanhos e o tipo de arquivo de carregamento, consulte este Now Support artigo.

    Tipo de dados: cadeia de caracteres/fluxo

    Cabeçalhos

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

    Tabela 40. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json

    Tipo de conteúdo Tipo de conteúdo do arquivo a ser carregado. Exemplos: aplicação/zip, texto/simples, aplicação/json.
    Tabela 41. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 42. Códigos de status
    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.
    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": "String",
      "message": "String"
    }
    erro.detalhe Informações adicionais sobre o erro.

    Tipo de dados: cadeia de caracteres

    erro.mensagem 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} para obter o status do upload.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    A chamada a seguir demonstra como carregar um arquivo de texto sem formatação para a pasta de 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 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_library

    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.

    Formato de URL

    URL com controle de versões: /api/sn_cdm/{api_version}/shared_libraries

    URL padrão: /api/sn_cdm/shared_libraries

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres

    Tabela 44. Parâmetros de consulta
    Nome Descrição
    nome Obrigatório. Nome da biblioteca compartilhada a ser atualizada. Localizado na tabela Aplicação do CDM [sn_cdm_application].

    Tipo de dados: cadeia de caracteres

    newAvailableState Sinalizador que indica o estado da biblioteca compartilhada.
    Valores válidos:
    • verdadeiro: a biblioteca compartilhada está ativa.
    • falso: a biblioteca compartilhada está inativa. Nenhum usuário tem permissão para acessar esta biblioteca.

    Padrão: verdadeiro

    novaDescrição Descrição atualizada da biblioteca compartilhada.

    Tipo de dados: cadeia de caracteres

    novoNome Novo nome da biblioteca compartilhada.

    Tipo de dados: cadeia de caracteres

    newUserGroupIds Lista separada por vírgulas de sys_ids dos grupos de usuários que podem acessar a biblioteca compartilhada associada. Localizado na tabela Grupo [sys_user_group].

    Tipo de dados: cadeia de caracteres

    returnFields Lista separada por vírgulas de campos na tabela da aplicação do CDM [sn_cdm_application] a serem retornados como parte da resposta.

    Tipo de dados: cadeia de caracteres

    Padrão: todos os campos que não sejam do sistema são retornados.

    Tabela 45. Parâmetros do corpo da solicitação
    Nome Descrição
    Nenhum

    Cabeçalhos

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

    Tabela 46. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta.

    Tipos compatíveis:

    • application/json
    • application/xml
    • text/xml

    Padrão: application/json

    Tabela 47. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 48. Códigos de status
    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.

    Parâmetros do corpo da resposta

    Nome Descrição
    <fields> Campos solicitados da tabela da aplicação do CDM [sn_cdm_application].

    Tipo de dados: variável

    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

    erro.mensagem 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_library/components

    Atualiza o nome e a descrição do componente compartilhado especificado.

    A função de Editor do CDM é necessária para acessar este endpoint.

    Nota:
    A renomeação só será permitida se um componente nunca tiver sido usado, como quando o snapshot do componente nunca foi importado. O cenário de renomeação é principalmente para fins de correção de erros de digitação ao criar novos componentes.

    Formato de URL

    URL com controle de versões: /api/sn_cdm/{api_version}/shared_libraries/components

    URL padrão: /api/sn_cdm/shared_libraries/components

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: cadeia de caracteres

    Tabela 50. Parâmetros de consulta
    Nome Descrição
    changesetNumber Obrigatório. Nome do changeset associado. Localizado na tabela Changeset do CDM [sn_cdm_changeset].

    Tipo de dados: cadeia de caracteres

    nome Obrigatório. Nome do componente compartilhado a ser atualizado. Localizado na tabela Componente compartilhado do CDM [sn_cdm_shared_component].

    Tipo de dados: cadeia de caracteres

    novoNome Obrigatório. Nome atualizado do componente compartilhado.

    Tipo de dados: cadeia de caracteres

    novaDescrição Descrição atualizada do componente compartilhado.

    Tipo de dados: cadeia de caracteres

    Padrão: vazio

    returnFields Lista separada por vírgulas de campos na tabela Componente compartilhado do CDM [sn_cdm_shared_component] a ser retornada como parte da resposta.

    Tipo de dados: cadeia de caracteres

    Padrão: todos os campos que não sejam do sistema são retornados.

    Tabela 51. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum

    Cabeçalhos

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

    Tabela 52. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta.

    Tipos compatíveis:

    • application/json
    • application/xml
    • text/xml

    Padrão: application/json

    Tabela 53. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 54. Códigos de status
    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.

    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": "String",
      "message": "String"
    }
    erro.detalhe Informações adicionais sobre o erro.

    Tipo de dados: cadeia de caracteres

    erro.mensagem 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':'password

    Resposta:

    {
      "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
      }
    }