Task REST API
Published: 2024-05-15
Resource Name
/task
GET
Returns information about a specific task or subtask
Request
Path parameters
proj Required
string
The Project ID
task Required
integer
A Task Number within the Project
stsk Required
integer
A Subtask within the Task. Pass the value of 0 if retrieving information for the Task itself.
Example:
endpoint/mdcms/task?proj=MDSD&task=141&stsk=0
Response
Body parameters
See POST method
Example:
{ "proj": "MDSD", "task": "141", "stsk": "0", "tskt": "SD_ENHANCE", "sum": "Default Project and Task Types", "agp": "", "iref": "", "pri": "3", "sts": "7", "dued": "0", "duet": "0", "agrp": "", "ausr": "MMORGAN", "tstg": "", "tstu": "", "requester": "JIRA", "requestDate": "20190211", "requestTime": "191136", "closer": "JIRA", "closeDate": "20190416", "closeTime": "121142", "hrse": ".00", "cste": ".00", "hrsa": ".00", "csta": ".00" }
POST
Create or update a Task or Subtask 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 ID of an existing, open Project
task
integer
Specifies an existing Task number, or 0 if information is for a new Task Number. MDCMS will automatically generate the number for a new Task.
stsk
integer
Specifies an existing Subtask number. If 0: when nsts (new subtask) = *NO, then the API will process at the Task level when nsts (new subtask) = *YES, then the API will create a new Subtask
nsts
string
Specifies if the values should be saved to a new Subtask.
*NO If parameter task = 0, then a new task will be created. If task > 0 and stsk = 0, then the existing task will be updated. If task > 0 and stsk > 0, then the existing subtask will be updated.
*YES If parameter task = 0, then a new task will be created If parameter task > 0, then a new subtask for the task will be created
*REF If the value of iref is found in the database for the given project, then the referenced task or subtask will be updated. If parameter task = 0, and the value of IREF isn't found in the database for the given project, then a new task will be created. If parameter task > 0, and the value of IREF isn't found in the database for the given project, then a new subtask will be created for the task.
*NOREF If the value of IREF is found in the database for the given project, then the referenced task or subtask will be updated. If the value of IREF isn't found in the database for the given project, then nothing will occur.
tskt
string
A valid Task Type to apply to the Task. If not included for a new Task, the default type will be used.
sum Required when new
string
A brief description of the task
agp
string
An optional application code to apply to the task
iref
string
An optional internal reference code for the task
pri
integer
The priority of the Task. If not included for a new Task, the priority will be set to 3=Medium.
1 - Critical 2 - High 3 - Medium 4 - Low 5 - Optional
sts
string
The Status of the Task. If not included for a new Task, the status will be set to 1=Open
dued
integer
The Date when the Task or Subtask is expected to be completed. The format of the date is YYYYMMDD with Y=Year, M=Month and D=Day of Month.
duet
integer
The Time when the Task or Subtask is expected to be completed. The format of the time is HHMMSS with H=Hour, M=Minute and S=Second
agrp
string
The User Group to assign the task to
ausr
string
A specific user to assign the task to
tstg
string
The User Group responsible for testing the results of the task
tstu
string
A specific user responsible for testing the results of the task
hrse
decimal
The number of hours expected to complete the task
cste
decimal
The expected cost to complete the task
musr
string
The user to register as the creator or modifier of the task
edsc
string
The extended description of the task
Example:
{ "proj": "demopro", "task": "1", "stsk": "1", "tskt": "admin", "sum": "a subtask created directly from the rest api", "nsts": "*no", "agp": "TEST", "agrp": "pgmr 1", "pri": "2", "sts": "3", "musr": "mmorgan", "dued": "20190415", "duet": "110000", }
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: