Project REST API
Published: 2024-05-15
Resource Name
/project
GET
Returns information about a specific project
Request
Path parameters
proj Required
string
The Project ID
Example:
endpoint/mdcms/project?proj=DEMO044
Response
Body parameters
See POST method
Example:
{ "proj": "DEMO044", "prjt": "ONLYTASKS", "agp": "TEST", "agrp": "", "ausr": "", "pri": "3", "edat": "20170430", "sts": "1", "dsc": "Demo project 44", "requester": "REN", "requestDate": "20170320", "requestTime": "115201", "closer": "", "closeDate": "0", "closeTime": "0", "hrse": "11.00", "cste": "1999.99", "hrsa": "10.00", "csta": "1300.00" }
POST
Create or update a Project in MDCMS.
When for update, parameters only need to be included in the body if a new value should be set for the parameter. For any parameters that aren't included, the existing value remains in place.
Request
Path parameters
none
Body parameters
proj Required
string
The Project ID. If the ID already exists in MDCMS, then an update will be performed, otherwise the Project will be added to MDCMS.
prjt
string
A valid Project Type to apply to the project. If not included for a new Project, the default type will be used.
agp
string
An optional application code to apply to the project
agrp
string
The User Group to assign the Project to
ausr
string
A specific user to assign the Project to
pri
integer
The priority of the Project. If not included for a new Project, the priority will be set to 3=Medium.
1 - Critical 2 - High 3 - Medium 4 - Low 5 - Optional
sts
string
The Status of the Project. If not included for a new Project, the status will be set to 1=Open
dsc Required when new
string
A brief description or title for the Project
hrse
decimal
The number of hours expected to complete the project
cste
decimal
The expected cost to complete the project
musr
string
The user to register as the creator or modifier of the project
edsc
string
The extended description of the Project
Example:
{ "proj": "RESTPROJ3", "agp": "TEST", "prjt": "onlytasks", "ausr": "mmorgan", "pri": "2", "musr": "mmorgan", "edat": "20190415", "dsc": "Project created via REST API", "hrse": "40.56789", "cste": "4567.89", "edsc": "this used mdwsproj to invoke program mdupdproj für Erzeugung von Überall" }
Response
Body parameters
The response provides a rtn structure with the following parameters:
sev
string
The message severity
10 - processed without errors or warnings 20 - processed, but warnings occurred 30 - did not process successfully due to errors
msg
string
The message text
Example: