Puntos de conexión de flujos de trabajo
Puntos de conexión de los flujos de trabajo y parámetros
Cargar un nuevo flujo de trabajo
Cargar una nueva versión de un flujo de trabajo existente
Recuperar todos los flujos de trabajo
Recuperar un registro de flujo de trabajo específico
Actualizar un flujo de trabajo existente
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 acerca de los 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): obligatorio. Ingresa tus comentarios.
isPublic (booleano): obligatorio. Selecciona si el flujo de trabajo estará 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): obligatorio.
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), "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 Opciones de flujo de trabajo en administrador .
Cargar una nueva versión de un flujo de trabajo existente
Para cargar una nueva versión de 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): opcional. 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), "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 Opciones de flujo de trabajo en administrador .
comments (cadena): obligatorio. 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 en “false” (falso) cuando insertas el flujo de trabajo en Server y, luego, solo tu podrás ejecutarlo.
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 cargar una nueva versión 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 en “false” (falso) cuando insertas el flujo de trabajo en 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 Opciones de flujo de trabajo en administrador .
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 falso. Si se programa un flujo de trabajo, el parámetro establecido en “true” (verdadero) eliminará todas las programaciones antes de suprimirlo.
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 vas a quitar 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 .
Ejemplos de solicitudes de Postman
GET /v3/workflows/{workflowId}
![Use GET /v3/workflows/{workflowId} endpoint.](../../../../image/uuid-0f4fcce4-2727-8722-e734-53dd81a439b3.png)