ProcessData

Utilice este recurso para recuperar detalles del proceso, como hitos, actividades y propiedades de actividad.

Resumen del método

Método HTTP	Vía de acceso	Descripción
GET	/scr/api/ProcessData	Recupera detalles acerca de un proceso.

GET/scr/api/ProcessData

Descripción: Utilice este método para recuperar detalles del proceso, como hitos, actividades y propiedades de actividad.

Información de recursos

Requisitos	Descripción
Formato de la respuesta	JSON
Requiere autenticación	Sí. El usuario debe tener al menos acceso de participante al proceso.
Permite credenciales de cliente de OAuth 2	Sí, utilizando un ID de servicio de usuario que contiene la categoría de creación de informes de artefactos
Velocidad limitada	Aún no

Parámetros

Nombre	Ubicación	Descripción	Obligatorio	Tipo
X-On-Behalf-Of	Cabecera	El contexto de usuario. El valor debe ser un nombre de usuario en la cuenta. El usuario debe tener permiso para realizar la acción en la cuenta y en el espacio padre especificado, si lo hay.	Necesario si se utilizan credenciales OAuth de ID de servicio. No es necesario cuando se utiliza la credencial OAuth de ID de servicio de usuario.	Serie
processId	Consulta	ID del proceso para recuperar.	Sí	Serie

Respuesta

Los datos se devuelven como una correlación de elementos. Cada elemento de una cuenta tiene un ID exclusivo; los valores de ID enlazan todos los elementos de la cuenta juntos.

Entrada de ejemplo

Utilizando las credenciales de cliente OAuth 2:

curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/ProcessData?processId=100005"

Resultado de ejemplo

{
  "processId":"100005",
  "accessControl":{
    "isAuthor":"true"
  },  
   "items":{  
      "5f500e10929de":{  
         "positionFlowsRight":"false",
         "participants":"3d9200f4",
         "majorType":"activity",
         "textAnnotation": "5d1f04",
         "uiTaskIncludeAttach":"false",
         "uiTaskIncludeDoc":"false",
         "name":"Generate Conterct Document",
         "itemType":"ACTIVITY"
      },
      "5f500e110054b":{  
         "name":"myProb",
         "itemType":"PROBLEM"
      },
      "5f500e1092907":{ 
         "attachedEvents": [
            {
               "val": "5f500e57b6202"
            },
            {
               "val": "5f500e57b6206"
            },
            {
               "val": "5f500e57b620a"
            }
         ],  
         "businessOwners":[  
            {  
               "val":"5f500e1100507"
            }
         ],
         "activityDecisionDiagram":"5f500e109293d",
         "experts":[  
            {  
               "val":"5f500e110050f"
            }
         ],
         "uiTaskIncludeDoc":"false",
         "name":"Prequalify Vehicle",
         "cost":"10.00",
         "risk":"1",
         "outputs":[  
            {  
               "val":"3d92069b"
            }
         ],
         "majorType":"activity",
         "uiTaskIncludeAttach":"false",
         "customers":[  
            {  
               "val":"5f500e107002f"
            }
         ],
         "ruleType":"ruleDecision",
         "participants":"3d9200ee",
         "positionFlowsRight":"false",
         "waitTime":".64532m",
         "fileItems":[  
            {  
               "val":"5f500e11000fd",
               "fileItemId":"5f500e11000fb"
            }
         ],
         "systems":[  
            {  
               "val":"5f500e1100517"
            }
         ],
         "suppliers":[  
            {  
               "val":"5f500e1070032"
            }
         ],
         "inputs":[  
            {  
               "val":"3d920697"
            }
         ],
         "itemType":"ACTIVITY",
         "valueAdd":"3",
         "comments":[  
            {  
               "val":"5f500e1100574"
            }
         ],
         "problems":[  
            {  
               "val":"5f500e110054b",
               "frequency":"9",
               "severity":"9"
            },
            {  
               "val":"5f500e110055e"
            },
            {  
               "val":"5f500e1100563",
               "frequency":"3",
               "severity":"3"
            }
         ],
         "workTime":"20h",
         "activityPolicies":[  
            {  
               "val":"3d920015"
            }
         ]
      },
      "3d920015":{  
         "policyAbrvDesc":"This policy describes the special considerations for handling relocations of military families. Unlike other policyholders, military personnel and their families are often allowed to keep their insurance when moving out of the area.",
         "name":"Legal Handling of Military Family Moves out of State",
         "itemType":"POLICY",
         "itemParent":"3d920002"
      },
      "5f500e1092598":{  
         "name":"Validate Vehicle",
         "itemType":"DECISION_DIAGRAM",
         "itemParent":"5f500e10900d3"
      },
      "5f500e10928e2":{  
         "playbackPath":[  
            {  
               "val":"5f500e10928fd"
            }
         ],
         "playbackParent":"5f500e10928e0",
         "name":"Test Playback",
         "itemType":"PLAYBACK"
      },
      "5f500e1081072":{  
         "name":"Alternate Start Event",
         "itemType":"PROJECT"
      },
      "5f500e1100576":{  
         "isRead":"true",
         "createdByUserId":"7f0002",
         "createdDate":"1427234810125",
         "createdByName":"admin",
         "name":"reply",
         "itemType":"COMMENT",
         "ownerId":"5f500e10900d2"
      },
      "3d92069b":{  
         "name":"Activity Output 1",
         "itemType":"INPUTOUTPUT"
      },
      "5f500e11000fd":{  
         "itemType":"FILEITEM"
      },
      "5f500e10928f4":{  
         "positionFlowsRight":"false",
         "majorType":"milestone",
         "uiTaskIncludeAttach":"false",
         "uiTaskIncludeDoc":"false",
         "name":"Make final decisions",
         "itemType":"ACTIVITY",
         "activities":[  
            {  
               "val":"5f500e109297f"
            },
            {  
               "val":"5f500e1092981"
            },
            {  
               "val":"5f500e1092983"
            },
            {  
               "val":"5f500e1092985"
            }
         ]
      },
      "5f500e107002f":{  
         "name":"Activity Customer Search API",
         "itemType":"SUPPLIERCUSTOMER"
      },
      "5f500e109292e":{  
         "itemType":"FILEITEM"
      },
      "files":{  
      "5f500e11000fb":{  
         "size":"3.0",
         "deleted":false,
         "type":"9",
         "name":"bar.txt"
      }
   }
   "5d1f04": {
      "association": "5d1f06",
      "itemType": "TEXT_ANNOTATION",
      "name": "Activity text Annotation"
   },
   "5d1f06": {
      "associationFrom": "5d00c9",
      "associationTo": "5d1f04",
      "itemType": "ASSOCIATION",
      "name": ""
   },
   "5d1f0a": {
      "itemType": "TEXT_ANNOTATION",
      "name": "Process text annotation",
      "textAnnotationLaneId": "default_lane",
      "textAnnotationPosition": "2-3"
   }
   "5f500e57b6202": {
      "attachedEventPort": "2-4",
      "isPinned": "false",
      "itemType": "ACTIVITY",
      "majorType": "intermediateEventAttached",
      "name": "Message",
      "positionFlowsRight": "false",
      "uiTaskIncludeAttach": "false",
      "uiTaskIncludeDoc": "false"
   },
   "5f500e57b6206": {
      "attachedEventPort": "2-0",
      "isPinned": "false",
      "itemType": "ACTIVITY",
      "majorType": "intermediateEventAttached",
      "name": "Timer",
      "positionFlowsRight": "false",
      "uiTaskIncludeAttach": "false",
      "uiTaskIncludeDoc": "false"
   },
   "5f500e57b620a": {
      "attachedEventPort": "1-2",
      "isPinned": "false",
      "itemType": "ACTIVITY",
      "majorType": "intermediateEventAttached",
      "name": "Error",
      "positionFlowsRight": "false",
      "uiTaskIncludeAttach": "false",
      "uiTaskIncludeDoc": "false"
   }
}

Propiedades de respuesta

accessControl

Propiedades de acceso que tiene el usuario solicitante para el proceso.

activities

Matriz que contiene los ID de subactividades de una actividad. Para la actividad raíz, las subactividades son hitos.

attachedEvents

Matriz que contiene los ID de sucesos adjuntos de una actividad.

association

Asociación entre la actividad y la anotación para una anotación de texto enlazada.

associationFrom

ID de la actividad que contiene la anotación de texto.

associationTo

ID de la anotación de texto.

businessOwners

Matriz que contiene los ID de los propietarios de negocios que están enlazados con la actividad. Cada entrada de la matriz es un objeto con una única propiedad val que contiene el ID del elemento ACTOR del propietario del negocio.

childComments

Matriz que contiene los ID de las respuestas al comentario. Cada entrada de la matriz es un objeto con una única propiedad val que contiene el ID del elemento COMMENT.

comments

Matriz que contiene los ID de los comentarios que están enlazados con la actividad. Cada entrada de la matriz es un objeto con una única propiedad val que contiene el ID del elemento COMMENT.

cost

Número que representa el coste.

createdByName

Nombre del usuario que ha creado el comentario.

createdByUserId

ID del usuario que ha creado el comentario.

createdDate

Valor en milisegundos que representa cuando se ha creado el comentario.

customers

matriz que contiene los ID de los clientes asociados a la actividad. Cada entrada de la matriz es un objeto con una única propiedad val que contiene el ID del elemento SUPPLIERCUSTOMER.

cycleTime

Valor de tiempo de ciclo que se expresa con un número seguido por un marcador de unidad de carácter.

Marcador de unidad de carácter	Descripción
`m`	minutos
`h`	horas
`d`	días
`w`	semanas
`M`	meses

deleted

Indicación de si se han suprimido los datos del archivo. Los valores posibles son true o false.

diagram

ID del diagrama, si el proceso tiene uno. El elemento diagram propiamente dicho no está presente en los datos.

experts

Matriz con los ID de los expertos que están enlazados con la actividad. Cada entrada de la matriz es un objeto con una única propiedad val que contiene el ID del elemento ACTOR experto.

files

La correlación files. key es el ID del archivo y value es el objeto con las propiedades del archivo.

fileItemId

ID del archivo en la correlación files. Esta propiedad se puede utilizar con FileDownload para descargar contenido del archivo.

fileItems

Matriz con los ID de los elementos de archivo que están enlazados con la actividad. Cada entrada es un objeto con una propiedad val que contiene el ID del elemento fileItem y la propiedad fileItemId que contiene el ID de una entrada en la correlación files. La entrada de la correlación files contiene la información sobre el archivo.

frequency

Frecuencia con la que se produce un problema. Los valores están clasificados de la siguiente manera:

Menos de 3 es Baja
Menos de 9 y más de 3 es Media
9 o más es Alta

IBM Blueworks Live establece los valores de la forma siguiente:

1 para Baja
3 para Media
9 para Alta

hideOnMap

Indica si el usuario ha elegido ocultar el elemento de la vista de mapa en Blueworks Live.

inputs

Matriz con los ID de las entradas que están enlazadas con la actividad. Cada entrada de la matriz es un objeto con una única propiedad val que contiene el ID del elemento INPUTOUTPUT.

isAuthor

Esta propiedad booleana de control de accesos indica si el usuario que realiza la solicitud tiene acceso de autor al proceso.

isRead

El valor de true se establece si se ha leído el comentario.

items

La correlación items que tiene una entrada para cada elemento. key es el ID de elemento y value es el objeto con las propiedades del elemento.

itemType

El tipo de elemento.

El valor del tipo de elemento	Descripción	Propiedades del tipo de elemento
`ACTIVITY`	Cualquier elemento, incluidos los hitos, es una actividad de la correlación o el diagrama.	La propiedad `majorType` distingue entre diferentes `subtypes` de una actividad.
`ACTOR`	Una persona o un rol. Se utilizan actores para participantes, propietarios de negocios y expertos.	`itemType` y `Name`
`COMMENT`	Un comentario	La propiedad `name` del comentario es el texto del comentario.
`FILEITEM`	Un archivo	Sin propiedades. La información sobre el archivo está en la correlación `files`. Consulte la documentación de la propiedad `fileItems`.
`INPUTOUTPUT`	Algo que se puede utilizar como entrada o salida.	`itemType` y `Name`
`PROBLEM`	Un problema	`itemType` y `Name`
`PROCESS`	Un proceso	`itemType` y `Name`
`PROJECT`	Un proyecto	`itemType` y `Name`
`SYSTEM`	Un sistema	`itemType` y `Name`
`SUPPLIERCUSTOMER`	Elemento que se puede utilizar como proveedor o cliente	`itemType` y `Name`
`TEXT_ANNOTATION`	Una anotación de texto	`itemType`, `Name`, `associationFrom`, `associationTo`

majorType

Tipo de actividad que representa el elemento. Esta propiedad sólo está presente para los elementos ACTIVITY.

Tipo de actividad	Descripción
`activity`	Actividad normal
`endEvent`	Suceso final en el diagrama
`gateway`	Pasarela en el diagrama
`intermediateEvent`	Suceso intermedio (por ejemplo, un suceso de mensaje, error o temporizador) en el diagrama
`intermediateEventAttached`	Suceso intermedio (por ejemplo, un suceso de mensaje, error o temporizador) adjunto a una actividad en el diagrama
`linkedprocess`	Enlazar a otro proceso
`milestone`	Objetivo
`startEvent`	Suceso inicial en el diagrama
`subprocess`	Subproceso

name

Nombre del elemento.

Para un elemento comment, el nombre es el texto de comentario real.
Para un elemento process, el nombre del proceso está en el nombre de la actividad raíz de la propiedad rootActivityId.

outputs

Matriz con los ID de las salidas que están enlazadas con la actividad. Cada entrada de la matriz es un objeto con una única propiedad val que contiene el ID del elemento INPUTOUTPUT.

participants

El valor es el ID de un único elemento ACTOR participante asociado a una actividad.

problems

La matriz de enlaces a elementos PROBLEM. Cada entrada de la matriz es un objeto con una propiedad val, que es el ID del elemento problem enlazado y las propiedades frequency y severity opcionales.

process

Propiedad de un comentario con el ID del proceso al que está asociado el comentario.

processId

El ID del proceso. La correlación items contiene una entrada para este ID.

project

La propiedad del elemento PROCESS con el ID del elemento PROJECT que representa el proyecto en el que se encuentra el proceso.

risk

Cantidad de riesgo que la actividad introduce en el proceso. El riesgo se representa con uno de los siguientes valores numéricos.

Valor de riesgo	Descripción
1	Controlado
2	Bajo
3	Medio
4	Alto

rootActivityID

ID de la actividad de nivel superior en el proceso. Esta propiedad no se visualiza en la correlación o el diagrama. Sus hijos son hitos.

severity

Gravedad de un problema. Los valores están clasificados de la siguiente manera:

Menos de 3 es Baja
Más de 3 y menos de 9 es Media
9 o más es Alta

Blueworks Live establece los valores de la forma siguiente:

1 para Baja
3 para Media
9 para Alta

size

Propiedad de un elemento de la matriz de archivos que contiene el tamaño del archivo, en bytes.

suppliers

Matriz que contiene los ID de los proveedores asociados a la actividad. Cada entrada de la matriz es un objeto con una única propiedad val que contiene el ID del elemento SUPPLIERCUSTOMER.

systems

La matriz de enlaces a elementos SYSTEM. Cada entrada de la matriz es un objeto con una única propiedad val que contiene el ID del elemento SYSTEM.

type

Propiedad del elemento de la matriz de archivos que define el tipo del archivo.

Valor de tipo	Descripción
1	Documento genérico. Se utiliza si el archivo no corresponde a ninguno de los otros valores.
2	Archivo de Microsoft Excel
3	Image
4	Documento PDF
5	Documento de Microsoft PowerPoint
6	Documento de Microsoft Project
7	Documento de Microsoft Visio
8	Documento de Microsoft Word

val

ID de otro elemento.

valueAdd

Uno de los valores numéricos siguientes que representa si la actividad añade valor al proceso.

Valor numérico	Descripción
1	Sí
2	Nee
3	Obligatorio

Mensajes de respuesta

Código HTTP	Razón
200	La solicitud se ha completado correctamente.
401	El usuario no está autorizado a realizar la petición.
403	El usuario no tiene acceso al proceso.