Puntos de conexión de flujos de trabajo
Parámetros y puntos de conexión de los flujos de trabajo
Para obtener más información sobre las relaciones entre objetos y cómo utilizarlas en la API, ve a la sección Relaciones entre objetos .
Para obtener más información sobre flujos de trabajo, visita la página de ayuda Flujos de trabajo .
Cargar un nuevo flujo de trabajo
Para cargar un nuevo flujo de trabajo, utiliza el punto de conexión
POST {baseURL}/v3/workflows
.
Parámetros
file (archivo): obligatorio. Selecciona el archivo específico que deseas cargar en el sistema. El tipo de medio debe ser un archivo YXZP.
name (cadena): obligatorio. Ingresa un nombre de flujo de trabajo. Este es el nombre del flujo de trabajo que se mostrará en la interfaz de usuario de Server.
ownerId (cadena): obligatorio. Ingresa el Id. del propietario.
workerTag (cadena): opcional. Especifica la etiqueta de trabajador definida en los trabajadores para ayudar a asignar tareas a determinados nodos de trabajadores. Para obtener más información, visita la página de ayuda Trabajador .
districtTags (cadena): opcional. Enviar como matriz formateada JSON, por ejemplo, ["id1", "id2"]. Utiliza los distritos para agrupar flujos de trabajo públicos y compartidos, de modo que los usuarios puedan encontrarlos fácilmente. Para obtener más información, visita la página de ayuda Distritos .
comments (cadena): opcional. Ingresa tus comentarios.
isPublic (booleano): obligatorio. Selecciona “true” (verdadero) para que el flujo de trabajo esté disponible públicamente. Selecciona “false” (falso) para que el flujo de trabajo sea privado y no esté disponible públicamente.
isReadyForMigration (booleano): obligatorio. Selecciona si el flujo de trabajo está listo para migrar. Para obtener más información sobre la migración del entorno de un Alteryx Server a otro, consulta la página de ayuda Activar flujos de trabajo para la migración .
sourceAppId (cadena): opcional. Establece el Id. de la aplicación de origen de un flujo de trabajo. Se puede utilizar como la referencia “sourceId” para el punto de conexión
POST admin/v1/workflows. Proporcionar un sourceAppId preexistente dará como resultado una solicitud no válida.othersMayDownload (booleano): obligatorio. Especifica si otros usuarios pueden descargar este flujo de trabajo.
othersCanExecute (booleano): obligatorio. Especifica si otros usuarios pueden ejecutar este flujo de trabajo.
executionMode (cadena): obligatorio. Los valores aceptados son "Safe" (seguro), "SemiSafe" (semiseguro) y "Standard" (estándar). Para obtener más información sobre el modo de ejecución, consulta la página de ayuda Modos de ejecución Seguro y Semiseguro: herramientas, eventos y conectores de datos bloqueados .
hasPrivateDataExemption (booleano): opcional. Proporciona una exención para permitir la ejecución de un flujo de trabajo con datos privados. Selecciona “true” (verdadero) para permitir una exención o “false” (falso) para denegar una exención. Para obtener más información, visita la página de ayuda Opciones de flujo de trabajo en Administrador .
workflowCredentialType (cadena): obligatorio. Los valores aceptados son "Default" (predeterminado), "Required" (obligatorio), and "Specific" (específico).
credentialId (cadena): opcional. Especifica el credentialId para este flujo de trabajo.
collectionIds (cadena): opcional. Ingresa los collectionId(s) a los que se debe agregar este flujo de trabajo. Enviar como matriz formateada JSON, por ejemplo, ["id1", "id2"].
Cargar una nueva versión a un flujo de trabajo existente
Para cargar una nueva versión a un flujo de trabajo existente, utiliza el punto de conexión
POST {baseURL}/v3/workflows/{workflowId}/versions
.
Parámetros
workflowId (cadena): obligatorio. Ingresa el Id. de flujo de trabajo para el que deseas cargar una nueva versión.
file (archivo): obligatorio. Selecciona el archivo específico que deseas cargar en el sistema como una nueva versión. El tipo de medio debe ser un archivo YXZP.
name (cadena): obligatorio. Ingresa el nombre del flujo de trabajo. Este es el nombre del flujo de trabajo que se mostrará en la interfaz de usuario de Server.
ownerId (cadena): obligatorio. Ingresa el Id. del propietario.
othersMayDownload (booleano): obligatorio. El valor predeterminado es “true” (verdadero).
othersCanExecute (booleano): obligatorio. El valor predeterminado es “true” (verdadero).
executionMode (cadena): obligatorio. Los valores aceptados son "Safe" (seguro), "SemiSafe" (semiseguro) y "Standard" (estándar). Para obtener más información sobre el modo de ejecución, consulta la página de ayuda Modos de ejecución Seguro y Semiseguro: herramientas, eventos y conectores de datos bloqueados .
hasPrivateDataExemption (booleano): opcional. Proporciona una exención para permitir la ejecución de un flujo de trabajo con datos privados. Selecciona “true” (verdadero) para permitir una exención o “false” (falso) para denegar una exención. Para obtener más información, visita la página de ayuda Opciones de flujo de trabajo en Administrador .
comments (cadena): opcional. Ingresa tus comentarios.
makePublished (booleano): obligatorio. El valor predeterminado es “true” (verdadero). El parámetro makePublished es una forma de controlar si la nueva versión de un flujo de trabajo que se inserta en Alteryx Server debe ser la versión publicada o no. Puedes establecer el valor a “false” (falso) cuando insertas el flujo de trabajo a Server y, luego, solo tu podrás ejecutarlo.
workflowCredentialType (cadena): obligatorio. Ingresa el tipo de credencial que se va a utilizar para este flujo de trabajo. Los valores aceptados son "Default" (predeterminado), "Required" (obligatorio), and "Specific" (específico).
credentialId (cadena): opcional. Especifica el credentialId para este flujo de trabajo. Para obtener más información sobre los puntos de conexión de credenciales, ve a Puntos de conexión de credenciales .
Recuperar todos los flujos de trabajo
Para obtener información sobre todos los registros de flujo de trabajo, utiliza el punto de conexión
GET {baseURL}/v3/workflows/
.
Parámetros
view (cadena): opcional. Selecciona cómo deseas que se muestre la información del flujo de trabajo. Se puede dejar sin un valor. Puedes seleccionar entre los siguientes valores: “Default" (predeterminado) y "Full" (completo). Si este parámetro se define como “Default" (predeterminado), entonces se devolverá un objeto de vista reducida. Cuando no se especifica, se utiliza el valor “Default" (predeterminado).
name (cadena): opcional. Ingresa el nombre del flujo de trabajo en caso de que desees filtrar los flujos de trabajo por nombre. Este es el nombre del flujo de trabajo que se mostrará en la interfaz de usuario de Server.
ownerId (cadena): opcional. Ingresa el Id. del propietario en caso de que desees filtrar los flujos de trabajo por su propietario.
createdAfter (cadena): opcional. Ingresa la fecha y la hora después de la cual se creó el flujo de trabajo. Ingresa la fecha y la hora en formato ISO8601.
createdBefore (cadena): opcional. Ingresa la fecha y la hora antes de la cual se creó el flujo de trabajo. Ingresa la fecha y la hora en formato ISO8601.
Ejemplo de solicitud: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Recuperar un registro de flujo de trabajo específico
Para obtener información sobre un flujo de trabajo específico, utiliza el punto de conexión
GET {baseURL}/v3/workflows/{workflowId}
.
Parámetros
workflowId (cadena): obligatorio. Ingresa el Id. de flujo de trabajo para obtener información sobre este.
Ejemplo de solicitud: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Actualizar un flujo de trabajo existente
Para cambiar la información acerca de un flujo de trabajo existente, utiliza el punto de conexión
PUT {baseURL}/v3/workflows/{workflowId}
.
Nota
Para cambiar el ownerId, el nuevo propietario debe estar en la misma suscripción que el propietario actual.
Parámetros
workflowId (cadena): obligatorio. Ingresa el Id. del flujo de trabajo que deseas actualizar.
updateWorkflowContract (cuerpo): obligatorio. Ingresa la información del flujo de trabajo que quieres actualizar.
name (cadena): obligatorio. Ingresa el nombre del flujo de trabajo. Este es el nombre del flujo de trabajo que se mostrará en la interfaz de usuario de Server.
versionId (cadena): obligatorio. Ingresa el Id. de la versión.
makePublished (booleano): opcional. Cuando no se especifica, el valor permanece igual que antes. El parámetro makePublished es una forma de controlar si la nueva versión de un flujo de trabajo que se inserta en Alteryx Server debe ser la versión publicada o no. Puedes establecer el valor a “false” (falso) cuando insertas el flujo de trabajo a Server y, luego, solo tu podrás ejecutarlo.
ownerId (cadena): obligatorio. Ingresa el Id. del propietario.
workerTag (cadena): obligatorio. Si no hay workerTag, utiliza "" en su lugar.
districtTags (cadena): obligatorio. Ingresa las etiquetas de distritos. Utiliza los distritos para agrupar flujos de trabajo públicos y compartidos, de modo que los usuarios puedan encontrarlos fácilmente. Para obtener más información, visita la página de ayuda Distritos .
comments (cadena): obligatorio. Ingresa tus comentarios.
isPublic (booleano): opcional. Cuando no se especifica, el valor permanece igual que antes.
isReadyForMigration (booleano): opcional. Cuando no se especifica, el valor permanece igual que antes.
othersMayDownload (booleano): opcional. Cuando no se especifica, el valor permanece igual que antes. Cuando está definido en “false” (falso) para un flujo de trabajo público, el flujo de trabajo será inutilizable.
othersCanExecute (booleano): opcional. Cuando no se especifica, el valor permanece igual que antes. Cuando está definido en “false” (falso) para un flujo de trabajo público, el flujo de trabajo será inutilizable.
executionMode (cadena): opcional. Los valores aceptados son "Safe" (seguro), "SemiSafe" (semiseguro), "Standard" (estándar). Para obtener más información sobre el modo de ejecución, consulta la página de ayuda Modos de ejecución Seguro y Semiseguro: herramientas, eventos y conectores de datos bloqueados .
hasPrivateDataExemption (booleano): opcional. Proporciona una exención para permitir la ejecución de un flujo de trabajo con datos privados. Selecciona “true” (verdadero) para permitir una exención o “false” (falso) para denegar una exención. Cuando no se especifica, el valor permanece igual que antes. Para obtener más información, visita la página de ayuda Opciones de flujo de trabajo en Administrador .
Descargar un paquete de flujo de trabajo
Para descargar un paquete de flujo de trabajo, utiliza el punto de conexión
GET {baseURL}/v3/workflows/{workflowId}/package
.
Parámetros
workflowId (cadena): obligatorio. Ingresa el Id. de flujo de trabajo para el que deseas descargar el paquete.
versionId (cadena): opcional. Ingresa el Id. de la versión específica de un flujo de trabajo. Si no se proporciona ninguna versión, se descarga la versión publicada.
Nota
Si el versionID es de dos dígitos, podría alcanzar el límite de tamaño, y tú podrías recibir un error "414 - URI demasiado largo". En este caso, analiza la cadena JSON versionID y recórtala solo a la versión más reciente. Esto mantendrá la longitud del campo bajo control.
Ejemplo de solicitud: cURL
curl -X GET --header 'Accept: application/octet-stream' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a4be7dc6e24bb8ff0/package'
Recuperar información de preguntas para un flujo de trabajo
Para obtener información de preguntas para un flujo de trabajo, utiliza el punto de conexión
GET {baseURL}/v3/workflows/{workflowId}/questions
.
Parámetros
workflowId (cadena): obligatorio. Ingresa el Id. de flujo de trabajo del que deseas recuperar la información.
versionId (cadena): opcional. Ingresa el Id. de la versión específica de un flujo de trabajo. Si no se proporciona ninguna versión, se utiliza la versión publicada.
Ejemplo de solicitud: cURL
curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a4bc6e24b78d0b8ff0/questions'
Obtener información sobre tareas para un flujo de trabajo específico
Para obtener información sobre las tareas de un flujo de trabajo específico, utiliza el punto de conexión
GET {baseURL}/v3/workflows/{workflowId}/jobs
.
Parámetros
workflowId (cadena): obligatorio. Ingresa el Id. de flujo de trabajo del que deseas recuperar la información.
sortField (cadena): opcional.
direction (cadena): opcional.
offset (cadena): opcional.
limit (cadena): opcional.
Ejemplo de solicitud: cURL
curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a4be6e24b78d0b8ff0/jobs'
Eliminar un flujo de trabajo
Para eliminar un flujo de trabajo específico, utiliza el punto de conexión
DELETE {baseURL}/v3/workflows/{workflowId}
.
Parámetros
workflowId (cadena): obligatorio. Ingresa el Id. de flujo de trabajo que deseas eliminar.
force (booleano): opcional. Si no se selecciona, el valor predeterminado es “false” (falso). Si se programa un flujo de trabajo, el parámetro establecido en “true” (verdadero) eliminará todas las programaciones antes de suprimirlo.
Ejemplo de solicitud: cURL
curl -X DELETE --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a752fdc6e278d0ba40b'
Crear una nueva tarea
Para crear una nueva tarea y agregarla a la cola, usa el punto de conexión
POST /v3/workflows/{workflowId}/jobs
.
Parámetros
workflowId (cadena): obligatorio. Ingresa un Id. de flujo de trabajo que deseas programar.
contract (cuerpo): para crear una nueva tarea, especifica los siguientes parámetros:
workerTag (cadena): opcional. Especifica el trabajador asignado. Si no se especifica, el valor será “Ninguno”.
credentialId (cadena): opcional. Especifica el credentialId para este flujo de trabajo.
questions (cadena): opcional. Para una aplicación analítica, especifica las preguntas y respuestas para ejecutar el flujo de trabajo.
priority (cadena): opcional. Especifica la prioridad para ejecutar la programación. Elige entre las siguientes opciones: “Low” (bajo), “Medium” (medio), “High” (alto) y “Critical” (crítico). Si no se especifica, el valor predeterminado será “Low” (bajo).
EJEMPLO DE SOLICITUD: cURL
Ejemplo de una solicitud para crear una tarea:
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' -d '{ \ "workerTag": "", \ "credentialId": "", \ "questions": [], \ "priority": "Low" \ }' 'http://localhost/webapi/v3/workflows/651faa8bde3e5381fd0dac29/jobs'{ "workerTag": "tag1", "credentialId": "652e6f90ea174cd34f6779d2", "questions": [ { "name": "Drop_Down", "value": "true" } ], "priority": "Low"}
Transfer Workflows and Schedules to a Specified Owner
To transfer a specific workflow to a specific owner, together with schedules if desired, use the PUT {baseURL}/v3/workflows/{workflowId}/transfer endpoint.
Nota
Only Curators can use this API endpoint.
If any of the workflows require DCM connections, Server connections, or specific run as credentials to run, these items need to be updated before the workflow can run.
If users are not in the same studio and when a workflow is transferred to the new studio, all other users in the new owner's studio will also receive access to the workflow, and all users from the old studio will lose access.
Workflows can only be transferred to a user with the Artisan or Curator role.
If transferring schedules, the new owner must have access to the scheduled workflow, otherwise you won’t be able to transfer that workflow to the new owner.
If transferring schedules, the new owner must have permission to schedule workflows.
If the user is deleted, it returns a list of schedule Ids that will be broken or disabled after transfer.
Parameters
workflowId (string): Required. Specify the Id of the workflow to transfer.
contract (body): Required. Specify the following information:
ownerId (string): Specify the Id of the new owner.
transferSchedules (Boolean): Specify whether the schedules should be transferred to a new owner together with the workflow. Only the schedules owned by the current workflow owner will be transferred to the new owner.
Request Example: cURL
curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ "ownerId": "63d17f6cb049da66d0afd4e2", \ "transferSchedules": true \ }' 'http://localhost/webapi/v3/workflows/7917969784f84bd09442f66996ecb8f3/transfer'
Relaciones entre objetos
Si vas a cargar un flujo de trabajo, puedes utilizar los objetos creados de la siguiente manera:
Objeto creado: “ workflowId ” (por ejemplo, “id”: “7917969784f84bd09442f66996ecb8f3”)
Puedes usarlo como:
workflowId si vas a agregar flujos de trabajo a una colección .
appId si estás eliminando flujos de trabajo de una colección .
workflowId si vas a buscar un flujo de trabajo específico .
workflowId si vas a eliminar un flujo de trabajo específico .
workflowId si vas a actualizar un flujo de trabajo existente .
workflowId si vas a cargar una nueva versión de un flujo de trabajo existente .
workflowId si vas a buscar una programación .
workflowId si vas a crear una programación .
workflowId si vas a descargar un paquete de flujo de trabajo .
workflowId si deseas recuperar información de preguntas para un flujo de trabajo .
workflowId si deseas obtener información sobre las tareas de un flujo de trabajo.
Ejemplos de solicitudes de Postman
GET /v3/workflows/{workflowId}
Para obtener más información sobre las solicitudes de Postman, visita la página de ayuda Cómo usar Postman .