Nota
Questa pagina di assistenza illustra l'utilizzo di un endpoint dell'API Server. Per iniziare a utilizzare l'API Server, consulta la sezione Panoramica sull'API Server.
Utilizza l'endpoint migratable per migrare i flussi di lavoro tra gli ambienti di Server. Puoi utilizzare questo endpoint per gestire le distribuzioni dei flusso di lavoro durante le fasi di sviluppo e test.
Per iniziare, è necessario abilitare i flussi di lavoro per la migrazione. Dopo aver contrassegnato i flussi di lavoro per la migrazione, attieniti alla procedura di seguito per pubblicarli dall'ambiente di origine nell'iscrizione appropriata (studio) dell'ambiente di destinazione.
Successivamente, ottieni un elenco di flussi di lavoro pronti per la migrazione utilizzando il seguente endpoint:
Ambiente: origine
Metodo: GET
Endpoint: webapi/admin/v1/workflows/migratable/?subscriptionIds={subscriptionIds}/
Includi un elenco separato da virgole di subscriptionIds come parametro di query. Gli ID iscrizione identificano uno studio specifico.
Il risultato è una serie di flussi di lavoro contrassegnati come pronti per la migrazione con l'iscrizione specificata (studio). Se non specifichi nessun subscriptionIds, vengono forniti tutti i flussi di lavoro contrassegnati come pronti per la migrazione. Il risultato include 3 proprietà: appId, revisionid attualmente pubblicato e subscriptionID di appartenenza del flusso di lavoro.
Il seguente endpoint scarica il flusso di lavoro come file YXZP.
Ambiente: origine
Metodo: GET
Endpoint: webapi/admin/v1/{appID}/package/
Includi un appID come parametro di percorso. Il risultato sarà un download dell'intero flusso di lavoro come pacchetto.
Il seguente endpoint pubblica il flusso di lavoro scaricato nell'ambiente di destinazione.
Ambiente: destinazione
Metodo: POST
Endpoint: webapi/admin/v1/workflows/
Parametri | |||
Parametro | Descrizione | Tipo | Obbligatorio |
|---|---|---|---|
file | Il nome file del nuovo flusso di lavoro. | Stringa | Vero |
name | Il nome del nuovo flusso di lavoro. | Stringa | Vero |
owner | Il proprietario del flusso di lavoro migrato. L'indirizzo e-mail deve esistere nell'ambiente di destinazione. | Stringa | Vero |
validate | Contrassegno per convalidare il flusso di lavoro durante la migrazione all'ambiente di destinazione. | Booleano | Vero |
isPublic | Contrassegno per impostare il flusso di lavoro come pubblico e visualizzarlo in "Server della mia azienda" nell'ambiente di destinazione. | Booleano | Vero |
sourceId | L'appId dell'ambiente di origine del flusso di lavoro da migrare. Se esiste un flusso di lavoro con lo stesso sourceId, la versione del flusso di lavoro viene incrementata. In caso contrario, viene generato un nuovo flusso di lavoro. (Invia una stringa vuota se non desideri specificare un appID.) | Stringa | Vero |
workerTag | Aggiungi un tag worker al flusso di lavoro se desideri che questo sia eseguito da un worker specifico. (Invia una stringa vuota se non desideri specificare il worker.) | Stringa | Vero |
canDownload | Contrassegno per impostare il flusso di lavoro come disponibile per il download da parte di altri utenti nell'ambiente di destinazione. | Booleano | Vero |
Puoi utilizzare l'endpoint migratable per reimpostare l'opzione Questo flusso di lavoro è pronto per la migrazione di un flusso di lavoro su No nell'ambiente di origine dopo la migrazione del flusso di lavoro nell'ambiente di destinazione.
Ambiente: origine
Metodo: PUT
Endpoint: webapi/admin/v1/workflows/migratable/{appID}/