PostComment

Utilice este recurso para añadir un comentario a una actividad o para responder a un comentario existente.

Nota: La documentación de la API se ha migrado a IBM API Hub El enlace externo abre una nueva ventana o pestaña

. Encuentre las últimas actualizaciones y documentación sobre Blueworks Live API en API Hub.

Resumen del método

Método HTTP	Vía de acceso	Descripción
POST	/scr/api/PostComment	Añade un comentario a una actividad o responde a un comentario existente.

POST/scr/api/PostComment

Descripción: Utilice este método para añadir un comentario a una actividad o para responder a un comentario existente.
Utilice la WorkComment llamada para añadir comentarios a las instancias de trabajo.

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 que contiene la actividad a la que se añade un comentario.
Permite credenciales de cliente de OAuth 2	Sí utilizando un ID de servicio de usuario que contiene la categoría de creación 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 de ID de servicio OAuth. No es necesario cuando se utiliza la credencial de ID de servicio de usuario OAuth.	Serie
activityId	Consulta	ID de la actividad a la que se adjunta un comentario.	Sí	Serie
comment	Consulta	El texto del comentario.	Sí	Serie
parentCommentId	Consulta	ID del comentario al que responde el usuario con un nuevo comentario.	Sí, si el usuario publica un comentario.	Serie
processId	Consulta	ID del proceso que contiene la actividad a la que se adjunta un comentario.	Sí	Serie

Respuesta

Entrada de ejemplo

Publicar un comentario asdf a la actividad con el ID 800c4 que se encuentra en el proceso con el ID 80012:

Uso de la ID de servicio de usuario OAuth 2 credenciales de cliente:

curl -i -H "Authorization: Bearer access_token" -H "Content-Type:application/json" 
    -X POST "https://your_server_url/scr/api/PostComment?processId=80012&activityId=800c4&comment=asdf"

Uso de la ID de servicio OAuth 2 credenciales de cliente:

curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com" -H "Content-Type:application/json" 
    -X POST "https://your_server_url/scr/api/PostComment?processId=80012&activityId=800c4&comment=asdf"

Resultado de ejemplo

{           
      "commentId":"5f504e13c80d6"               
}

Propiedades de respuesta

commentId: ID del comentario que se acaba de crear.

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.
405	El método especificado no está permitido. Seleccione el método POST para esta solicitud.