Skip to main content

Puntos de conexión de flujos de trabajo

Puntos de conexión de los flujos de trabajo y parámetros

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

curl -X 'POST' \
  'http://localhost/webapi/v3/workflows' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@Workflow2.yxzp;type=application/yxzp' \
  -F 'name=Workflow2' \
  -F 'ownerId=66ebd0896e52ae73b4951072' \
  -F 'isPublic=true' \
  -F 'isReadyForMigration=true' \
  -F 'othersMayDownload=true' \
  -F 'othersCanExecute=false' \
  -F 'executionMode=Standard' \
  -F 'workflowCredentialType=Default'

  • 200: OK

    "string"

  • 400: BadRequest

  • 401: Unauthorized (sin autorización)

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.

curl -X 'POST' \
  'http://localhost/webapi/v3/workflows/66ebd18d6e52ae73b4951085/versions' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@Workflow3.yxzp;type=application/yxzp' \
  -F 'name=Workflow1_3' \
  -F 'ownerId=66ebd0896e52ae73b4951072' \
  -F 'othersMayDownload=true' \
  -F 'othersCanExecute=true' \
  -F 'executionMode=Standard' \
  -F 'makePublished=true' \
  -F 'workflowCredentialType=Default'

  • 200: OK

    {
  "id": "string",
  "sourceAppId": "string",
  "dateCreated": "2024-09-19T07:33:01.072Z",
  "runCount": 0,
  "versions": [
    {
      "versionId": "string",
      "versionNumber": 0,
      "dateCreated": "2024-09-19T07:33:01.072Z",
      "uploadSource": "Designer",
      "uploadDate": "2024-09-19T07:33:01.072Z",
      "packageWorkflowType": "App",
      "published": true,
      "comments": "string",
      "runDisabled": true,
      "executionMode": "Safe",
      "workflowCredentialType": "Default",
      "credentialId": "string",
      "hasPrivateDataExemption": true,
      "othersMayDownload": true,
      "othersCanViewHistory": true,
      "details": {
        "isAmp": true,
        "fileName": "string",
        "author": "string",
        "copyright": "string",
        "description": "string",
        "name": "string",
        "noOutputFilesMessage": "string",
        "outputMessage": "string",
        "url": "string",
        "urlText": "string"
      }
    }
  ],
  "name": "string",
  "ownerId": "string",
  "workerTag": "string",
  "districtTags": [
    "string"
  ],
  "comments": "string",
  "isPublic": true,
  "isReadyForMigration": true,
  "publishedVersionId": "string",
  "othersMayDownload": true,
  "othersCanViewHistory": true,
  "othersCanExecute": true,
  "executionMode": "Safe",
  "hasPrivateDataExemption": true
}

  • 401: BadRequest

  • 401: Unauthorized (sin autorización)

  • 404: Indica que el workflowId en la ruta no es válido.

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.

curl -X 'GET' \
  'http://localhost/webapi/v3/workflows' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

  • 200: OK

      {
    "id": "string",
    "sourceAppId": "string",
    "name": "string",
    "ownerId": "string",
    "dateCreated": "2024-08-15T11:14:56.965Z",
    "publishedVersionNumber": 0,
    "isAmp": true,
    "executionMode": "Safe"
  }
]

  • 400: BadRequest

  • 401: Unauthorized (sin autorización)

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

Nota

Los no administradores pueden usar el punto de conexión GET/v3/workflows/{workflowId} para los flujos de trabajo a los que tienen acceso. Anteriormente, este punto de conexión se limitaba solo a los administradores.

Parámetros

  • workflowId (cadena): obligatorio. Ingresa el Id. de flujo de trabajo para obtener información sobre este.

curl -X 'GET' \
  'http://localhost/webapi/v3/workflows/670ce5cef10214f22a6637a3' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

  • 200: OK

    {
  "id": "string",
  "sourceAppId": "string",
  "dateCreated": "2024-09-05T10:42:53.360Z",
  "runCount": 0,
  "versions": [
    {
      "versionId": "string",
      "versionNumber": 0,
      "dateCreated": "2024-09-05T10:42:53.360Z",
      "uploadSource": "Designer",
      "uploadDate": "2024-09-05T10:42:53.360Z",
      "packageWorkflowType": "App",
      "published": true,
      "comments": "string",
      "runDisabled": true,
      "executionMode": "Safe",
      "workflowCredentialType": "Default",
      "credentialId": "string",
      "hasPrivateDataExemption": true,
      "othersMayDownload": true,
      "othersCanViewHistory": true,
      "details": {
        "isAmp": true,
        "fileName": "string",
        "author": "string",
        "copyright": "string",
        "description": "string",
        "name": "string",
        "noOutputFilesMessage": "string",
        "outputMessage": "string",
        "url": "string",
        "urlText": "string"
      }
    }
  ],
  "name": "string",
  "ownerId": "string",
  "workerTag": "string",
  "districtTags": [
    "string"
  ],
  "comments": "string",
  "isPublic": true,
  "isReadyForMigration": true,
  "publishedVersionId": "string",
  "othersMayDownload": true,
  "othersCanViewHistory": true,
  "othersCanExecute": true,
  "executionMode": "Safe",
  "hasPrivateDataExemption": true
}

  • 401: Unauthorized (sin autorización)

  • 404: NotFound

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

Solo los administradores pueden usar este punto de conexión de la API.

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.

    • workflowCredentialType (cadena): opcional. Los valores aceptados son "Default" (predeterminado), "Required" (obligatorio), and "Specific" (específico).

    • credentialId (cadena): opcional. Especifica el credentialId para este flujo de trabajo.

  • Ejemplo de valor de updateWorkflowContract:

    {
  "name": "string",
  "versionId": "string",
  "makePublished": true,
  "ownerId": "string",
  "workerTag": "string",
  "districtTags": [
    "string"
  ],
  "comments": "string",
  "isPublic": true,
  "isReadyForMigration": true,
  "othersMayDownload": true,
  "othersCanExecute": true,
  "executionMode": "Safe",
  "hasPrivateDataExemption": true,
  "workflowCredentialType": "Default",
  "credentialId": "string"
}
curl -X 'PUT' \
  'http://localhost/webapi/v3/workflows/66ebd18d6e52ae73b4951085' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Workflow_3_4",
  "versionId": "66ebd18d3d6200007e000d89",
  "makePublished": true,
  "ownerId": "66ebd0896e52ae73b4951072",
  "workerTag": "",
  "districtTags": [],
  "comments": "nothing",
  "isPublic": true,
  "isReadyForMigration": true,
  "othersMayDownload": true,
  "othersCanExecute": true,
  "executionMode": "Safe",
  "hasPrivateDataExemption": true,
  "workflowCredentialType": "Default",
  "credentialId": ""
}'

  • 200: OK

    {
  "id": "string",
  "sourceAppId": "string",
  "dateCreated": "2024-08-15T11:20:45.231Z",
  "runCount": 0,
  "versions": [
    {
      "versionId": "string",
      "versionNumber": 0,
      "dateCreated": "2024-08-15T11:20:45.231Z",
      "uploadSource": "Designer",
      "uploadDate": "2024-08-15T11:20:45.231Z",
      "packageWorkflowType": "App",
      "published": true,
      "comments": "string",
      "runDisabled": true,
      "executionMode": "Safe",
      "workflowCredentialType": "Default",
      "credentialId": "string",
      "hasPrivateDataExemption": true,
      "othersMayDownload": true,
      "othersCanViewHistory": true,
      "details": {
        "isAmp": true,
        "fileName": "string",
        "author": "string",
        "copyright": "string",
        "description": "string",
        "name": "string",
        "noOutputFilesMessage": "string",
        "outputMessage": "string",
        "url": "string",
        "urlText": "string"
      }
    }
  ],
  "name": "string",
  "ownerId": "string",
  "workerTag": "string",
  "districtTags": [
    "string"
  ],
  "comments": "string",
  "isPublic": true,
  "isReadyForMigration": true,
  "publishedVersionId": "string",
  "othersMayDownload": true,
  "othersCanViewHistory": true,
  "othersCanExecute": true,
  "executionMode": "Safe",
  "hasPrivateDataExemption": true
}

  • 400: BadRequest

  • 401: Unauthorized (sin autorización)

  • 404: NotFound

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'

Ejemplo de respuesta

  • 200: El flujo de descarga del archivo YXZP.

  • 400: VersionId no válida

  • 401: Unauthorized (sin autorización)

  • 403: El usuario autenticado no tiene permiso para descargar el flujo de trabajo o no se permite descargar el flujo de trabajo directamente.

  • 404: NotFound

Recuperar información de preguntas para un flujo de trabajo

Para obtener información de preguntas para un flujo de trabajo o una aplicación analítica, 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.

curl -X 'GET' \
  'http://localhost/webapi/v3/workflows/670ce5cef10214f22a6637a3/questions' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

  • 200: OK

    [
  {
    "name": "string",
    "questionType": "string",
    "description": "string",
    "value": "string",
    "multiple": true,
    "items": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
]

  • 400: BadRequest

  • 401: Unauthorized (sin autorización)

  • 403: El usuario autenticado no tiene acceso al flujo de trabajo o las preguntas.

  • 404: NotFound

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.

Nota

Una tarea puede devolverse como Completada incluso si el estado de la consulta es Error. Esto indica que se produjo un error durante la ejecución, pero el flujo de trabajo se ejecutó.

Parámetros

  • workflowId (cadena): obligatorio. Ingresa el Id. de flujo de trabajo del que deseas recuperar la información.

  • sortField (cadena): opcional. Ingresa el nombre del campo por el que deseas ordenar los resultados.

  • direction (cadena): opcional. Especifica el orden de clasificación aquí. Los valores aceptados son “asc” (ascendente) y “desc” (descendente). Si no se especifica ninguna clasificación, el valor predeterminado será ascendente.

  • offset (cadena): opcional. Se refiere al registro con el que deseas que tus resultados comiencen.

  • limit (cadena): opcional. Se refiere al último registro con el que deseas que tus resultados terminen.

  • status (cadena): opcional. El estado general de la ejecución del trabajo. Un trabajo completado podría haber fallado. Los valores permitidos son: “Complete” (Completo), “Error”, “Running” (En ejecución) y “Queued” (En cola).

  • resultCode (cadena): opcional. El código de resultado de la ejecución de un flujo de trabajo. Esto indica un flujo de trabajo fallido, pero una tarea exitosa. Los valores aceptados son: “Success” (Éxito), “Warning” (Advertencia) y “Error”.

curl -X 'GET' \
  'http://localhost/webapi/v3/workflows/670ce5cef10214f22a6637a3/jobs' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

  • 200: OK

    [
  {
    "id": "string",
    "createDate": "2024-08-15T11:29:53.357Z",
    "status": "Created",
    "priority": "string",
    "workerTag": "string",
    "runWithE2": true
  }
]

  • 400: BadRequest

  • 401: Unauthorized (sin autorización)

  • 404: NotFound

Eliminar un flujo de trabajo

Para eliminar un flujo de trabajo específico, utiliza el punto de conexión DELETE {baseURL}/v3/workflows/{workflowId}.

Nota

Solo los administradores pueden usar este punto de conexión de la API.

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.

curl -X 'DELETE' \
  'http://localhost/webapi/v3/workflows/670ce95bf10214f22a665bc4' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

  • 200: OK

  • 400: BadRequest

  • 401: Unauthorized (sin autorización)

  • 404: NotFound

Crear un nuevo trabajo

Para crear un nuevo trabajo y agregarlo a la cola de ejecución de trabajos, 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 un nuevo trabajo, especifica los siguientes parámetros:

    • workerTag (cadena): opcional. Especifica el trabajador asignado. Si no se especifica, el valor será “none” (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.

      • name (cadena): opcional.

      • value (cadena): opcional.

    • priority (cadena): opcional. Especifica la prioridad para ejecutar la programación. Elige entre los siguientes valores: “Low” (bajo), “Medium” (medio), “High” (alto) y “Critical” (crítico). Si no se especifica, el valor predeterminado será “Low” (bajo).

Ejemplo de valor de contract:

{
  "workerTag": "string",
  "credentialId": "string",
  "questions": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "priority": "Default"
}

Ejemplo de una solicitud para crear una tarea:

curl -X 'POST' \
  'http://localhost/webapi/v3/workflows/670ce5cef10214f22a6637a3/jobs' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "workerTag": "",
  "credentialId": "",
  "priority": "Low"
}'

  • 200: OK

    {
  "id": "string",
  "appId": "string",
  "createDateTime": "2024-09-05T11:13:04.586Z",
  "status": "string",
  "disposition": "string",
  "outputs": [
    {
      "id": "string",
      "availableFormats": [
        "string"
      ],
      "fileName": "string"
    }
  ],
  "messages": [
    {
      "status": 0,
      "text": "string",
      "toolId": 0
    }
  ],
  "priority": "Default",
  "workerTag": "string",
  "runWithE2": true
}

  • 400: BadRequest

  • 401: Unauthorized (sin autorización)

  • 403: El usuario autenticado no tiene acceso para ejecutar el flujo de trabajo.

  • 404: NotFound

Transfiere flujos de trabajo y programaciones a un propietario especificado

Para transferir un flujo de trabajo específico a un propietario específico, junto con las programaciones si lo deseas, utiliza el punto de conexión PUT {baseURL}/v3/workflows/{workflowId}/transfer.

Nota

  • Solo los administradores pueden usar este punto de conexión de la API.

  • Si alguno de los flujos de trabajo requiere conexiones de DCM, conexiones de Server o credenciales específicas para ejecutarse, estos elementos deben actualizarse antes de que se pueda ejecutar el flujo de trabajo.

  • Si los usuarios no están en el mismo estudio, cuando se transfiere un flujo de trabajo al nuevo estudio, todos los demás usuarios del estudio del nuevo propietario también recibirán acceso al flujo de trabajo, y todos los usuarios del estudio antiguo perderán el acceso.

  • Los flujos de trabajo solo se pueden transferir a un usuario con el rol de Creador o Administrador.

  • Si se transfieren programaciones, el nuevo propietario debe tener acceso al flujo de trabajo programado; de lo contrario, no podrás transferir ese flujo de trabajo al nuevo propietario.

  • Si transfieres programaciones, el nuevo propietario debe tener permiso para programar flujos de trabajo.

  • Si se elimina el usuario, devuelve una lista de IDs de programación que se romperán o deshabilitarán después de la transferencia.

Parámetros

  • workflowId (cadena): obligatorio. Especifica el ID del flujo de trabajo que se transferirá.

  • contract (cuerpo): obligatorio. Especifica la siguiente información:

    • ownerId (cadena): obligatorio. Especifica el ID del nuevo propietario.

    • transferSchedules (booleano): obligatorio. Especifica si las programaciones deben transferirse a un nuevo propietario junto con el flujo de trabajo. Solo se transferirán al nuevo propietario las programaciones que pertenezcan al propietario actual del flujo de trabajo.

Ejemplo de valor de contract:

{
  "ownerId": "string",
  "transferSchedules": true
}
curl -X 'PUT' \
  'http://localhost/webapi/v3/workflows/670ce5cef10214f22a6637a3/transfer' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "ownerId": "670ceafbf10214f22a666c76",
  "transferSchedules": true
}'

  • 200: OK

  • 400: BadRequest

    "string"

  • 401: Unauthorized (sin autorización)

  • 403: Forbidden (prohibido)

    "string"

  • 404: NotFound

    "string"

  • 500: InternalServerError

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.