ActivityDocumentation
Utilice este recurso para recuperar documentación para una actividad.
Resumen del método
| Método HTTP | Vía de acceso | Descripción |
|---|---|---|
| GET | /scr/api/ActivityDocumentation | Recupera documentación para una actividad. |
GET/scr/api/ActivityDocumentation
- Descripción
- Utilice este método para recuperar documentación para una 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 que contiene la actividad para la que se recupera la documentación. 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 activityId Consulta ID de la actividad para la que se recupera la documentación. Sí Serie processId Consulta ID del proceso que contiene la actividad. Sí Serie
- Respuesta
- Entrada de ejemplo
- Utilizando credenciales de cliente OAuth 2 de ID de servicio de usuario:
curl -i -H "Authorization: Bearer access_token" "https://your_server_url/scr/api/ActivityDocumentation?processId=80012&activityId=5f500e10928f0" - Utilizando credenciales de cliente OAuth 2 de ID de servicio:
curl -i -H "Authorization: Bearer access_token" "https://your_server_url/scr/api/ActivityDocumentation?processId=80012&activityId=5f500e10928f0" - Utilizando las credenciales de cliente OAuth 2 con el contexto de usuario:
curl -i -H "Authorization: Bearer access_token" "X-On-Behalf-Of:user_name@domain.com" "https://your_server_url/scr/api/ActivityDocumentation?processId=80012&activityId=5f500e10928f0"
- Utilizando credenciales de cliente OAuth 2 de ID de servicio de usuario:
- Resultado de ejemplo
{ "activityId":"5f500e10928f0", "description":"<b><i><u>ActivityDocumentation API test<\/u><\/i><\/b>" }
- Propiedades de respuesta
- activityId
- ID de la actividad solicitada.
- description
- La documentación de la actividad que contiene marcación HTML especificada por el usuario. Esta propiedad no está presente si no hay documentación.
- Mensajes de respuesta
Código HTTP Razón 200 La solicitud se ha completado correctamente.
400 Se ha producido un error al procesar la solicitud. Faltaban algunos parámetros obligatorios o contenían valores no válidos.
401 El usuario no está autorizado a realizar la petición.
403 El usuario no tiene acceso al proceso. El proceso requiere al menos acceso de participante.