Introduction

LegatoPPM API

REST

This API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model:

• /budgetClass
• /budgetClass/{id}
• /budgetClass/all
• /connect/{userName}/{password}
• /costCenter
• /costCenter/{id}
• /costCenter/all
• /customCategory
• /customCategory/{categoryId}
• /customCategory/all
• /customCategory/values/{categoryId}
• /department
• /department/{id}
• /department/all
• /disconnect/{sessionId}
• /project
• /project/{projectId}
• /project/{projectId}/category/{fullId}
• /project/{projectId}/category/{fullId}/{valueId}
• /project/name/{searchString}
• /project/portfolio/{portfolioId}
• /project/tracked
• /projectStatus
• /projectStatus/{id}
• /projectStatus/all
• /projectType
• /projectType/{id}
• /projectType/all
• /skillClass
• /skillClass/{id}
• /skillClass/all
• /task
• /task/{projectId}
• /task/{projectId}/{taskId}
• /task/ext/{projectId}
• /task/gantt/{projectId}
• /task/ganttdep/{projectId}
• /taskStatus
• /taskStatus/{id}
• /taskStatus/all
• /taskType
• /taskType/{id}
• /taskType/all
• /user
• /user/{userName}
• /user/allDisabledUserNames
• /user/allEnabledUsers
• /user/allUsers
• /user/managers
• /user/owners
• /user/requestors
• /user/roles/{userId}
• /user/roles/{userName}
• /user/sponsors
• /user/submittedtos
• /user/taskowners

There is also a WADL document describing the REST API.

SOAP

This API is exposed through a set of WSI Basic Profile -compliant SOAP v1.1 endpoints. The API supports XML-binary Optimized Pacakging (XOP) and SOAP Message Transmission Optimization Mechanism (MTOM) for transmission of binary data. The SOAP API is fully described by the following endpoints:

• LegatoBudgetClassServiceService
• LegatoCostCenterServiceService
• LegatoCustomCategoryServiceService
• LegatoDepartmentServiceService
• LegatoProjectServiceService
• LegatoProjectStatusServiceService
• LegatoProjectTypeServiceService
• LegatoSkillClassServiceService
• LegatoTaskServiceService
• LegatoTaskStatusServiceService
• LegatoTaskTypeServiceService
• LegatoUserServiceService

The SOAP API is also accessible by client-side libraries that can be downloaded from the download page.

Data

All endpoints act on a common set of data. The data can be represented in different data formats (i.e. MIME types), depending on the endpoint that consumes and/or produces the data. The data can described by XML Schema, which definitively describes the XML representation of the data, but is also useful for describing the other formats of the data, such as JSON.

This document will describe the data using terms based on XML Schema. Data can be grouped by namespace, with a schema document describing the elements and types of the namespace. Generally speaking, types define the structure of the data and elements are instances of a type. For example, elements are usually produced by (or consumed by) a REST endpoint, and the structure of each element is described by its type.

Data Schemas

XML Data Elements

• namespace ns0
  • role
  • userView
• namespace session
  • session

XML Data Types

• namespace ns0
  • budgetClass
  • capacity
  • categoryValue
  • costCenter
  • costResource
  • customCategory
  • customCategoryValue
  • department
  • extTask
  • ganttDependency
  • ganttTask
  • manHourResource
  • project
  • projectNode
  • projectStatus
  • projectType
  • role
  • skillClass
  • task
  • taskNode
  • taskStatus
  • taskType
  • userProfile
  • userSkillClass
  • userView
• namespace session
  • session