Interfaccia REST per risorse correlate a BPD - Risorsa definizioni di avviso - Metodo PUT (salvataggio di massa)

Utilizzare questo metodo per eseguire un'operazione di salvataggio su più definizioni di avviso.

Richiamo del metodo di esempio

PUT /rest/bpm/wle/v1/system/alertDefinitions[?importMode={boolean}]

Richiamo metodo alternativo

POST /rest/bpm/wle/v1/system/alertDefinitions[?importMode={boolean}]

Parametri

Parametri facoltativi
NomeTipo valoreDescrizione
importMode booleano
Salvare le definizioni di avviso in modalità di importazione senza convalidare se le risorse associate esistono. Quando questo parametro facoltativo è impostato su true, il sistema ignora anche la proprietà dell'identificativo per evitare che le definizioni di avviso importate sovrascrivano le definizioni di avviso esistenti con lo stesso identificativo. Per default, la modalità di importazione è impostata su false.

Contenuto richiesta

Un elenco di definizioni di avviso da salvare (AlertDefinitions complexType).

Il tipo di contenuto predefinito èapplication/json.

Tipo MIME: application / json


Schema
{
   "title": "Definizioni di avviso",
   "description": "L'elenco delle definizioni di avviso.",
   "type": "oggetto",
   "proprietà": {
      "definizioni": {
         "type": "array",
         "proprietà": {
            "id": {
               "type": "stringa",
               "description": " L'ID della definizione di segnalazione. Questo campo è facoltativo. Quando non impostato, viene creata una nuova definizione di avviso al salvataggio. ",
               "richiesto" :false
            },
            "displayName":{
               "type": "stringa",
               "description": " Il nome di visualizzazione della definizione di segnalazione. Questo campo è obbligatorio. ",
               "richiesto" :true
            },
            "categoria": {
               "type": "stringa",
               "description": " La categoria della definizione di segnalazione. I valori validi sono: INSTANCE e TASK. Questo campo è obbligatorio. ",
               "enumerazione": [
                  "ISTANZA",
                  "ATTIVITÀ"
               ],
               "richiesto" :true
            },
            "projectId":{
               "type": "stringa",
               "description": " L'ID di applicazione del processo selezionato nella definizione di avviso in formato stringa esterna (ad esempio 2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0). Questo campo è facoltativo. Verrà impostato automaticamente quando sono impostate le proprietà 'snapshotId' o 'bpdId'. Se non si specifica un progetto, per impostazione predefinita tutti i progetti vengono inclusi nella definizione di segnalazione. ",
               "richiesto" :false
            },
            "snapshotId":{
               "type": "stringa",
               "description": " l'ID istantanea selezionato nella definizione di avviso in formato stringa esterna (ad esempio 2064.aaa569e9-a57a-4684-b357-34237e4e49ea). Questo campo è facoltativo. La snapshot specificata con questa proprietà deve essere correlata al progetto facoltativamente specificato con la proprietà 'projectId'. Se non viene specificata un'istantanea, tutte le istantanee sono incluse per impostazione predefinita. ",
               "richiesto" :false
            },
            "bpdId":{
               "type": "stringa",
               "description": " L'ID definizione di processo di business selezionato nella definizione di avviso in formato stringa esterna (ad esempio 25.c904b3b1-afc1-4698-bf5a-a20892c20275). Questo campo è facoltativo a meno che non sia impostata la proprietà 'bpdDisplayName'. La definizione di processo di business specificata con questa proprietà deve essere correlata al progetto facoltativamente specificato nella proprietà 'projectId' e alla snapshot specificata con la proprietà 'snapshotId'. Se non viene specificata una definizione di processo di business, tutte le definizioni di processo di business vengono incluse per impostazione predefinita. ",
               "richiesto" :false
            },
            "NomebpdDisplay": {
               "type": "stringa",
               "description": " Il nome di visualizzazione della definizione del processo di business selezionato nella definizione di segnalazione. Questo campo è facoltativo e non ha alcun impatto sulla valutazione della definizione di avviso. Questa proprietà e la proprietà 'bpdId' devono provenire dalla stessa definizione di processo di business. Viene impostato automaticamente quando la proprietà 'bpdId' è impostata. ",
               "richiesto" :false
            },
            "instanceStatus":{
               "type": "stringa",
               "description": " Lo stato di esecuzione istanza selezionato nella definizione di avviso. I valori validi sono ACTIVE, COMPLETED, FAILED, TERMINATE e SUSPENDED. Questo campo è facoltativo. Se non è impostato, la definizione di segnalazione è destinata a tutti gli stati di esecuzione dell'istanza. ",
               "enumerazione": [
                  "ATTIVO",
                  "COMPLETATO",
                  "NON RIUSCITO",
                  "TERMINATO",
                  "SOSPESO"
               ],
               "richiesto" :false
            },
            "taskStatus":{
               "type": "stringa",
               "description": " Lo stato di esecuzione attività selezionato nella definizione di avviso. I valori validi sono NEW, RECEIVED e CLOSED. Questo campo è facoltativo. Se non è impostato, la definizione di avviso indica tutti e tre gli stati di esecuzione dell'attività. Questo campo è applicabile solo per le definizioni di avviso di tipo TASK. ",
               "enumerazione": [
                  "NUOVO",
                  "RICEVUTO",
                  "CHIUSO"
               ],
               "richiesto" :false
            },
            "thresholdOperator":{
               "type": "stringa",
               "description": " L'operatore soglia nella definizione di avviso. I valori validi sono GREATER, EQUAL e LESS. Questo campo è obbligatorio. ",
               "enumerazione": [
                  "MAGGIORE",
                  "EQUAL",
                  "LESS"
               ],
               "richiesto" :true
            },
            "thresholdValue":{
               "type": "stringa",
               "description": " Il valore di soglia nella definizione di avviso. I valori validi devono essere numerici e maggiori o uguali a zero. Questo campo è obbligatorio. ",
               "richiesto" :true
            }
         }
      }
   }
}
Contenuto di esempio
{
   "definizioni": [
      {
         "displayName": "Istanze attive",
         "categoria": "ISTANZA",
         "thresholdOperator": "MAGGIORE",
         "thresholdValue": "100",
         "instanceStatus": "ATTIVO"
      },
      {
         "displayName": "Istanze completate nel progetto",
         "categoria": "ISTANZA",
         "thresholdOperator": "EQUAL",
         "thresholdValue": "100",
         "projectId":"2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0",
         "instanceStatus": "COMPLETATO"
      },
      {
         "displayName": "Attività generali",
         "categoria": "TASK",
         "thresholdOperator": "EQUAL",
         "thresholdValue": "0"
      },
      {
         "displayName": "Attività chiuse in istanze attive di bpd in snapshot e progetto",
         "categoria": "TASK",
         "thresholdOperator": "MAGGIORE",
         "thresholdValue": "100",
         "projectId":"2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0",
         "snapshotId":"2064.d841529d-5d60-4905-9b8e-1361901380bd",
         "bpdId":"25.c904b3b1-afc1-4698-bf5a-a20892c20275",
         "instanceStatus": "ATTIVO",
         "taskStatus": "CHIUSO"
      }
   ]
}

Tipo MIME: application / xml


Schema
<?xml version="1.0" encoding="UTF-8"?>
< schema targetNamespace= "http://rest.bpm.ibm.com/v1/data/alertDefinition"
        elementFormDefault= "non qualificato" xmlns= "http://www.w3.org/2001/XMLSchema"
        xmlns:tns = "http://rest.bpm.ibm.com/v1/data/alertDefinition"
        xmlns:pref = "http://rest.bpm.ibm.com/v1/data/root"
        xmlns:common = "http://rest.bpm.ibm.com/v1/data/common">

    < import schemaLocation= "BPMRestData.xsd="http://rest.bpm.ibm.com/v1/data/root" />
    < import schemaLocation= "Common.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/common" />


    <!-- 
     Questo tipo rappresenta una definizione di avviso definita per l'installazione di IBM BPM .
    -->
    <complexType nome= "AlertDefinition">
        <complexContent>
            < estensione base= " pref :Data"> 
                < sequenza>
                    <!-- 
                    L'ID della definizione di avviso.
                    Questo campo è facoltativo.
                    Quando non è impostato, al salvataggio viene creata una nuova definizione di avviso.
                    -->
                    < nome elemento = "ID" tipo = "stringa " />
                    <!-- 
                    Il nome di visualizzazione della definizione di avviso. 
                    Questo campo è obbligatorio. 
                    -->
                    < nome elemento= "displayName" type = "string " />
                    <!-- 
                    La categoria della definizione di avviso. 
                    I valori validi sono INSTANCE e TASK. 
                    Questo campo è obbligatorio. 
                    -->
                    < nome elemento = "categoria" tipo = "stringa " />
                    <!-- 
                    L'ID dell'applicazione del processo selezionato nella definizione di avviso in formato stringa esterno 
                    (ad esempio 2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0). Questo campo è facoltativo. 
                    Verrà impostato automaticamente quando sono impostate le proprietà 'snapshotId' o 'bpdId'. 
                    Se non viene specificato un progetto, per impostazione predefinita tutti i progetti vengono inclusi nella definizione di avviso.
                    -->
                    < element name= "projectId" type = "string " />
                    <!-- 
                    L'ID istantanea selezionato nella definizione di avviso in formato stringa esterna 
                    (ad esempio 2064.aaa569e9-a57a-4684-b357-34237e4e49ea). Questo campo è facoltativo. 
                    La snapshot specificata con questa proprietà deve essere correlata al progetto facoltativamente specificato con la proprietà 'projectId'. 
                    Se non viene specificata una snapshot, per impostazione predefinita vengono incluse tutte le snapshot.
                    -->
                    < nome elemento= "snapshotId" type = "stringa " />
                    <!-- 
                    L'ID di definizione del processo di business selezionato nella definizione di avviso in formato stringa esterno 
                    (ad esempio, 25.c904b3b1-afc1-4698-bf5a-a20892c20275). Questo campo è facoltativo a meno che non sia impostata la proprietà 'bpdDisplayName'. 
                    La definizione del processo di business specificata con questa proprietà deve essere correlata al progetto facoltativamente specificato 
                    nella proprietà 'projectId' e l'istantanea facoltativamente specificata con la proprietà 'snapshotId'. 
                    Se non viene specificata una definizione di processo di business, per impostazione predefinita vengono incluse tutte le definizioni di processo di business.
                    -->
                    < nome elemento= "bpdId" type = "string " />
                    <!-- 
                    Il nome di visualizzazione della definizione di processo di business selezionata nella definizione di avviso. 
                    Questo campo è facoltativo e non ha alcun impatto sulla valutazione della definizione di avviso. 
                    Questa proprietà e la proprietà 'bpdId' devono provenire dalla stessa definizione di processo di business. 
                    Viene impostata automaticamente quando è impostata la proprietà 'bpdId'.
                    -->
                    < element name= "bpdDisplayName" type="string " />
                    <!-- 
                    Lo stato di esecuzione dell'istanza selezionato nella definizione di avviso. 
                    I valori validi sono ACTIVE, COMPLETED, FAILED, TERMINATE e SUSPENDED.
                    Questo campo è facoltativo.
                    Se non è impostato, tutti gli stati di esecuzione dell'istanza vengono inclusi nella definizione di avviso per impostazione predefinita.
                    -->
                    < nome elemento= "instanceStatus" type = "string " />
                    <!-- 
                    Lo stato di esecuzione di attività selezionato nella definizione di avviso. 
                    I valori validi sono NEW, RECEIVED e CLOSED.
                    Questo campo è facoltativo.
                    Se non impostato, per impostazione predefinita tutti e tre gli stati di esecuzione dell'attività sono inclusi nella definizione di segnalazione.
                    Questo campo è applicabile solo per le definizioni di avviso di tipo TASK.
                    -->
                    < element name= "taskStatus" type = "string " />
                    <!-- 
                    L'operatore di soglia nella definizione di avviso.
                    I valori validi sono GREATER, EQUAL e LESS.
                    Questo campo è obbligatorio. 
                    -->
                    < element name= "thresholdOperator" type = "string " />
                    <!-- 
                    Il valore di soglia nella definizione di avviso.
                    I valori validi devono essere numerici e maggiori o uguali a zero.
                    Questo campo è obbligatorio.
                    -->
                    < nome elemento= "thresholdValue" type = "stringa " />
                < /sequenza>
            < /estensione>
        </complexContent>
    </complexType>
    
    <!-- 
        Un elenco di definizioni di avviso. 
    -->
    <complexType nome= "AlertDefinitions">
        <complexContent>
            < estensione base= " pref :Data">
                < sequenza>
                    < element name = "definitions "type="tns:AlertDefinition" minOccurs= "0 " maxOccurs= "unbounded" />
                < /sequenza>
            < /estensione>
        </complexContent>
    </complexType>
    
    <!-- 
     Questo tipo rappresenta uno stato di definizione di segnalazione che contiene informazioni sullo stato di runtime di una definizione di segnalazione.
    -->
    <complexType name= "AlertDefinitionStatus">
        <complexContent>
            < estensione base= " pref :Data"> 
                < sequenza>
                    <! -- La definizione di segnalazione -->
                    < element name = "definition "type="tns:AlertDefinition" />
                    <! -- Il valore effettivo al runtime per il valore di soglia impostato nella definizione di avviso -->
                    < element name= "actualValue" type = "string " />
                    <! -- Se la condizione della definizione di segnalazione è stata soddisfatta -->
                    < element name= "conditionMet" type = "boolean" />
                < /sequenza>
            < /estensione>
        </complexContent>
    </complexType>


    <!--
        Questo tipo descrive un'operazione non riuscita durante un'operazione di definizione di avviso di massa.
    -->
    <complexType nome= "FailedOperation">
        < sequenza>
            <! -- L'ID oggetto su cui l'operazione ha avuto esito negativo -->
            < element name= "objectId" type = "string " />

            <! -- Il prefisso del messaggio di errore associato all'errore -->
            < nome elemento= "errorNumber" type = "string " />

            <! -- Il messaggio di errore associato all'errore -->
            < nome elemento= "errorMessage" type = "string " />
        < /sequenza>
    </complexType>
    
    
    <!-- 
        Un elenco di operazioni non riuscite. 
    -->
    <complexType nome= "FailedOperations">
        <complexContent>
            < estensione base= " pref :Data">
                < sequenza>
                    < element name= "failedOperations" type="tns:FailedOperation" minOccurs=" 0 " maxOccurs=" unbounded " />
                < /sequenza>
            < /estensione>
        </complexContent>
    </complexType>
    
    
    <!--
         Questo tipo viene utilizzato per restituire i risultati dell'esecuzione di un'operazione di massa su più definizioni di avviso.
    -->
    <complexType name= "AlertDefinitionStatusResponse">
        <complexContent>
            < estensione base= " pref :Data">
                < sequenza>
                    <! -- Un elenco di zero o più operazioni non riuscite -->
                    < element name= "failedOperations" type="tns:FailedOperation" minOccurs=" 0 " maxOccurs=" unbounded " />

                    <! -- Un elenco di zero o più oggetti che contengono lo stato della definizione di segnalazione. -->
                    < element name= "alertDefinitionStatus" type="tns:AlertDefinitionStatus " minOccurs= "0" maxOccurs= "unbounded " />
                < /sequenza>
            < /estensione>
        </complexContent>
    </complexType>
    
< /schema>
Contenuto di esempio
< data xmlns: xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:ns8="http://rest.bpm.ibm.com/v1/data/alertDefinition" xsi:type = "ns8:AlertDefinitions">
    < definizioni>
        <id>2040.1052</id>
        <displayName> Istanze attive < /displayName>
        < categoria> ISTANZA < /categoria>
        <instanceStatus> ATTIVO < /instanceStatus>
        <thresholdOperator> MAGGIORE < /thresholdOperator>
        <thresholdValue>100</thresholdValue>
    < /definizioni>
    < definizioni>
        <id>2040.1053</id>
        <displayName> Istanze completate nel progetto < /displayName>
        < categoria> ISTANZA < /categoria>
        <projectId>2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0</projectId>
        <instanceStatus> COMPLETATO < /instanceStatus>
        <thresholdOperator> EQUAL < /thresholdOperator>
        <thresholdValue>100</thresholdValue>
    < /definizioni>
    < definizioni>
        <id>2040.1054</id>
        <displayName> Attività generali < /displayName>
        < categoria> TASK < /categoria>
        <thresholdOperator> EQUAL < /thresholdOperator>
        <thresholdValue>0</thresholdValue>
    < /definizioni>
    < definizioni>
        <id>2040.1055</id>
        <displayName> Attività chiuse in istanze attive di bpd in snapshot e progetto < /displayName>
        < categoria> TASK < /categoria>
        <projectId>2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0</projectId>
        <snapshotId>2064.d841529d-5d60-4905-9b8e-1361901380bd</snapshotId>
        <bpdId>25.c904b3b1-afc1-4698-bf5a-a20892c20275</bpdId>
        <bpdDisplayName> Standard HR Apri nuova posizione < /bpdDisplayName>
        <instanceStatus> ATTIVO < /instanceStatus>
        <taskStatus> CHIUSO < /taskStatus>
        <thresholdOperator> MAGGIORE < /thresholdOperator>
        <thresholdValue>100</thresholdValue>
    < /definizioni>
< /dati>

Tipo MIME: application / x - javascript

Contenuto della risposta

L'elenco di definizioni di avviso (AlertDefinitions complexType) interessate dall'operazione di salvataggio.

Il tipo di contenuto predefinito èapplication/json.

Tipo MIME: application / json


Schema
{
   "title": "Definizioni di avviso",
   "description": "L'elenco delle definizioni di avviso.",
   "type": "oggetto",
   "proprietà": {
      "definizioni": {
         "type": "array",
         "proprietà": {
            "id": {
               "type": "stringa",
               "description": " L'ID della definizione di segnalazione. Questo campo è facoltativo. Quando non impostato, viene creata una nuova definizione di avviso al salvataggio. ",
               "richiesto" :false
            },
            "displayName":{
               "type": "stringa",
               "description": " Il nome di visualizzazione della definizione di segnalazione. Questo campo è obbligatorio. ",
               "richiesto" :true
            },
            "categoria": {
               "type": "stringa",
               "description": " La categoria della definizione di segnalazione. I valori validi sono: INSTANCE e TASK. Questo campo è obbligatorio. ",
               "enumerazione": [
                  "ISTANZA",
                  "ATTIVITÀ"
               ],
               "richiesto" :true
            },
            "projectId":{
               "type": "stringa",
               "description": " L'ID di applicazione del processo selezionato nella definizione di avviso in formato stringa esterna (ad esempio 2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0). Questo campo è facoltativo. Verrà impostato automaticamente quando sono impostate le proprietà 'snapshotId' o 'bpdId'. Se non si specifica un progetto, per impostazione predefinita tutti i progetti vengono inclusi nella definizione di segnalazione. ",
               "richiesto" :false
            },
            "snapshotId":{
               "type": "stringa",
               "description": " l'ID istantanea selezionato nella definizione di avviso in formato stringa esterna (ad esempio 2064.aaa569e9-a57a-4684-b357-34237e4e49ea). Questo campo è facoltativo. La snapshot specificata con questa proprietà deve essere correlata al progetto facoltativamente specificato con la proprietà 'projectId'. Se non viene specificata un'istantanea, tutte le istantanee sono incluse per impostazione predefinita. ",
               "richiesto" :false
            },
            "bpdId":{
               "type": "stringa",
               "description": " L'ID definizione di processo di business selezionato nella definizione di avviso in formato stringa esterna (ad esempio 25.c904b3b1-afc1-4698-bf5a-a20892c20275). Questo campo è facoltativo a meno che non sia impostata la proprietà 'bpdDisplayName'. La definizione di processo di business specificata con questa proprietà deve essere correlata al progetto facoltativamente specificato nella proprietà 'projectId' e alla snapshot specificata con la proprietà 'snapshotId'. Se non viene specificata una definizione di processo di business, tutte le definizioni di processo di business vengono incluse per impostazione predefinita. ",
               "richiesto" :false
            },
            "NomebpdDisplay": {
               "type": "stringa",
               "description": " Il nome di visualizzazione della definizione del processo di business selezionato nella definizione di segnalazione. Questo campo è facoltativo e non ha alcun impatto sulla valutazione della definizione di avviso. Questa proprietà e la proprietà 'bpdId' devono provenire dalla stessa definizione di processo di business. Viene impostato automaticamente quando la proprietà 'bpdId' è impostata. ",
               "richiesto" :false
            },
            "instanceStatus":{
               "type": "stringa",
               "description": " Lo stato di esecuzione istanza selezionato nella definizione di avviso. I valori validi sono ACTIVE, COMPLETED, FAILED, TERMINATE e SUSPENDED. Questo campo è facoltativo. Se non è impostato, la definizione di segnalazione è destinata a tutti gli stati di esecuzione dell'istanza. ",
               "enumerazione": [
                  "ATTIVO",
                  "COMPLETATO",
                  "NON RIUSCITO",
                  "TERMINATO",
                  "SOSPESO"
               ],
               "richiesto" :false
            },
            "taskStatus":{
               "type": "stringa",
               "description": " Lo stato di esecuzione attività selezionato nella definizione di avviso. I valori validi sono NEW, RECEIVED e CLOSED. Questo campo è facoltativo. Se non è impostato, la definizione di avviso indica tutti e tre gli stati di esecuzione dell'attività. Questo campo è applicabile solo per le definizioni di avviso di tipo TASK. ",
               "enumerazione": [
                  "NUOVO",
                  "RICEVUTO",
                  "CHIUSO"
               ],
               "richiesto" :false
            },
            "thresholdOperator":{
               "type": "stringa",
               "description": " L'operatore soglia nella definizione di avviso. I valori validi sono GREATER, EQUAL e LESS. Questo campo è obbligatorio. ",
               "enumerazione": [
                  "MAGGIORE",
                  "EQUAL",
                  "LESS"
               ],
               "richiesto" :true
            },
            "thresholdValue":{
               "type": "stringa",
               "description": " Il valore di soglia nella definizione di avviso. I valori validi devono essere numerici e maggiori o uguali a zero. Questo campo è obbligatorio. ",
               "richiesto" :true
            }
         }
      }
   }
}
Contenuto di esempio
{
   "stato": "200",
   "dati":
   {
       "definizioni":
       [
           {
               "id": "2040.1006",
               "displayName": "Istanze attive",
               "categoria": "ISTANZA",
               "instanceStatus": "ATTIVO",
               "thresholdOperator": "MAGGIORE",
               "thresholdValue": "100"
           },
           {
               "id":2040.1007",
               "displayName": "Istanze completate nel progetto",
               "categoria": "ISTANZA",
               "projectId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0",
               "instanceStatus": "COMPLETATO",
               "thresholdOperator": "EQUAL",
               "thresholdValue": "100"
           },
           {
               "id": "2040.1008",
               "displayName": "Attività generali",
               "categoria": "TASK",
               "thresholdOperator": "EQUAL",
               "thresholdValue": "0"
           },
           {
               "id": "2040.1009",
               "displayName": "Attività chiuse in istanze attive di bpd in snapshot e progetto",
               "categoria": "TASK",
               "projectId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0",
               "snapshotId": "2064.d841529d-5d60-4905-9b8e-1361901380bd",
               "bpdId": "25.c904b3b1-afc1-4698-bf5a-a20892c20275",
               "bpdDisplayName": "Standard HR Apri nuova posizione",
               "instanceStatus": "ATTIVO",
               "taskStatus": "CHIUSO",
               "thresholdOperator": "MAGGIORE",
               "thresholdValue": "100"
           }
       ]
   }
}

Tipo MIME: application / xml


Schema
<?xml version="1.0" encoding="UTF-8"?>
< schema targetNamespace= "http://rest.bpm.ibm.com/v1/data/alertDefinition"
        elementFormDefault= "non qualificato" xmlns= "http://www.w3.org/2001/XMLSchema"
        xmlns:tns = "http://rest.bpm.ibm.com/v1/data/alertDefinition"
        xmlns:pref = "http://rest.bpm.ibm.com/v1/data/root"
        xmlns:common = "http://rest.bpm.ibm.com/v1/data/common">

    < import schemaLocation= "BPMRestData.xsd="http://rest.bpm.ibm.com/v1/data/root" />
    < import schemaLocation= "Common.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/common" />


    <!-- 
     Questo tipo rappresenta una definizione di avviso definita per l'installazione di IBM BPM .
    -->
    <complexType nome= "AlertDefinition">
        <complexContent>
            < estensione base= " pref :Data"> 
                < sequenza>
                    <!-- 
                    L'ID della definizione di avviso.
                    Questo campo è facoltativo.
                    Quando non è impostato, al salvataggio viene creata una nuova definizione di avviso.
                    -->
                    < nome elemento = "ID" tipo = "stringa " />
                    <!-- 
                    Il nome di visualizzazione della definizione di avviso. 
                    Questo campo è obbligatorio. 
                    -->
                    < nome elemento= "displayName" type = "string " />
                    <!-- 
                    La categoria della definizione di avviso. 
                    I valori validi sono INSTANCE e TASK. 
                    Questo campo è obbligatorio. 
                    -->
                    < nome elemento = "categoria" tipo = "stringa " />
                    <!-- 
                    L'ID dell'applicazione del processo selezionato nella definizione di avviso in formato stringa esterno 
                    (ad esempio 2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0). Questo campo è facoltativo. 
                    Verrà impostato automaticamente quando sono impostate le proprietà 'snapshotId' o 'bpdId'. 
                    Se non viene specificato un progetto, per impostazione predefinita tutti i progetti vengono inclusi nella definizione di avviso.
                    -->
                    < element name= "projectId" type = "string " />
                    <!-- 
                    L'ID istantanea selezionato nella definizione di avviso in formato stringa esterna 
                    (ad esempio 2064.aaa569e9-a57a-4684-b357-34237e4e49ea). Questo campo è facoltativo. 
                    La snapshot specificata con questa proprietà deve essere correlata al progetto facoltativamente specificato con la proprietà 'projectId'. 
                    Se non viene specificata una snapshot, per impostazione predefinita vengono incluse tutte le snapshot.
                    -->
                    < nome elemento= "snapshotId" type = "stringa " />
                    <!-- 
                    L'ID di definizione del processo di business selezionato nella definizione di avviso in formato stringa esterno 
                    (ad esempio, 25.c904b3b1-afc1-4698-bf5a-a20892c20275). Questo campo è facoltativo a meno che non sia impostata la proprietà 'bpdDisplayName'. 
                    La definizione del processo di business specificata con questa proprietà deve essere correlata al progetto facoltativamente specificato 
                    nella proprietà 'projectId' e l'istantanea facoltativamente specificata con la proprietà 'snapshotId'. 
                    Se non viene specificata una definizione di processo di business, per impostazione predefinita vengono incluse tutte le definizioni di processo di business.
                    -->
                    < nome elemento= "bpdId" type = "string " />
                    <!-- 
                    Il nome di visualizzazione della definizione di processo di business selezionata nella definizione di avviso. 
                    Questo campo è facoltativo e non ha alcun impatto sulla valutazione della definizione di avviso. 
                    Questa proprietà e la proprietà 'bpdId' devono provenire dalla stessa definizione di processo di business. 
                    Viene impostata automaticamente quando è impostata la proprietà 'bpdId'.
                    -->
                    < element name= "bpdDisplayName" type="string " />
                    <!-- 
                    Lo stato di esecuzione dell'istanza selezionato nella definizione di avviso. 
                    I valori validi sono ACTIVE, COMPLETED, FAILED, TERMINATE e SUSPENDED.
                    Questo campo è facoltativo.
                    Se non è impostato, tutti gli stati di esecuzione dell'istanza vengono inclusi nella definizione di avviso per impostazione predefinita.
                    -->
                    < nome elemento= "instanceStatus" type = "string " />
                    <!-- 
                    Lo stato di esecuzione di attività selezionato nella definizione di avviso. 
                    I valori validi sono NEW, RECEIVED e CLOSED.
                    Questo campo è facoltativo.
                    Se non impostato, per impostazione predefinita tutti e tre gli stati di esecuzione dell'attività sono inclusi nella definizione di segnalazione.
                    Questo campo è applicabile solo per le definizioni di avviso di tipo TASK.
                    -->
                    < element name= "taskStatus" type = "string " />
                    <!-- 
                    L'operatore di soglia nella definizione di avviso.
                    I valori validi sono GREATER, EQUAL e LESS.
                    Questo campo è obbligatorio. 
                    -->
                    < element name= "thresholdOperator" type = "string " />
                    <!-- 
                    Il valore di soglia nella definizione di avviso.
                    I valori validi devono essere numerici e maggiori o uguali a zero.
                    Questo campo è obbligatorio.
                    -->
                    < nome elemento= "thresholdValue" type = "stringa " />
                < /sequenza>
            < /estensione>
        </complexContent>
    </complexType>
    
    <!-- 
        Un elenco di definizioni di avviso. 
    -->
    <complexType nome= "AlertDefinitions">
        <complexContent>
            < estensione base= " pref :Data">
                < sequenza>
                    < element name = "definitions "type="tns:AlertDefinition" minOccurs= "0 " maxOccurs= "unbounded" />
                < /sequenza>
            < /estensione>
        </complexContent>
    </complexType>
    
    <!-- 
     Questo tipo rappresenta uno stato di definizione di segnalazione che contiene informazioni sullo stato di runtime di una definizione di segnalazione.
    -->
    <complexType name= "AlertDefinitionStatus">
        <complexContent>
            < estensione base= " pref :Data"> 
                < sequenza>
                    <! -- La definizione di segnalazione -->
                    < element name = "definition "type="tns:AlertDefinition" />
                    <! -- Il valore effettivo al runtime per il valore di soglia impostato nella definizione di avviso -->
                    < element name= "actualValue" type = "string " />
                    <! -- Se la condizione della definizione di segnalazione è stata soddisfatta -->
                    < element name= "conditionMet" type = "boolean" />
                < /sequenza>
            < /estensione>
        </complexContent>
    </complexType>


    <!--
        Questo tipo descrive un'operazione non riuscita durante un'operazione di definizione di avviso di massa.
    -->
    <complexType nome= "FailedOperation">
        < sequenza>
            <! -- L'ID oggetto su cui l'operazione ha avuto esito negativo -->
            < element name= "objectId" type = "string " />

            <! -- Il prefisso del messaggio di errore associato all'errore -->
            < nome elemento= "errorNumber" type = "string " />

            <! -- Il messaggio di errore associato all'errore -->
            < nome elemento= "errorMessage" type = "string " />
        < /sequenza>
    </complexType>
    
    
    <!-- 
        Un elenco di operazioni non riuscite. 
    -->
    <complexType nome= "FailedOperations">
        <complexContent>
            < estensione base= " pref :Data">
                < sequenza>
                    < element name= "failedOperations" type="tns:FailedOperation" minOccurs=" 0 " maxOccurs=" unbounded " />
                < /sequenza>
            < /estensione>
        </complexContent>
    </complexType>
    
    
    <!--
         Questo tipo viene utilizzato per restituire i risultati dell'esecuzione di un'operazione di massa su più definizioni di avviso.
    -->
    <complexType name= "AlertDefinitionStatusResponse">
        <complexContent>
            < estensione base= " pref :Data">
                < sequenza>
                    <! -- Un elenco di zero o più operazioni non riuscite -->
                    < element name= "failedOperations" type="tns:FailedOperation" minOccurs=" 0 " maxOccurs=" unbounded " />

                    <! -- Un elenco di zero o più oggetti che contengono lo stato della definizione di segnalazione. -->
                    < element name= "alertDefinitionStatus" type="tns:AlertDefinitionStatus " minOccurs= "0" maxOccurs= "unbounded " />
                < /sequenza>
            < /estensione>
        </complexContent>
    </complexType>
    
< /schema>
Contenuto di esempio
< ?xml version= "1.0" encoding= "UTF-8" standalone="yes " ?>
< bpm:ResponseData xmlns:bpm = "http://rest.bpm.ibm.com/v1/data" xmlns:ex = "http://rest.bpm.ibm.com/v1/data/exception" xmlns:soc = "http://rest.bpm.ibm.com/v1/data/social" xmlns:sys = "http://rest.bpm.ibm.com/v1/data/system" xmlns:ug = "http://rest.bpm.ibm.com/v1/data/usergroup">
    <status>200</status>
    < data xmlns: xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:ns8="http://rest.bpm.ibm.com/v1/data/alertDefinition" xsi:type = "ns8:AlertDefinitions">
        < definizioni>
            <id>2040.1052</id>
            <displayName> Istanze attive < /displayName>
            < categoria> ISTANZA < /categoria>
            <instanceStatus> ATTIVO < /instanceStatus>
            <thresholdOperator> MAGGIORE < /thresholdOperator>
            <thresholdValue>100</thresholdValue>
        < /definizioni>
        < definizioni>
            <id>2040.1053</id>
            <displayName> Istanze completate nel progetto < /displayName>
            < categoria> ISTANZA < /categoria>
            <projectId>2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0</projectId>
            <instanceStatus> COMPLETATO < /instanceStatus>
            <thresholdOperator> EQUAL < /thresholdOperator>
            <thresholdValue>100</thresholdValue>
        < /definizioni>
        < definizioni>
            <id>2040.1054</id>
            <displayName> Attività generali < /displayName>
            < categoria> TASK < /categoria>
            <thresholdOperator> EQUAL < /thresholdOperator>
            <thresholdValue>0</thresholdValue>
        < /definizioni>
        < definizioni>
            <id>2040.1055</id>
            <displayName> Attività chiuse in istanze attive di bpd in snapshot e progetto < /displayName>
            < categoria> TASK < /categoria>
            <projectId>2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0</projectId>
            <snapshotId>2064.d841529d-5d60-4905-9b8e-1361901380bd</snapshotId>
            <bpdId>25.c904b3b1-afc1-4698-bf5a-a20892c20275</bpdId>
            <bpdDisplayName> Standard HR Apri nuova posizione < /bpdDisplayName>
            <instanceStatus> ATTIVO < /instanceStatus>
            <taskStatus> CHIUSO < /taskStatus>
            <thresholdOperator> MAGGIORE < /thresholdOperator>
            <thresholdValue>100</thresholdValue>
        < /definizioni>
    < /dati>
< /bpm:ResponseData>

Tipo MIME: application / x - javascript

Contenuto risposta errore

Informazioni dettagliate sull'errore.

Il tipo di contenuto predefinito èapplication/json.

Tipo MIME: application / json


Schema
{"description": "Risposta errore WLE", 
   "type": "oggetto",
   "proprietà":
   {"stato": {"tipo": "stringa",
         "description": "Lo stato della chiamata API precedente."
      },
      "exceptionType": {"tipo": "stringa",
         "description": "Il nome classe associato all'eccezione."
      },
      "errorNumber": {"tipo": "stringa",
         "description": "ID messaggio dell'eccezione."
      },
      "errorMessage": {"tipo": "stringa",
         "description": "Testo del messaggio dell'eccezione."
      },
      "errorMessageParametri": {"type": [ "string"], "optional": true,
         "description": "Parametri di testo del messaggio dell'eccezione."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description": "Ulteriori dettagli dell'eccezione, ad esempio, una traccia di stack."
      }
   }
} 

Tipo MIME: application / xml


Schema
<?xml version="1.0" encoding="UTF-8"?>
< schema targetNamespace= "http://rest.bpm.ibm.com/v1/data/exception"
	elementFormDefault= "non qualificato" xmlns= "http://www.w3.org/2001/XMLSchema"
	xmlns:tns = "http://rest.bpm.ibm.com/v1/data/exception"
	xmlns:dat = "http://rest.bpm.ibm.com/v1/data/root">

    < import schemaLocation= "BPMRestData.xsd="http://rest.bpm.ibm.com/v1/data/root" />
    
    <!--
	Questo tipo rappresenta una risposta di errore.
    -->    
    < element name= "RestRuntimeException">
	<complexType>
	    < sequenza>
		< element name = "status "type="string" />
		< element name="Data " type="tns:ExceptionData">
    		< /elemento>
	    < /sequenza>
	</complexType>
    < /elemento>

    <!-- 
	 Questo tipo contiene informazioni dettagliate sull'errore associate ad un'eccezione.
    -->
    <complexType nome= "ExceptionData">
	< sequenza>
	    < element name = "status "type="string" />

	    <! -- Specifica il nome della classe java dell'eccezione -->
	    < element name= "exceptionType" type="string " />

	    <! -- L'ID messaggio del messaggio di errore -->
	    < element name= "errorNumber" type="string " minOccurs= "0" />

	    <! -- Messaggio di errore completo -->
	    < element name= "errorMessage" type="string " />

	    <! -- L'elenco di stringhe inserite nel messaggio di errore -->
	    < element name= "errorMessageParameters" type="string " minOccurs=" 0 " maxOccurs= "unbounded" />

	    <!-- 
		 La traccia di stack associata all'eccezione.
		 Notare che questo verrà omesso a meno che la proprietà "server - stacktrace - enabled"
		 è abilitato nel file 100Custom.xml del server.
	    -->     
	    < element name= "programmersDetails" type="string"> < /element>
	    
	    <! -- Risposte precedenti.  Impostare se è stato utilizzato un comando di massa -->
	    < element name = "responses "type="dat:BulkCommandResponses" minOccurs= "0"> < /element>

            < element name= "errorData" type="tns:ErrorData" minOccurs= "0" />
	< /sequenza>
    </complexType>

    <complexType nome= "ErrorData">
        < sequenza>
            < nome elemento = "codice" tipo = "stringa " />
            < element name = "data "type="string" minOccurs= "0 " />
        < /sequenza>
    </complexType>
    
< /schema>

Tipo MIME: application / x - javascript

Codici di stato

Il metodo restituisce uno dei seguenti codici di stato:
CodiceDescrizione
200 OK
Completamento riuscito.
400 Richiesta non valida
Richiesta non valida
403 Accesso negato
Il chiamante non è autorizzato ad effettuare questa operazione.
406 Non accettabileIl tipo di contenuto o la codifica del contenuto richiesti non sono supportati.
415 Tipo di supporto non supportatoIl tipo di contenuto o la codifica del contenuto della richiesta non è supportato.
Errore interno del server 500
Errore server interno. Vedere i dettagli forniti.

Disponibile da

8.5.6.0

Argomento principale: Risorsa definizioni di avviso