Skip to main content

Endpoint del flusso di lavoro

Workflow Endpoints and Parameters

Per ulteriori informazioni sulle relazioni tra oggetti e su come utilizzarle nell'API, consulta la sezione Relazioni tra oggetti .

Per ulteriori informazioni sui flussi di lavoro, consulta la pagina di assistenza Flussi di lavoro .

Caricamento di un nuovo flusso di lavoro

Per caricare un nuovo flusso di lavoro, utilizza l'endpoint POST {baseURL}/v3/workflows .

Parametri

  • file  (file): obbligatorio. Consente di selezionare il file che desideri caricare sul sistema. Il tipo di media deve essere un file YXZP.

  • name  (stringa): obbligatorio. Immetti il nome di un flusso di lavoro. Si tratta del nome del flusso di lavoro da visualizzare nell'interfaccia utente di Server.

  • ownerId  (stringa): obbligatorio. Immetti l'ID del proprietario.

  • workerTag  (stringa): opzionale. Specifica il tag worker definito nei worker per facilitare l'assegnazione dei processi a determinati nodi worker. Per ulteriori informazioni, consulta la pagina di assistenza Worker .

  • districtTags  (stringa): opzionale. Invia come array in formato JSON, ad esempio, ["id1", "id2"]. Utilizza i distretti per raggruppare i flussi di lavoro pubblici condivisi per tag in modo che gli utenti possano trovarli facilmente. Per ulteriori informazioni, consulta la pagina di assistenza Distretti .

  • comments  (stringa): opzionale. Immetti i commenti.

  • isPublic  (booleano): obbligatorio. Seleziona "true" per rendere il flusso di lavoro disponibile pubblicamente. Seleziona "false" per rendere il flusso di lavoro privato e non disponibile pubblicamente.

  • isReadyForMigration  (booleano): obbligatorio. Specifica se il flusso di lavoro è pronto per la migrazione. Per ulteriori informazioni sulla migrazione da un ambiente Server a un altro, consulta la pagina di assistenza Abilitazione dei flussi di lavoro per la migrazione .

  • sourceAppId  (stringa): opzionale. Imposta l'ID dell'app di origine di un flusso di lavoro. Puoi utilizzarlo come riferimento "sourceId" per l'endpoint POST admin/v1/workflows . Se fornisci un parametro sourceAppId preesistente, la richiesta non sarà valida.

  • othersMayDownload  (booleano): obbligatorio. Specifica se altri utenti possono scaricare il flusso di lavoro.

  • othersCanExecute  (booleano): obbligatorio. Specifica se altri utenti possono eseguire il flusso di lavoro.

  • executionMode  (stringa): obbligatorio. I valori accettati sono "Provvisoria", "Semi provvisoria" e "Standard". Per ulteriori informazioni sulla modalità di esecuzione, consulta la pagina di assistenza Modalità di esecuzione Provvisoria e Semi provvisoria: strumenti, eventi e connettori dati bloccati .

  • hasPrivateDataExemption  (booleano): opzionale. Fornisci un'esenzione per consentire l'esecuzione di un flusso di lavoro con dati privati. Seleziona "true" per consentire un'esenzione o "false" per rifiutarla. Per ulteriori informazioni, consulta la pagina  Opzioni del flusso di lavoro nell'interfaccia di amministrazione .

  • workflowCredentialType (stringa): obbligatorio. I valori accettati sono "Predefinito", "Obbligatorio" e "Specifico".

  • credentialId (stringa): opzionale. Specifica il parametro credentialId del flusso di lavoro.

  • collectionIds (stringa): opzionale. Immetti il parametro collectionId(s) in cui aggiungere il flusso di lavoro. Invia come array in formato JSON, ad esempio, ["id1", "id2"].

Request Example: cURL
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'
Response Example

  • 200: OK

    "string"

  • 400: BadRequest

  • 401: Unauthorized

Caricamento di una nuova versione in un flusso di lavoro esistente

Per caricare una nuova versione di un flusso di lavoro esistente, utilizza l'endpoint POST {baseURL}/v3/workflows/{workflowId}/versions .

Parametri

  • workflowId  (stringa): obbligatorio. Immetti l'ID del flusso di lavoro di cui desideri caricare una nuova versione.

  • file  (file): obbligatorio. Scegli il file che desideri caricare nel sistema come nuova versione. Il tipo di media deve essere un file YXZP.

  • name  (stringa): obbligatorio. Immetti il nome del flusso di lavoro. Si tratta del nome del flusso di lavoro da visualizzare nell'interfaccia utente di Server.

  • ownerId  (stringa): obbligatorio. Immetti l'ID del proprietario.

  • othersMayDownload  (booleano): obbligatorio. L'impostazione predefinita è "true".

  • othersCanExecute  (booleano): obbligatorio. L'impostazione predefinita è "true".

  • executionMode  (stringa): obbligatorio. I valori accettati sono "Provvisoria", "Semi provvisoria" e "Standard". Per ulteriori informazioni sulla modalità di esecuzione, consulta la pagina di assistenza Modalità di esecuzione Provvisoria e Semi provvisoria: strumenti, eventi e connettori dati bloccati .

  • hasPrivateDataExemption  (booleano): opzionale. Fornisci un'esenzione per consentire l'esecuzione di un flusso di lavoro con dati privati. Seleziona "true" per consentire un'esenzione o "false" per rifiutarla. Per ulteriori informazioni, consulta la pagina  Opzioni del flusso di lavoro nell'interfaccia di amministrazione .

  • comments  (stringa): opzionale. Immetti i commenti.

  • makePublished  (booleano): obbligatorio. L'impostazione predefinita è "true". Il parametro makePublished consente di controllare se la nuova versione di un flusso di lavoro che invii a Server deve essere o meno quella pubblicata. Puoi impostare il valore su "false" quando invii il flusso di lavoro a Server, nel qual caso solo tu potrai eseguirlo.

  • workflowCredentialType (stringa): obbligatorio. Immetti il tipo di credenziale da utilizzare per il flusso di lavoro. I valori accettati sono "Predefinito", "Obbligatorio" e "Specifico".

  • credentialId (stringa): opzionale. Specifica il parametro credentialId per il flusso di lavoro. Per ulteriori informazioni sugli endpoint delle credenziali, consulta Endpoint delle credenziali .

Request Example: cURL
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'
Response Example

  • 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

  • 404: Indicates that the workflowId in the path is invalid.

Recupero di tutti i flussi di lavoro

Per ottenere informazioni su tutti i record del flusso di lavoro, utilizza l'endpoint GET {baseURL}/v3/workflows/ .

Parametri

  • view  (stringa): opzionale. Seleziona la modalità di visualizzazione delle informazioni del flusso di lavoro. È possibile non specificare alcun valore o selezionare "Default" e "Full". Se il parametro è impostato su "Default", viene restituito un oggetto vista ridotto. Se non è specificato alcun valore, viene utilizzato "Default".

  • name  (stringa): opzionale. Immetti il nome del flusso di lavoro se desideri filtrare i flussi di lavoro per nome. Si tratta del nome del flusso di lavoro visualizzato nell'interfaccia utente di Server.

  • ownerId  (stringa): opzionale. Immetti l'ID del proprietario se desideri filtrare i flussi di lavoro per proprietario.

  • createdAfter  (stringa): opzionale. Immetti la data e l'ora dopo le quali è stato creato il flusso di lavoro. Immetti la data e l'ora in formato ISO8601 .

  • createdBefore  (stringa): opzionale. Immetti la data e l'ora prima delle quali è stato creato il flusso di lavoro. Immetti la data e l'ora in formato ISO8601 .

Esempio di richiesta: cURL

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

Response Example

  • 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

Recupero del record di un flusso di lavoro specifico

Per ottenere informazioni su un flusso di lavoro specifico, utilizza l'endpoint GET {baseURL}/v3/workflows/{workflowId} .

Nota

Non-Curators can use the GET v3/workflows/{workflowId} endpoint for workflows they have access to. Previously, this endpoint was limited to Curators only.

Parametri

  • workflowId  (stringa): obbligatorio. Immetti l'ID del flusso di lavoro per ottenere informazioni sul flusso di lavoro.

Esempio di richiesta: cURL

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

Response Example

  • 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

  • 404: NotFound

Aggiornamento di un flusso di lavoro esistente

Per modificare le informazioni su un flusso di lavoro esistente, utilizza PUT {baseURL}/v3/workflows/{workflowId} endpoint.

Nota

Only Curators can use this API endpoint.

Per modificare il parametro ownerId, il nuovo proprietario deve far parte della stessa iscrizione di quello corrente.

Parametri

  • workflowId  (stringa): obbligatorio. Immetti l'ID del flusso di lavoro da aggiornare.

  • updateWorkflowContract  (corpo): obbligatorio. Immetti i dati del flusso di lavoro da aggiornare.

    • name (string): Required. Enter the workflow name. This is the name of the workflow to display in Server UI.

    • versionId (string): Required. Enter the version ID.

    • makePublished (boolean): Optional. When not specified, the value stays the same as before. The makePublished parameter is a way to control whether the new version of a workflow that you push to Server should be the published version or not. You can set the value to "false" when you push the workflow to Server, and then only you will have the ability to run it.

    • ownerId (string): Required. Enter the owner ID.

    • workerTag (string): Required. When there is no workerTag, use "" instead.

    • districtTags (string): Required. Enter the district tags. Use districts to group shared, public workflows by tags so that users can easily find them. For more information, visit the Districts help page.

    • comments (string): Required. Enter your comments.

    • isPublic (boolean): Optional. When not specified, the value stays the same as before.

    • isReadyForMigration (boolean): Optional. When not specified, the value stays the same as before.

    • othersMayDownload (boolean): Optional. When not specified, the value stays the same as before. When set to "false" for a public workflow, the workflow will be unusable.

    • othersCanExecute (boolean): Optional. When not specified, the value stays the same as before. When set to "false" for a public workflow, the workflow will be unusable.

    • executionMode (string): Optional. Accepted values are "Safe", "SemiSafe", "Standard". For more information about the execution mode, see the Safe and Semi-safe Run Modes: Blocked Tools, Events, and Data Connectors help page.

    • hasPrivateDataExemption (boolean): Optional. Give an exemption to allow a workflow with private data to run. Select "true" to allow an exemption or "false" to deny an exemption. When not specified, the value stays the same as before. For more information, visit the Workflow Options in Admin page.

    • workflowCredentialType (string): Optional. Accepted values are "Default", "Required", and "Specific".

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

  • Example value of 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"
}
Request Example: cURL
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": ""
}'
Response Example

  • 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

  • 404: NotFound

Download di un pacchetto del flusso di lavoro

Per scaricare un pacchetto del flusso di lavoro, utilizza l'endpoint GET {baseURL}/v3/workflows/{workflowId}/package .

Parametri

  • workflowId  (stringa): obbligatorio. Immetti l'ID del flusso di lavoro per il quale desideri scaricare il pacchetto.

  • versionId  (stringa): opzionale. Immetti l'ID della versione specifica di un flusso di lavoro. Se non viene fornita alcuna versione, viene scaricata quella pubblicata.

    Nota

    Se versionID ha due cifre, potrebbe raggiungere le dimensioni massime consentite e potrebbe apparire l'errore "414 - URI troppo lungo". In questo caso, analizza la stringa JSON versionID e ritagliala in modo da includere solo la versione più recente. Ciò permetterà di controllare la lunghezza del campo.

Esempio di richiesta: cURL

curl -X GET --header 'Accept: application/octet-stream' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a4be7dc6e24bb8ff0/package'

Response Example

  • 200: The download stream of the YXZP file.

  • 400: Invalid VersionId

  • 401: Unauthorized

  • 403: The authenticated user does not have permission to download the workflow, or the workflow is not allowed to be downloaded directly.

  • 404: NotFound

Recupero delle informazioni sulle domande relative a un flusso di lavoro

Per ottenere informazioni sulle domande relative a un flusso di lavoro, utilizza l'endpoint GET {baseURL}/v3/workflows/{workflowId}/questions .

Parametri

  • workflowId  (stringa): obbligatorio. Immetti l'ID del flusso di lavoro per il quale desideri recuperare le informazioni.

  • versionId  (stringa): opzionale. Immetti l'ID della versione specifica di un flusso di lavoro. Se non viene fornita alcuna versione, viene utilizzata quella pubblicata.

Esempio di richiesta: cURL

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

Response Example

  • 200: OK

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

  • 400: BadRequest

  • 401: Unauthorized

  • 403: The authenticated user does not have access to the workflow or questions.

  • 404: NotFound

Informazioni sui processi di un flusso di lavoro specifico

Per ottenere informazioni sui processi di un flusso di lavoro specifico, utilizza l'endpoint GET {baseURL}/v3/workflows/{workflowId}/jobs .

Nota

A job might be returned as Completed even if the query status is Error. This indicates an error occurred during execution, but the workflow was run.

Parametri

  • workflowId  (stringa): obbligatorio. Immetti l'ID del flusso di lavoro per il quale desideri recuperare le informazioni.

  • sortField (stringa): opzionale.

  • direction (stringa): opzionale.

  • offset (stringa): opzionale.

  • limit (stringa): opzionale.

  • status (string): Optional. The overall status of the job execution. A completed job might still have failed. Accepted values are: "Complete", "Error", "Running", and "Queued".

  • resultCode (string): Optional. The result code of the execution of a workflow. This indicates a failed workflow, but a successful job. Accepted values are: "Success", "Warning", and "Error".

Esempio di richiesta: cURL

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

Response Example

  • 200: OK

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

  • 400: BadRequest

  • 401: Unauthorized

  • 404: NotFound

Eliminazione di un flusso di lavoro

Per eliminare un flusso di lavoro specifico, utilizza l'endpoint DELETE {baseURL}/v3/workflows/{workflowId} .

Nota

Only Curators can use this API endpoint.

Parametri

  • workflowId  (stringa): obbligatorio. Immetti l'ID del flusso di lavoro da eliminare.

  • force  (booleano): opzionale. In assenza di una specifica, il valore predefinito è "false". Se è pianificato un flusso di lavoro, il parametro impostato su "true" eliminerà tutte le pianificazioni prima di procedere con l'eliminazione.

Esempio di richiesta: cURL

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

Response Example

  • 200: OK

  • 400: BadRequest

  • 401: Unauthorized

  • 404: NotFound

Creazione di un nuovo processo

Per creare un nuovo processo e aggiungerlo alla coda, utilizza l'endpoint POST /v3/workflows/{workflowId}/jobs .

Parametri

  • workflowId  (stringa): obbligatorio. Immetti l'ID di un flusso di lavoro che desideri pianificare.

  • contract (corpo): per creare un nuovo processo, specifica i seguenti parametri:

    • workerTag  (stringa): opzionale. Specifica il worker assegnato. In assenza di specifica, il valore sarà "none".

    • credentialId (stringa): opzionale. Specifica il parametro credentialId per il flusso di lavoro.

    • questions (stringa): opzionale. Per le app analitiche, specifica le domande e le risposte per eseguire il flusso di lavoro.

      • name (string): Optional.

      • value (string): Optional.

    • priority (stringa): opzionale. Specifica la priorità per l'esecuzione della pianificazione. Puoi scegliere tra le seguenti opzioni: "Low", "Medium", "High" e "Critical". In assenza di specifica, il valore predefinito sarà "Low".

Example value of contract:

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

Request Example: cURL

Example of a request to create a job:

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

Response Example

  • 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

  • 403: The authenticated user does not have access to execute the workflow.

  • 404: NotFound

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): Required. Specify the Id of the new owner.

    • transferSchedules (Boolean): Required. 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.

Example value of contract:

{
  "ownerId": "string",
  "transferSchedules": true
}

Request Example: cURL

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

Response Example

  • 200: OK

  • 400: BadRequest

    "string"

  • 401: Unauthorized

  • 403: Forbidden

    "string"

  • 404: NotFound

    "string"

  • 500: InternalServerError

Relazioni tra oggetti

Se stai caricando un flusso di lavoro, puoi utilizzare gli oggetti creati nel modo seguente:

Oggetto creato: " workflowId " (ad esempio, "id": "7917969784f84bd09442f66996ecb8f3")

Puoi utilizzarlo come:

Esempi di richiesta Postman

GET /v3/Workflows/{workflowId}

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

Per ulteriori informazioni sulle richieste Postman, consulta la pagina di assistenza Come utilizzare Postman .

In questa sezione: