Skip to main content

Points de terminaison du workflow

Workflow Endpoints and Parameters

Pour en savoir plus sur les relations d'objets et sur leur utilisation dans l'API, consultez la section Relations d'objets .

Pour plus d'informations à propos des workflows, consultez la page d'aide Workflows .

Charger un nouveau workflow

Pour charger un nouveau workflow, utilisez le point de terminaison POST {baseURL}/v3/workflows .

Paramètres

  • file (fichier) : obligatoire. Sélectionnez le fichier réel que vous souhaitez charger dans le système. Le type de support doit être un fichier YXZP.

  • name (chaîne) : obligatoire. Saisissez un nom de workflow. Il s'agit du nom du workflow à afficher dans l'interface utilisateur Server.

  • ownerId (chaîne) : obligatoire. Saisissez l'ID du propriétaire.

  • workerTag  (chaîne) : facultatif. Indiquez la balise worker définie dans les workers pour attribuer des tâches à certains nœuds worker. Pour plus d'informations, consultez la page d'aide Worker .

  • districtTags  (chaîne) : facultatif. Soumettez sous forme de tableau au format JSON, par exemple, ["id1", "id2"]. Utilisez les catégories pour regrouper les workflows publics partagés par balise, afin que les utilisateurs puissent les trouver facilement. Pour plus d'informations, consultez la page d'aide  Catégories .

  • comments  (chaîne) : facultatif. Saisissez vos commentaires.

  • isPublic  (booléen) : obligatoire. Sélectionnez « true » pour rendre le workflow accessible au public. Sélectionnez « false » pour rendre le workflow privé et inaccessible au public.

  • isReadyForMigration  (booléen) : obligatoire. Indiquez si le workflow est prêt à être migré. Pour plus d'informations sur la migration d'un environnement Server à un autre, consultez la page d'aide  Activer les workflows pour la migration .

  • sourceAppId  (chaîne) : facultatif. Définit l'ID de l'application source d'un workflow. Vous pouvez l'utiliser en tant que référence « sourceId » pour le point de terminaison POST admin/v1/workflows . Si vous fournissez un ID d'application source préexistant, la demande sera non valide.

  • othersMayDownload  (booléen) : obligatoire. Indiquez si les autres utilisateurs peuvent télécharger ce workflow.

  • othersCanExecute  (booléen) : obligatoire. Indiquez si les autres utilisateurs peuvent exécuter ce workflow.

  • executionMode  (chaîne) : obligatoire. Les valeurs acceptées sont « Safe », « SemiSafe » et « Standard ». Pour plus d'informations sur le mode d'exécution, consultez la page d'aide  Modes d'exécution sécurisé et semi-sécurisé : outils bloqués, événements et connecteurs de données .

  • hasPrivateDataExemption  (booléen) : facultatif. Accordez une exemption pour permettre l'exécution d'un workflow avec des données privées. Sélectionnez « true » pour autoriser une exemption ou « false » pour refuser une exemption. Pour plus d'informations, consultez la page  Options de workflow dans l'interface d'administration .

  • workflowCredentialType (chaîne) : obligatoire. Les valeurs acceptées sont « Default », « Required » et « Specific ».

  • credentialId (chaîne) : facultatif. Indiquez  l'ID d'identification pour ce workflow.

  • collectionIds (chaîne) : facultatif. Saisissez le(s) Id(s) de collection où ce workflow doit être ajouté. Soumettez sous forme de tableau au format JSON, par exemple : ["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

Charger une nouvelle version dans un workflow existant

Pour charger une nouvelle version d'un workflow existant, utilisez le point de terminaison  POST {baseURL}/v3/workflows/{workflowId}/versions endpoint.

Paramètres

  • workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow dont vous souhaitez charger une nouvelle version.

  • file (file) : obligatoire. Sélectionnez le fichier réel que vous souhaitez charger dans le système en tant que nouvelle version. Le type de support doit être un fichier YXZP.

  • name (string) : obligatoire. Saisissez le nom du workflow. Il s'agit du nom du workflow à afficher dans l'interface utilisateur Server.

  • ownerId (chaîne) : obligatoire. Saisissez l'ID du propriétaire.

  • othersMayDownload  (booléen) : obligatoire. La valeur par défaut est « true ».

  • othersCanExecute  (booléen) : obligatoire. La valeur par défaut est « true ».

  • executionMode  (chaîne) : obligatoire. Les valeurs acceptées sont « Safe », « SemiSafe » et « Standard ». Pour plus d'informations sur le mode d'exécution, consultez la page d'aide  Modes d'exécution sécurisé et semi-sécurisé : outils bloqués, événements et connecteurs de données .

  • hasPrivateDataExemption  (booléen) : facultatif. Accordez une exemption pour permettre l'exécution d'un workflow avec des données privées. Sélectionnez « true » pour autoriser une exemption ou « false » pour refuser une exemption. Pour plus d'informations, consultez la page  Options de workflow dans l'interface d'administration .

  • comments (chaîne) : facultatif. Saisissez vos commentaires.

  • makePublished  (booléen) : obligatoire. La valeur par défaut est « true ». Le paramètre makePublished permet de contrôler si la nouvelle version d'un workflow que vous transmettez à Server doit être la version publiée ou non. Si vous définissez la valeur sur « false » lorsque vous transmettez le workflow à Server, vous seul aurez la possibilité de l'exécuter.

  • workflowCredentialType (chaîne) : obligatoire. Saisissez le type d'informations d'identification à utiliser pour ce workflow. Les valeurs acceptées sont « Default », « Required » et « Specific ».

  • credentialId (chaîne) : facultatif. Indiquez l'Id d'identification pour ce workflow. Pour plus d'informations sur les points de terminaison d'informations d'identification, accédez à Points de terminaison d'informations d'identification .

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.

Récupérer tous les workflows

Pour obtenir des informations sur tous les enregistrements de workflow, utilisez le point de terminaison  GET {baseURL}/v3/workflows/ .

Paramètres

  • view (chaîne) : facultatif. Sélectionnez le mode d'affichage des informations du workflow. Peut être laissé sans valeur. Vous pouvez choisir parmi les valeurs suivantes : « Default » et « Full ». Si ce paramètre est défini sur « Default », un objet de vue réduite est renvoyé. Lorsqu'elle n'est pas spécifiée, la valeur « Default » est utilisée.

  • name (chaîne) : facultatif. Saisissez le nom du workflow si vous souhaitez filtrer les workflows par nom. Il s'agit du nom du workflow affiché dans l'interface utilisateur Server.

  • ownerId  (chaîne) : facultatif. Saisissez l'ID du propriétaire si vous souhaitez filtrer les workflows selon leurs propriétaires.

  • createdAfter  (chaîne) : facultatif. Saisissez la date et l'heure après laquelle le workflow a été créé. Saisissez la date et l'heure au format ISO8601.

  • createdBefore  (chaîne) : facultatif. Saisissez la date et l'heure avant laquelle le workflow a été créé. Saisissez la date et l'heure au format ISO8601.

Exemple de demande : 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

Récupérer un enregistrement de workflow spécifique

Pour obtenir des informations sur un workflow spécifique, utilisez le point de terminaison  GET {baseURL}/v3/workflows/{workflowId} .

Note

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

Paramètres

  • workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow pour obtenir des informations sur ce workflow.

Exemple de demande : 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

Mettre à jour un workflow existant

Pour modifier les informations d'un workflow existant, utilisez le point de terminaison  PUT {baseURL}/v3/workflows/{workflowId} .

Note

Only Curators can use this API endpoint.

Pour modifier la valeur ownerId, le nouveau propriétaire doit disposer de la même souscription que le propriétaire actuel.

Paramètres

  • workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow que vous souhaitez mettre à jour.

  • updateWorkflowContract  (corps) : obligatoire. Saisissez les informations du workflow à mettre à jour.

    • 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

Télécharger un package de workflow

Pour télécharger un package de workflow, utilisez le point de terminaison  GET {baseURL}/v3/workflows/{workflowId}/package .

Paramètres

  • workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow pour lequel vous souhaitez télécharger un package.

  • versionId  (chaîne) : facultatif. Saisissez l'ID de version spécifique d'un workflow. Si aucune version n'est fournie, la version publiée est téléchargée.

    Note

    Si l'ID de version est à deux chiffres, il peut atteindre la limite de taille et vous risquez d'obtenir une erreur « 414 - URI trop long ». Dans ce cas, analysez la chaîne JSON versionID et ajustez-la à la version la plus récente. La longueur du champ sera ainsi maîtrisée.

Exemple de demande : 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

Récupérer les informations sur une question pour un workflow

Pour obtenir des informations sur une question pour un workflow, utilisez le point de terminaison  GET {baseURL}/v3/workflows/{workflowId}/questions .

Paramètres

  • workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow dont vous souhaitez récupérer les informations.

  • versionId  (chaîne) : facultatif. Saisissez l'ID de version spécifique d'un workflow. Si aucune version n'est fournie, la version publiée est utilisée.

Exemple de demande : 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

Obtenir des informations sur les tâches pour un workflow spécifique

Pour obtenir des informations sur les tâches pour un workflow spécifique, utilisez le point de terminaison  GET {baseURL}/v3/workflows/{workflowId}/jobs .

Note

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.

Paramètres

  • workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow dont vous souhaitez récupérer les informations.

  • sortField (chaîne) : facultatif.

  • direction (chaîne) : facultatif.

  • offset (chaîne) : facultatif.

  • limit (chaîne) : facultatif.

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

Exemple de demande : 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

Supprimer un workflow

Pour supprimer un workflow spécifique, utilisez le point de terminaison  DELETE {baseURL}/v3/workflows/{workflowId} .

Note

Only Curators can use this API endpoint.

Paramètres

  • workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow à supprimer.

  • force  (booléen) : facultatif. Lorsque cette option n'est pas sélectionnée, la valeur par défaut est « false ». Si un workflow est planifié, le paramètre défini sur « true » supprimera toutes les planifications avant de le supprimer.

Exemple de demande : 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

Créer une nouvelle tâche

Pour créer une nouvelle tâche et l'ajouter à la file d'attente, utilisez le point de terminaison POST /v3/workflows/{workflowId}/jobs .

Paramètres

  • workflowId (chaîne) : obligatoire. Saisissez un ID de workflow que vous souhaitez planifier.

  • contract (corps) : pour créer une nouvelle tâche, spécifiez les paramètres suivants :

    • workerTag  (chaîne) : facultatif. Indiquez le worker affecté. S'il n'est pas précisé, la valeur sera « none ».

    • credentialId (chaîne) : facultatif. Indiquez l'Id d'identification pour ce workflow.

    • questions (chaîne) : facultatif. Pour une application analytique, spécifiez les questions et réponses pour exécuter le workflow.

      • name (string): Optional.

      • value (string): Optional.

    • priority (chaîne) : facultatif. Précisez la priorité de l'exécution de la planification. Choisissez parmi les options suivantes : « Low », «Medium », « High » et « Critical ». Si elle n'est pas précisée, la valeur par défaut sera « 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.

Note

  • 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

Relations d'objets

Si vous chargez un workflow, vous pouvez utiliser les objets créés comme suit :

Objet créé : «  workflowId  » (par exemple, "id" : "7917969784f84bd09442f66996ecb8f3")

Vous pouvez l'utiliser comme :

Exemples de demandes Postman

GET /v3/workflows/{workflowId}

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

Pour en savoir plus sur les demandes Postman, consultez la page d'aide Comment utiliser Postman .

Dans cette section​: