API do Catálogo de serviços

A API do Catálogo de serviços fornece endpoints que acessam Catálogo de serviços configuração e ações de dentro de um Portal de serviços.

Catálogo de serviços - DELETE /sn_sc/servicecatalog/cart/{cart_item_id}

Exclui o item especificado do carrinho atual.

Formato da URL

URL com controle de versões: /api/sn_sc/{api_version}/servicecatalog/cart/{cart_item_id}

URL padrão: /api/sn_sc/servicecatalog/cart/{cart_item_id}

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
carrinho_item_id	Sys_id do item a ser excluído do carrinho atual. Tipo de dados: cadeia de caracteres

Tabela 2. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 3. Parâmetros do corpo da solicitação (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
Nenhum(a)

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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 6. Códigos de status

Código do status	Descrição
204	Indica que a solicitação foi concluída com sucesso e que o item especificado foi excluído do carrinho.
400	Indica que o especificado cart_item_id é inválido ou que o usuário não tem acesso ao item do carrinho.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
Nenhum(a)

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/cart/1f4cc597db21120064301150f0b8f5fc" \
--request DELETE \
--user "username":"password"

None

Catálogo de serviços - DELETE /sn_sc/servicecatalog/cart/{sys_id}/empty

Exclui um carrinho especificado e o conteúdo do carrinho.

As capacidades do que um usuário pode excluir (itens e/ou carrinho) dependem da função que ele usa para autenticar.

Funções de usuário necessárias para excluir o carrinho e o conteúdo do carrinho:

• admin/catalog_admin: pode esvaziar o carrinho de qualquer usuário.
• admin: pode excluir o carrinho depois que todo o conteúdo do carrinho é excluído.
• catalog_admin: pode excluir todos os itens do carrinho.

Formato da URL

URL com controle de versão: /api/sn_sc/{api_version}/servicecatalog/cart/{sys_id}/vazio

URL padrão: /api/sn_sc/servicecatalog/cart/{sys_id}/empty

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do carrinho a ser esvaziado e excluído. Tipo de dados: cadeia de caracteres

Tabela 8. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 9. Parâmetros do corpo da solicitação (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
Nenhum(a)

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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 12. Códigos de status

Código do status	Descrição
204	A solicitação foi concluída com sucesso e esvazia e exclui o carrinho.
400	Indica um erro por um dos seguintes motivos: carrinhoId inválido. O usuário não tem a função admin/catalog_admin ou está tentando esvaziar o carrinho de outro usuário.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
Nenhum(a)

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/dde34ad713426300027879d96144b072/empty" \
--request DELETE \
--user 'username':'password'

None

Catálogo de serviços - GET /sn_sc/servicecatalog/cart

Recupera os detalhes dos itens no carrinho do usuário conectado.

Formato da URL

URL com controle de versão: /api/sn_sc/{api_version}/servicecatalog/cart

URL padrão: /api/sn_sc/servicecatalog/cart

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 14. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 15. Parâmetros do corpo da solicitação (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/json ou 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 18. Códigos de status

Código do status	Descrição
200	Indica que a solicitação foi concluída com sucesso. Se não houver nenhum item no carrinho, ele retornará as informações básicas do carrinho e os preços para o usuário. Se o carrinho contiver itens, as informações sobre os itens e seus preços individuais também serão incluídos.
400	Indica que o carrinho está vazio e não pode fazer check-out.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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)

Parâmetro	Descrição
ID_do_carrinho	Sys_id do carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>	Lista de itens no carrinho com uma frequência recorrente específica. Os valores possíveis incluem: diariamente mensal anual nenhum (sem taxas recorrentes) Tipo de dados: objeto "<recurring_frequency>": { "frequency_label": "String", "items": [Array], "show_subtotal_price": "String", "subtotal_price": "String", "subtotal_recurring_frequency": "String", "subtotal_recurring_price": "String", "subtotal_title": "String", "total_title": "String"
<recurring_frequency>.frequency_label	Frequência da taxa recorrente associada. Tipo de dados: cadeia de caracteres Padrão: nulo
<recurring_frequency>.itens	Lista de objetos que contêm detalhes de cada item associado à categoria de frequência recorrente especificada. Tipo de dados: matriz "items": [{ "cart_item_id": "String", "catalog_item_id": "String", "created.by": "String", "created_on": "String", "delivery_time": "String", "item_id": "String", "item_name": "String", "localized_price": "String", "localized_recurring_price": "String", "name": "String", "order_guide": "String", "picture": "String", "price": "String", "quantity": "String", "recurring_frequency": "String", "recurring_price": "String", "recurring_subtotal": Number, "recurring_subtotal_price": "String", "short_description": "String", "show_price": Boolean, "show_quantity": Boolean, "show_recurring_price": Boolean, "subtotal": Number, "subtotal_price": "String", "sys_class_name": "String", "sys_id": "String", "updated_by": "String", "updated_on": "String", "variables": {Object} }]
<recurring_frequency>.items.cart_item_id	Sys_id do item neste carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.catalog_item_id	Sys_id do catálogo associado ao item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.created.by	Usuário que inicialmente colocou o item no carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.criados_em	Data em que o item foi colocado inicialmente no carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.tempo_de_entrega	Tempo que o item especificado leva para ser entregue. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.item_id	sys_id do catálogo do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.item_name	Nome do item especificado. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.localizado_preço	Preço do item na moeda local. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.localized_recurring_Price	Taxa recorrente para o item especificado na moeda local. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.name	Nome do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.order_guide	Nome do guia de pedido ao qual este item está associado. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.imagem	Nome do arquivo da imagem do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.preço	Preço do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.quantidade	Número do item especificado no carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.frequência_recorrente	A frequência com que a taxa recorrente é cobrada pelo item especificado. Tipo de dados: cadeia de caracteres Padrão: nulo
<recurring_frequency>.itens.preço_recorrente	Taxa recorrente para o item especificado. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.subtotal_recorrente	Subtotal das taxas recorrentes do item (recurring_price x quantity). Tipo de dados: número
<recurring_frequency>.itens.recurring_subtotal_Price	Subtotal das taxas recorrentes do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.short_description	Descrição resumida do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.mostrar_preço	Sinalizador que indica se o preço do item é mostrado no carrinho. Valores possíveis: verdadeiro: mostra o preço do item no carrinho. falso: não mostra o preço do item no carrinho. Tipo de dados: booliano
<recurring_frequency>.itens.mostrar_quantidade	Sinalizador que indica se a quantidade de itens no carrinho deve ser mostrada. Valores possíveis: verdadeiro: mostra a quantidade de itens no carrinho. falso: não mostra a quantidade de itens no carrinho. Tipo de dados: booliano
<recurring_frequency>.itens.mostrar_preço_recorrente	Sinalizador que indica se as taxas recorrentes devem aparecer no carrinho. Valores possíveis: verdadeiro: mostra as taxas recorrentes no carrinho. falso: não mostra as taxas recorrentes no carrinho. Tipo de dados: booliano
<recurring_frequency>.itens.subtotal	Número subtotal de itens. Tipo de dados: número
<recurring_frequency>.itens.subtotal_preço	Subtotal do item (price x quantity). Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.sys_class_name	Nome de classificação do sistema do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.sys_id	Sys_id do registro do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.atualizados_por	Usuário que atualizou o item depois que ele foi colocado inicialmente no carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.atualizados_em	Última data/hora em que o item foi colocado inicialmente no carrinho ou atualizado. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.variáveis	Lista de pares de nome/valor das variáveis de item. Tipo de dados: objeto
<recurring_frequency>.mostrar_subtotal_preço	Sinalizador que indica se um subtotal deve ser mostrado para a categoria de taxa recorrente associada. Valores possíveis: verdadeiro: mostrar subtotais no carrinho. falso: não mostra subtotais no carrinho. Tipo de dados: booliano
<recurring_frequency>.subtotal_Price	Subtotal do custo de todos os itens para a categoria de frequência recorrente associada. Tipo de dados: cadeia de caracteres
<recurring_frequency>.subtotal_recurring_frequency	Tipo de frequência recorrente de subtotal, como diária, mensal etc. Igual a subtotal_recurring_frequency. Tipo de dados: cadeia de caracteres
<recurring_frequency>.subtotal_recurring_Price	Subtotal das taxas recorrentes dos itens na categoria de frequência recorrente associada. Tipo de dados: cadeia de caracteres
<recurring_frequency>.subtotal_title	Se o show_subtotal_price estiver definido como verdadeiro, o texto a ser exibido no carrinho para a legenda associada. Tipo de dados: cadeia de caracteres
<recurring_frequency>.total_title	Texto a ser exibido para o título total da categoria de frequência recorrente associada. Tipo de dados: cadeia de caracteres
mostrar_subtotal_preço	Sinalizador que indica se o preço do subtotal deve ser mostrado no carrinho. Valores possíveis: verdadeiro: mostrar subtotais no carrinho. falso: não mostra subtotais no carrinho. Tipo de dados: cadeia de caracteres
preço_subtotal	Subtotal de todos os itens no carrinho em dólares inteiros. Tipo de dados: cadeia de caracteres
subtotal_recurring_frequency	Tipo de frequência recorrente de subtotal, como diária, mensal etc. Igual a <recurring_frequency>.subtotal_recurring_frequency. Tipo de dados: cadeia de caracteres
preço_recorrente_subtotal	Subtotal das taxas de frequência recorrentes para todos os itens no carrinho. Tipo de dados: cadeia de caracteres
subtotal_título	Texto a ser exibido no carrinho para o título do campo de subtotal. Tipo de dados: cadeia de caracteres
total_title	Texto a ser exibido no carrinho para o título do campo total. Tipo de dados: cadeia de caracteres

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "cart_id": "6d88bc29137d2300027879d96144b04b",
    "subtotal_price": "$1,598.00",
    "subtotal_recurring_frequency": "",
    "subtotal_recurring_price": "$0.00",
    "total_title": "Total",
    "none": {
      "subtotal_price": "$1,598.00",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "frequency_label": null,
      "items": [
      {
        "updated_on": "2018-11-15 14:24:00",
        "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
        "short_description": "Apple iPhone 7 ",
        "recurring_subtotal_price": "$0.00",
        "delivery_time": "2 Days",
        "sys_class_name": "sc_cat_item",
        "sys_id": "1f88bc29137d2300027879d96144b056",
        "price": "$799.00",
        "recurring_frequency": null,
        "subtotal_price": "$799.00",
        "variables": {},
        "quantity": "1",
        "item_id": "07f1666b0bf00300eba42da0d5673ab0",
        "recurring_price": "$0.00",
        "show_price": true,
        "item_name": "Apple iPhone7",
        "cart_item_id": "1f88bc29137d2300027879d96144b056",
        "recurring_subtotal": 0,
        "show_quantity": true,
        "created_by": "admin",
        "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
        "created_on": "2018-11-15 14:24:00",
        "localized_price": "$799.00",
        "subtotal": 799,
        "show_recurring_price": false,
        "name": "Apple iPhone7",
        "updated_by": "admin",
        "localized_recurring_price": "$0.00",
        "order_guide": ""
      },
    ],
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
   },
   "show_subtotal_price": "true",
   "subtotal_title": "Subtotal"
 }
}

Catálogo de serviços - GET /sn_sc/servicecatalog/cart/delivery_address/{user_id}

Recupera o endereço de envio do usuário especificado com base na propriedade glide.sc.req_for.roles e no comportamento padrão configurado em glide.sc.req_for.roles.defaultproperty.

Formato da URL

URL com controle de versão: /api/sn_sc/{api_version}/servicecatalog/cart/delivery_address/{user_id}

URL padrão: /api/sn_sc/servicecatalog/cart/delivery_address/{user_id}

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
user_id	Sys_id do usuário cujo endereço de envio será recuperado. Tipo de dados: cadeia de caracteres Tabela: usuário [sys_user]

Tabela 20. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 21. Parâmetros do corpo da solicitação (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/json ou 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 24. Códigos de status

Código do status	Descrição
200	Solicitação concluída com sucesso; retorna o endereço de envio do usuário especificado.
400	O sys_id do usuário é inválido.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
resultado	Endereço do usuário especificado. Tipo de dados: cadeia de caracteres

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/delivery_address/62826bf03710200044e0bfc8bcbe5df1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
'result': '25 New Chardon Street, Boston\nBoston, MA, 02114-1801\nUSA'
}

Catálogo de serviços - GET /sn_sc/servicecatalog/catalogs

Recupera uma lista de catálogos aos quais o usuário tem acesso com base nos parâmetros passados.

Formato da URL

URL com controle de versão: /api/sn_sc/{api_version}/servicecatalog/catalogs

URL padrão: /api/sn_sc/servicecatalog/catalogs

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

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. Somente especifique este valor 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
sysparm_limit	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro. Este limite é aplicado antes da avaliação da ACL. Se nenhum registro for retornado, incluindo os registros aos quais você tem acesso, reorganize a ordem dos registros para que os registros aos quais você tem acesso sejam retornados primeiro. Nota: Valores sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema. Tipo de dados: número Padrão: 20 Máximo: 100
sysparm_text	Palavra-chave a ser pesquisada no campo "título" dos catálogos de serviço disponíveis. Tipo de dados: cadeia de caracteres
sysparm_view	Dispositivo no qual o item pode exibir: desktop: na área de trabalho. mobile: Em um dispositivo móvel. both: em uma área de trabalho e em um dispositivo móvel. Tipo de dados: cadeia de caracteres

Tabela 27. Parâmetros do corpo da solicitação (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/json ou 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 30. Códigos de status

Código do status	Descrição
200	Indica que a solicitação foi concluída com sucesso. Se uma consulta válida não retornar resultados, o corpo da resposta conterá apenas uma matriz de resultados vazia.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
descrição	Descrição do catálogo. Tipo de dados: cadeia de caracteres
imagem_desktop	Imagem que aparece na área de trabalho deste catálogo. Tipo de dados: cadeia de caracteres
tem_categorias	Sinalizador que indica se o catálogo contém categorias. Valores possíveis: verdadeiro: o catálogo contém categorias. falso: o catálogo não contém categorias. Tipo de dados: booliano
tem_itens	Sinalizador que indica se o catálogo contém itens. Valores possíveis: verdadeiro: o catálogo contém itens. falso: o catálogo não contém itens. Tipo de dados: booliano
sys_id	Sys_id do catálogo. Tipo de dados: cadeia de caracteres
título	Título do catálogo. Tipo de dados: cadeia de caracteres

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/catalogs?sysparm_limit=10" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": [
    {
      "title": "Technical Catalog",
      "sys_id": "742ce428d7211100f2d224837e61036d",
      "has_categories": true,
      "has_items": true,
      "description": "Products and services for the IT department",
      "desktop_image": "7a7c8271475211002ee987e8dee4906d.iix"
    },
    {
      "title": "Service Catalog",
      "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
      "has_categories": true,
      "has_items": true,
      "description": "Service Catalog - IT Now",
      "desktop_image": "adbcc271475211002ee987e8dee49001.iix"
    }
  ]
}

Catálogo de serviços - GET /sn_sc/servicecatalog/catalogs/{sys_id}/categories

Recupera a lista de categorias disponíveis para o catálogo especificado.

Formato da URL

URL com controle de versão: /api/sn_sc/{api_version}/servicecatalog/catalogs/{sys_id}/categories

URL padrão: /api/sn_sc/servicecatalog/catalogs/{sys_id}/categories

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

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. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do catálogo cujas categorias são solicitadas. Tipo de dados: cadeia de caracteres

Tabela 32. Parâmetros de consulta

Nome	Descrição
sysparm_limit	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro. Este limite é aplicado antes da avaliação da ACL. Se nenhum registro for retornado, incluindo os registros aos quais você tem acesso, reorganize a ordem dos registros para que os registros aos quais você tem acesso sejam retornados primeiro. Nota: Valores sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema. Tipo de dados: número Padrão: 20 Máximo: 100
sysparm_offset	Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limitaté chegar ao fim de todos os registros. Não passe um número negativo no parâmetro sysparm_offset. Tipo de dados: número Padrão: 0
sysparm_top_level_only	Retornar somente as categorias cujo primário é um catálogo. Valores válidos: verdadeiro: retorna somente as categorias cujo primário é um catálogo. falso: retorna todas as categorias. Tipo de dados: booliano
sysparm_view	Exibição de IU para a qual os dados serão renderizados. Determina os campos retornados na resposta. Valores válidos: área de trabalho celular ambos Se você também especificar o parâmetro sysparm_fields, ele terá precedência. Tipo de dados: cadeia de caracteres

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

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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 36. Códigos de status

Código do status	Descrição
200	Retorna uma lista de categorias em um catálogo. Se não houver resultados de consulta, uma matriz vazia será retornada.
400	Indica que a solicitação ou o sys_id do catálogo é inválido.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
contagem	Número de itens na categoria. Tipo de dados: número
descrição	Breve descrição da categoria. Tipo de dados: cadeia de caracteres
_descrição_completa	Descrição detalhada da categoria. Tipo de dados: cadeia de caracteres
cabeçalho_ícone	Ícone usado em cabeçalhos de categoria. Tipo de dados: cadeia de caracteres
imagem_página_inicial	Imagem que aparece para esta categoria na página inicial da categoria. Tipo de dados: cadeia de caracteres
ícones	Ícone a ser usado para dar significado a esta categoria. Tipo de dados: cadeia de caracteres
subcategorias	Lista de subcategorias na categoria. Tipo de dados: matriz "subcategories": [ "sys_id": "String", "title": "String ]
subcategorias.sys_id	Sys_id da subcategoria. Tipo de dados: cadeia de caracteres
subcategorias.título	Título da subcategoria. Tipo de dados: cadeia de caracteres
sys_id	Sys_id da categoria. Tipo de dados: cadeia de caracteres
título	Título da categoria. Tipo de dados: cadeia de caracteres

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/catalogs/e0d08b13c3330100c8b837659bba8fb4/categories?sysparm_limit=2 \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": [
    {
      "title": "Can We Help You?",
      "description": "Your IT gateway. Report issues and submit requests.\n\t\t",
      "full_description": null,
      "icon": "",
      "header_icon": "",
      "homepage_image": "29f8ffa9471211002ee987e8dee4905e.iix",
      "count": 14,
      "subcategories": [],
      "sys_id": "e15706fc0a0a0aa7007fc21e1ab70c2f"
    },
    {
      "title": "Departmental Services",
      "description": "Services offered by different departments in the organization",
      "full_description": null,
      "icon": "",
      "header_icon": "",
      "homepage_image": "6fb4a1d95f2211001c9b2572f2b47748.iix",
      "count": 1,
      "subcategories": [],
      "sys_id": "95fc11615f1211001c9b2572f2b477c6"
    },
    {
      "title": "Desktops",
      "description": "Desktop computers for your work area.",
      "full_description": null,
      "icon": "",
      "header_icon": "",
      "homepage_image": "1bface31475211002ee987e8dee49095.iix",
      "count": 1,
      "subcategories": [],
      "sys_id": "900682363731300054b6a3549dbe5d5f"
    }
  ]
}

Catálogo de serviços - GET /sn_sc/servicecatalog/catalogs/{sys_id}

Recupera as informações disponíveis para um catálogo especificado.

Formato da URL

URL com controle de versão: /api/sn_sc/{api_version}/servicecatalog/catalogs/{sys_id}

URL padrão: /api/sn_sc/servicecatalog/catalogs/{sys_id}

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

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. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do catálogo a ser recuperado. Tipo de dados: cadeia de caracteres

Tabela 38. Parâmetros de consulta

Nome	Descrição
sysparm_view	Dispositivo no qual o item pode exibir: desktop: na área de trabalho. mobile: Em um dispositivo móvel. both: em uma área de trabalho e em um dispositivo móvel. Tipo de dados: cadeia de caracteres

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

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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 42. Códigos de status

Código do status	Descrição
200	Indica que a solicitação foi concluída com sucesso e retorna as informações disponíveis para o catálogo especificado.
400	Indica que a solicitação é inválida por um dos seguintes motivos: O usuário não tem acesso ao catálogo. sys_id inválido.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
categorias	Lista de objetos que descrevem categorias no catálogo. Tipo de dados: matriz "categories": [ "description": "String", "header_image": "String", "sys_id": "String", "title": "String ]
categorias.descrição	Descrição da categoria. Tipo de dados: cadeia de caracteres
categorias.cabeçalho_imagem	Imagem do cabeçalho da categoria. Tipo de dados: cadeia de caracteres
categorias.sys_id	Identificador de categoria exclusivo (sys_id). Tipo de dados: cadeia de caracteres
categorias.título	Título da categoria. Tipo de dados: cadeia de caracteres
descrição	Descrição do catálogo. Tipo de dados: cadeia de caracteres
imagem_desktop	Origem da imagem exibida com o catálogo na exibição da área de trabalho. Tipo de dados: cadeia de caracteres
tem_categorias	Sinalizador que indica se o catálogo tem categorias. Valores possíveis: verdadeiro: o catálogo tem categorias. falso: o catálogo não tem categorias. Tipo de dados: booliano
tem_itens	Sinalizador que indica se há itens na categoria. Valores possíveis: verdadeiro: o catálogo tem itens associados a ele. falso: o catálogo não tem nenhum item associado a ele. Tipo de dados: booliano
sys_id	sys_id do catálogo exclusivo. Tipo de dados: cadeia de caracteres
título	Título do catálogo. Tipo de dados: cadeia de caracteres

Solicitação de cURL

curl "https://instance.servicenow.comaqsw" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "title": "Customer Service",
    "sys_id": "65bcd377c3011200b12d9f2974d3aea0",
    "has_categories": true,
    "categories": [
      {
        "header_image": "",
        "sys_id": "4cb69d19c3921200b0449f2974d3ae69",
        "description": null,
        "title": "Services"
      },
      {
        "header_image": "",
        "sys_id": "1b8611d5c3921200b0449f2974d3ae12",
        "description": null,
        "title": "Support"
      }
    ],
    "has_items": true,
    "description": "Customer Service",
    "desktop_image": ""
  }
}

Catálogo de serviços - GET /sn_sc/servicecatalog/categories/{sys_id}

Recupera as informações disponíveis para uma categoria especificada.

Formato da URL

URL com controle de versão: /api/sn_sc/{api_version}/servicecatalog/categories/{sys_id}

URL padrão: /api/sn_sc/servicecatalog/categories/{sys_id}

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

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. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id da categoria para a qual as informações serão retornadas. Tipo de dados: cadeia de caracteres

Tabela 44. Parâmetros de consulta

Nome	Descrição
sysparm_view	Exibição de IU para a qual os dados serão renderizados. Determina os campos retornados na resposta. Valores válidos: área de trabalho celular ambos Se você também especificar o parâmetro sysparm_fields, ele terá precedência. Tipo de dados: cadeia de caracteres

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

Tabela 47. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 48. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Indica que a solicitação é inválida por um dos seguintes motivos: O usuário não tem acesso à categoria. sys_id inválido.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
categorias_crianças	Lista de objetos que descrevem as categorias secundárias que pertencem a esta categoria. Tipo de dados: matriz "child_categories": [ "count": Number, "isParentCategory": "String", "parent": "String", "subcategories": [Array], "sys_id": "String", "title": "String" ]
child_categories.count	Número de itens na categoria secundária. Tipo de dados: número
child_categories.isParentCategory	Sinalizador que indica se esta é uma categoria primária. Valores possíveis: verdadeiro: categoria primária. falso: não é a categoria primária. Tipo de dados: booliano
criança_categorias.primário	Sys_id do primário da categoria secundária. Tipo de dados: cadeia de caracteres
subcategorias_crianças.	Lista de objetos que descreve as subcategorias desta categoria secundária. Tipo de dados: matriz "subcategories": [ "sys_id": "String", "title": "String" ]
child_categories.subcategorias.sys_id	Sys_id da subcategoria secundária. Tipo de dados: cadeia de caracteres
child_categories.subcategorias.título	Título da subcategoria secundária. Tipo de dados: cadeia de caracteres
child_categories.sys_id	Sys_id da categoria secundária. Tipo de dados: cadeia de caracteres
child_categories.título	Título da categoria secundária. Tipo de dados: cadeia de caracteres
descrição	Descrição resumida da categoria. Tipo de dados: cadeia de caracteres
descrição_completa	Descrição detalhada da categoria. Tipo de dados: cadeia de caracteres
cabeçalho_ícone	Origem do ícone exibido ao lado do cabeçalho da categoria quando a categoria está listada na categoria de nível superior. Tipo de dados: cadeia de caracteres
imagem_página_inicial	Origem da imagem da página inicial da categoria. Tipo de dados: cadeia de caracteres
ícones	Origem do pequeno ícone exibido ao lado do nome da categoria quando a categoria é listada como uma subcategoria. Tipo de dados: cadeia de caracteres
sys_id	Sys_id da categoria. Tipo de dados: cadeia de caracteres
título	Título da categoria. Tipo de dados: cadeia de caracteres

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/categories/b0fdfb01932002009ca87a75e57ffbe9" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "title": "Office",
    "description": "Office services such as printing, supplies requisition\n\t\t\tand document shipping and delivery.\n\t\t",
    "full_description": null,
    "icon": "",
    "header_icon": "",
    "homepage_image": "498b0271475211002ee987e8dee490ea.iix",
    "sys_id": "109cdff8c6112276003b17991a09ad65",
    "child_categories": [
      {
        "sys_id": "109f0438c6112276003ae8ac13e7009d",
        "title": "Services",
        "count": 16,
        "parent": "109cdff8c6112276003b17991a09ad65",
        "subcategories": [],
        "isParentCategory": false
      }
    ]
  }
}

Catálogo de serviços - GET /sn_sc/servicecatalog/items

Recupera uma lista de itens do catálogo com base nos parâmetros especificados.

Formato da URL

URL com controle de versões: /api/sn_sc/{api_version}/servicecatalog/items

URL padrão: /api/sn_sc/servicecatalog/items

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

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. Somente especifique este valor 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
sysparm_catálogo	sys_id do catálogo do item. Use este parâmetro para localizar itens em um catálogo específico. Tipo de dados: cadeia de caracteres
sysparm_category	sys_id da categoria do item. Use este parâmetro para localizar itens do catálogo em uma categoria específica. Tipo de dados: cadeia de caracteres
sysparm_limit	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro. Este limite é aplicado antes da avaliação da ACL. Se nenhum registro for retornado, incluindo os registros aos quais você tem acesso, reorganize a ordem dos registros para que os registros aos quais você tem acesso sejam retornados primeiro. Nota: Valores sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema. Tipo de dados: número Padrão: 20 Máximo: 100
sysparm_offset	Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limitaté chegar ao fim de todos os registros. Não passe um número negativo no parâmetro sysparm_offset. Tipo de dados: número Padrão: 0
sysparm_text	Texto específico a ser pesquisado nos itens da categoria. Por exemplo, sysparm_text="iPhone" ou sysparm_text="Dispositivos móveis". Tipo de dados: cadeia de caracteres
sysparm_type	Tipo de item. Valores de pesquisa válidos: Produtor de registro Guia de pedido Se qualquer outro valor for passado, as informações serão ignoradas. Tipo de dados: cadeia de caracteres
sysparm_view	Exibição de IU para a qual os dados serão renderizados. Determina os campos retornados na resposta. Valores válidos: área de trabalho celular ambos Se você também especificar o parâmetro sysparm_fields, ele terá precedência. Tipo de dados: cadeia de caracteres

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

Tabela 53. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 54. Códigos de status

Código do status	Descrição
200	Retorna uma lista de catálogos e itens com base nos parâmetros especificados. Se uma consulta válida não resultar em nenhum item, o corpo da resposta conterá apenas uma matriz de resultados vazia.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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)

Parâmetro	Descrição
catálogos	Lista de objetos que descreve os catálogos que contêm este item. Tipo de dados: matriz "catalogs": [{ "sys_id": "String", "title": "String" }]
catálogos.sys_id	Sys_id do catálogo. Tipo de dados: cadeia de caracteres
catálogos.título	Título do catálogo. Tipo de dados: cadeia de caracteres
categoria	Descreve a categoria que contém este item. Tipo de dados: objeto "catalogs": { "sys_id": "String", "title": "String" }
categoria.sys_id	Sys_id da categoria. Tipo de dados: cadeia de caracteres
categoria.título	Título da categoria Tipo de dados: cadeia de caracteres
content_type	Tipo de conteúdo. Tipo de dados: cadeia de caracteres
descrição	Descrição detalhada do item. Tipo de dados: cadeia de caracteres
ícones	Origem do pequeno ícone exibido ao lado do nome do item. Tipo de dados: cadeia de caracteres
kb_article	Artigo baseado em conhecimento associado ao item. Tipo de dados: cadeia de caracteres
moeda_local	Código da moeda do país para a moeda local. Tipo de dados: cadeia de caracteres
preço_localizado	Preço do item expresso na moeda definida por local_currency. Tipo de dados: cadeia de caracteres
preço_recorrente_localizado	Preço da taxa recorrente expresso na moeda definida por local_currency. Tipo de dados: cadeia de caracteres
nome	Nome do item. Tipo de dados: cadeia de caracteres
pedido	Ordem predefinida à qual o item pertence. Tipo de dados: número
imagem	Caminho para a imagem a ser exibida para o item. Tipo de dados: cadeia de caracteres
preço	Preço do item expresso na moeda definida por price_currency. Tipo de dados: cadeia de caracteres
preço_moeda	Código da moeda do país para o qual o preço do item é expresso. Tipo de dados: cadeia de caracteres
recurring_frequency	Frequência na qual as taxas recorrentes são aplicadas, como diária, mensal ou anual; null se não houver taxas para o item. Tipo de dados: cadeia de caracteres
recurring_price	Valor da taxa recorrente associada ao item. Tipo de dados: cadeia de caracteres
preço_currency_recorrente	Código da moeda do país para o qual as taxas recorrentes são expressas. Tipo de dados: cadeia de caracteres
short_description	Breve descrição do item. Tipo de dados: cadeia de caracteres
mostrar_preço	Sinalizador que indica se o preço do item deve ser mostrado no carrinho. Valores possíveis: verdadeiro: os pares de nome-valor são retornados nos parâmetros de resposta. falso: os pares de nome-valor não são retornados nos parâmetros de resposta. Tipo de dados: booliano
mostrar_quantidade	Sinalizador que indica se a quantidade de itens no carrinho deve ser exibida. Valores possíveis: verdadeiro: exibe a quantidade de itens no carrinho. falso: não exibe a quantidade de itens no carrinho. Tipo de dados: booliano
sys_class_name	Tabela à qual o registro pertence, como sc_cat_item_producer. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do item. Tipo de dados: cadeia de caracteres
tipo	Tipo de item. Tipo de dados: cadeia de caracteres
URL	URL do item. Tipo de dados: cadeia de caracteres

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items?sysparm_catalog=e0d08b13c3330100c8b837659bba8fb4&sysparm_limit=2" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": [
    {
      "short_description": null,
      "kb_article": "",
      "icon": "images/icons/catalog_item.gifx",
      "description": "<p class=\"p1\"><font size=\"2\"><span class=\"s1\">Request an existing Standard Change Template is made unavailable when it is no longer required or no longer acceptable as a Standard Change.  This will be confirmed by your Change Management team.</span></font></p>",
      "show_price": false,
      "type": "record_producer",
      "show_quantity": true,
      "sys_class_name": "sc_cat_item_producer",
      "picture": "",
      "url": "",
      "sys_id": "011f117a9f3002002920bde8132e7020",
      "content_type": "",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "Retire a Standard Change Template",
      "category": {
        "sys_id": "00728916937002002dcef157b67ffb6d",
        "title": "Template Management"
      },
      "order": 30
    },
    {
      "short_description": null,
      "kb_article": "",
      "icon": "4cc3ec3d471211002ee987e8dee490d0.iix",
      "description": "<p><font size=\"3\" color=\"#808080\" face=\"arial,helvetica,sans-serif\">A role delegator may delegate any role they have to any member of the specified group</font></p>",
      "show_price": false,
      "type": "record_producer",
      "show_quantity": true,
      "sys_class_name": "sc_cat_item_producer",
      "picture": "ed44b5804f889200086eeed18110c7ca.iix",
      "url": "",
      "sys_id": "01205b180a0a0b3000b6efd641d24b75",
      "content_type": "",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "Grant role delegation rights within a group",
      "category": {
        "sys_id": "496a3a7e0a0a0bc00089b39df14eb56e",
        "title": "Role Delegation"
      },
      "order": 100
    }
  ]
}

Catálogo de serviços - GET /sn_sc/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}

Verifica se o usuário delegado especificado tem direitos de aquisição para o item do catálogo de serviços especificado.

Formato da URL

URL com controle de versão: /api/sn_sc/{api_version}/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}

URL padrão: /api/sn_sc/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 55. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
item_sys_id	Sys_id do item do catálogo de serviços para verificar se o usuário especificado tem direitos de aquisição. Tipo de dados: cadeia de caracteres Tabela: Catálogo de serviços [sc_catalog]
user_sys_id	Sys_id do usuário para verificar se ele tem direitos de aquisição para o item do catálogo de serviços especificado. Tipo de dados: cadeia de caracteres Tabela: Usuários [sys_users]

Tabela 56. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Tabela 59. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 60. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
resultado	Sinalizador que indica se o usuário especificado tem direitos de aquisição para o item do catálogo de serviços especificado. Valores válidos: verdadeiro: o usuário tem direitos de aquisição. falso: o usuário não tem direitos de aquisição.

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/5c7e9fd20f1010108af26b198b767eb8/delegation/62826bf03710200044e0bfc8bcbe5df1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "result": true
  }
}

Catálogo de serviços - GET /sn_sc/servicecatalog/items/{sys_id}

Recupera um item do catálogo especificado.

Formato da URL

URL com controle de versão: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}

URL padrão: /api/sn_sc/servicecatalog/items/{sys_id}

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 61. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do item do catálogo a ser retornado. Tipo de dados: cadeia de caracteres

Tabela 62. Parâmetros de consulta

Nome	Descrição
sysparm_view	Exibição de IU para a qual os dados serão renderizados. Determina os campos retornados na resposta. Valores válidos: área de trabalho celular ambos Se você também especificar o parâmetro sysparm_fields, ele terá precedência. Tipo de dados: cadeia de caracteres

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

Tabela 65. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 66. Códigos de status

Código do status	Descrição
200	Indica que a solicitação foi concluída com sucesso e retorna os detalhes do item do catálogo.
400	Indica que a solicitação é inválida por um dos seguintes motivos: O usuário não tem acesso ao item do catálogo. sys_id inválido.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
catálogos	Lista de objetos que descreve os catálogos que contêm este item. Tipo de dados: matriz "catalogs": [{ "sys_id": "String", "title": "String" }]
catálogos.sys_id	Sys_id do catálogo. Tipo de dados: cadeia de caracteres
catálogos.título	Título do catálogo. Tipo de dados: cadeia de caracteres
categorias	Lista de objetos que descreve as categorias que contêm este item. Tipo de dados: matriz "categories": [{ "active": Boolean, "category": {Object}, "sys_id": "String", "title": "String" }]
categorias.ativo	Sinalizador que indica se a categoria está ativa. Valores possíveis: verdadeiro: a categoria está ativa. falso: a categoria está inativa. Tipo de dados: booliano
categorias.categoria	Descreve a categoria associada. Tipo de dados: objeto "category": { "active": Boolean, "sys_id": "String", "title": "String" }
categories.category.active	Sinalizador que indica se a categoria está ativa. Valores possíveis: verdadeiro: a categoria está ativa. falso: a categoria está inativa. Tipo de dados: booliano
categorias.categoria.sys_id	Sys_id da categoria. Tipo de dados: cadeia de caracteres
categorias.categoria.título	Título da categoria. Tipo de dados: cadeia de caracteres
categorias.sys_id	Categoria primária da categoria especificada em categories.category. Tipo de dados: cadeia de caracteres
categoria	Categoria primária à qual o item pertence. Tipo de dados: objeto "category": { "sys_id": "String", "title": "String" }
categoria.sys_id	Sys_id da categoria primária. Tipo de dados: cadeia de caracteres
categoria.título	Título da categoria primária. Tipo de dados: cadeia de caracteres
client_script	Lista de todos os scripts de cliente do catálogo definidos no item do catálogo. Tipo de dados: objeto "client_script": { "onChange": [Array], "onLoad": [Array], "onSubmit": [Array] }
client_script.onChange	Lista de client scripts onChange associados ao item. Tipo de dados: matriz
client_script.onSubmit	Lista de client scripts onSubmit associados ao item. Tipo de dados: matriz
client_script.onLoad	Lista de client scripts onLoad associados ao item. Tipo de dados: matriz
content_type	Tipo de conteúdo. Tipo de dados: cadeia de caracteres
pesquisa_dados	Lista de pesquisas de dados definidas no item do catálogo. Tipo de dados: matriz
descrição	Descrição detalhada do item. Tipo de dados: cadeia de caracteres
ícones	Origem do pequeno ícone exibido ao lado do nome do item. Tipo de dados: cadeia de caracteres
kb_article	Artigo baseado em conhecimento associado ao item. Tipo de dados: cadeia de caracteres
moeda_local	Código da moeda do país para a moeda local. Tipo de dados: cadeia de caracteres
preço_localizado	Preço do item expresso na moeda definida por local_currency. Tipo de dados: cadeia de caracteres
preço_recorrente_localizado	Preço da taxa recorrente expresso na moeda definida por local_currency. Tipo de dados: cadeia de caracteres
nome	Nome do item. Tipo de dados: cadeia de caracteres
pedido	Número de pedidos do item. Tipo de dados: número
imagem	Nome do arquivo da imagem a ser exibida para o item. Tipo de dados: cadeia de caracteres
preço	Preço do item expresso na moeda definida por price_currency. Tipo de dados: cadeia de caracteres
preço_moeda	Código da moeda do país para o qual o preço do item é expresso. Tipo de dados: cadeia de caracteres
recurring_frequency	Frequência na qual as taxas recorrentes são aplicadas, como diária, mensal ou anual. Tipo de dados: cadeia de caracteres
recurring_price	Valor da taxa recorrente associada ao item Tipo de dados: cadeia de caracteres
preço_currency_recorrente	Código da moeda do país para o qual as taxas recorrentes são expressas. Tipo de dados: cadeia de caracteres
short_description	Breve descrição do item. Tipo de dados: cadeia de caracteres
mostrar_preço	Sinalizador que indica se o preço do item deve ser mostrado no carrinho. Valores possíveis: verdadeiro: os pares de nome/valor de preço são retornados nos parâmetros de resposta. falso: os pares de nome/valor de preços não são retornados nos parâmetros de resposta. Tipo de dados: booliano
mostrar_quantidade	Sinalizador que indica se a quantidade de itens no carrinho deve ser exibida. Valores possíveis: verdadeiro: exibe a quantidade de itens no carrinho. falso: não exibe a quantidade de itens no carrinho. Tipo de dados: booliano
sys_class_name	Nome da tabela à qual este registro pertence. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do item. Tipo de dados: cadeia de caracteres
tipo	Tipo de item. Tipo de dados: cadeia de caracteres
ui_policy	Lista de políticas de IU associadas ao item. Tipo de dados: matriz
URL	URL da imagem do item. Tipo de dados: cadeia de caracteres
variáveis	Lista de variáveis disponíveis associadas ao item. Tipo de dados: matriz

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/0cf7477237153000158bbfc8bcbe5dec" \
  --request GET \
  --header "Accept:application/json" \
  --user "username":"password"

{
  "result": {
    "short_description": "Apple iPad 3",
    "kb_article": "",
    "icon": "e6b3bc0647311200e0ef563dbb9a71fc.iix",
    "description": "\n\t\t\t<p>\n\t\t\t\t<font size=\"3\">\n\t\t\t\t\t<span style=\"color: gray;\">\n\t\t\t\t\t\tiPad with Retina display Wi-Fi 16GB - Black </span>\n\t\t\t\t</font>\n\t\t\t</p>\n\t\t\t<p>\n\t\t\t\t<span style=\"color: gray;\">Key Features:</span>\n\t\t\t</p>\n\t\t\t<ul><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Retina display (2048x1536 resolution)</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">16GB storage</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Wi-Fi enabled</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Built-in speaker, microphone and camera</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Up to 10 hours battery life</span>\n\t\t\t\t</li></ul>",
    "show_price": true,
    "recurring_price": "$0.00",
    "type": "catalog_item",
    "show_quantity": true,
    "local_currency": "USD",
    "sys_class_name": "pc_hardware_cat_item",
    "picture": "5b977690cb921200f2de77a4634c9c6a.iix",
    "url": "",
    "sys_id": "060f3afa3731300054b6a3549dbe5d3e",
    "recurring_price_currency": "USD",
    "content_type": "",
    "localized_price": "$600.00",
    "price": "$600.00",
    "catalogs": [
      {
        "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
         "title": "Service Catalog"
      }
    ],
    "recurring_frequency": null,
    "name": "Apple iPad 3",
    "localized_recurring_price": "$0.00",
    "category": {
      "sys_id": "b06546f23731300054b6a3549dbe5dd8",
      "title": "Tablets"
    },
    "price_currency": "USD",
    "order": 0,
    "categories": [
      {
        "sys_id": "d258b953c611227a0146101fb1be7c31",
        "active": true,
        "category": {
          "sys_id": "b06546f23731300054b6a3549dbe5dd8",
          "active": true,
          "title": "Tablets"
        },
        "title": "Hardware"
      }
    ],
    "variables": [],
    "ui_policy": [],
    "client_script": {
      "onChange": [],
      "onSubmit": [],
      "onLoad": []
    },
    "data_lookup": []
  }
}

Catálogo de serviços - GET /sn_sc/servicecatalog/wishlist

Recupera a lista de itens na lista de desejos do usuário conectado.

Formato da URL

URL com controle de versões: /api/sn_sc/{api_version}/servicecatalog/wishlist

URL padrão: /api/sn_sc/servicecatalog/wishlist

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 67. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 68. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Tabela 71. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 72. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
ID_do_carrinho	Sys_id do carrinho da lista de desejos. Tipo de dados: cadeia de caracteres
itens	Lista de objetos que descreve os itens no carrinho da lista de desejos. Tipo de dados: matriz "items": [{ "cart_item_id": "String", "catalog_item_id": "String", "created_by": "String", "created_on": "String", "delivery_time": "String", "item_id": "String", "item_name": "String", "localized_price": "String", "localized_recurring_price": "String", "name": "String", "order_guide": "String", "picture": "String", "price": "String", "quantity": "String", "recurring_frequency": "String", "recurring_price": "String", "recurring_subtotal": Number, "recurring_subtotal_price": "String", "short_descriptions": "String", "show_price": Boolean, "show_quantity": Boolean, "show_recurring_price": Boolean, "subtotal": Number, "subtotal_price": "String", "sys_class_name": "String", "sys_id": "String", "updated_by": "String", "updated_on": "String", "variables": {Object} }]
itens.cart_item_id	Sys_id do item. Igual a items.sys_id. Tipo de dados: cadeia de caracteres
itens.catalog_item_id	Sys_id do identificador do catálogo para este item no carrinho da lista de desejos. Igual a items.item_id. Tipo de dados: cadeia de caracteres
itens.criados_por	Usuário que inicialmente colocou o item no carrinho da lista de desejos. Tipo de dados: cadeia de caracteres
itens.criados_em	Data e hora em que o item foi colocado inicialmente no carrinho da lista de desejos. Tipo de dados: cadeia de caracteres
itens.tempo_de_entrega	Quantidade de tempo necessária para entregar o item. Tipo de dados: cadeia de caracteres
itens.item_id	Identificador de catálogo exclusivo para este item no carrinho da lista de desejos (sys_id). Igual a itens.catalog_item_id. Tipo de dados: cadeia de caracteres
itens.item_name	Nome do item. Tipo de dados: cadeia de caracteres
itens.localizado_preço	Preço do item expresso na moeda local. Tipo de dados: cadeia de caracteres
itens.localized_recurring_Price	Preço da taxa recorrente expresso na moeda local. Tipo de dados: cadeia de caracteres
items.name	Nome do item. Tipo de dados: cadeia de caracteres
itens.ordem_guia	Guia de pedido ao qual o item está associado. Tipo de dados: cadeia de caracteres
itens.imagem	Caminho para a imagem a ser exibida para o item. Tipo de dados: cadeia de caracteres
itens.preço	Preço do item. Tipo de dados: cadeia de caracteres
itens.quantidade	Número deste item no carrinho da lista de desejos. Tipo de dados: cadeia de caracteres
itens.frequência_recorrente	Frequência na qual as taxas recorrentes são aplicadas, como diária, mensal ou anual. Nulo se não houver taxas recorrentes para este item. Tipo de dados: cadeia de caracteres
itens.preco_recorrente	Valor da taxa recorrente associada ao item. Tipo de dados: cadeia de caracteres
itens.subtotal_recorrente	Subtotal das taxas recorrentes deste item (recurring_Price x quantidade). Tipo de dados: número
itens.recurring_subtotal_Price	Subtotal das taxas recorrentes deste item (recurring_Price x quantidade). Tipo de dados: cadeia de caracteres
itens.short_description	Breve descrição do item. Tipo de dados: cadeia de caracteres
itens.mostrar_preço	Sinalizador que indica se o preço do item deve ser mostrado no carrinho. Se este parâmetro estiver definido como "falso", os pares de nome/valor de preço não serão retornados nos parâmetros de resposta. Tipo de dados: booliano
itens.mostrar_quantidade	Sinalizador que indica se a quantidade de itens no carrinho deve ser exibida. Tipo de dados: booliano
itens.mostrar_preço_recorrente	Sinalizador que indica se as taxas recorrentes devem ser exibidas no carrinho. Tipo de dados: booliano
itens.subtotal	Subtotal deste item - sem incluir centavos (preço x quantidade). Tipo de dados: número
itens.subtotal_preço	Subtotal deste item - incluindo centavos (preço x quantidade). Tipo de dados: cadeia de caracteres
itens.sys_class_name	Classe secundária à qual o registro do item associado pertence. Tipo de dados: cadeia de caracteres
itens.sys_id	Identificador exclusivo do item (sys_id). Igual a itens.cart_item_id. Tipo de dados: cadeia de caracteres
itens.atualizados_por	Usuário que atualizou este item no carrinho da lista de desejos. Tipo de dados: cadeia de caracteres
itens.atualizados_on	Data e hora em que o item foi colocado na lista de desejos. Tipo de dados: cadeia de caracteres
itens.variáveis	Pares de nome-valor de variáveis associadas ao item. Tipo de dados: objeto

Solicitação de cURL

curl "http://instance.servicenow.com/api/sn_sc/servicecatalog/wishlist" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

{
  "result": {
    "cart_id": "3a68c46013f12300027879d96144b0ce",
    "items": [
      {
        "updated_on": "2018-11-16 05:54:41",
        "catalog_item_id": "774906834fbb4200086eeed18110c737",
        "short_description": "Macbook Pro",
        "recurring_subtotal_price": "$100.00",
        "delivery_time": "5 Days 0 seconds",
        "sys_class_name": "sc_cat_item",
        "sys_id": "3b8d887113b5a300027879d96144b0c2",
        "price": "$1,499.00",
        "recurring_frequency": "Annually",
        "subtotal_price": "$1,499.00",
        "variables": {
          "Adobe Photoshop": "false",
          "Adobe Acrobat": "false",
          "Optional Software": "true",
          "Additional software requirements": "",
          "Eclipse IDE": "true"
        },
        "quantity": "1",
        "item_id": "774906834fbb4200086eeed18110c737",
        "recurring_price": "$100.00",
        "show_price": true,
        "item_name": "Developer Laptop (Mac)",
        "cart_item_id": "3b8d887113b5a300027879d96144b0c2",
        "recurring_subtotal": 100,
        "show_quantity": true,
        "created_by": "admin",
        "picture": "4e4efd444f889200086eeed18110c7e6.iix",
        "created_on": "2018-11-16 05:54:41",
        "localized_price": "$1,499.00",
        "subtotal": 1499,
        "show_recurring_price": true,
        "name": "Developer Laptop (Mac)",
        "updated_by": "admin",
        "localized_recurring_price": "$100.00",
        "order_guide": ""
      }
    ]
  }
}

Catálogo de serviços - GET /sn_sc/servicecatalog/wishlist/{cart_item_id}

Recupera os detalhes do item especificado armazenado no carrinho da lista de desejos.

Formato da URL

URL com controle de versão: /api/sn_sc/v1/servicecatalog/wishlist/{cart_item_id}

URL padrão: /api/sn_sc/servicecatalog/wishlist/{cart_item_id}

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 73. Parâmetros de caminho

Nome	Descrição
carrinho_item_id	Sys_id do item do carrinho da lista de desejos a ser recuperado. Tipo de dados: cadeia de caracteres

Tabela 74. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Tabela 77. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 78. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Indica uma solicitação com falha. ID do item do carrinho incorreto ou o item não existe no carrinho da lista de desejos.
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
carrinho_item_id	Sys_id do item. Tipo de dados: cadeia de caracteres
catalog_item_id	Sys_id do identificador do catálogo para este item no carrinho da lista de desejos. Tipo de dados: cadeia de caracteres
entrega_tempo	Quantidade de tempo necessária para entregar o item. Tipo de dados: cadeia de caracteres
item_name	Nome do item. Tipo de dados: cadeia de caracteres
preço_localizado	Preço do item expresso na moeda local. Tipo de dados: cadeia de caracteres
preço_recorrente_localizado	Preço da taxa recorrente expresso na moeda local. Tipo de dados: cadeia de caracteres
preço	Preço do item. Tipo de dados: cadeia de caracteres
quantidade	Número deste item no carrinho da lista de desejos. Tipo de dados: cadeia de caracteres
recurring_frequency	Frequência na qual as taxas recorrentes são aplicadas, como diária, mensal ou anual. Nulo se não houver taxas recorrentes para este item. Tipo de dados: cadeia de caracteres
recurring_price	Valor da taxa recorrente associada ao item. Tipo de dados: cadeia de caracteres
variáveis	Pares de nome-valor das variáveis associadas ao item. Tipo de dados: objeto

Solicitação de cURL

curl "http://instance.servicenow.com/api/sn_sc/servicecatalog/wishlist/774906834fbb4200086eeed18110c737" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "catalog_item_id": "04b7e94b4f7b4200086eeed18110c7fd",
    "variables": {
      "Adobe Photoshop": "",
      "Adobe Acrobat": "",
      "Optional Software": "",
      "Additional software requirements": ""
    },
    "quantity": "1",
    "localized_price": "$1,100.00",
    "price": "$1,100.00",
    "recurring_frequency": "Annually",
    "localized_recurring_price": "$100.00",
    "recurring_price": "$100.00",
    "item_name": "Standard Laptop &",
    "cart_item_id": "d31be364c3012200d68d3b0ac3d3aecf",
    "delivery_time": "5 Days"
  }
}

Catálogo de serviços - POST /sn_sc/servicecatalog/cart/checkout

Recupera e processa a finalização de compra do carrinho atual com base no fato de o processo de finalização de compra em duas etapas estar habilitado.

No caso de check-out em uma etapa, o método faz check-out (salva) do carrinho e retorna o número da solicitação e o ID do pedido da solicitação. Se for check-out em duas etapas, o método retornará o status do pedido do carrinho e todas as informações necessárias para o check-out em duas etapas.

Formato da URL

URL com controle de versão: /api/sn_sc/{api_version}/servicecatalog/cart/checkout

URL padrão: /api/sn_sc/servicecatalog/cart/checkout

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 79. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 80. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Tabela 83. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 84. Códigos de status

Código do status	Descrição
200	Indica que a solicitação foi concluída com sucesso. Retorna as informações de total e subtotal e informações sobre os itens no carrinho. No caso de check-out em uma etapa, o método faz check-out (salva) do carrinho e retorna o número da solicitação e o ID do pedido da solicitação. Se for check-out em duas etapas, o método retornará o status do pedido do carrinho e todas as informações necessárias para o check-out em duas etapas.
400	Indica que o carrinho está vazio e não pode fazer check-out.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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)

Parâmetro	Descrição
ID_do_carrinho	Sys_id do carrinho. Tipo de dados: cadeia de caracteres
endereço_de_entrega	Endereço para o qual os itens do carrinho serão entregues. Tipo de dados: cadeia de caracteres
<recurring_frequency>	Lista de itens no carrinho com uma frequência recorrente específica. Os valores possíveis incluem: diariamente mensal anual nenhum (sem taxas recorrentes) Tipo de dados: objeto "<recurring_frequency>": { "frequency_label": "String", "items": [Array], "show_subtotal_price": "String", "subtotal_price": "String", "subtotal_recurring_frequency": "String", "subtotal_recurring_price": "String", "subtotal_title": "String", "total_title": "String" }
<recurring_frequency>.frequency_label	Frequência da taxa recorrente associada. Se não houver taxas recorrentes para o item, este parâmetro conterá "nulo". Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens	Matriz de objetos que contém detalhes de cada item associado à categoria de frequência recorrente especificada. Tipo de dados: matriz "items": [{ "cart_item_id": "String", "catalog_item_id": "String", "created.by": "String", "created_on": "String", "delivery_time": "String", "item_id": "String", "item_name": "String", "localized_price": "String", "localized_recurring_price": "String", "name": "String", "order_guide": "String", "picture": "String", "price": "String", "quantity": "String", "recurring_frequency": "String", "recurring_price": "String", "recurring_subtotal": Number, "recurring_subtotal_price": "String", "short_description": "String", "show_price": Boolean, "show_quantity": Boolean, "show_recurring_price": Boolean, "subtotal": Number, "subtotal_price": "String", "sys_class_name": "String", "sys_id": "String", "updated_by": "String", "updated_on": "String", "variables": {Object} }]
<recurring_frequency>.items.cart_item_id	Sys_id do item neste carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.catalog_item_id	sys_id do catálogo do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.created.by	Usuário que inicialmente colocou o item no carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.criados_em	Data em que o item foi colocado inicialmente no carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.tempo_de_entrega	Tempo que o item especificado leva para ser entregue. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.item_id	Sys_id do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.item_name	Nome do item especificado. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.localizado_preço	Preço do item na moeda local. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.localized_recurring_Price	Taxa recorrente para o item especificado na moeda local. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.name	Nome do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.order_guide	Nome do guia de pedido ao qual este item está associado. Se este item não estiver associado a um guia de pedido, este parâmetro conterá uma cadeia de caracteres vazia. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.imagem	Nome do arquivo da imagem do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.preço	Preço do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.quantidade	Número do item especificado no carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.frequência_recorrente	A frequência com que a taxa recorrente é cobrada pelo item especificado. Se não houver taxas recorrentes para o item, este parâmetro conterá "nulo". Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.preço_recorrente	Taxa recorrente para o item especificado. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.subtotal_recorrente	Subtotal das taxas recorrentes do item (recurring_price x quantity). Tipo de dados: número
<recurring_frequency>.itens.recurring_subtotal_Price	Subtotal das taxas recorrentes do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.short_description	Descrição resumida do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.mostrar_preço	Sinalizador que indica se o preço do item é mostrado no carrinho. Valores possíveis: verdadeiro: mostra o preço do item no carrinho. falso: não mostra o preço do item no carrinho. Tipo de dados: booliano
<recurring_frequency>.itens.mostrar_quantidade	Sinalizador que indica se a quantidade de itens no carrinho deve ser mostrada. Valores possíveis: verdadeiro: mostra a quantidade de itens no carrinho. falso: não mostra a quantidade de itens no carrinho. Tipo de dados: booliano
<recurring_frequency>.itens.mostrar_preço_recorrente	Sinalizador que indica se as taxas recorrentes devem aparecer no carrinho. Valores possíveis: verdadeiro: mostra as taxas recorrentes no carrinho. falso: não mostra as taxas recorrentes no carrinho. Tipo de dados: booliano
<recurring_frequency>.itens.subtotal	Número subtotal de itens. Tipo de dados: número
<recurring_frequency>.itens.subtotal_preço	Subtotal do item (price x quantity). Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.sys_class_name	Nome de classificação do sistema do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.sys_id	Sys_id do registro do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.atualizados_por	Usuário que atualizou o item depois que ele foi colocado inicialmente no carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.atualizados_em	Última data/hora em que o item foi colocado inicialmente no carrinho ou atualizado. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.variáveis	Lista de pares de nome-valor das variáveis de item. Tipo de dados: objeto
<recurring_frequency>.mostrar_subtotal_preço	Sinalizador que indica se um subtotal deve ser mostrado para a categoria de taxa recorrente associada. Valores possíveis: verdadeiro: mostrar subtotais no carrinho. falso: não mostra subtotais no carrinho. Tipo de dados: booliano
<recurring_frequency>.subtotal_Price	Subtotal do custo de todos os itens para a categoria de frequência recorrente associada. Tipo de dados: cadeia de caracteres
<recurring_frequency>.subtotal_recurring_frequency	Tipo de frequência recorrente de subtotal, como diária, mensal etc. Igual a subtotal_recurring_frequency. Tipo de dados: cadeia de caracteres
<recurring_frequency>.subtotal_recurring_Price	Subtotal das taxas recorrentes dos itens na categoria de frequência recorrente associada. Tipo de dados: cadeia de caracteres
<recurring_frequency>.subtotal_title	Se o show_subtotal_price estiver definido como verdadeiro, o texto a ser exibido no carrinho para a legenda associada. Tipo de dados: cadeia de caracteres
<recurring_frequency>.total_title	Texto a ser exibido para o título total da categoria de frequência recorrente associada. Tipo de dados: cadeia de caracteres
requested_for	Sys_id do usuário para quem o item foi solicitado. Tipo de dados: cadeia de caracteres
solicitado_para_usuário	Usuário que solicitou o item em nome de outra pessoa. Tipo de dados: cadeia de caracteres
mostrar_subtotal_preço	Sinalizador que indica se o preço do subtotal deve ser mostrado no carrinho. Valores possíveis: verdadeiro: mostrar subtotais no carrinho. falso: não mostra subtotais no carrinho. Tipo de dados: cadeia de caracteres
instruções_especiais	Todas as instruções dadas pelo cliente sobre o item. Tipo de dados: cadeia de caracteres
preço_subtotal	Subtotal de todos os itens no carrinho em dólares inteiros. Tipo de dados: cadeia de caracteres
subtotal_recurring_frequency	Tipo de frequência recorrente de subtotal, como diária, mensal etc. Igual a <recurring_frequency>.subtotal_recurring_frequency. Tipo de dados: cadeia de caracteres
preço_recorrente_subtotal	Subtotal das taxas de frequência recorrentes para todos os itens no carrinho. Tipo de dados: cadeia de caracteres
subtotal_título	Texto a ser exibido no carrinho para o título do campo de subtotal. Tipo de dados: cadeia de caracteres
total_title	Texto a ser exibido no carrinho para o título do campo total. Tipo de dados: cadeia de caracteres

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/checkout" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "cart_id": "0830db8413a56300397533e2e144b0ba",
    "subtotal_price": "$1,598.00",
    "subtotal_recurring_frequency": "",
    "delivery_address": "",
    "special_instructions": "",
    "subtotal_recurring_price": "$0.00",
    "total_title": "Total",
    "requested_for_user": "System Administrator",
    "none": {
      "subtotal_price": "$1,598.00",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "frequency_label": null,
      "items": [
        {
          "updated_on": "2018-11-06 17:01:21",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "a846872a1369e300027879d96144b07e",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$799.00",
          "variables": {},
          "quantity": "1",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "a846872a1369e300027879d96144b07e",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 17:01:21",
          "localized_price": "$799.00",
          "subtotal": 799,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        },
        {
          "updated_on": "2018-11-06 17:34:15",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "7d138fa21329e300027879d96144b065",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$799.00",
          "variables": {},
          "quantity": "1",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "7d138fa21329e300027879d96144b065",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 16:47:30",
          "localized_price": "$799.00",
          "subtotal": 799,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "requested_for": "6816f79cc0a8016401c5a33be04be441",
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
  }
}

Catálogo de serviços - POST /sn_sc/servicecatalog/cart/submit_order

Faz check-out do carrinho do usuário, com base no tipo de check-out atual (em uma ou duas etapas).

No caso de check-out em uma etapa, o método faz check-out (salva) do carrinho e retorna o número da solicitação e o ID do pedido da solicitação. Se for check-out em duas etapas, o método retornará o status do pedido do carrinho e todas as informações necessárias para o check-out em duas etapas.

Formato da URL

URL com controle de versões: /api/sn_sc/{api_version}/servicecatalog/cart/submit_order

URL padrão: /api/sn_sc/servicecatalog/cart/submit_order

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 85. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 86. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Tabela 89. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 90. Códigos de status

Código do status	Descrição
200	Indica que a solicitação foi concluída com sucesso e os itens no carrinho foram submetidos a check-out com sucesso. No caso de check-out em uma etapa, o método faz check-out (salva) do carrinho e retorna o número da solicitação e o ID do pedido da solicitação. Se for check-out em duas etapas, o método retornará o status do pedido do carrinho e todas as informações necessárias para o check-out em duas etapas.
400	Indica que o carrinho do usuário está vazio.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
parent_id	Se disponível, sys_id do registro primário a partir do qual a solicitação é criada. Para obter mais informações, consulte Configuração de um mapeamento primário para uma solicitação. Tipo de dados: cadeia de caracteres
parent_table	Nome da tabela primária. Tipo de dados: cadeia de caracteres
request_id	Sys_id da solicitação de pedido gerada. Tipo de dados: cadeia de caracteres
request_number	Número da solicitação gerada. Tipo de dados: cadeia de caracteres

Solicitação de cURL

curl "https://instance.servicenow.com /api/sn_sc/v1/servicecatalog/cart/submit_order " \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "request_number": "REQ0010010",
    "request_id": "f89ed597db21120064301150f0b8f5ff"
  }
}

Catálogo de serviços - POST /sn_sc/servicecatalog/items/{sys_id}/add_to_cart

Adiciona o item especificado ao carrinho do usuário atual.

Formato da URL

URL com controle de versão: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/add_to_cart

URL padrão: /api/sn_sc/servicecatalog/items/{sys_id}/add_to_cart

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 91. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do item a ser adicionado ao carrinho atual. Tipo de dados: cadeia de caracteres

Tabela 92. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 93. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
sysparm_also_request_for	Cadeia de caracteres separada por vírgulas de sys_ids de usuários de outros usuários para os quais o item especificado será solicitado. Você não pode especificar mais de 50 usuários adicionais para receber o item. Se alguma pessoa na lista não se qualificar para o item, a solicitação inteira será rejeitada. Se o item associado não tiver o conjunto de variáveis requested_for, a solicitação será rejeitada. Se o item associado tiver a variável requested_for definida, mas a variável Habilitar também solicitação para não estiver configurada ou o usuário de chamada não tiver as funções apropriadas, a solicitação será rejeitada. Tabela: usuário [sys_user]
sysparm_quantity	Obrigatório. Quantidade do item. Não pode ser um número negativo. Tipo de dados: número
sysparm_requested_for	Sys_id do usuário para quem o item especificado será solicitado. Tipo de dados: cadeia de caracteres Tabela: usuário [sys_user]
variáveis	Pares de nome-valor de todas as variáveis de item do carrinho obrigatórias. As variáveis obrigatórias são definidas no formulário associado. 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 94. Cabeçalhos da solicitação

Cabeçalho	Descrição
Nenhum(a)

Tabela 95. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 96. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Os seguintes erros podem ocorrer: Valor de quantidade inválido: indica que o parâmetro sysparm_quantity não foi fornecido ou contém um valor inválido. As restrições de segurança impedem a ordenação do item: indica que o sys_id do item do carrinho especificado nos parâmetros de caminho é inválido ou que o usuário não tem acesso ao item. Variáveis obrigatórias são necessárias: indica que uma ou mais variáveis obrigatórias não foram fornecidas na solicitação.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
ID_do_carrinho	sys_id do carrinho. Tipo de dados: cadeia de caracteres
itens	Detalhes de todos os itens no carrinho. Tipo de dados: matriz "items":[ { "cart_item_id":"String", "catalog_item_id":"String", "item_name":"String", "localized_recurring_price":"String", "localized_price":"String", "price":"String", "quantity":"String", "recurring_frequency":"String", "recurring_price":"String" } ]
itens.cart_item_id	Sys_id do item. Tipo de dados: cadeia de caracteres
itens.catalog_item_id	sys_id do catálogo do item. Tipo de dados: cadeia de caracteres
itens.item_name	Nome do item. Tipo de dados: cadeia de caracteres
itens.localizado_preço	Preço do item na moeda local do usuário. Tipo de dados: cadeia de caracteres
itens.localized_recurring_Price	Preço recorrente do item na moeda local do usuário. Tipo de dados: cadeia de caracteres
itens.preço	Preço base. Tipo de dados: cadeia de caracteres
itens.quantidade	Quantidade do item no carrinho. Tipo de dados: cadeia de caracteres
itens.frequência_recorrente	Frequência na qual o preço recorrente é aplicado. Tipo de dados: cadeia de caracteres
itens.preco_recorrente	Preço recorrente. Tipo de dados: cadeia de caracteres
subtotal	Subtotal dos itens no carrinho. Tipo de dados: cadeia de caracteres

Amostra de solicitação e resposta de cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/0d08837237153000158bbfc8bcbe5d02/add_to_cart" \
--request POST \
--header "Accept:application/json" \
--data "{ 'sysparm_quantity' : '1',
  'variables' : {
    'acrobat' : 'true'
  }
}" \
--user "username":"password"

{
  "result": {
    "cart_id": "0951c597db21120064301150f0b8f5cf",
    "subtotal": "$1,599.98",
    "items": [
      {
        "catalog_item_id": "0d08837237153000158bbfc8bcbe5d02",
        "quantity": "1",
        "localized_price": "$799.99",
        "price": "$799.99",
        "recurring_frequency": "Monthly",
        "localized_recurring_price": "$30.00",
        "recurring_price": "$29.00",
        "item_name": "Apple iPhone 5",
        "cart_item_id": "ac61c597db21120064301150f0b8f5f9"
      }
    ]
  }
}

Catálogo de serviços - POST /sn_sc/servicecatalog/items/{sys_id}/add_to_wishlist

Adiciona o item especificado ao carrinho da lista de desejos.

Formato da URL

URL com controle de versão: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/add_to_wishlist

URL padrão: /api/sn_sc/ servicecatalog/items/{sys_id}/add_to_wishlist

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 97. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do item a ser adicionado à lista de desejos. Tipo de dados: cadeia de caracteres

Tabela 98. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 99. Parâmetros do corpo da solicitação (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 100. 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	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json

Tabela 101. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 102. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Indica uma solicitação com falha. Dados de solicitação inválidos ou o usuário não pode adicionar itens à lista de desejos.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
Nenhum(a)

Solicitação de cURL

curl "http://instance.servicenow.com/api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/add_to_wishlist" \
 --request POST \
 --header "Accept:application/json" \
 --header "Content-Type:application/json" \
 --data "{\"sysparm_quantity\":\"1\"}" \
 --user "username":"password"

{
  "result": {
    "cart_id": "02a559a7c3b02200d68d3b0ac3d3ae5d",
    "items": [
      {
        "catalog_item_id": "04b7e94b4f7b4200086eeed18110c7fd",
        "variables": {
          "Adobe Photoshop": "",
          "Adobe Acrobat": "",
          "Optional Software": "",
          "Additional software requirements": ""
        },
        "quantity": "1",
        "localized_price": "$1,100.00",
        "price": "$1,100.00",
        "recurring_frequency": "Annually",
        "localized_recurring_price": "$100.00",
        "recurring_price": "$100.00",
        "item_name": "Standard Laptop &",
        "cart_item_id": "d31be364c3012200d68d3b0ac3d3aecf",
        "delivery_time": "5 Days"
      }
    ]
  }
}

Catálogo de serviços - POST /sn_sc/servicecatalog/items/{sys_id}/checkout_guide

Recupera uma matriz de conteúdos solicitados para check-out.

Formato da URL

URL com controle de versões: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/checkout_guide

URL padrão: /api/sn_sc/servicecatalog/items/{sys_id}/checkout_guide

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 103. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do guia de finalização de compra para o qual as informações serão retornadas. Tipo de dados: cadeia de caracteres

Tabela 104. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 105. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
itens	Lista de objetos que descreve os itens solicitados para check-out. Tipo de dados: matriz "items": [{ "sys_id": "String", "sysparm_quantity": "String", "variables": {Object} }]
itens.sys_id	Obrigatório. Sys_id do item do catálogo. Tipo de dados: cadeia de caracteres
itens.sysparm_quantity	Número de itens. Tipo de dados: cadeia de caracteres Padrão: 1
itens.variáveis	Pares de nome-valor de variáveis associadas ao item. Tipo de dados: objeto Padrão: sem variáveis

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 106. 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	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json

Tabela 107. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 108. Códigos de status

Código do status	Descrição
200	Indica que a solicitação foi concluída com sucesso. Não é de duas etapas: os itens são adicionados ao carrinho e o conteúdo do carrinho é retornado. É de duas etapas: retorna o número da solicitação e o sys_id da solicitação após o check-out.
400	Indica que a solicitação é inválida. Pode ser devido a um dos seguintes motivos: Um ou mais itens enviados não existem. O usuário não tem acesso a um ou mais itens. Variáveis obrigatórias de um ou mais itens não foram respondidas. (Somente variáveis definidas como obrigatórias são respeitadas.) O valor da quantidade é enviado e não é um número inteiro positivo.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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)

Tabela 109. Elementos retornados no corpo da resposta quando a finalização de compra em duas etapas é falsa

Nome	Descrição
ID_do_carrinho	Sys_id do carrinho. Tipo de dados: cadeia de caracteres
itens	Lista de objetos que contém detalhes de todos os itens no carrinho. Tipo de dados: matriz "items": [{ "cart_item_id": "String", "catalog_item_id": "String", "delivery_time": "String", "item_name": "String", "localized_price": "String", "localized_recurring_price": "String", "price": "String", "quantity": "String", "recurring_frequency": "String", "recurring_price": "String", "variables": {Object} }]
itens.cart_item_id	Sys_id do item no carrinho. Tipo de dados: cadeia de caracteres
itens.catalog_item_id	Sys_id do item do catálogo no carrinho. Tipo de dados: cadeia de caracteres
itens.tempo_de_entrega	Quantidade de tempo necessária para entregar o item. Tipo de dados: cadeia de caracteres
itens.item_name	Nome do item no carrinho. Tipo de dados: cadeia de caracteres
itens.localizado_preço	Preço do item na moeda local. Tipo de dados: cadeia de caracteres
itens.localized_recurring_Price	Preço recorrente do item na moeda local. Tipo de dados: cadeia de caracteres
itens.preço	Preço do item. Tipo de dados: cadeia de caracteres
itens.quantidade	Número do item no carrinho. Tipo de dados: cadeia de caracteres
itens.frequência_recorrente	Frequência recorrente do item. Tipo de dados: cadeia de caracteres
itens.preco_recorrente	Preço recorrente do item. Tipo de dados: cadeia de caracteres
itens.variáveis	Pares de nome-valor associados ao item no carrinho. Tipo de dados: objeto
parent_id	Se disponível, o sys_id do registro primário a partir do qual a solicitação é criada. Para obter mais informações, consulte Configuração de um mapeamento primário para uma solicitação. Tipo de dados: cadeia de caracteres
parent_table	Nome da tabela primária (diferencia maiúsculas de minúsculas). Tipo de dados: cadeia de caracteres
request_number	Solicitar número de registro. Tipo de dados: cadeia de caracteres
request_id	Sys_id da solicitação. Tipo de dados: cadeia de caracteres
preço_subtotal	Subtotal do carrinho. Tipo de dados: cadeia de caracteres
preço_subtotal	Subtotal do bloco de frequência atual. Tipo de dados: cadeia de caracteres
subtotal_recurring_frequency	Subtotal de frequência recorrente do carrinho. Tipo de dados: cadeia de caracteres
subtotal_recurring_frequency	Subtotal de frequência recorrente do bloco de frequência atual. Tipo de dados: cadeia de caracteres
preço_recorrente_subtotal	Subtotal do preço recorrente do carrinho. Tipo de dados: cadeia de caracteres
preço_recorrente_subtotal	Subtotal de preço recorrente do bloco de frequência atual Tipo de dados: cadeia de caracteres
total_title	Título do campo total na página. Tipo de dados: cadeia de caracteres
total_title	Título do campo total no bloco de frequência atual. Tipo de dados: cadeia de caracteres

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/items/6690750f4f7b4200086eeed18110c761/checkout_guide" \
--request POST \
--header "Accept:application/json"  \
--header "Content-Type:application/json" \
--data "{\"items\":[{
  \"sys_id\":\"04b7e94b4f7b4200086eeed18110c7fd\",
  \"variables\":{
    \"acrobat\":\"true\",
    \"Additional_software_requirements\":\"MS Office 2007\"
  },
  \"sysparm_quantity\":\"3\"
},
{
  \"sys_id\":\"e1be6dcb4f7b4200086eeed18110c74c\"
},
{
  \"sys_id\":\"186d917a6fab7980575967ddbb3ee4f2\",
  \"variables\":{
    \"new_email\":\"[e-mail]\"
  }
},
{
  \"sys_id\":\"8b3ae7fedc1be1004ece5c08239e522b\"
},
{
  \"sys_id\":\"962967674ff38200086eeed18110c7e7\",
  \"variables\":{
    \"ergonomic_office\":\"Office chair should have lumbar support\"
  }
}]}" \
--user "username":"password"

<!--Case-1: if two-step is false:-->
{
  "result": {
    "cart_id": "0d8c7a32c3211200d68d3b0ac3d3aeba",
    "subtotal_price": "$3,350.00",
    "subtotal_recurring_frequency": "",
    "subtotal_recurring_price": "$300.00",
    "total_title": "Total",
    "monthly": {
      "subtotal_price": "$50.00",
      "subtotal_recurring_frequency": "Monthly",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "items": [
        {
          "catalog_item_id": "90af095bcd38798071a208d710d1b64f",
          "variables": {},
          "quantity": "1",
          "localized_price": "$50.00",
          "price": "$50.00",
          "recurring_frequency": "Monthly",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "Belkin iPad Mini Case",
          "cart_item_id": "cb6e485fc3211200d68d3b0ac3d3ae35",
          "delivery_time": "2 Days"
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "none": {
      "subtotal_price": "-",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "items": [
        {
          "catalog_item_id": "186d917a6fab7980575967ddbb3ee4f2",
          "variables": {
            "Preferred Email address": "[e-mail]"
          },
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "New Email Account",
          "cart_item_id": "17c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "global.Workflow"
        },
        {
          "catalog_item_id": "8b3ae7fedc1be1004ece5c08239e522b",
          "variables": {},
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "Corp VPN",
          "cart_item_id": "97c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "2 Days"
        },
        {
          "catalog_item_id": "e1be6dcb4f7b4200086eeed18110c74c",
          "variables": {},
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "External Monitor",
          "cart_item_id": "d3c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "2 Days"
        },
        {
          "catalog_item_id": "962967674ff38200086eeed18110c7e7",
          "variables": {
            "Please describe any ergonomic requirements\n\t\t": "Office chair should have lumbar support"
          },
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "Desk Set Up",
          "cart_item_id": "d7c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "5 Days"
        }
      ],
      "show_subtotal_price": "false",
      "subtotal_title": "Subtotal"
    },
    "yearly": {
      "subtotal_price": "$3,300.00",
      "subtotal_recurring_frequency": "Annually",
      "subtotal_recurring_price": "$300.00",
      "total_title": "Total",
      "items": [
        {
          "catalog_item_id": "04b7e94b4f7b4200086eeed18110c7fd",
          "variables": {
            "Adobe Photoshop": "",
            "Adobe Acrobat": "true",
            "Optional Software": "",
            "Additional software requirements": "MS Office 2007"
          },
          "quantity": "3",
          "localized_price": "$1,100.00",
          "price": "$1,100.00",
          "recurring_frequency": "Annually",
          "localized_recurring_price": "$100.00",
          "recurring_price": "$100.00",
          "item_name": "Standard Laptop",
          "cart_item_id": "9fc5241fc3211200d68d3b0ac3d3ae7e",
          "delivery_time": "5 Days"
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
  }
}

Case-2: if two-step is true:
{
  "result": {
    "request_number": "REQ0010001",
    "request_id": "82a7e89fc3211200d68d3b0ac3d3ae0a"
  }
}

Catálogo de serviços - POST /sn_sc/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users

Retorna uma lista de usuários cuja solicitação do item especificado não pode ser delegada (solicitada por outro usuário).

Você pode chamar este endpoint antes de chamar um endpoint, como API do Catálogo de serviços - POST /sn_sc/servicecatalog/items/{sys_id}/add_to_cart ou API do Catálogo de serviços - POST /sn_sc/servicecatalog/items/{sys_id}/order_now que permitem o requisição de um item do catálogo de serviços em nome de outra pessoa. Essas chamadas falharão se você aprovar um usuário que não esteja autorizado para o item associado. Este endpoint permite que você verifique sua lista de usuários antes de chamar um endpoint que solicita o item ou tenta adicionar o item a um carrinho.

Formato da URL

URL com controle de versões: /api/sn_sc/{api_version}/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users

URL padrão: /api/sn_sc/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 110. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
item_sys_id	Sys_id do item do catálogo de serviços para verificar se o usuário especificado tem direitos de aquisição. Tipo de dados: cadeia de caracteres Tabela: Catálogo de serviços [sc_catalog]

Tabela 111. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 112. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
sysparm_also_request_for	Cadeia de caracteres separada por vírgulas de sys_ids de usuário válido. O endpoint verifica se esses usuários têm direitos de aquisição para o item do catálogo de serviços especificado. Tipo de dados: cadeia de caracteres Tabela: Usuários [sys_users]

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 113. 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	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json

Tabela 114. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 115. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Falha na solicitação. Solicitação incorreta fornecida para processamento. Consulte a mensagem nos resultados de retorno para obter informações adicionais sobre o erro.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
errCode	Número associado ao erro. Retornado somente se o endpoint falhar. Tipo de dados: cadeia de caracteres
errMsg	Descrição do erro que o endpoint encontrou quando falhou.
usuários inválidos	Nomes dos usuários que não podem solicitar o item do catálogo especificado. Tipo de dados: matriz

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/get_invalid_delegated_users" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"sysparm_also_request_for\":\"a8f98bb0eb32010045e1a5115206fe3a,62826bf03710200044e0bfc8bcbe5df1\"}" \
--user "username":"password"

{
  "result": {
    "invalidUsers": [
      "Abel Tuter"
    ]
  }
}

Solicitação de cURL

curl "https://instance.servicenow.com /api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/get_invalid_delegated_users" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"sysparm_also_request_for\":\"a8f98bb0eb32010045e1a5115206fe3a,62826bf03710200044e0bfc8bcbe5df1\"}" \
--user "username":"password"

{
  "result": {
    "errCode": "42202",
    "errMsg": "This item cannot be submitted for multiple people as it is not configured with Requested For"
  }
}

Catálogo de serviços - POST /sn_sc/servicecatalog/items/{sys_id}/order_now

Solicita o item do catálogo especificado.

Formato da URL

URL com controle de versões: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/order_now

URL padrão: /api/sn_sc/servicecatalog/items/{sys_id}/order_now

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 116. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do item do catálogo de serviços. Tipo de dados: cadeia de caracteres Tabela: item do catálogo [sc_cat_item]

Tabela 117. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 118. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
sysparm_also_request_for	Cadeia de caracteres separada por vírgulas de sys_ids de usuários de outros usuários para os quais o item especificado será solicitado. Você não pode especificar mais de 50 usuários adicionais para receber o item. Se alguma pessoa na lista não se qualificar para o item, a solicitação inteira será rejeitada. Se o item associado não tiver o conjunto de variáveis requested_for, a solicitação será rejeitada. Se o item associado tiver a variável requested_for definida, mas a variável Habilitar também solicitação para não estiver configurada ou o usuário de chamada não tiver as funções apropriadas, a solicitação será rejeitada. Tabela: usuário [sys_user]
sysparm_quantity	Obrigatório. Quantidade do item. Não pode ser um número negativo. Tipo de dados: número
sysparm_requested_for	Sys_id do usuário para quem o item especificado será solicitado. As configurações das propriedades glide.sc.req_for.roles e glide.sc.req_for.roles.default determinam o nível no qual um usuário pode solicitar itens. Se um valor for especificado na propriedade glide.sc.req_for.roles, o sistema verificará se o usuário tem a função especificada para solicitar informações de outros usuários. Se o valor da propriedade glide.sc.req_for.roles estiver vazio e o valor da propriedade glide.sc.req_for.roles.default for deny, nenhum usuário poderá solicitar itens para outros usuários. Se o valor da propriedade glide.sc.req_for.roles estiver vazio e o valor da propriedade glide.sc.req_for.roles.default for allow, qualquer usuário poderá solicitar itens para outros usuários. Tipo de dados: cadeia de caracteres
variáveis	Pares de nome-valor de todas as variáveis de item do carrinho obrigatórias. As variáveis obrigatórias são definidas no formulário associado. 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 119. 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	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json

Tabela 120. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 121. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Indica que o valor da quantidade é inválido e que a solicitação não foi feita.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
número	Número da solicitação gerada. Tipo de dados: cadeia de caracteres
parent_id	Se disponível, o sys_id do registro primário a partir do qual a solicitação é criada. Para obter mais informações, consulte Configuração de um mapeamento primário para uma solicitação. Tipo de dados: cadeia de caracteres
parent_table	Se disponível, o nome da tabela primária a partir da qual a solicitação é criada. Tipo de dados: cadeia de caracteres
request_id	Sys_id da solicitação de pedido. Tipo de dados: cadeia de caracteres
request_number	Número da solicitação. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do pedido. Tipo de dados: cadeia de caracteres
tabela	Nome da tabela da solicitação. Tipo de dados: cadeia de caracteres

Amostra de solicitação cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/d82ea08510247200964f77ffeec6c4ee/order_now" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  sysparm_quantity: 1,
  variables: {
    replacement: 'Yes',
    originalnumber: '1640000',
    data_plan: '500MB'
  }
}" \
--user "username":"password"

{
  "result": {
    "sys_id": "cf56a3fcdb3a2300e890f71fbf9619ac",
    "number": "REQ0010012",
    "request_number": "REQ0010012",
    "request_id": "cf56a3fcdb3a2300e890f71fbf9619ac",
    "table": "sc_request"
  }
}

Catálogo de serviços - POST /sn_sc/servicecatalog/items/{sys_id}/submit_producer

Cria um registro e retorna o caminho relativo da API da tabela e a URL de redirecionamento para acessar o registro criado.

Formato da URL

URL com controle de versões: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/submit_producer

URL padrão: /api/sn_sc/servicecatalog/items/{sys_id}/submit_producer

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 122. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id da tabela na qual o produtor de registro será criado. Tipo de dados: cadeia de caracteres

Tabela 123. Parâmetros de consulta

Nome	Descrição
sysparm_view	Exibição de IU para a qual os dados serão renderizados. Determina os campos retornados na resposta. Valores válidos: área de trabalho celular ambos Se você também especificar o parâmetro sysparm_fields, ele terá precedência. Tipo de dados: cadeia de caracteres

Tabela 124. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
variáveis	Pares de nome-valor das variáveis do registro do produtor a serem definidos.

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 125. 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	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json

Tabela 126. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 127. Códigos de status

Código do status	Descrição
200	Indica a solicitação bem-sucedida e retorna o objeto de resposta que consiste na API da tabela e na URL para acessar o registro criado.
400	A solicitação não foi processada devido a uma mensagem de solicitação incorreta.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não foi possível encontrar o recurso solicitado.
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
número	Número do tíquete associado ao produtor de registro. Tipo de dados: cadeia de caracteres
parent_id	Se disponível, sys_id do registro primário a partir do qual a solicitação é criada. Para obter mais informações, consulte Configuração de um mapeamento primário para uma solicitação. Tipo de dados: cadeia de caracteres
parent_table	Nome da tabela primária. Tipo de dados: cadeia de caracteres
registro	Caminho relativo da API de tabela do produtor de registro recém-criado. Tipo de dados: cadeia de caracteres
redirecionamento_portal_url	URL para o qual o Portal de serviços será redirecionado. Tipo de dados: cadeia de caracteres
redirecionar_para	Redirecionar valor. Tipo de dados: cadeia de caracteres
redirect_url	Redirecione a URL para acessar o produtor de registro criado. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do registro criado. Tipo de dados: cadeia de caracteres
tabela	Nome da tabela na qual a solicitação foi feita. Tipo de dados: cadeia de caracteres

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/3f1dd0320a0a0b99000a53f7604a2ef9/submit_producer" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{'variables':{'urgency':'2','comments':'This is sample incident'}}" \
--user "username":"password"

{
  "result": {
    "sys_id": "6baf4e1ddbba2300e890f71fbf961963",
    "number": "INC0010006",
    "parent_id": null,
    "record": "api/now/table/incident/6baf4e1ddbba2300e890f71fbf961963",
    "redirect_portal_url": "",
    "parent_table": "task",
    "redirect_url": "incident.do?sys_id=6baf4e1ddbba2300e890f71fbf961963&sysparm_view=ess",
    "table": "incident",
    "redirect_to": ""
  }
}

Catálogo de serviços - POST /sn/sc/servicecatalog/variables/{sys_id}/display_value

Retorna o valor de exibição da variável especificada.

Formato da URL

URL com controle de versões: /api/sn_sc/{api_version}/servicecatalog/variables/{sys_id}/display_value

URL padrão: /api/sn_sc/servicecatalog/variables/{sys_id}/display_value

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 128. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id da variável para a qual o valor de exibição será retornado. Tipo de dados: cadeia de caracteres

Tabela 129. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 130. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
sysparm_value	Sys_id do registro que contém o valor de exibição a ser retornado. 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 131. 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	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json

Tabela 132. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 133. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.
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
resultado	Valor de exibição da variável. Tipo de dados: cadeia de caracteres

Solicitação de cURL

 curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/variables/2a3947a10a0a020e007f12648f8790c0/display_value" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"sysparm_value\":\"62826bf03710200044e0bfc8bcbe5df1\"}" \ 
--user "username":"password" 

{
  "result": "Abel Tuter (Architect)"
}

Catálogo de serviços - PUT /sn_sc/servicecatalog/cart/{cart_item_id}

Atualiza o item especificado no carrinho do usuário conectado.

Formato da URL

URL com controle de versões: /api/sn_sc/{api_version}/servicecatalog/cart/{cart_item_id}

URL padrão: /api/sn_sc/servicecatalog/cart/{cart_item_id}

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 134. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
carrinho_item_id	Sys_id do item do carrinho a ser atualizado. Tipo de dados: cadeia de caracteres

Tabela 135. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 136. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
sysparm_quantity	Obrigatório. Quantidade do item para atualizar o carrinho. Tipo de dados: cadeia de caracteres
variáveis	Obrigatório se houver variáveis obrigatórias especificadas para o item. Objeto que consiste em todos os pares de nomes-valor de variáveis obrigatórias. Tipo de dados: objeto

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 137. 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	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json

Tabela 138. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 139. Códigos de status

Código do status	Descrição
201	Indica que a solicitação foi concluída com sucesso e que o item foi adicionado ao carrinho.
400	Os três erros a seguir podem ocorrer: Valor de quantidade inválido:indica que o parâmetro sysparm_quantity não foi fornecido ou contém um valor inválido. As restrições de segurança impedem a ordenação do item:indica que o ID do item especificado nos parâmetros de caminho é inválido ou que o usuário não tem acesso ao item. Variáveis obrigatórias são obrigatórias:indica que um ou mais valores de variáveis obrigatórias não foram fornecidos na solicitação.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
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
ID_do_carrinho	Sys_id do carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>	Descreve itens no carrinho que têm uma frequência recorrente específica. Os valores possíveis incluem: diariamente mensal anual nenhum (sem taxas recorrentes) Tipo de dados: objeto "<recurring_frequency>": { "frequency_label": "String", "items": [Array], "show_subtotal_price": "String", "subtotal_price": "String", "subtotal_recurring_frequency": "String", "subtotal_recurring_price": "String", "subtotal_title": "String", "total_title": "String" }
<recurring_frequency>.frequency_label	Frequência da taxa recorrente associada. Se não houver taxas recorrentes para o item, este parâmetro conterá "nulo". Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens	Lista de objetos que descreve cada item associado à categoria de frequência recorrente especificada. Tipo de dados: matriz "items": [{ "cart_item_id": "String", "catalog_item_id": "String", "created.by": "String", "created_on": "String", "delivery_time": "String", "item_id": "String", "item_name": "String", "localized_price": "String", "localized_recurring_price": "String", "name": "String", "order_guide": "String", "picture": "String", "price": "String", "quantity": "String", "recurring_frequency": "String", "recurring_price": "String", "recurring_subtotal": Number, "recurring_subtotal_price": "String", "short_description": "String", "show_price": Boolean, "show_quantity": Boolean, "show_recurring_price": Boolean, "subtotal": Number, "subtotal_price": "String", "sys_class_name": "String", "sys_id": "String", "updated_by": "String", "updated_on": "String", "variables": {Object} }]
<recurring_frequency>.items.cart_item_id	Sys_id do item neste carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.catalog_item_id	sys_id do catálogo do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.created.by	Usuário que inicialmente colocou o item no carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.criados_em	Data em que o item foi colocado inicialmente no carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.tempo_de_entrega	Tempo que o item especificado leva para ser entregue. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.item_id	sys_id do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.item_name	Nome do item especificado. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.localizado_preço	Preço do item (na moeda local). Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.localized_recurring_Price	Taxa recorrente para o item especificado (na moeda local). Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.name	Nome do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.order_guide	Nome do guia de pedido ao qual este item está associado. Se este item não estiver associado a um guia de pedido, este parâmetro conterá uma cadeia de caracteres vazia. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.imagem	Nome do arquivo da imagem do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.preço	Preço do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.quantidade	Número do item especificado no carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.frequência_recorrente	A frequência com que a taxa recorrente é cobrada pelo item especificado. Tipo de dados: cadeia de caracteres Padrão: nulo
<recurring_frequency>.itens.preço_recorrente	Taxa recorrente para o item especificado. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.subtotal_recorrente	Subtotal das taxas recorrentes do item (recurring_price x quantity). Tipo de dados: número
<recurring_frequency>.itens.recurring_subtotal_Price	Subtotal das taxas recorrentes do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.short_description	Descrição resumida do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.mostrar_preço	Sinalizador que indica se o preço do item é mostrado no carrinho. Valores possíveis: verdadeiro: mostra o preço do item no carrinho. falso: não mostra o preço do item no carrinho. Tipo de dados: booliano
<recurring_frequency>.itens.mostrar.quantidade	Sinalizador que indica se a quantidade de itens no carrinho deve ser mostrada. Valores possíveis: verdadeiro: mostra a quantidade de itens no carrinho. falso: não mostra a quantidade de itens no carrinho. Tipo de dados: booliano
<recurring_frequency>.itens.mostrar_preço_recorrente	Sinalizador que indica se as taxas recorrentes devem aparecer no carrinho. Valores possíveis: verdadeiro: mostra as taxas recorrentes no carrinho. falso: não mostra as taxas recorrentes no carrinho. Tipo de dados: booliano
<recurring_frequency>.itens.subtotal	Subtotal do número de itens. Tipo de dados: número
<recurring_frequency>.itens.subtotal_preço	Subtotal do item (price x quantity). Tipo de dados: cadeia de caracteres
<recurring_frequency>.items.sys_class_name	Nome de classificação do sistema do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.sys_id	Sys_id do item. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.atualizados_por	Usuário que atualizou o item depois que ele foi colocado inicialmente no carrinho. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.atualizados_em	Última data/hora em que o item foi colocado inicialmente no carrinho ou atualizado. Tipo de dados: cadeia de caracteres
<recurring_frequency>.itens.variáveis	Pares de nome-valor das variáveis de item. Tipo de dados: objeto
<recurring_frequency>.mostrar_subtotal_preço	Sinalizador que indica se um subtotal deve ser mostrado para a categoria de taxa recorrente associada. Tipo de dados: cadeia de caracteres
<recurring_frequency>.subtotal_Price	Subtotal do custo de todos os itens para a categoria de frequência recorrente associada. Tipo de dados: cadeia de caracteres
<recurring_frequency>.subtotal_recurring_frequency	Tipo de frequência recorrente de subtotal, como diária, mensal etc. Tipo de dados: cadeia de caracteres
<recurring_frequency>.subtotal_recurring_Price	Subtotal das taxas recorrentes dos itens na categoria de frequência recorrente associada. Tipo de dados: cadeia de caracteres
<recurring_frequency>.subtotal_title	Se o show_subtotal_price estiver definido como verdadeiro, o texto a ser exibido no carrinho para a legenda associada. Tipo de dados: cadeia de caracteres
<recurring_frequency>.total_title	Texto a ser exibido para o título total da categoria de frequência recorrente associada. Tipo de dados: cadeia de caracteres
mostrar_subtotal_preço	Sinalizador que indica se o preço do subtotal deve ser mostrado no carrinho. Valores possíveis: verdadeiro: mostrar subtotais no carrinho. falso: não mostra subtotais no carrinho. Tipo de dados: cadeia de caracteres
preço_subtotal	Subtotal de todos os itens no carrinho. Tipo de dados: cadeia de caracteres
subtotal_recurring_frequency	Tipo de frequência recorrente de subtotal, como diária, mensal etc. Igual a <recurring_frequency>.subtotal_recurring_frequency. Tipo de dados: cadeia de caracteres
preço_recorrente_subtotal	Subtotal das taxas de frequência recorrentes para todos os itens no carrinho. Tipo de dados: cadeia de caracteres
subtotal_título	Texto a ser exibido no carrinho para o título do campo de subtotal. Tipo de dados: cadeia de caracteres
total_title	Texto a ser exibido no carrinho para o título do campo total. Tipo de dados: cadeia de caracteres

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/cart/7d138fa21329e300027879d96144b065" \
--request PUT \
--header "Accept:application/json" \
--data "{\"sysparm_quantity\": \"2\" }" \
--user "username":"password"

{
  "result": {
    "cart_id": "0830db8413a56300397533e2e144b0ba",
    "subtotal_price": "$2,397.00",
    "subtotal_recurring_frequency": "",
    "subtotal_recurring_price": "$0.00",
    "total_title": "Total",
    "none": {
      "subtotal_price": "$2,397.00",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "frequency_label": null,
      "items": [
        {
          "updated_on": "2018-11-06 17:01:21",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "a846872a1369e300027879d96144b07e",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$799.00",
          "variables": {},
          "quantity": "1",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "a846872a1369e300027879d96144b07e",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 17:01:21",
          "localized_price": "$799.00",
          "subtotal": 799,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        },
        {
          "updated_on": "2018-11-06 17:21:08",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "7d138fa21329e300027879d96144b065",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$1,598.00",
          "variables": {},
          "quantity": "2",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "7d138fa21329e300027879d96144b065",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 16:47:30",
          "localized_price": "$799.00",
          "subtotal": 1598,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
  }
}

Catálogo de serviços - PUT /sn_sc/servicecatalog/items/{sys_id}/submit_guide

Recupera uma lista de itens com base nas necessidades descritas para um guia de pedido.

Formato da URL

URL com controle de versões: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/submit_guide

URL padrão: /api/sn_sc/servicecatalog/items/{sys_id}/submit_guide

Nota:

As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

Parâmetros de solicitação compatíveis

Tabela 140. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do guia de pedido cujos itens serão recuperados. Tipo de dados: cadeia de caracteres Tabela: Guia de pedido [sc_cat_item_guide]

Tabela 141. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 142. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
variáveis	Variáveis solicitadas para um item. Cada variável é um objeto JSON que consiste em pares de nome-valor. Tipo de dados: matriz

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 143. 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	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json

Tabela 144. 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 145. Códigos de status

Código do status	Descrição
200	Indica que a solicitação foi concluída com sucesso. Retorna uma lista de itens com base na lista de variáveis aprovada. Se o conjunto de resultados não contiver nenhum item, uma matriz vazia será retornada.
400	Indica que a solicitação é inválida. Pode ser devido a um dos seguintes motivos: O usuário não tem acesso ao item. Variáveis obrigatórias de um ou mais itens não foram respondidas. (Somente variáveis definidas como obrigatórias são respeitadas.)
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
500	Erro interno ao calcular itens, dependendo das opções escolhidas.

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

Nome	Descrição
catálogos	Lista de objetos aos quais o item pertence e cada título do catálogo e sys_id do catálogo. Tipo de dados: matriz de objetos "catalogs": [ { "sys_id": "String", "title": "String" } ]
catálogos.sys_id	Sys_id do catálogo. Tipo de dados: cadeia de caracteres
catálogos.título	Título do catálogo. Tipo de dados: cadeia de caracteres
categoria	Categoria que contém este item. Tipo de dados: objeto "catalogs": { "sys_id": "String", "title": "String" }
categoria.sys_id	Sys_id da categoria. Tipo de dados: cadeia de caracteres
categoria.título	Título da categoria Tipo de dados: cadeia de caracteres
client_script	Lista de todos os scripts de cliente do catálogo definidos no item do catálogo. Tipo de dados: objeto "client_script": { "onChange": [Array], "onLoad": [Array], "onSubmit": [Array] }
client_script.onChange	Lista de client scripts onChange associados ao item. Tipo de dados: matriz
client_script.onLoad	Lista de client scripts onLoad associados ao item. Tipo de dados: matriz
client_script.onSubmit	Lista de client scripts onSubmit associados ao item. Tipo de dados: matriz
pesquisa_dados	Pesquisas de dados definidas no item do catálogo. Tipo de dados: matriz
descrição	Descrição completa do item do catálogo. Tipo de dados: cadeia de caracteres
ícones	Caminho da imagem que aparece como um ícone ao lado do item do catálogo. Tipo de dados: cadeia de caracteres
nome	Nome do item do catálogo. Tipo de dados: cadeia de caracteres
short_description	Texto na página inicial do catálogo de serviços ou na página de resultados de pesquisa, ou o título no formulário de pedido do item do catálogo. Tipo de dados: cadeia de caracteres
mostrar_preço	Sinalizador que indica se os detalhes do preço devem ser mostrados. Se verdadeiro, retorna os seguintes detalhes. moeda_local preço_localizado preço_recorrente_localizado preço preço_moeda recurring_frequency recurring_price preço_currency_recorrente Tipo de dados: booliano
sys_id	Sys_id do item do catálogo. Tipo de dados: cadeia de caracteres
tipo	Tipo de item. Valores possíveis: item do catálogo guia de pedido item do produtor de registro Tipo de dados: cadeia de caracteres
variáveis	Pares de nome-valor de todas as variáveis associadas ao item do catálogo. Tipo de dados: matriz
ui_policy	Lista de todas as políticas de IU de catálogo definidas no item do catálogo. Tipo de dados: matriz

Solicitação de cURL

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/items/6690750f4f7b4200086eeed18110c761/submit_guide" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"variables\":{
    \"hiring_manager\":\"6816f79cc0a8016401c5a33be04be441\",
    \"hiring_group\":\"221f3db5c6112284009f4becd3039cc9\",
    \"remote\":\"No\",
    \"standard_package\":\"No\",
    \"laptop_type\":\"developer\"
  }
}" \
--user "username":"password"

{
  "result": [
    {
      "short_description": "Lenovo - Carbon x1",
      "icon": "1195c2084f889200086eeed18110c74a.iix",
      "description": "<p class=\"p1\"><font size=\"3\" color=\"#808080\"><span class=\"s1\">x1 Carbon</span></font></p>\n<p class=\"p1\"><font size=\"2\" color=\"#808080\" face=\"arial,helvetica,sans-serif\"><span class=\"s1\">The x1 Carbon is Lenovo's lightest ThinkPad yet. It provides a QHD display that fights glare and weighs less than three pounds. Ideal for most computing tasks, and highly mobile. </span></font></p>\n<p class=\"p2\"><font size=\"2\" color=\"#808080\" face=\"arial,helvetica,sans-serif\"><span class=\"s1\">Technical Specs:</span></font></p>\n<ul class=\"ul1\"><li class=\"li3\"><font size=\"2\" color=\"#808080\"><span class=\"s1\">Intel core i5 processor</span></font></li><li class=\"li3\"><font size=\"2\" color=\"#808080\"><span class=\"s1\">512GB solid state drive (SSD) </span></font></li><li class=\"li3\"><font size=\"2\" color=\"#808080\"><span class=\"s1\">Backlit keyboard</span></font></li></ul>",
      "show_price": true,
      "recurring_price": "$100.00",
      "type": "catalog_item",
      "local_currency": "USD",
      "sys_id": "04b7e94b4f7b4200086eeed18110c7fd",
      "recurring_price_currency": "USD",
      "localized_price": "$1,100.00",
      "price": "$1,100.00",
      "catalogs": [
       {
         "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
         "title": "Service Catalog"
       }
      ],
      "recurring_frequency": "Annually",
      "name": "Standard Laptop",
      "localized_recurring_price": "$100.00",
      "category": {
        "sys_id": "d258b953c611227a0146101fb1be7c31",
        "title": "Hardware"
      },
      "price_currency": "USD",
      "show_quantity": false,
      "quantity": "1",
      "order": "100",
      "variables": [
        {
          "label": "Optional Software",
          "type": 0,
          "mandatory": false,
          "displayvalue": "",
          "friendly_type": "container_start",
          "render_label": true,
          "read_only": false,
          "children": [
            {
              "label": "Adobe Acrobat",
              "type": 7,
              "mandatory": false,
              "displayvalue": "false",
              "friendly_type": "check_box",
              "display_type": "CheckBox",
              "render_label": true,
              "read_only": false,
              "pricing_implications": false,
              "name": "acrobat",
              "attributes": "edge_encryption_enabled=true",
              "id": "90b72d4b4f7b4200086eeed18110c701",
              "value": false,
              "help_text": "",
              "max_length": 0
            },
            {
              "label": "Adobe Photoshop",
              "type": 7,
              "mandatory": false,
              "displayvalue": "false",
              "friendly_type": "check_box",
              "display_type": "CheckBox",
              "render_label": true,
              "read_only": false,
              "pricing_implications": false,
              "name": "photoshop",
              "attributes": "edge_encryption_enabled=true",
              "id": "a8b72d4b4f7b4200086eeed18110c701",
              "value": false,
              "help_text": "",
              "max_length": 0
            }
          ],
          "name": "optional_label",
          "attributes": "edge_encryption_enabled=true",
          "id": "10b72d4b4f7b4200086eeed18110c700",
          "value": "",
          "help_text": "",
          "max_length": 0
        },
        {
          "label": "Additional software requirements",
          "type": 2,
          "mandatory": false,
          "displayvalue": "",
          "friendly_type": "multi_line_text",
          "display_type": "Multi Line Text",
          "render_label": true,
          "read_only": false,
          "name": "Additional_software_requirements",
          "attributes": "edge_encryption_enabled=true",
          "id": "a8b72d4b4f7b4200086eeed18110c702",
          "value": "",
          "help_text": "",
          "max_length": 0
        }
      ],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "e1be6dcb4f7b4200086eeed18110c74c",
      "short_description": "LG IPS 27\" Monitor",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "External Monitor",
      "icon": "08569a4c4f889200086eeed18110c77b.iix",
      "description": "<p><font size=\"2\"><span style=\"color: #485563;\"><br /> <font size=\"3\" color=\"#808080\">The striking design of the LG Cinema Screen incorporates an ultra-narrow bezel, so virtually all you see is picture. The viewing experience is more immersive for your favorite movies and games. Make the most of your time, with an LG Full HD LED monitor. </font></span></font></p>\n<p><font size=\"2\" color=\"#808080\">Item Specs:</font></p>\n<ul><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Screen Size: 27"</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Resolution: 1920 x 1080</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Aspect Ratio: 16:9</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Brightness: 250 cd/m2</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Supports Split Screen</font></li></ul>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "2c0b59874f7b4200086eeed18110c71f",
        "title": "Peripherals"
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "200",
      "variables": [],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "186d917a6fab7980575967ddbb3ee4f2",
      "short_description": "New Email Creation",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "New Email Account",
      "icon": "b630e97e6fab7980575967ddbb3ee4d2.iix",
      "description": "<p style=\"font-size: 13px;\"><font size=\"4\"><span style=\"color: #485563;\">Service Overview:</span></font></p>\n\t<p style=\"font-size: 13px;\"><font size=\"3\">Creation of a new email account within our Microsoft Exchange environment.  Creation of your email address will also create your Active Directory account. </font></p>\n\t<p> </p>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "109f0438c6112276003ae8ac13e7009d",
        "title": "Services"
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "300",
      "variables": [
        {
          "label": "Preferred Email address",
          "type": 6,
          "mandatory": true,
          "displayvalue": "",
          "friendly_type": "single_line_text",
          "display_type": "Single Line Text",
          "render_label": true,
          "read_only": false,
          "name": "new_email",
          "attributes": "edge_encryption_enabled=true",
          "id": "65865e474fbb4200086eeed18110c7dd",
          "value": "",
          "help_text": "",
          "max_length": 0
        }
      ],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "8b3ae7fedc1be1004ece5c08239e522b",
      "short_description": "Remote access to Internal Corporate Systems\n\t\t",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "Corp VPN",
      "icon": "11dc8df74f778200086eeed18110c78e.iix",
      "description": "<p><font size=\"3\"><span style=\"color: #485563;\">Corp VPN Account</span></font></p>\n<ul><li style=\"color: #485563;\"><font size=\"2\">Corp VPN provides VPN (Virtual Private Network) access to all Internal Corporate Systems and to IP Restricted Customer Instances</font></li><li style=\"color: #485563;\"><font size=\"2\">By utilizing Corp VPN, users will be provided a similar experience to being within one of the Corporate office locations, while offsite</font></li></ul>\n<p><font size=\"2\"><span style=\"color: #485563;\"> </span></font></p>\n<p><font size=\"2\"><span style=\"color: #485563;\">Please reference the <span style=\"color: #485563;\">CORP VPN </span><span style=\"color: #485563;\">Installation</span><span style=\"color: #485563;\"> and Support Documentation</span> for instructions on installation, usage and FAQ’s. For all other questions, please contact <span style=\"color: #485563;\">IT Support.</span></span></font></p>\n<p> </p>\n<p><span style=\"font-size: 10pt; font-family: tahoma, arial, helvetica, sans-serif;\"><br /><br /></span></p>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "d2f7cae4c611227a018ddc481b34e099",
        "title": "Security and Access"
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "600",
      "variables": [],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "962967674ff38200086eeed18110c7e7",
      "short_description": "Desk Set Up for New Hires or Employee Moves\n\t\t",
      "catalogs": [
        {
          "sys_id": "",
          "title": "Service Catalog"
        }
      ],
      "name": "Desk Set Up",
      "icon": "aa6b08ff4ff38200086eeed18110c7ed.iix",
      "description": "<p><font size=\"3\" face=\"arial, helvetica, sans-serif\">The facilities organization will set up your new desk with the following configuration:</font></p>\n<ul><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Docking Station</font></li><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Power Station</font></li><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Phone</font></li><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Office Chair</font></li></ul>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "",
        "title": null
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "900",
      "variables": [
        {
          "label": "Please describe any ergonomic requirements\n\t\t",
          "type": 2,
          "mandatory": false,
          "displayvalue": "",
          "friendly_type": "multi_line_text",
          "display_type": "Multi Line Text",
          "render_label": true,
          "read_only": false,
          "name": "ergonomic_office",
          "attributes": "edge_encryption_enabled=true",
          "id": "b0b9ab674ff38200086eeed18110c755",
          "value": "",
          "help_text": "",
          "max_length": 0
        }
      ],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    }
  ]
}