Skip to main content

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 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.

  • 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 de la API 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), "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 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): obligatorio. Elige el archivo que deseas cargar en el sistema como una nueva versión.

  • name  (cadena): obligatorio. Ingresa el nombre del flujo de trabajo.

  • 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 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.

  • 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.

  • 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.

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.

  • dirección  (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'

Create a New Job

To create a new job and add it to the queue, use the POST /v3/workflows/{workflowId}/jobs endpoint.

Parameters

  • workflowId (string): Required. Enter a workflow ID you want to schedule.

  • contract (body): To create a new job, specify the following parameters:

    • workerTag (string): Optional. Specify the assigned worker. If not specified, the value will be "none".

    • credentialId (string): Optional. Specify the credentialId for this workflow.

    • questions (string): Optional. For an analytic app, specify the questions and answers to run the workflow.

    • priority (string): Optional. Specify the priority for running the schedule. Choose from the following options: "Low", "Medium", "High", and "Critical". If not specified, the default value will be ‘Low’.

REQUEST EXAMPLE: cURL

Example of a request to create a job:

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"}

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:

Ejemplos de solicitudes de Postman

GET /v3/workflows/{workflowId}

Use GET /v3/workflows/{workflowId} endpoint.

Para obtener más información sobre las solicitudes de Postman, visita la página de ayuda Cómo usar Postman .