API do Catálogo de serviços em nuvem

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

    • . Catálogo de serviços em nuvem A API fornece métodos relacionados às operações Dia 1 (provisionamento) e Dia 2 (modificação) disponíveis no Catálogo de serviços em nuvem, como criar pilhas de serviços em nuvem e chamar solicitações de operação de recursos. Você também pode recuperar informações sobre solicitações de catálogo, pilhas que obtêm status e outras informações.

    Esta API está incluída no agora namespace e requer a função sn_cmp.cloud_service_user. O aplicativo Catálogo de serviços em nuvem (CSC) está disponível como uma assinatura separada e requer o pacote ITOM Enterprise ou o direito do produto ITOM Cloud Accelerate.

    . Catálogo de serviços em nuvem As ações de recursos da API que você executa durante as operações do Dia 2. No contexto desta API, os itens do catálogo de recursos se referem aos itens do catálogo relacionados às operações do dia 2.

    Para usar esta API, certifique-se de ter concluído o processo de configuração assistida do Catálogo de serviços em nuvem ou de ter uma configuração funcional em que as operações de provisionamento e catálogo estejam funcionando na IU. Para obter mais informações sobre essas etapas, consulte Cloud Services Catalog.

    Catálogo de serviços em nuvem - OBTENHA /now/cmp_catalog_api/itemsbyciclass

    Retorna uma lista de itens do catálogo de recursos com base em uma determinada classe de item de configuração (IC).

    Formato de URL

    URL padrão: /api/now/cmp_catalog_api/itemsbyciclass

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    ci_class Obrigatório. Nome da classe de IC da qual obter os itens do catálogo de recursos (por exemplo, "cmdb_ci_vm_instance"). Localizado no campo Tipo de IC de referência na tabela Item de configuração [cmdb_ci].

    Tipo de dados: Cadeia de caracteres
    display_variables Sinalizador que indica se variáveis de item do catálogo devem ser listadas associadas a cada item do catálogo.
    Valores válidos:
    • Verdadeiro: Exibe variáveis de item do catálogo de lista.
    • Falso: Não exibe variáveis de item do catálogo de lista.

    Tipo de dados: Booliano

    Padrão: Falso
    operation_name Opcional. Nome da operação. Localizado na coluna Nome da interface de recursos na tabela OperationSignature [sn_cmp_rb_op_signature].
    Nota:
    Este parâmetro pode consultar parte ou a totalidade da operação. Por exemplo, se você quiser listar todas as interfaces que começam com "ServiceNow", poderá definir a variável como Operation_name: ServiceNow .

    Padrão: Todos os itens do catálogo de todos os tipos de operação são retornados.

    Tipo de dados: Cadeia de caracteres
    resource_interface Opcional. Interface de recursos em que o item do catálogo de recursos está hospedado. Localizado na coluna Nome da tabela ResourceInterfaces [sn_cmp_rb_resourceinterface].

    Tipo de dados: Cadeia de caracteres
    Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

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

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

    Padrão: application/json
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    405 Método inválido. A funcionalidade está desabilitada.
    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
    ativo Estado ativo do item do catálogo de operação de recursos.

    Valores possíveis:

    • Verdadeiro: O item do catálogo de operação de recursos está ativo.
    • Falso: O item do catálogo de operação de recursos está inativo.

    Tipo de dados: Cadeia de caracteres
    created_on Carimbo de data/hora de quando o item do catálogo de operação de recursos foi criado.

    Formato: aaaa-MM-dd HH:mm:ss.

    Tipo de dados: Cadeia de caracteres
    display_name Nome da interface do recurso. Localizado na tabela ResourceInterfaces [sn_cmp_rb_resourceinterface].

    Tipo de dados: Cadeia de caracteres
    id Sys_id do item do catálogo de operação de recursos.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item do catálogo de operação de recursos [sn_cmp_rsrc_opr_cat_item]
    nome Nome do item do catálogo de operação de recursos. Localizado na tabela Item do catálogo de operação de recursos [sn_cmp_rsrc_opr_cat_item].

    Tipo de dados: Cadeia de caracteres
    short_description Breve descrição do item do catálogo de operação de recursos.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item do catálogo de operação de recursos [sn_cmp_rsrc_opr_cat_item]
    updated_on Carimbo de data/hora de quando o item do catálogo de operação de recursos foi atualizado pela última vez. Formato necessário: aaaa-MM-dd HH:mm:ss.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo a seguir solicita e retorna o status do item da solicitação.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/itemsbyciclass?ci_class=cmdb_ci_vm_instance&resource_interface=Virtual%20Machine%20Store%20Extension%20Interface&operation_name=Execute%20Job%20Template" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    Resposta:

    [
  {
    "display_name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "id": "01b2341a56789012345d6ddeeff7b89fc",
    "created_on": "2019-04-28 12:58:26",
    "updated_on": "2019-04-28 12:58:26",
    "name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "short_description": "Catalog item to invoke operation",
    "active": true
  }
]

    Catálogo de serviços em nuvem - OBTENHA /now/cmp_catalog_api/itemsbyrb

    Retorna uma lista de itens do catálogo de recursos com base em um determinado bloco de recursos.

    Formato de URL

    URL padrão: /api/now/cmp_catalog_api/itemsbyrb

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    display_variables Sinalizador que indica se variáveis de item do catálogo devem ser listadas associadas a cada item do catálogo.
    Valores válidos:
    • Verdadeiro: Exibe variáveis de item do catálogo de lista.
    • Falso: Não exibe variáveis de item do catálogo de lista.

    Tipo de dados: Booliano

    Padrão: Falso
    operation_name Opcional. Nome da operação. Localizado na coluna Nome da interface de recursos na tabela OperationSignature [sn_cmp_rb_op_signature].
    Nota:
    Este parâmetro pode consultar parte ou a totalidade da operação. Por exemplo, se você quiser listar todas as interfaces que começam com "ServiceNow", poderá definir a variável como Operation_name: ServiceNow .

    Padrão: Todos os itens do catálogo de todos os tipos de operação são retornados.

    Tipo de dados: Cadeia de caracteres
    resource_block Obrigatório. Nome do bloco de recursos do qual obter os itens do catálogo de operação de recursos relacionados (por exemplo, Servidor virtual).

    Padrão: Todos os itens do catálogo de todos os tipos de operação são retornados.

    Tipo de dados: Cadeia de caracteres

    Tabela: Bloco de recursos [sn_cmp_rb_resourceblock]
    resource_interface Opcional. Interface de recursos em que o item do catálogo de recursos está hospedado. Localizado na coluna Nome da tabela ResourceInterfaces [sn_cmp_rb_resourceinterface].

    Tipo de dados: Cadeia de caracteres
    Tabela 9. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

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

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

    Padrão: application/json
    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

    Tabela 12. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    405 Método inválido. A funcionalidade está desabilitada.
    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
    ativo Estado ativo do item do catálogo de operação de recursos.

    Valores possíveis:

    • Verdadeiro: O item do catálogo de operação de recursos está ativo.
    • Falso: O item do catálogo de operação de recursos está inativo.

    Tipo de dados: Cadeia de caracteres
    display_name Nome da interface do recurso. Localizado na tabela ResourceInterfaces [sn_cmp_rb_resourceinterface].

    Tipo de dados: Cadeia de caracteres
    id Sys_id do item do catálogo de operação de recursos.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item do catálogo de operação de recursos [sn_cmp_rsrc_opr_cat_item]
    nome Nome do item do catálogo de operação de recursos. Localizado na tabela Item do catálogo de operação de recursos [sn_cmp_rsrc_opr_cat_item].

    Tipo de dados: Cadeia de caracteres
    short_description Breve descrição do item do catálogo de operação de recursos.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item do catálogo de operação de recursos [sn_cmp_rsrc_opr_cat_item]
    variáveis Lista de detalhes extras sobre o item do catálogo de recursos. As variáveis retornadas nesta API variam com base nos parâmetros de consulta que foram passados.

    Tipo de dados: Matriz de objetos

    "variables": [
  {
    "parameter1": "String",
    "parameter2": "String"
  }
]

    Esta lista de exemplo de itens do catálogo de recursos com base em um bloco de recursos do Servidor virtual:

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/itemsbyrb?resource_interface=Virtual%20Machine%20Store%20Extension%20Interface&operation_name=Execute%20Job%20Template&resource_block=Virtual%20Server" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    Resposta:

    [
  {
    "display_name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "id": "01b2341a56789012345d6ddeeff7b89fc",
    "created_on": "2019-04-28 12:58:26",
    "updated_on": "2019-04-28 12:58:26",
    "name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "short_description": "Catalog item to invoke operation",
    "active": true
  }
]

    Catálogo de serviços em nuvem - OBTENHA /now/cmp_catalog_api/services

    Retorna uma lista de itens do catálogo com base no plano gráfico fornecido de um tipo de catálogo Provisionamento ou Ciclo de vida.

    Formato de URL

    URL padrão: /api/now/cmp_catalog_api/services

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    catalog_type Opcional. Tipo de item do catálogo. Valores aceitos (diferencia maiúsculas de minúsculas):
    • Provisionamento - Retorna todos os itens do catálogo do tipo Plano Gráfico.
    • Ciclo de vida - Retorna todos os itens do catálogo do tipo de operação do dia 2.

    Se a entrada estiver vazia (padrão), todos os serviços de ambos os tipos de catálogo serão retornados.

    Tipo de dados: Cadeia de caracteres
    display_variables Sinalizador que indica se variáveis de item do catálogo devem ser listadas associadas a cada item do catálogo.
    Valores válidos:
    • Verdadeiro: Exibe variáveis de item do catálogo de lista.
    • Falso: Não exibe variáveis de item do catálogo de lista.

    Tipo de dados: Booliano

    Padrão: Falso
    blueprint_name Opcional. Nome do plano gráfico no qual buscar os itens do catálogo relacionados. Localizado na tabela Item de categoria [sn_cmp_bp_cat_item].
    Nota:
    Este parâmetro pode consultar parte ou todo o nome do plano gráfico. Por exemplo, se você quiser listar todos os blueprints que começam com "ServiceNow", poderá definir a variável como ServiceNow .

    Padrão: Todos os serviços de todos os blueprints são retornados.

    Tipo de dados: Cadeia de caracteres
    Tabela 15. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

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

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

    Padrão: application/json
    Tabela 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

    Tabela 18. Códigos de status
    Código do status Descrição
    200 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.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    405 Método inválido. A funcionalidade está desabilitada.
    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
    ativo Sinalizador que indica se o catálogo está ativo.
    Valores possíveis:
    • Verdadeiro: O catálogo está ativo.
    • Falso: O catálogo não está ativo.

    Tipo de dados: Cadeia de caracteres
    plano gráfico Sys_id do plano gráfico.

    Tipo de dados: Cadeia de caracteres

    Tabela: Plano gráfico [sn_cmp_bp_blueprint]
    blueprint_category Sys_id da categoria de plano gráfico.

    Tipo de dados: Cadeia de caracteres

    Tabela: Categoria de serviço em nuvem [sn_capi_service_category]
    blueprint_category_name Nome da categoria de plano gráfico.
    Valores possíveis:
    • Acesso
    • Análise
    • Serviços de aplicações
    • Blockchain
    • Produtividade dos negócios
    • Computação
    • Gestão de configuração
    • Contêineres
    • Banco de dados
    • Ferramentas do desenvolvedor
    • Evento
    • Nuvem híbrida
    • IOT
    • IPAM
    • Balanceador alto
    • Aprendizado de Máquina
    • Ferramentas de gestão
    • Mercado
    • Móvel
    • Rede
    • Produtividade
    • Segurança
    • Acesso ao shell
    • Armazenamento
    • Ferramentas
    • Desconhecido
    • Realidade virtual

    Tipo de dados: Cadeia de caracteres

    Tabela: Categoria de serviço em nuvem [sn_capi_service_category]
    blueprint_name Nome do plano gráfico. Localizado na tabela Plano gráfico [sn_cmp_bp_blueprint].

    Tipo de dados: Cadeia de caracteres
    blueprint_type Tipo de plano gráfico.

    Valor possível: Plano gráfico personalizado

    Tipo de dados: Cadeia de caracteres
    catalog_name Nome do catálogo.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item do catálogo na nuvem [sn_cmp_bp_cat_item]
    catalog_type Tipo de catálogo.
    Valores possíveis:
    • 1 : Catálogo é do tipo Provisionamento.
    • 2 : O catálogo é do tipo ciclo de vida.

    Tipo de dados: Cadeia de caracteres
    catalog_type Tipo de catálogo.
    Valores possíveis:
    • 1 : Catálogo é do tipo Provisionamento.
    • 2 : O catálogo é do tipo ciclo de vida.

    Tipo de dados: Cadeia de caracteres
    createdOn Carimbo de data/hora de quando o item do catálogo foi criado.

    Tipo de dados: Cadeia de caracteres
    createdBy Usuário que criou o item do catálogo.

    Tipo de dados: Cadeia de caracteres
    id Sys_id do plano gráfico.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item do catálogo na nuvem [sn_cmp_bp_cat_item]
    last_updated_on Carimbo de data/hora de quando o item do catálogo foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres
    last_updated_by Usuário que atualizou o item do catálogo pela última vez, como um administrador ou o sistema.

    Tipo de dados: Cadeia de caracteres
    operação Sys_id da operação.

    Tipo de dados: Cadeia de caracteres

    Tabela: OperationSignature [sn_cmp_rb_op_signature]
    operation_name Nome da operação.
    Valores possíveis:
    • Desprovisionamento: Exclui recursos com um estado Encerrado e atualiza as tabelas de recursos do CMDB de acordo.
    • ModificyLease: Modifica a operação de leasing programada nos recursos provisionados.
    • ModificySchedule: Modifica a programação dos recursos provisionados.
    • Iniciar: Inicia os recursos que estão em um estado desativado.
    • Parar: Interrompe os recursos que estão em um estado Ativado.

    Tipo de dados: Cadeia de caracteres
    variáveis Detalhes sobre o item do catálogo da lista. As variáveis retornadas nesta API variam com base nos parâmetros de consulta que são passados na solicitação.

    Tipo de dados: Matriz de objetos

    "variables": [
  {
    "parameter1": "String",
    "parameter2": "String"
  }
]

    Este exemplo retorna todos os itens do catálogo de um plano gráfico do tipo Ciclo de vida chamado "classiclb".

    curl "https://instance.servicenow.comapi/now/cmp_catalog_api/services?display_variables=true&catalog_type=LifeCycle&blueprint_name=classiclb" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    Resposta:

    [
  {
    "catalog_name": "Deprovision",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "01b2341a56789012345d6ddeeff7b89fc",
    "variables": [
      {
        "id": "a12d34c5678c91234bf45678912d34e4",
        "name": "StackID",
        "question_text": "StackID",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:46:03",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:46:02",
    "created_by": "user@password.com",
    "operation": "a70d51c0476c46104bf15222516d4375",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Deprovision"
  },
  {
    "catalog_name": "ModifySchedule",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": null,
    "id": "361d55c0476c46104bf15222516d4351",
    "variables": [
      {
        "id": "031d55c0476c46104bf15222516d43af",
        "name": "ScheduleProfile",
        "question_text": "ScheduleProfile",
        "default_value": "Not specified"
      },
      {
        "id": "0b1d55c0476c46104bf15222516d43c9",
        "name": "ScheduleTimeZone",
        "question_text": "ScheduleTimeZone",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:45:53",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:52",
    "created_by": "user@password.com",
    "operation": "130d51c0476c46104bf15222516d436c",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "ModifySchedule"
  },
  {
    "catalog_name": "Stop",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "542dd5c0476c46104bf15222516d43b0",
    "variables": [
      {
        "id": "a02d19c0476c46104bf15222516d4301",
        "name": "StackID",
        "question_text": "StackID",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:46:00",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:58",
    "created_by": "user@password.com",
    "operation": "930d51c0476c46104bf15222516d436f",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Stop"
  },
  {
    "catalog_name": "Cleanup",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "712d59c0476c46104bf15222516d435c",
    "variables": [
      {
        "id": "da2d59c0476c46104bf15222516d43dc",
        "name": "resourceId",
        "question_text": "ResourceId",
        "default_value": "Not specified"
      },
      {
        "id": "da2d59c0476c46104bf15222516d43e2",
        "name": "operationName",
        "question_text": "OperationName",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:46:06",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:46:04",
    "created_by": "user@password.com",
    "operation": "ab0d51c0476c46104bf15222516d437b",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Cleanup"
  },
  {
    "catalog_name": "ModifyLease",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": null,
    "id": "bb1dd5c0476c46104bf15222516d4301",
    "variables": [
      {
        "id": "142dd5c0476c46104bf15222516d4382",
        "name": "resourceId",
        "question_text": "ResourceId",
        "default_value": "Not specified"
      },
      {
        "id": "d82dd5c0476c46104bf15222516d4394",
        "name": "operationName",
        "question_text": "OperationName",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:45:58",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:56",
    "created_by": "user@password.com",
    "operation": "2b0d51c0476c46104bf15222516d4378",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "ModifyLease"
  },
  {
    "catalog_name": "Start",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "d71d95c0476c46104bf15222516d4312",
    "variables": [
      {
        "id": "731d95c0476c46104bf15222516d43ae",
        "name": "resourceId",
        "question_text": "ResourceId",
        "default_value": "Not specified"
      },
      {
        "id": "731d95c0476c46104bf15222516d43b4",
        "name": "operationName",
        "question_text": "OperationName",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:45:55",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:54",
    "created_by": "user@password.com",
    "operation": "270d51c0476c46104bf15222516d4372",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Start"
  }
]

    Catálogo de serviços em nuvem - OBTENHA /now/cmp_catalog_api/stacks

    Retorna uma lista de itens do catálogo com base em blueprints do tipo de provisionamento (também conhecidos como pilhas).

    Formato de URL

    URL padrão: /api/now/cmp_catalog_api/stacks

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    blueprint_name Opcional. Nome do plano gráfico no qual buscar os itens do catálogo relacionados. Localizado na tabela Item de categoria [sn_cmp_bp_cat_item].
    Nota:
    Este parâmetro pode consultar parte ou todo o nome do plano gráfico. Por exemplo, se você quiser listar todos os blueprints que começam com "ServiceNow", poderá definir a variável como ServiceNow .

    Padrão: Todos os serviços de todos os blueprints são retornados.

    Tipo de dados: Cadeia de caracteres
    display_variables Sinalizador que indica se variáveis de item do catálogo devem ser listadas associadas a cada item do catálogo.
    Valores válidos:
    • Verdadeiro: Exibe variáveis de item do catálogo de lista.
    • Falso: Não exibe variáveis de item do catálogo de lista.

    Tipo de dados: Booliano

    Padrão: Falso
    Tabela 21. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

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

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

    Padrão: application/json
    Tabela 23. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

    Tabela 24. Códigos de status
    Código do status Descrição
    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.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    405 Método inválido. A funcionalidade está desabilitada.
    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
    ativo Sinalizador que indica se o catálogo está ativo.
    Valores possíveis:
    • Verdadeiro: O catálogo está ativo.
    • Falso: O catálogo não está ativo.

    Tipo de dados: Cadeia de caracteres
    plano gráfico Sys_id do plano gráfico.

    Tipo de dados: Cadeia de caracteres

    Tabela: Plano gráfico [sn_cmp_bp_blueprint]
    blueprint_category Sys_id da categoria de plano gráfico.

    Tipo de dados: Cadeia de caracteres

    Tabela: Categoria de serviço em nuvem [sn_capi_service_category]
    blueprint_category_name Nome da categoria de plano gráfico.
    Valores possíveis:
    • Acesso
    • Análise
    • Serviços de aplicações
    • Blockchain
    • Produtividade dos negócios
    • Computação
    • Gestão de configuração
    • Contêineres
    • Banco de dados
    • Ferramentas do desenvolvedor
    • Evento
    • Nuvem híbrida
    • IOT
    • IPAM
    • Balanceador alto
    • Aprendizado de Máquina
    • Ferramentas de gestão
    • Mercado
    • Móvel
    • Rede
    • Produtividade
    • Segurança
    • Acesso ao shell
    • Armazenamento
    • Ferramentas
    • Desconhecido
    • Realidade virtual

    Tipo de dados: Cadeia de caracteres

    Tabela: Categoria de serviço em nuvem [sn_capi_service_category]
    blueprint_name Nome do plano gráfico. Localizado na tabela Plano gráfico [sn_cmp_bp_blueprint].

    Tipo de dados: Cadeia de caracteres
    blueprint_type Tipo de plano gráfico.

    Valor possível: Plano gráfico personalizado

    Tipo de dados: Cadeia de caracteres
    catalog_name Nome do catálogo.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item do catálogo na nuvem [sn_cmp_bp_cat_item]
    catalog_type Tipo de catálogo.
    Valores possíveis:
    • 1 : Catálogo é do tipo Provisionamento.
    • 2 : O catálogo é do tipo ciclo de vida.

    Tipo de dados: Cadeia de caracteres
    catalog_type_name Nome do tipo de catálogo.
    Valores possíveis:
    • Operação de provisionamento (dia 1): O tipo de catálogo é chamado Provisionamento.
    • Operação de ciclo de vida (dia 2): O tipo de catálogo é chamado de ciclo de vida.

    Tipo de dados: Cadeia de caracteres
    id Sys_id do plano gráfico.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item do catálogo na nuvem [sn_cmp_bp_cat_item]
    LifecycleOperations Objeto que contém o nome da operação do ciclo de vida e o sys_id.

    Tipo de data: Matriz de objetos

    "lifecycleOperations": [
      {
        "id": "String",
        "name": "String"
      }
    lifecycleOperations.id Sys_id da operação do ciclo de vida.

    Tipo de dados: Cadeia de caracteres

    Tabela: OperationSignature [sn_cmp_rb_op_signature]
    lifeCycleOperations.name Tipo de operações do ciclo de vida.
    Valores possíveis:
    • Limpeza: Limpa recursos com um estado Encerrado.
    • Desprovisionamento: Exclui recursos em um estado Encerrado e atualiza as tabelas de recursos do CMDB de acordo.
    • ModificyLease: Modifica a operação de leasing programada nos recursos provisionados.
    • ModificySchedule: Executa o agendamento de horário de trabalho em pilhas no momento do provisionamento ou em pilhas existentes.
    • Iniciar: Inicia os recursos que estão em um estado desativado.
    • Parar: Interrompe os recursos que estão em um estado Ativado.

    Tipo de data: Objeto
    operação Sys_id da operação.

    Tipo de dados: Cadeia de caracteres

    Tabela: OperationSignature [sn_cmp_rb_op_signature]
    operation_name Nome da operação.
    Valores possíveis:
    • Desprovisionamento: Exclui recursos com um estado Encerrado e atualiza as tabelas de recursos do CMDB de acordo.
    • ModificyLease: Modifica a operação de leasing programada nos recursos provisionados.
    • ModificySchedule: Modifica a programação dos recursos provisionados.
    • Iniciar: Inicia os recursos que estão em um estado desativado.
    • Parar: Interrompe os recursos que estão em um estado Ativado.

    Tipo de dados: Cadeia de caracteres
    shortDescription Breve descrição do catálogo.

    Tipo de dados: Cadeia de caracteres
    template_name Nome do modelo.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item do catálogo na nuvem [sn_cmp_bp_cat_item]
    template_type Sys_id do tipo de modelo.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item do catálogo na nuvem [sn_cmp_bp_cat_item]
    template_cloud_product_name Nome do produto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item do catálogo na nuvem [sn_cmp_bp_cat_item]
    variáveis Detalhes sobre o item do catálogo da lista. As variáveis retornadas nesta API variam com base nos parâmetros de consulta que são passados na solicitação.

    Tipo de dados: Matriz de objetos

    "variables": [
  {
    "parameter1": "String",
    "parameter2": "String"
  }
]

    O exemplo a seguir retorna todos os itens do catálogo na instância com o tipo de catálogo Provisionar.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/stacks" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    Retornar:

    [
  {
    "catalog_type": "1",
    "catalog_type_name": "Provision Operation (Day 1)",
    "catalog_name": "classiclb",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "blueprint_category_name": "Compute",
    "active": true,
    "category": "8641fe260b212200eff7ef9bb4673a3d",
    "shortDescription": null,
    "id": "07cc9580476c46104bf15222516d43c3",
    "last_updated_on": "2024-02-19 07:46:13",
    "last_updated_by": "user@servicenow.com",
    "blueprint_type": "Cloud Template",
    "template_type": "932f81e49f00320048111f80a57fcf6e",
    "template_name": "CloudFormation Template",
    "template_cloud_product": "52cfc4749f00320048111f80a57fcf9a",
    "template_cloud_product_name": "AWS CloudFormation",
    "lifecycleOperations": [
      {
        "id": "1d2d19c0476c46104bf15222516d4392",
        "name": "Deprovision"
      },
      {
        "id": "361d55c0476c46104bf15222516d4351",
        "name": "ModifySchedule"
      },
      {
        "id": "542dd5c0476c46104bf15222516d43b0",
        "name": "Stop"
      },
      {
        "id": "712d59c0476c46104bf15222516d435c",
        "name": "Cleanup"
      },
      {
        "id": "bb1dd5c0476c46104bf15222516d4301",
        "name": "ModifyLease"
      },
      {
        "id": "d71d95c0476c46104bf15222516d4312",
        "name": "Start"
      }
    ],
    "created_on": "2024-02-19 07:44:44",
    "created_by": "user@servicenow.com",
    "operation": "130d51c0476c46104bf15222516d4368",
    "operation_name": "Provision"
  }
]

    Catálogo de serviços em nuvem - OBTENHA /now/cmp_catalog_api/status

    Retorna o status e os detalhes de um determinado ritm do catálogo (item da solicitação).

    Use este método para identificar e rastrear a origem da solicitação e monitorar seu fluxo. A resposta inclui o seguinte:
    1. Número ritm da solicitação enviada
    2. A fase em que a solicitação está
    3. Os usuários que abriram e receberam a solicitação
    4. O grupo atribuído à solicitação
    5. Quando a solicitação foi aberta
    6. O estado em que a solicitação está
    7. Dados de envio

    Formato de URL

    URL padrão: /api/now/cmp_catalog_api/status

    Parâmetros de solicitação compatíveis

    Tabela 25. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 26. Parâmetros de consulta
    Nome Descrição
    req_item Número exclusivo do item da solicitação na tabela Item solicitado [sc_req_item]. Por exemplo, RITM0000001 .

    Tipo de dados: Cadeia de caracteres
    Tabela 27. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

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

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

    Padrão: application/json
    Tabela 29. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

    Tabela 30. Códigos de status
    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.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    405 Método inválido. A funcionalidade está desabilitada.
    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
    grupoAtribuição Grupo atribuído à solicitação.

    Tipo de dados: Cadeia de caracteres
    assignedTo E-mail do usuário atribuído à solicitação.

    Tipo de dados: Cadeia de caracteres
    CatItem Sys_id da solicitação de item do catálogo.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item do catálogo na nuvem [sn_cmp_bp_cat_item]
    erro Mensagem com detalhes sobre um erro retornado.
    Possíveis mensagens de erro:
    • Registro não encontrado: O item da solicitação não existe.
    • Usuário não autenticado: As credenciais do usuário não estão autorizadas a fazer esta solicitação.

    Tipo de dados: Cadeia de caracteres
    número Número do item da solicitação (ritm) exclusivo fornecido ao novo item da solicitação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item da solicitação [sc_req_item]
    openedAt Carimbo de data/hora de quando o item da solicitação foi aberto.

    Formato: aaaa-MM-dd HH:mm:ss.

    Tipo de data: Cadeia de caracteres
    Aberto por Sys_id do usuário que abriu a solicitação.

    Tipo de dados: Cadeia de caracteres
    fase Fase de processamento atual do item da solicitação.
    Valores possíveis:
    • Implantação de Pilha
    • Implantação Cancelada
    • Falha de Layout
    • Implantação Bem-sucedida
    • Limite de recursos excedido
    • Tentando Novamente a Implantação da Pilha
    • Tarefa Criada para o Usuário
    • Aguardando aprovação de provisionamento

    Tipo de dados: Cadeia de caracteres
    estado Estado de conclusão atual do item da solicitação.
    Valores possíveis:
    • Encerradas concluídas
    • Encerrado incompleto
    • Encerrado ignorado
    • Em aberto
    • Pendente
    • Trabalho em andamento

    Tipo de dados: Cadeia de caracteres
    SubmissionData Informações sobre o envio da solicitação, como conta de nuvem, local, aplicação e dados do centro de custos. Os dados de envio variam dependendo do número do item da solicitação aprovado na solicitação.

    Tipo de dados: Objeto

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id Sys_id do registro do item da solicitação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item da solicitação [sc_req_item]

    Solicitação de curl

    O exemplo a seguir retorna informações de status para o número do item da solicitação, RITM0010076.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/statusreq_item=RITM0010076" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    Resposta:

    { 
  "catItem": "39737024c390719005091d75e0013115", 
  "stage": "Task Created for User", 
  "sys_id": "ee1197db476cc2904bf15222516d439f", 
  "assignedTo": null, 
  "assignmentGroup": null, 
  "number": "RITM0010072", 
  "openedAt": "2024-02-29 18:32:55", 
  "openedBy": "6816f79cc0a8016401c5a33be04be441", 
  "state": "Open", 
  "submissionData": "{\"CloudAccount\":\"AzureCA\",\"CSC_Azure_Functions_newResourceGroup\":\"test-rg-dnd\",\"CSC_Azure_Functions_runTimeVersion\":\"~18\",\"CSC_Azure_Functions_runTimeEngine\":\"node\",\"CSC_Azure_Functions_os\":\"Windows\",\"CSC_Azure_Functions_functionAppName\":\"sa02291029-fa\",\"LeaseEndDate\":\"2024-05-29 17:29:57\",\"ScheduleProfile\":\"-- No Schedule --\",\"UserGroup\":\"cfcbad03d711110050f5edcb9e61038f\",\"CSC_Azure_Functions_applicationName\":\"function-app\",\"ScheduleTimeZone\":\"America/Los_Angeles\",\"BusinessService\":\"\",\"environment\":\"Production\",\"CostCenter\":\"\",\"UseExistingWorkspace\":false,\"CSC_Azure_Functions_existingResourceGroup\":\"cpg-dnd\",\"CSC_Azure_Functions_isNewResourceGroup\":\"false\",\"CSC_Azure_Functions_storageAccountName\":\"sa02291029fasa\",\"Application\":\"\",\"StackName\":\"sa02291029\",\"Location\":\"Azure Datacenter - eastus\",\"Workspace\":\"\"}" 
}

    Catálogo de serviços em nuvem - POST /now/cmp_catalog_api/submitoprequest

    Envia uma solicitação de operação de recurso para executar operações do dia 2 em recursos provisionados.

    Formato de URL

    URL padrão: /api/now/cmp_catalog_api/submitoprequest

    Parâmetros de solicitação compatíveis

    Tabela 31. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 32. Parâmetros de consulta
    Nome Descrição
    cat_id Obrigatório. sys_id do item do catálogo na nuvem a ser invocado. Disponível na tabela Item do catálogo em nuvem [sn_cmp_bp_cat_item].

    Tipo de dados: Cadeia de caracteres
    Tabela 33. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    CloudAccount Obrigatório. Nome da conta de nuvem para a qual enviar a solicitação. Os nomes das contas estão disponíveis na tabela Conta de nuvem [cmdb_ci_cmp_cloud_account].

    Tipo de dados: Cadeia de caracteres
    Local Obrigatório. Local do datacenter no qual provisionar o recurso. Por exemplo, oeste-1 ou ásia-sul-2 . Este valor deve corresponder ao local do datacenter do provedor de plataforma da conta de nuvem. Disponível na tabela Datacenter associado [sn_cmp_ca_assc_datacenter].

    Tipo de dados: Cadeia de caracteres
    StackName Obrigatório. Nome da pilha. O nome da pilha é dinâmico e é refletido na gestão de recursos.

    Tipo de dados: Cadeia de caracteres
    resourceId Obrigatório. Sys_id do recurso em que as operações do dia 2 serão realizadas.

    Tipo de dados: Cadeia de caracteres

    Tabela: Itens de pilha [sn_cmp_stack_item]
    resource_block Obrigatório. Nome do bloco de recursos do qual obter os itens do catálogo de operação de recursos relacionados (por exemplo, Servidor virtual).

    Padrão: Todos os itens do catálogo de todos os tipos de operação são retornados.

    Tipo de dados: Cadeia de caracteres

    Tabela: Bloco de recursos [sn_cmp_rb_resourceblock]
    operation_name Opcional. Nome da operação. Localizado na coluna Nome da interface de recursos na tabela OperationSignature [sn_cmp_rb_op_signature].O nome da operação que você insere depende do valor passado no resourceBlockparâmetro.
    Nota:
    Este parâmetro pode consultar parte ou a totalidade da operação. Por exemplo, se você quiser listar todas as interfaces que começam com "ServiceNow", poderá definir a variável como Operation_name: ServiceNow .
    Padrão: Todos os itens do catálogo de todos os tipos de operação são retornados.Tipo de dados: Cadeia de caracteres
    ResourceInterface Obrigatório. Nome do bloco de recursos do qual obter os itens do catálogo de operação de recursos relacionados (por exemplo, Servidor virtual).A interface de recursos inserida depende do valor passado no resourceBlocke. operation_nameparâmetros.

    Padrão: Todos os itens do catálogo de todos os tipos de operação são retornados.

    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 34. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tabela 35. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

    Tabela 36. Códigos de status
    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.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    405 Método inválido. A funcionalidade está desabilitada.
    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
    grupoAtribuição Grupo atribuído à solicitação.

    Tipo de dados: Cadeia de caracteres
    assignedTo E-mail do usuário atribuído à solicitação.

    Tipo de dados: Cadeia de caracteres
    CatItem Sys_id da solicitação de item do catálogo.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item do catálogo na nuvem [sn_cmp_bp_cat_item]
    número Número do item da solicitação (ritm) exclusivo fornecido ao novo item da solicitação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item da solicitação [sc_req_item]
    openedAt Carimbo de data/hora de quando o item da solicitação foi aberto.

    Formato: aaaa-MM-dd HH:mm:ss.

    Tipo de data: Cadeia de caracteres
    Aberto por Sys_id do usuário que abriu a solicitação.

    Tipo de dados: Cadeia de caracteres
    fase Fase de processamento atual do item da solicitação.
    Valores possíveis:
    • Implantação de Pilha
    • Implantação Cancelada
    • Falha de Layout
    • Implantação Bem-sucedida
    • Limite de recursos excedido
    • Tentando Novamente a Implantação da Pilha
    • Tarefa Criada para o Usuário
    • Aguardando aprovação de provisionamento

    Tipo de dados: Cadeia de caracteres
    estado Estado de conclusão atual do item da solicitação.
    Valores possíveis:
    • Encerradas concluídas
    • Encerrado incompleto
    • Encerrado ignorado
    • Em aberto
    • Pendente
    • Trabalho em andamento

    Tipo de dados: Cadeia de caracteres
    SubmissionData Informações sobre o envio da solicitação, como conta de nuvem, local, aplicação e dados do centro de custos. Os dados de envio variam dependendo do número do item da solicitação aprovado na solicitação.

    Tipo de dados: Objeto

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id Sys_id do registro do item da solicitação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item da solicitação [sc_req_item]

    O exemplo a seguir cria um item de solicitação de operação do dia 2.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/submitoprequest?cat_id=e44dcd238731e5101126cbb4dabb3506" /
--request POST\ 
--header 'Accept: application/json' \ 
--user 'username':'password'

//Request body:
{"StackName":"sa02292143","CloudAccount":"AWS","Location":"AWS Datacenter - us-east-1","resourceId":"df8c61e3eb2cc210d298fbbdbad0cd74","operationName":"Deprovision","resourceInterface":"S3 Interface","resourceBlock":"S3"}

    Corpo da resposta:

    { 
  "number": "RITM0010078", 
  "catItem": "e44dcd238731e5101126cbb4dabb3506", 
  "stage": "request_approved", 
  "sys_id": "9bf5cab3c3594610bc89b33605013190", 
  "assignedTo": null, 
  "assignmentGroup": null, 
  "openedAt": "2024-04-08 09:08:47", 
  "openedBy": "6816f79cc0a8016401c5a33be04be441", 
  "state": "Open", 
  "submissionData": "{\"StackName\":\"sa02292143\",\"CloudAccount\":\"AWS\",\"Location\":\"AWS Datacenter - us-east-1\",\"resourceId\":\"df8c61e3eb2cc210d298fbbdbad0cd74\",\"operationName\":\"Deprovision\",\"resourceInterface\":\"S3 Interface\",\"resourceBlock\":\"S3\"}" 
} 
 
Sample Request Body for CSC S3 Bucket Catalog Order: 
 
{"StackName":"sa02292143","CloudAccount":"AWS","Location":"AWS Datacenter - us-east-1","resourceId":"df8c61e3eb2cc210d298fbbdbad0cd74","operationName":"Deprovision","resourceInterface":"S3 Interface","resourceBlock":"S3"}

    Catálogo de serviços em nuvem - POST /now/cmp_catalog_api/submitrequest

    Envia uma solicitação de serviços em nuvem. Este método aceita solicitações provisionadas para operações do dia 2 e pilhas ou itens do catálogo de operações de recursos.

    Formato de URL

    URL padrão: /api/now/cmp_catalog_api/submitrequest

    Parâmetros de solicitação compatíveis

    Tabela 37. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 38. Parâmetros de consulta
    Nome Descrição
    cat_id Obrigatório. sys_id do item do catálogo na nuvem a ser invocado. Disponível na tabela Item do catálogo em nuvem [sn_cmp_bp_cat_item].

    Tipo de dados: Cadeia de caracteres
    Tabela 39. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    CloudAccount Obrigatório. Nome da conta de nuvem para a qual enviar a solicitação. Os nomes das contas estão disponíveis na tabela Conta de nuvem [cmdb_ci_cmp_cloud_account].

    Tipo de dados: Cadeia de caracteres
    Local Obrigatório. Local do datacenter no qual provisionar o recurso. Por exemplo, oeste-1 ou ásia-sul-2 . Este valor deve corresponder ao local do datacenter do provedor de plataforma da conta de nuvem. Disponível na tabela Datacenter associado [sn_cmp_ca_assc_datacenter].

    Tipo de dados: Cadeia de caracteres
    StackName Obrigatório. Nome da pilha. O nome da pilha é dinâmico e é refletido na gestão de recursos.

    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 40. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tabela 41. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

    Tabela 42. Códigos de status
    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.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    405 Método inválido. A funcionalidade está desabilitada.
    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
    grupoAtribuição Grupo atribuído à solicitação.

    Tipo de dados: Cadeia de caracteres
    assignedTo E-mail do usuário atribuído à solicitação.

    Tipo de dados: Cadeia de caracteres
    CatItem Sys_id da solicitação de item do catálogo.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item do catálogo na nuvem [sn_cmp_bp_cat_item]
    número Número do item da solicitação (ritm) exclusivo fornecido ao novo item da solicitação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item da solicitação [sc_req_item]
    openedAt Carimbo de data/hora de quando o item da solicitação foi aberto.

    Formato: aaaa-MM-dd HH:mm:ss.

    Tipo de data: Cadeia de caracteres
    Aberto por Sys_id do usuário que abriu a solicitação.

    Tipo de dados: Cadeia de caracteres
    fase Fase de processamento atual do item da solicitação.
    Valores possíveis:
    • Implantação de Pilha
    • Implantação Cancelada
    • Falha de Layout
    • Implantação Bem-sucedida
    • Limite de recursos excedido
    • Tentando Novamente a Implantação da Pilha
    • Tarefa Criada para o Usuário
    • Aguardando aprovação de provisionamento

    Tipo de dados: Cadeia de caracteres
    estado Estado de conclusão atual do item da solicitação.
    Valores possíveis:
    • Encerradas concluídas
    • Encerrado incompleto
    • Encerrado ignorado
    • Em aberto
    • Pendente
    • Trabalho em andamento

    Tipo de dados: Cadeia de caracteres
    SubmissionData Informações sobre o envio da solicitação, como conta de nuvem, local, aplicação e dados do centro de custos. Os dados de envio variam dependendo do número do item da solicitação aprovado na solicitação.

    Tipo de dados: Objeto

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id Sys_id do registro do item da solicitação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item da solicitação [sc_req_item]

    O exemplo a seguir envia uma solicitação de recurso de nuvem na conta de nuvem da AWS da instância.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/submitrequest?cat_id=022e3deec3122910a769f44ed40131b9" /
--request POST \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

//Request body:
{"CloudAccount":"AWS","Location":"us-east-1","StackName":"ss"}

    Resposta:

    { 
  "number": "RITM0010001", 
  "catItem": "022e3deec3122910a769f44ed40131b9", 
  "stage": "check_permissions", 
  "sys_id": "86d34233c3594610bc89b336050131dd", 
  "assignedTo": null, 
  "assignmentGroup": null, 
  "openedAt": "2024-04-08 08:59:25", 
  "openedBy": "6816f79cc0a8016401c5a33be04be441", 
  "state": "Open", 
  "submissionData": "{\"CloudAccount\":\"AWS\",\"Location\":\"us-east-1\",\"StackName\":\"ss\"}" 
}