API de gestión de proyectos de TI

Este artículo describe las API de REST disponibles en el módulo de gestión de proyectos de TI (ITPM). Los desarrolladores de integración pueden utilizar estas API para integrar ServiceAide Cloud Service Management con aplicaciones externas.

Se utilizan las API para ejecutar las siguientes acciones en Cloud Service Management mediante una aplicación externa:

Consultar el módulo de gestión de proyectos de TI para obtener una lista de proyectos y tareas que están relacionados con un proyecto específico.
Marcar los proyectos como favoritos.
Crear un proyecto y tareas dentro de ese proyecto desde un sistema externo.
Actualizar las propiedades del proyecto y agregar a los miembros del equipo.
Actualizar tareas del proyecto para asignar propietarios, cerrar la tarea, y modificar las estimaciones y el tiempo invertido.
Bloquear o desbloquear las tareas.
Eliminar proyectos o tareas dentro de un proyecto.
Crear y modificar carriles en el tablero de tareas.

Cada API tiene la siguiente estructura:

URL: la dirección URL de la aplicación específica para el segmento.
Encabezado: los identificadores básicos para el segmento y el usuario conectado.
Carga: el script para ejecutar una acción.
Puede sustituir las variables de este script por los valores reales durante la ejecución de la API. Para algunas API no se requiere una carga. Los valores se pueden enviar directamente en el campo URL de dicha API.

Nota: Todos los valores de fecha son UTC en milisegundos.

El encabezado de cada llamada de la API requiere encabezados (obligatorios). La siguiente tabla describe los encabezados obligatorios y los valores correspondientes:

Encabezado	Valor	Obligatorio para
Cookie	Cloud Service válido Sesión de gestión	Todas las llamadas de la API
Content-type	application/json	POST, PUT
Accept	application/json	POST.PUT, DELETE, GET

El módulo ITPM incluye las siguientes API:

Las API del proyecto

Se pueden utilizar las siguientes API para ejecutar acciones en un proyecto. Al trabajar con un proyecto existente, incluya el ID del proyecto en la dirección URL tal y como se muestra a continuación:

http://<URL aplicación>/itpm/Project('project ID')

Get by Id

Recuperar un proyecto mediante el ID del proyecto.

URL

http://<URL aplicación>/itpm/Project('project ID')

Carga útil

N/D

Método

GET

Respuesta

N/D

Crear

Crear un proyecto.

URL

http://<URL aplicación>/itpm/Project

Carga útil

Code Block

{
 "projectName": "Project Name",
 "description": "Project Description",
 "startDate": 0,
 "endDate": 1,
 "plannedCost": 1000,
 "actualCost": 1000
}

Método

POST

Respuesta

N/D

Update

Actualizar un proyecto.

URL

http://<URL aplicación>/itpm/Project('project ID')

Carga útil

Code Block

{
 "projectName": "Project Name updated"
}

Método

POST

Respuesta

N/D

Deactivate

Desactivar un proyecto.

URL

http://<URL aplicación>/itpm/Project('project ID')

Carga útil

N/D

Método

DELETE

Respuesta

N/D

Get All

Recuperar una lista de todos los proyectos de los que es propietario.

URL

http://<URL aplicación>/itpm/Project

Carga útil

N/D

Método

GET

Respuesta

N/D

Mark or Unmark as Favorite

Marcar un proyecto como favorito.

URL

http://<URL aplicación>/itpm/Project('project ID')

Carga útil

Code Block

{
 "favorite": true
}

Método

POST

Respuesta

N/D

Change Project Owner

Cambiar el propietario de un proyecto.

URL

http://<URL aplicación>/itpm/Project('project ID')/$links/ownedBy

Carga útil

Code Block

{
 "url": "/itpm/Contact(1)"
}

Método

PUT

Respuesta

N/D

Modificación de la organización de proyectos

N/D

Las API de adjudicación

Estas API se utilizan para asignar miembros a un proyecto.

Allocate User

Asignar un usuario a un proyecto.

URL

http://<URL aplicación>/itpm/Allocation?$expand=project, user

Carga útil

Code Block

{
 "project": {
 "__metadata": {
 "uri": "/itpm/Project('831ab858-4ae3-4a01-b151-5dba7b3a6445')",
 "type": "odata.Project"
 }
 },
 "user": {
 "__metadata": {
 "uri": "/itpm/User(1)",
 "type": "odata.User"
 }
 }
}

Método

POST

Respuesta

N/D

Deallocate User

Eliminar un usuario de la pertenencia a un proyecto.

URL

http://<URL aplicación>/itpm/Allocation('allocation ID')

Carga útil

N/D

Método

DELETE

Respuesta

N/D

Change Allocation

Eliminar o proporcionar los permisos de edición a un usuario.

URL

http://<URL aplicación>/itpm/Allocation('allocation ID')

Carga útil

Code Block

{
 "editPermission": true
}

Método

POST

Respuesta

N/D

Get Allocations

Recuperar la lista de los miembros de un proyecto.

URL

http://<URL aplicación>/itpm/Project('project ID')/allocations

Carga útil

N/D

Método

GET

Respuesta

N/D

Las API del carril

Estas API se utilizan para crear y modificar los carriles del tablero de tareas de un proyecto.

Add Lane

Crear un carril en el tablero de tareas.

URL

http://<URL aplicación>/itpm/Lane

Carga útil

Code Block

{
 "name": "name of the lane",
 "position": 1000,
 "project": {
 "__metadata": {
 "uri": "/itpm/Project('project ID')",
 "type": "odata.Project"
 }
 }
}

Método

POST

Respuesta

N/D

Update Lane

Modificar un carril del tablero de tareas.

URL

http://<URL aplicación>/itpm/Lane('project ID')

Carga útil

Code Block

{
 "name": "name of the lane"
}

Método

POST

Respuesta

N/D

Delete Lane

Eliminar un carril del tablero de tareas de un proyecto.

URL

http://<URL aplicación>/itpm/Lane('Lane ID')

Carga útil

N/D

Método

DELETE

Respuesta

N/D

Get Lanes

Recuperar la lista de todos los carriles del tablero de tareas de un proyecto.

URL

http://<URL aplicación>/itpm/Project('project ID')/lanes

Carga útil

N/D

Método

GET

Respuesta

N/D

Las API de la tarea

Estas API se utilizan para crear y modificar las tareas dentro de un proyecto.

Crear

Crear una tarea.

URL

http://<URL aplicación>/itpm/Task

Carga útil

Code Block

{
 "taskName": "name of the task",
 "position": 2232,
 "description": "test",
 "dueDate": 12,
 "priority": "CRITICAL",
 "lane": {
 "__metadata": {
 "uri": "/itpm/Lane('Lane ID') 
 "type": "odata.Lane"
 }
 },
 "taskType": "TASK"
}

Método

POST

Respuesta

N/D

Get All Tasks by Project

Recuperar todas las tareas de un proyecto.

URL

http://<URL aplicación>/itpm/Project('project ID')/tasks?$filter=

Carga útil

N/D

Método

GET

Respuesta

N/D

Get All Tasks by Lane

Recuperar todas las tareas de un carril concreto.

URL

http://<URL aplicación>/itpm/Lane('lane ID')/tasks

Carga útil

N/D

Método

GET

Respuesta

N/D

Delete Task

Eliminar una tarea del proyecto.

URL

http://<URL aplicación>/itpm/Task('task ID')

Carga útil

N/D

Método

DELETE

Respuesta

N/D

Update

Modificar una tarea.

URL

http://localhost:9000/itpm/Task('task ID')

Carga útil

Code Block

{
 "taskName": "task name",
 "position": 22,
 "description": "test",
 "dueDate": 12,
 "priority": "HIGH",
 "lane": {
 "__metadata": {
 "uri": "/itpm/Lane('5757f538-4cbe-44c3-96de-eba243467ad5')",
 "type": "odata.Lane"
 }
 }
}

Método

POST

Respuesta

N/D

API de la lista de comprobación de la tarea

Se pueden crear elementos de lista la de comprobación para una tarea.

Creación de una lista de comprobación

URL

http://<URL aplicación>/itpm/CheckListItem

Método

POST

Carga útil

 {
   "description":"Item 1 to be finished",
   "position":2232,
   "done":false,
   "task":{
      "__metadata":{
         "uri":"/itpm/Task('6e87bc52-0aad-4faa-b633-cec827858c04')",
         "type":"odata.Task"
      }
   }
}

Respuesta

N/D

Actualización de una lista de comprobación

URL

http://<URL aplicación>/itpm/CheckListItem('checklistItemId')

Método

POST

Carga útil

 {
   "description":"Item 1 to be finished updated",
   "position":2236,
   "done":true,
   "task":{
      "__metadata":{
         "uri":"/itpm/Task('6e87bc52-0aad-4faa-b633-cec827858c04')",
         "type":"odata.Task"
      }
   }
}

Respuesta

N/D

Cómo obtener todos los elementos de la lista de comprobación

URL

http://<URL aplicación>/itpm/Task('taskId')

Método

GET

Respuesta

N/D

Cómo obtener todos los elementos de la lista de comprobación completada de una tarea

URL

http://<URL aplicación>/itpm/Task('taskId')/checklistItems?$filter=done eq true

Método

GET

Respuesta

N/D

Supresión de una lista de comprobación

URL

http://<URL aplicación>/itpm/CheckListItem('checkListItemId')

Método

DELETE

Respuesta

N/D

Cómo suprimir todo

URL

http://<URL aplicación>/itpm/Task('taskId')/$links/checklistItems

Método

DELETE

Respuesta

N/D

API del ticket

Se pueden importar varios tickets.

URL

http://<URL aplicación>/ImportTickets?$expand=importResults/task/ticket

Método

POST

Carga útil

{
   "lane":{
      "__metadata":{
         "uri":"/itpm/Lane('872586ad-b903-466e-a498-dc5b73a4f91e')",
         "type":"odata.Lane"
      }
   },
   "ticketIds":[7,8,9]
}

Respuesta

N/D

API de autorización de inicio de sesión

La API siguiente le permite autenticar un usuario en la aplicación en función de un nombre de usuario y una contraseña.

URL

http:/<URL_contexto>/odata/login?$format=JSON

Método

POST

Encabezados

application/x-www-form-urlencoded

Parámetros del formulario

Nombre de usuario: <user_login>

Contraseña: <password>

Respuesta

La respuesta contiene los siguientes parámetros en formato JSON.

Estado
primary_org_logo_idb
external_slice
external_user_id
maintenance_notice

Nota: La respuesta también contiene la cookie " LOTUSSESSION="1389265934:080c19ee-e95c-4dce-bfda-09d2ff4dd87d:abb769cf-b153-4052-aa0c-b807434e3191:1945ad38cf8891e3cec4e9d6e33267b417a6c2cb"; Version=1; Path=/"