¿Cómo utilizo la API de búsqueda?

Los ejemplos siguientes le ayudan a empezar a utilizar la API de búsqueda de IBM Blueworks Live .

Los ejemplos se basan en la siguiente jerarquía de espacio:

Grandparent Space
-Grandparent Process
-Parent Space
--Parent Process # linked to "Linked Process"
--Child Space
---Child Process
Linked Space
-Linked Process

Búsqueda de un espacio por el nombre

Al buscar un espacio, se devuelven todos los espacios hijo y todos los procesos en los espacios hijo. Si una actividad está enlazada a un proceso en otro espacio, el proceso enlazado se referencia, pero no se devuelve.

Por ejemplo, si busca mediante los parámetros siguientes:

searchValue=Grandparent Space
searchFieldName=space_name

Obtendrá los resultados siguientes:

{
 "spaces": [
   {
     "id": "2737002c",
     "name": "Grandparent Space",
     "processes": [
       {
         "id": "27370032",
         "milestones": [...], # Everything in the process is returned.
         "name": "Grandparent Process"
       }
     ]
   },
   {
     "id": "27260049",
     "name": "Parent Space",
     "parentSpaceId": "2737002c",
     "processes": [
       {
         "id": "2726004f",
         "milestones": [...],  # Everything in the process is returned. If an activity is linked to a process in another space, it has a "linkedProcessId" property.
         "name": "Parent Process"
       }
     ]
   },
   {
     "id": "27260002",
     "name": "Child Space",
     "parentSpaceId": "27260049",
     "processes": [
       {
         "id": "27260008",
         "milestones": [...],  # Everything in the process is returned.
         "name": "Child Process"
       }
     ]
   }
 ]
}

Si busca un espacio que no tiene espacios hijo, sólo se devuelven ese espacio y sus procesos. Por ejemplo, si busca mediante los parámetros siguientes:

searchValue=Child Space
searchFieldName=space_name

Obtendrá los resultados siguientes:

{
 "spaces": [
   {
     "id": "27260002",
     "name": "Child Space",
     "parentSpaceId": "27260049",
     "processes": [
       {
         "id": "27260008",
         "milestones": [...], # Everything in the process is returned.
         "name": "Child Process"
       }
     ]
   }
 ]
}

Buscando un proceso por el nombre

Al buscar un proceso, se devuelve el espacio padre directo.

Por ejemplo, si busca mediante los parámetros siguientes:

searchValue=Parent Process
searchFieldName=process_name

Obtendrá los resultados siguientes:

{
 "spaces": [
   {
     "id": "27260049",
     "name": "Parent Space",
     "processes": [
       {
         "id": "2726004f",
         "milestones": [...],  # Everything in the process is returned. If an activity is linked to a process in another space, it has a "linkedProcessId" property.
         "name": "Parent Process"
       }
     ]
   }
 ]
}

Si la búsqueda utilizando los parámetros siguientes:

searchValue=Grandparent Process
searchFieldName=process_name

Obtendrá los resultados siguientes:

{
 "spaces": [
   {
     "id": "2737002c",
     "name": "Grandparent Space",
     "processes": [
       {
         "id": "27370032",
         "milestones": [...],  # Everything in the process is returned.
         "name": "Grandparent Process"
       }
     ]
   }
 ]
}

Búsqueda de una propiedad

El ejemplo siguiente muestra una búsqueda de una propiedad, en este caso una entrada en un hito. Sólo se devuelve el hito de la actividad, con el proceso padre directo y el espacio padre directo.

Si la búsqueda utilizando los parámetros siguientes:

searchValue=Parent process input
searchFieldName=input

Obtendrá los resultados siguientes:

{
 "spaces": [
   {
     "id": "27260049",
     "name": "Parent Space",
     "processes": [
       {
         "id": "2726004f",
         "milestones": [
           {
             "business owners": [
               {
                 "id": "27373507",
                 "name": "parent process business owner"
               }
             ],
             "id": "27260053",
             "inputs": [
               {
                 "id": "27372d07",
                 "name": "Parent process input"
               }
             ],
             "name": "Milestone 1"
           }
         ],
         "name": "Parent Process"
       }
     ]
   }
 ]
}

El ejemplo siguiente muestra una búsqueda de una entrada en una actividad con un proceso enlazado. El proceso enlazado se referencia, pero no se devuelve.

Si la búsqueda utilizando los parámetros siguientes:

searchValue=Parent process input on linked activity
searchFieldName=input

Obtendrá los resultados siguientes:

{
 "spaces": [
   {
     "id": "27260049",
     "name": "Parent Space",
     "processes": [
       {
         "id": "2726004f",
         "milestones": [
           {
             "activities": [
               {
                 "business owners": [
                   {
                     "id": "27374202",
                     "name": "Parent process business owner on linked activity"
                   }
                 ],
                 "id": "27260057",
                 "inputs": [
                   {
                     "id": "27372d11",
                     "name": "Parent process input on linked activity"
                   }
                 ],
                 "linkedProcessId": "27370070",
                 "name": "Activity",
               }
             ],
             "id": "27260053",
             "name": "Milestone 1"
           }
         ],
         "name": "Parent Process"
       }
     ]
   }
 ]
}

Para consultar la documentación de la API, véase Búsqueda.