ServiceNow
ServiceNow mejora los niveles de servicio, energiza a los empleados y permite a su empresa trabajar a velocidad ligera. Cree, lea y actualice los registros almacenados en ServiceNow, incluidos incidentes, preguntas, usuarios y mucho más.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - China Cloud operado por 21Vianet |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - China Cloud operado por 21Vianet |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - China Cloud operado por 21Vianet |
| Contacto | |
|---|---|
| Nombre | Microsoft |
| URL | https://learn.microsoft.com/connectors/service-now/ |
| Metadatos del conector | |
|---|---|
| Publicador | Microsoft |
| Sitio web | https://www.servicenow.com/ |
| Directiva de privacidad | https://www.servicenow.com/privacy-statement.html |
| Categorías | Sitio web |
Nota:
La operación Obtener artículos de conocimiento solo se puede usar cuando se activa el complemento knowledge API (sn_km_api).
Problemas conocidos y limitaciones
Al usar la acción Crear registro , no es posible especificar la descripción completa del registro. El valor del campo se omitirá debido a Service-Now limitaciones de la API REST.
La acción Obtener registros puede devolver una "Tabla no válida" u otro error en Power Apps. En el caso de las implementaciones de Power Apps, la solución sugerida consiste en usar la acción Obtener registros en Power Automate y devolver los datos a Power Apps.
Actualmente, el conector solo admite direcciones URL de instancia que terminan con "service-now.com". El uso de dominios alternativos como "servicenowservices.com" puede provocar errores de conexión. En tales casos, especialmente cuando se trabaja con un nuevo dominio de ServiceNow en GCC, se recomienda usar la autenticación básica.
Si se produce un error emergente que indica "Redirect_uri no válido", copie la dirección URL completa de la ventana emergente y extraiga el parámetro redirect_uri (por ejemplo, redirect_uri=https%3a%2f%2ftip1-shared.consent.azure-apim.net%2fredirect). Después de descodificar la dirección URL (reemplazando %3a por : y %2f por /), actualice el campo Url de redirección en el registro de aplicaciones de OAuth de la instancia de ServiceNow, como se muestra en la imagen siguiente. A continuación, intente volver a agregar la conexión.
Configuración de una conexión de Power Platform de ServiceNow que usa microsoft Entra ID
Hay dos tipos de conexión:
OAuth de Id. de Entra de Microsoft mediante certificado: se trata de un tipo de autenticación basado en tokens de aplicación en el que se puede usar una aplicación registrada en Entra ID para acceder a ServiceNow obteniendo un token con el recurso establecido como la aplicación id. entra representativa de ServiceNow.
Microsoft Entra ID OAuth mediante el inicio de sesión de usuario: se trata de un tipo de autenticación basado en tokens de usuario en el que el usuario final puede iniciar sesión en la aplicación Entra ID 1P (Aplicación serviceNow Connector 1p) y obtener un token de acceso con el ámbito establecido para la aplicación Entra ID representativa de ServiceNow.
Pasos para crear una conexión de OAuth id. de Microsoft Entra mediante el certificado
Paso 1: Registrar una "aplicación A" en Microsoft Entra ID para la integración de OIDC con ServiceNow. Esta es la aplicación id. de Entra representativa de ServiceNow.
Vaya a Registros > de aplicaciones Nuevo registro para crear un nuevo registro de aplicación.
Nombre: cualquier nombre que prefiera
URI de redirección: no necesario
Agregar
aud,emailyupna las notificaciones en "Notificaciones opcionales"
Paso 2: Registrar el mismo identificador que un proveedor de OIDC en ServiceNow
Vaya a para
System OAuth > Application Registry > New > Configure an OIDC providercomprobar los tokens de identificador- Nombre: cualquier nombre que prefiera
-
Id. de cliente: el de "Aplicación A" creado en el
client IDpaso 1 - Secreto de cliente: esto no se usará realmente, se puede establecer ningún valor.
En el formulario de registro del proveedor OIDC, agregue una nueva configuración del proveedor OIDC. Seleccione el icono de búsqueda en el campo Configuración del proveedor de OAuth OIDC para abrir los registros de configuraciones de OIDC, seleccione "Nuevo".
- Proveedor de OIDC: Id. de Entra de Microsoft
-
Dirección URL de metadatos de OIDC: la dirección URL debe estar en el formato
https://login.microsoftonline.com/<tenantID>/.well-known/openid-configuration, reemplace portenantID.Directory (tenant) ID - Duración de la caché de configuración de OIDC: 120
- Aplicación: Global
- Notificación de usuario: oid
- Campo de usuario: id. de usuario
- Habilitación de la comprobación de notificaciones de JTI: Deshabilitado
Seleccione "Submit" (Enviar) y actualice el formulario de entidad de OAuth OIDC.
Paso 3: Registrar una "aplicación B" en el identificador de Entra de Microsoft para el uso del conector. Esta es la aplicación que desempeña el rol de un usuario con permisos elevados en la instancia de ServiceNow.
Vaya a para
App registrations > New registrationcrear una aplicación- Nombre: cualquier nombre que prefiera
- En Certificados y secretos, cargue el archivo .cer del certificado En caso de certificado SNI, basta con agregar
trustedCertificateSubjectsen el manifiesto de la aplicación con los pertinentesauthorityIdysubjectName
Paso 4: Crear un usuario del sistema en ServiceNow. Se trata de la "aplicación B" como usuario en la instancia de ServiceNow.
Vaya a para
User Administration > Userscrear un nuevo usuario.- Id. de usuario: el identificador de objeto de la entidad de servicio de "Aplicación B" creada en el paso 3
- Comprobar
Web service access only
Paso 5: Conexión mediante el conector – Copilot Studio – Configuración del conector
Configure el conector con la siguiente información y conéctese:
- Nombre de instancia: nombre de instancia de ServiceNow
- Id. de inquilino: el identificador de inquilino del inquilino de Microsoft Entra
- Id. de cliente: el identificador de cliente de "Aplicación B" creado en el paso 3
- URI de recurso: el identificador de cliente de "Aplicación A" creado en el paso 1 (no el URI de la aplicación)
- Secreto de certificado de cliente: el archivo .pfx del certificado creado en el paso 3
- Contraseña del certificado: la contraseña del archivo .pfx
Pasos para crear el inicio de sesión de usuario de OAuth id. de Microsoft Entra
Para configurar una conexión de inicio de sesión de usuario de OAuth id. de Microsoft Entra, complete el paso 1 y el paso 2, tal y como se describe en la sección autenticación de certificados anterior.
El paso 1 permanece igual. En el paso 2, actualice la notificación de usuario a upn o la propiedad de notificación personalizada del token (para proveedores de identidades de terceros distintos de Entra) en ServiceNow. El campo de usuario debe coincidir con el campo de tabla de usuario del sistema serviceNow que contiene el upn o el identificador de usuario.
Los pasos 3 y 4 de la sección de autenticación de certificados anterior no son necesarios. En su lugar, "Aplicación B" en este caso es una aplicación de 1p que se crea para el conector de ServiceNow. La aplicación siguiente debe concederse permisos en la "Aplicación A".
Id. de "Aplicación B": c26b24aa-7874-4e06-ad55-7d06b1f79b63
Importante
En este escenario "Aplicación B" debe usar el identificador c26b24aa-7874-4e06-ad55-7d06b1f79b63 que es una aplicación de 1p existente que pertenece a Microsoft, no una aplicación creada por el usuario (como se requiere para crear una conexión de OAuth id. de Microsoft Entra mediante certificado).
Al crear la conexión para el conector de ServiceNow, el usuario debe seleccionar "Inicio de sesión de usuario de Id. de Entra de Microsoft" como el tipo de autenticación y solo debe proporcionar el nombre de la instancia de ServiceNow y el identificador de recurso (que sería el identificador de "Aplicación A"). Después de esto, el botón de inicio de sesión llevará al usuario a través del inicio de sesión de Entra ID mediante su propia cuenta.
Uso de un proveedor de identidades de terceros o errores de coincidencia de datos existentes entre el usuario en Entra ID y la tabla de usuarios de ServiceNow
- Si hay un error de coincidencia entre la propiedad de identificador de usuario en el token de Id. de Entra y el valor de identificador de usuario que se encuentra en la tabla de ServiceNow
- Por ejemplo, el token contiene el upn completo (junto con el dominio –
abc@contoso.com) y la tabla de usuarios de ServiceNow solo contiene el identificador de usuario (abc). Se recomienda agregar un atributo personalizado al token que contiene un valor que coincida con el identificador de usuario en el identificador de ServiceNow aplicando una fórmula y, a continuación, aprovechar esa nueva propiedad para realizar la asignación de notificaciones en el paso 2. - Documentación de Microsoft Learn que describe el proceso de agregar una nueva propiedad de notificación: https://learn.microsoft.com/entra/external-id/customers/how-to-add-attributes-to-token
- Por ejemplo, el token contiene el upn completo (junto con el dominio –
Referencias de "How to set up a ServiceNow Power Platform that uses Microsoft Entra ID":
- Id. externa Token Authentication (OIDC) para las API rest: soporte técnico y solución de problemas
- Conector de Microsoft Graph del catálogo de ServiceNow | Microsoft Learn
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Autenticación básica | Inicio de sesión con autenticación básica | Todas las regiones | No se puede compartir |
| OAuth de Microsoft Entra ID mediante certificado | OAuth con el identificador de Entra de Microsoft mediante el certificado PFX. | Solo POWERPLATFORM | Compartible |
| Inicio de sesión de usuario de Microsoft Entra ID | Inicio de sesión con credenciales de Id. de Entra de Microsoft | Todas las regiones | No se puede compartir |
| Uso de Oauth2 | Inicio de sesión con Oauth2 | Todas las regiones | No se puede compartir |
| Valor predeterminado [EN DESUSO] | Esta opción solo es para conexiones anteriores sin un tipo de autenticación explícito y solo se proporciona para la compatibilidad con versiones anteriores. | Todas las regiones | No se puede compartir |
Autenticación básica
Identificador de autenticación: basicAuthentication
Aplicable: Todas las regiones
Inicio de sesión con autenticación básica
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Instancia | cuerda / cadena | Nombre de la instancia de para service-now.com o dirección URL personalizada para la cuenta migrada | Cierto |
| Nombre de usuario | cuerda / cadena | Nombre de usuario de esta instancia | Cierto |
| Contraseña | securestring | La contraseña de esta cuenta | Cierto |
Microsoft Entra id. OAuth mediante certificado
Identificador de autenticación: aadOAuthCert
Aplicable: solo POWERPLATFORM
OAuth con el identificador de Entra de Microsoft mediante el certificado PFX.
Se trata de una conexión que se puede compartir. Si la aplicación de energía se comparte con otro usuario, también se comparte la conexión. Para más información, consulte introducción a los conectores para aplicaciones de lienzo: Power Apps | Microsoft Docs
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Nombre de la instancia | cuerda / cadena | Nombre de instancia usado para identificar la URl del sitio de ServiceNow | Cierto |
| Id. de inquilino | cuerda / cadena | Cierto | |
| Id. de cliente | cuerda / cadena | Cierto | |
| URI de recurso | cuerda / cadena | Cierto | |
| Secreto de certificado de cliente | Certificado de cliente | Secreto de certificado de cliente permitido por esta aplicación | Cierto |
Inicio de sesión de usuario de Microsoft Entra ID
Identificador de autenticación: entraIDUserLogin
Aplicable: Todas las regiones
Inicio de sesión con credenciales de Id. de Entra de Microsoft
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| URI de recurso | cuerda / cadena | Cierto | |
| Nombre de la instancia | cuerda / cadena | Nombre de instancia usado para identificar la dirección URL del sitio de ServiceNow | Cierto |
Uso de Oauth2
Identificador de autenticación: oauth2ServiceNow
Aplicable: Todas las regiones
Inicio de sesión con Oauth2
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Nombre de la instancia | cuerda / cadena | Nombre de instancia usado para identificar la URl del sitio de ServiceNow | Cierto |
| Identificador de cliente | cuerda / cadena | Identificador que se usa para identificar esta aplicación con el proveedor de servicios | Cierto |
| Secreto del cliente | securestring | Secreto compartido que se usa para autenticar esta aplicación con el proveedor de servicios | Cierto |
Valor predeterminado [EN DESUSO]
Aplicable: Todas las regiones
Esta opción solo es para conexiones anteriores sin un tipo de autenticación explícito y solo se proporciona para la compatibilidad con versiones anteriores.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Instancia | cuerda / cadena | Nombre de la instancia de para service-now.com o dirección URL personalizada para la cuenta migrada | Cierto |
| Nombre de usuario | cuerda / cadena | Nombre de usuario de esta instancia | Cierto |
| Contraseña | securestring | La contraseña de esta cuenta | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 600 | 60 segundos |
Acciones
| Actualizar registro |
Actualiza un registro para un tipo de objeto de ServiceNow, como "Incidentes". |
| Carga de datos adjuntos de varios elementos (versión preliminar) |
Cargar datos adjuntos desde un formulario de varias partes |
| Cargar un archivo binario como datos adjuntos (versión preliminar) |
Carga un archivo binario como datos adjuntos en un registro especificado |
| Crear registro |
Cree un registro en una tabla de ServiceNow. |
| Elemento de pedido |
Ordena o compra un artículo de catálogo específico. |
| Eliminar datos adjuntos (versión preliminar) |
Eliminar datos adjuntos |
| Eliminar registro |
Elimina un registro para un tipo de objeto de ServiceNow, como "Incidentes". |
| Enumerar registros |
Obtiene registros de un tipo de objeto de ServiceNow determinado, como "Incidentes". |
| Obtener artículos de conocimientos |
Devuelve una lista de artículos de knowledge base (KB) que se pueden buscar y filtrar. |
| Obtener categorías de catálogo |
Recupera la lista de categorías de un catálogo específico. |
| Obtener catálogos |
Recupera una lista de catálogos |
| Obtener elemento de catálogo |
Recuperar un elemento de catálogo específico. |
| Obtener elementos de catálogo |
Recupera una lista de elementos de catálogo basados en los parámetros especificados, como un texto de búsqueda o un catálogo. |
| Obtener metadatos de datos adjuntos (versión preliminar) |
Recuperación de metadatos para datos adjuntos |
| Obtener registro |
Obtiene un registro para un tipo de objeto de ServiceNow, como "Incidentes". |
| Obtener tipos de registro |
Enumera los tipos de registro disponibles |
| Recuperación de metadatos adjuntos (versión preliminar) |
Recuperación de metadatos de datos adjuntos |
| Recuperar contenido adjunto (versión preliminar) |
Recuperar contenido adjunto |
Actualizar registro
Actualiza un registro para un tipo de objeto de ServiceNow, como "Incidentes".
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
tableType | True | string |
Tipo de registro que se va a enumerar |
|
Identificador del sistema
|
sysid | True | string |
Identificador del sistema para el registro. |
|
body
|
body | True | dynamic | |
|
Mostrar referencias del sistema
|
sysparm_display_value | boolean |
Determina si se deben incluir referencias del sistema. |
|
|
Excluir vínculos de referencia
|
sysparm_exclude_reference_link | boolean |
Determina si se deben excluir vínculos de referencia. |
|
|
Fields
|
sysparm_fields | string |
Lista separada por comas de campos que se van a devolver. Ejemplo: nombre, correo electrónico, teléfono |
Devoluciones
Carga de datos adjuntos de varios elementos (versión preliminar)
Cargar datos adjuntos desde un formulario de varias partes
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Contenido adjunto
|
attachment_content | True | file |
Datos adjuntos para cargar |
|
Nombre de tabla
|
table_name | True | string |
Nombre de la tabla a la que desea adjuntar el archivo. |
|
Id. de tabla
|
table_sys_id | True | string |
Sys_id del registro de la tabla especificada a la que desea adjuntar el archivo |
Devoluciones
Cargar un archivo binario como datos adjuntos (versión preliminar)
Carga un archivo binario como datos adjuntos en un registro especificado
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de tabla
|
table_name | True | string |
Nombre de la tabla a la que desea adjuntar el archivo |
|
Identificador de sys
|
table_sys_id | True | string |
Sys_id del registro de la tabla especificada a la que desea adjuntar el archivo |
|
Nombre de archivo
|
file_name | True | string |
Nombre para asignar los datos adjuntos |
|
Archivo
|
file | True | binary |
Archivo binario que se va a adjuntar al registro especificado |
Devoluciones
Crear registro
Cree un registro en una tabla de ServiceNow.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
tableType | True | string |
Tipo de registro que se va a enumerar |
|
body
|
body | True | dynamic | |
|
Mostrar referencias del sistema
|
sysparm_display_value | boolean |
Determina si se deben incluir referencias del sistema. |
|
|
Excluir vínculos de referencia
|
sysparm_exclude_reference_link | boolean |
Determina si se deben excluir vínculos de referencia. |
|
|
Fields
|
sysparm_fields | string |
Lista separada por comas de campos que se van a devolver. Ejemplo: nombre, correo electrónico, teléfono |
Devoluciones
Elemento de pedido
Ordena o compra un artículo de catálogo específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de elemento
|
sys_id | True | string |
El sys_id del elemento de catálogo que se va a ordenar |
|
Cuerpo del elemento de pedido
|
body | True | dynamic |
Cuerpo de la solicitud de elemento de pedido. Contiene la cantidad, el usuario solicitado para y cualquier variable adicional que requiera el elemento de catálogo. |
Devoluciones
- Body
- OrderItemResponse
Eliminar datos adjuntos (versión preliminar)
Eliminar datos adjuntos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de sys
|
sys_id | True | string |
Sys_id de los datos adjuntos que se van a eliminar |
Eliminar registro
Elimina un registro para un tipo de objeto de ServiceNow, como "Incidentes".
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
tableType | True | string |
Tipo de registro que se va a enumerar |
|
Identificador del sistema
|
sysid | True | string |
Identificador del sistema para el registro. |
Enumerar registros
Obtiene registros de un tipo de objeto de ServiceNow determinado, como "Incidentes".
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
tableType | True | string |
Tipo de registro que se va a enumerar |
|
Mostrar referencias del sistema
|
sysparm_display_value | boolean |
Determina si se deben incluir referencias del sistema. |
|
|
Excluir vínculos de referencia
|
sysparm_exclude_reference_link | boolean |
Determina si se deben excluir vínculos de referencia. |
|
|
Query
|
sysparm_query | string |
Consulta codificada que se usa para filtrar el conjunto de resultados. Ejemplo: active=true^ORDERBYnumber^ORDERBYDESCcategory |
|
|
Limit
|
sysparm_limit | integer |
Límite que se aplicará en la paginación. El valor predeterminado es 10000. |
|
|
Desplazar
|
sysparm_offset | integer |
Número de registros que se van a excluir de la consulta. |
|
|
Fields
|
sysparm_fields | string |
Lista separada por comas de campos que se van a devolver. Ejemplo: nombre, correo electrónico, teléfono |
Devoluciones
Obtener artículos de conocimientos
Devuelve una lista de artículos de knowledge base (KB) que se pueden buscar y filtrar.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Fields
|
fields | string |
Lista separada por comas de campos de la tabla De conocimiento. |
|
|
Limit
|
limit | integer |
Número máximo de registros que se van a devolver. |
|
|
Query
|
query | True | string |
Texto que se va a buscar. |
|
Filter
|
filter | string |
Consulta codificada que se va a usar para filtrar el conjunto de resultados. |
|
|
Kb
|
kb | string |
Lista separada por comas de sys_ids de la base de conocimiento. |
Devoluciones
- Body
- GetArticlesResponse
Obtener categorías de catálogo
Recupera la lista de categorías de un catálogo específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de catálogo
|
catalogId | True | string |
Identificador del catálogo para el que se van a recuperar categorías |
|
Limit
|
sysparm_limit | integer |
Número de categorías de catálogo que se van a recuperar |
|
|
Desplazar
|
sysparm_offset | integer |
Desplazamiento de la consulta |
Devoluciones
Obtener catálogos
Recupera una lista de catálogos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
sysparm_limit | integer |
Número de catálogos que se van a recuperar |
|
|
Buscar texto
|
sysparm_text | string |
Buscar texto para filtrar catálogos por nombre o descripción |
Devoluciones
- Body
- GetCatalogsResponse
Obtener elemento de catálogo
Recuperar un elemento de catálogo específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de elemento
|
sys_id | True | string |
El sys_id del elemento de catálogo que se va a recuperar |
Devoluciones
Obtener elementos de catálogo
Recupera una lista de elementos de catálogo basados en los parámetros especificados, como un texto de búsqueda o un catálogo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Categoría
|
sysparm_category | string |
Identificador de categoría por el que se van a filtrar los elementos. Si no se especifica, se devuelven todos los elementos. |
|
|
Limit
|
sysparm_limit | True | integer |
Número de elementos de catálogo que se van a recuperar |
|
Buscar texto
|
sysparm_text | string |
Buscar texto para filtrar elementos por |
|
|
Catalog
|
sysparm_catalog | string |
Identificador de catálogo por el que se van a filtrar los elementos. Si no se especifica, se devuelven elementos de todos los catálogos. |
Devoluciones
Obtener metadatos de datos adjuntos (versión preliminar)
Recuperación de metadatos para datos adjuntos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
sysparm_limit | string |
Límite que se aplicará en la paginación. Nota: Los valores de sysparm_limit inusualmente grandes pueden afectar al rendimiento del sistema. Valor predeterminado: 1000 |
|
|
Desplazar
|
sysparm_offset | string |
Número de registros que se van a excluir de la consulta. Use este parámetro para obtener más registros de los especificados en sysparm_limit. Por ejemplo, si sysparm_limit está establecido en 500, pero hay registros adicionales que desea consultar, puede especificar un valor de sysparm_offset de 500 para obtener el segundo conjunto de registros. Valor predeterminado: 0 |
|
|
Query
|
sysparm_query | string |
Consulta codificada. Las consultas de la API de datos adjuntos son relativas a la tabla Attachments [sys_attachment]. Por ejemplo: (sysparm_query=file_name=attachment.doc) |
Obtener registro
Obtiene un registro para un tipo de objeto de ServiceNow, como "Incidentes".
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
tableType | True | string |
Tipo de registro que se va a enumerar |
|
Identificador del sistema
|
sysid | True | string |
Identificador del sistema para el registro. |
|
Mostrar referencias del sistema
|
sysparm_display_value | boolean |
Determina si se deben incluir referencias del sistema. |
|
|
Excluir vínculos de referencia
|
sysparm_exclude_reference_link | boolean |
Determina si se deben excluir vínculos de referencia. |
|
|
Fields
|
sysparm_fields | string |
Lista separada por comas de campos que se van a devolver. Ejemplo: nombre, correo electrónico, teléfono |
Devoluciones
Obtener tipos de registro
Recuperación de metadatos adjuntos (versión preliminar)
Recuperación de metadatos de datos adjuntos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
sys_id | True | string |
Sys_id de los datos adjuntos para recuperar metadatos |
Recuperar contenido adjunto (versión preliminar)
Recuperar contenido adjunto
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de sys
|
sys_id | True | string |
Sys_id de los datos adjuntos para los que recuperar contenido |
Definiciones
UploadAttachmentResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
average_image_color
|
result.average_image_color | string |
Si los datos adjuntos son una imagen, la suma de todos los colores. |
|
comprimido
|
result.compressed | string |
Marca que indica si el archivo adjunto se ha comprimido. |
|
content_type
|
result.content_type | string |
Tipo de contenido del archivo adjunto asociado, como imagen o jpeg o application/x-shockwave-flash. |
|
created_by_name
|
result.created_by_name | string |
Nombre completo de la entidad que creó originalmente el archivo adjunto. |
|
download_link
|
result.download_link | string |
Descargue la dirección URL de los datos adjuntos en la instancia de ServiceNow. |
|
nombre_de_archivo
|
result.file_name | string |
Nombre de archivo de los datos adjuntos. |
|
image_height
|
result.image_height | string |
Si es un archivo de imagen, el alto de la imagen. Unidad: píxeles |
|
image_width
|
result.image_width | string |
Si es un archivo de imagen, el ancho de la imagen. Unidad: píxeles |
|
size_bytes
|
result.size_bytes | string |
Tamaño de los datos adjuntos. Unidad: bytes |
|
size_compressed
|
result.size_compressed | string |
Tamaño de los datos adjuntos. Unidad: bytes |
|
sys_created_by
|
result.sys_created_by | string |
Entidad que creó originalmente el archivo adjunto. |
|
sys_created_on
|
result.sys_created_on | string |
Fecha y hora en que el archivo adjunto se guardó inicialmente en la instancia. |
|
sys_id
|
result.sys_id | string |
Sys_id del archivo adjunto. |
|
sys_mod_count
|
result.sys_mod_count | string |
Número de veces que se ha modificado el archivo adjunto (cargado en la instancia). |
|
sys_tags
|
result.sys_tags | string |
Cualquier etiqueta del sistema asociada al archivo adjunto. |
|
sys_updated_by
|
result.sys_updated_by | string |
Cualquier etiqueta del sistema asociada al archivo adjunto. |
|
sys_updated_on
|
result.sys_updated_on | string |
Fecha y hora en que se actualizó por última vez el archivo adjunto. |
|
table_name
|
result.table_name | string |
Nombre de la tabla a la que están asociados los datos adjuntos. |
|
table_sys_id
|
result.table_sys_id | string |
Sys_id de la tabla asociada a los datos adjuntos. |
|
updated_by_name
|
result.updated_by_name | string |
Nombre completo de la entidad que actualizó el archivo adjunto por última vez. |
GetTypesResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
resultado
|
result | array of object |
Conjunto de resultados de todos los tipos de registro para la instancia actual. |
|
Nombre para mostrar
|
result.label | string |
Nombre para mostrar del tipo de registro. |
|
Importancia
|
result.value | string |
Valor del tipo de registro. |
GetCatalogsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
resultado
|
result | array of object | |
|
title
|
result.title | string | |
|
sys_id
|
result.sys_id | string | |
|
has_categories
|
result.has_categories | boolean | |
|
has_items
|
result.has_items | boolean | |
|
descripción
|
result.description | string | |
|
desktop_image
|
result.desktop_image | string |
GetCatalogCategoriesResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
resultado
|
result | array of object | |
|
title
|
result.title | string | |
|
descripción
|
result.description | string | |
|
full_description
|
result.full_description | string | |
|
icono
|
result.icon | string | |
|
header_icon
|
result.header_icon | string | |
|
homepage_image
|
result.homepage_image | string | |
|
count
|
result.count | integer | |
|
Subcategorías
|
result.subcategories | array of object | |
|
sys_id
|
result.subcategories.sys_id | string | |
|
title
|
result.subcategories.title | string | |
|
sys_id
|
result.sys_id | string |
GetCatalogItemsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
resultado
|
result | array of object | |
|
short_description
|
result.short_description | string | |
|
kb_article
|
result.kb_article | string | |
|
icono
|
result.icon | string | |
|
descripción
|
result.description | string | |
|
availability
|
result.availability | string | |
|
mandatory_attachment
|
result.mandatory_attachment | boolean | |
|
request_method
|
result.request_method | string | |
|
type
|
result.type | string | |
|
visible_standalone
|
result.visible_standalone | boolean | |
|
local_currency
|
result.local_currency | string | |
|
sys_class_name
|
result.sys_class_name | string | |
|
sys_id
|
result.sys_id | string | |
|
content_type
|
result.content_type | string | |
|
precio
|
result.price | string | |
|
recurring_frequency
|
result.recurring_frequency | string | |
|
price_currency
|
result.price_currency | string | |
|
order
|
result.order | integer | |
|
make_item_non_conversational
|
result.make_item_non_conversational | boolean | |
|
owner
|
result.owner | string | |
|
show_price
|
result.show_price | boolean | |
|
recurring_price
|
result.recurring_price | string | |
|
show_quantity
|
result.show_quantity | boolean | |
|
imagen
|
result.picture | string | |
|
URL
|
result.url | string | |
|
recurring_price_currency
|
result.recurring_price_currency | string | |
|
localized_price
|
result.localized_price | string | |
|
catalogs
|
result.catalogs | array of object | |
|
sys_id
|
result.catalogs.sys_id | string | |
|
activo
|
result.catalogs.active | boolean | |
|
title
|
result.catalogs.title | string | |
|
nombre
|
result.name | string | |
|
localized_recurring_price
|
result.localized_recurring_price | string | |
|
show_wishlist
|
result.show_wishlist | boolean | |
|
sys_id
|
result.category.sys_id | string | |
|
title
|
result.category.title | string | |
|
turn_off_nowassist_conversation
|
result.turn_off_nowassist_conversation | boolean | |
|
show_delivery_time
|
result.show_delivery_time | boolean |
GetCatalogItemResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
short_description
|
result.short_description | string |
short_description |
|
kb_article
|
result.kb_article | string |
kb_article |
|
icono
|
result.icon | string |
icono |
|
descripción
|
result.description | string |
descripción |
|
availability
|
result.availability | string |
availability |
|
mandatory_attachment
|
result.mandatory_attachment | boolean |
mandatory_attachment |
|
request_method
|
result.request_method | string |
request_method |
|
type
|
result.type | string |
type |
|
visible_standalone
|
result.visible_standalone | boolean |
visible_standalone |
|
sys_class_name
|
result.sys_class_name | string |
sys_class_name |
|
sys_id
|
result.sys_id | string |
sys_id |
|
content_type
|
result.content_type | string |
content_type |
|
order
|
result.order | integer |
order |
|
make_item_non_conversational
|
result.make_item_non_conversational | boolean |
make_item_non_conversational |
|
owner
|
result.owner | string |
owner |
|
show_price
|
result.show_price | boolean |
show_price |
|
show_quantity
|
result.show_quantity | boolean |
show_quantity |
|
imagen
|
result.picture | string |
imagen |
|
URL
|
result.url | string |
URL |
|
catalogs
|
result.catalogs | array of object |
catalogs |
|
sys_id
|
result.catalogs.sys_id | string |
sys_id |
|
activo
|
result.catalogs.active | boolean |
activo |
|
title
|
result.catalogs.title | string |
title |
|
nombre
|
result.name | string |
nombre |
|
show_wishlist
|
result.show_wishlist | boolean |
show_wishlist |
|
sys_id
|
result.category.sys_id | string |
sys_id |
|
title
|
result.category.title | string |
title |
|
turn_off_nowassist_conversation
|
result.turn_off_nowassist_conversation | boolean |
turn_off_nowassist_conversation |
|
show_delivery_time
|
result.show_delivery_time | boolean |
show_delivery_time |
|
categories
|
result.categories | array of object |
categories |
|
sys_id
|
result.categories.sys_id | string |
sys_id |
|
activo
|
result.categories.active | boolean |
activo |
|
sys_id
|
result.categories.category.sys_id | string |
sys_id |
|
activo
|
result.categories.category.active | boolean |
activo |
|
title
|
result.categories.category.title | string |
title |
|
title
|
result.categories.title | string |
title |
|
variables
|
result.variables | array of object |
variables |
|
ui_policy
|
result.ui_policy | array of |
ui_policy |
|
onChange
|
result.client_script.onChange | array of |
onChange |
|
onSubmit
|
result.client_script.onSubmit | array of |
onSubmit |
|
onLoad
|
result.client_script.onLoad | array of |
onLoad |
|
data_lookup
|
result.data_lookup | array of |
data_lookup |
|
variablesSchema
|
result.variablesSchema | object |
OrderItemResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
sys_id
|
result.sys_id | string |
sys_id |
|
number
|
result.number | string |
number |
|
request_number
|
result.request_number | string |
request_number |
|
identificador_de_solicitud
|
result.request_id | string |
identificador_de_solicitud |
|
table
|
result.table | string |
table |
GetArticlesResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
meta.count | integer |
Número de artículos de KB disponibles |
|
Fin
|
meta.end | integer |
Índice final del conjunto de resultados |
|
Fields
|
meta.fields | string |
Campos del artículo |
|
Filter
|
meta.filter | string |
Filtro usado para adquirir los datos |
|
Kb
|
meta.kb | string |
Lista de sys_ids de artículos de knowledge base |
|
Language
|
meta.language | string |
Lista de idiomas separados por comas de los artículos de KB solicitados |
|
Query
|
meta.query | string |
Consulta de solicitud especificada |
|
Comenzar
|
meta.start | string |
Índice inicial del conjunto de resultados |
|
Estado
|
meta.status.code | string |
Estado de la llamada |
|
Kb
|
meta.ts_query_id | string |
Lista de idiomas separados por comas de los artículos de KB solicitados |
|
artículos
|
articles | array of object | |
|
Mostrar valor
|
articles.fields.display_value | string |
Mostrar el valor del campo solicitado |
|
Etiqueta
|
articles.fields.label | string |
Etiqueta que representa el campo solicitado |
|
Nombre
|
articles.fields.name | string |
Nombre del campo solicitado |
|
Tipo
|
articles.fields.type | string |
Tipo de datos del campo solicitado |
|
Importancia
|
articles.fields.value | string |
Valor del campo solicitado |
|
Link
|
articles.Link | string |
Vínculo al artículo |
|
id
|
articles.id | string |
Artículo de conocimientos sys_id de la tabla Knowledge [kb_knowledge] |
|
Number
|
articles.number | string |
Artículo de conocimientos sys_id de la tabla Knowledge [kb_knowledge] |
|
Rango
|
articles.rank | float |
Clasificación de búsqueda del artículo específico de esta búsqueda |
|
Puntuación
|
articles.score | float |
Puntuación de relevancia, resultados ordenados en orden descendente por puntuación |
|
Fragmento
|
articles.snippet | string |
Texto que muestra una pequeña parte del artículo de conocimiento |
|
Title
|
articles.title | string |
Descripción breve o título del artículo de conocimiento |