Project

  • 19.3.8
This article is up to date with the latest stable release of M4.

Description

The Project endpoint provides the API consumer with access to methods pertaining to projects and related data objects. The endpoint allows consumers to create a project from a ticket and find details about a project.

Methods

URL base/Workforce/Project/Specification
Action GET
Description Returns a data dictionary that details the available web service methods related to Projects.
Parameters None
 Returns  A JSON object with method descriptions
Sample Return Object 
[
  {
    "HttpAction": "Post",
    "MethodName": "AddProject",
    "Description": "Creates a new Project based on the TicketID passed in.",
    "Format": {
       "CreateUserID": 123, 
       "ProjectNumber": "SO-12345_Master", 
       "TicketID": 321 
    }
  }
]
URL base/Workforce/Project/AddProject
Action POST
Description Adds the specified Project object and returns the newly added Project object.
Parameters
Name Required? Type Description
CreateUserID No Integer The ID of the User creating this project
ProjectNumber No String The name of the Project.
TicketID Yes Integer The ID of the Ticket attached to the project.
Sample JSON Package 
{
    "CreateUserID": 123,
    "ProjectNumber": "SO-12345_Master",
    "TicketID": 321
}
Returns A JSON Project data object
Sample Return Object 
{
    "ID": 103,
    "ProjectID": 789,
    "ProjectNumber": "SO-12345_Master",
    "ProjectDescription": "My description",
    "HeadProjectTaskID": 123, 
    "IsActive": true, 
    "CreateUserID": 1, 
    "MasterUserID": 1, 
    "CreateDateTime": "2019-01-01 00:01:00", 
    "IsTicketGroupProject": true, 
    "TemplateID": 1, 
}
Business Rules
Any violations of these business rules result in an appropriate error message being returned to the API consumer.
  • TicketID: must exist in Ticket.ID
URL base/Workforce/Project/GetProject/ID
Action GET
Description Returns a Project object when given an ID of a valid project in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of a project in the M4 database.
Returns A JSON Contact data object
Sample Return Object
{
    "ID": 2992728,
    "ProjectID": 2992728,
    "ProjectNumber": "OrderFulfilmentPlanning-2992727 [master]",
    "ProjectDescription": "OrderFulfilmentPlanning-2992727",
    "HeadProjectTaskID": 981539,
    "IsActive": true,
    "CreaterUserID": null,
    "MasterUserID": null,
    "CreateDateTime": "2022-12-08T15:53:35.137",
    "IsTicketGroupProject": false,
    "TemplateID": 1001
}
URL base/Workforce/Project/GetProjectsByTicket/ID
Action GET
Description Returns a list of Project objects when given a Ticket ID of a valid ticket in the M4 database. The Ticket is a task of each of the projects returned.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing a Ticket ID in the M4 database.
Returns A JSON Contact data object
Sample Return Object
[
    {
        "ID": 2992728,
        "ProjectID": 2992728,
        "ProjectNumber": "OrderFulfilmentPlanning-2992727 [master]",
        "ProjectDescription": "OrderFulfilmentPlanning-2992727",
        "HeadProjectTaskID": 981539,
        "IsActive": true,
        "CreaterUserID": null,
        "MasterUserID": null,
        "CreateDateTime": "2022-12-08T15:53:35.137",
        "IsTicketGroupProject": false,
        "TemplateID": 1001
    }
]
URL base/Workforce/Project/GetProjectsByTicket/ID
Action GET
Description Returns a list of Task objects when given a Project ID of a valid Project in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing a Project ID in the M4 database.
Returns A JSON Contact data object
Sample Return Object
[
    {
        "ID": 981545,
        "MasterID": 981541,
        "PT_ProjectID": 2992728,
        "DisplayOrder": 3,
        "DependencyOrder": 3,
        "SubProjectNumber": null,
        "MasterTicketCodeID": 1032,
        "ChildTicketCodeID": 1034,
        "MasterDependentOn": false,
        "ChildClearOnMaster": false,
        "SiblingClearCreate": false,
        "DependentOnPrevSibling": true,
        "OrderString": "(1.3)",
        "TicketID": null,
        "ApptID": null,
        "WorkOrdersID": null
    },
    {
        "ID": 981540,
        "MasterID": 981539,
        "PT_ProjectID": 2992728,
        "DisplayOrder": 1,
        "DependencyOrder": 1,
        "SubProjectNumber": null,
        "MasterTicketCodeID": 1038,
        "ChildTicketCodeID": 1031,
        "MasterDependentOn": false,
        "ChildClearOnMaster": false,
        "SiblingClearCreate": false,
        "DependentOnPrevSibling": true,
        "OrderString": "(1)",
        "TicketID": 2992727,
        "ApptID": 3639719,
        "WorkOrdersID": null
    },
    {
        "ID": 981539,
        "MasterID": 981539,
        "PT_ProjectID": 2992728,
        "DisplayOrder": 0,
        "DependencyOrder": 0,
        "SubProjectNumber": "wf_TicketType_OrderFulfilmentPlanning-2992727 [master]",
        "MasterTicketCodeID": 1038,
        "ChildTicketCodeID": 1038,
        "MasterDependentOn": false,
        "ChildClearOnMaster": false,
        "SiblingClearCreate": false,
        "DependentOnPrevSibling": false,
        "OrderString": null,
        "TicketID": 2992728,
        "ApptID": 3639718,
        "WorkOrdersID": null
    },
    {
        "ID": 981541,
        "MasterID": 981539,
        "PT_ProjectID": 2992728,
        "DisplayOrder": 2,
        "DependencyOrder": 1,
        "SubProjectNumber": null,
        "MasterTicketCodeID": 1031,
        "ChildTicketCodeID": 1032,
        "MasterDependentOn": false,
        "ChildClearOnMaster": false,
        "SiblingClearCreate": false,
        "DependentOnPrevSibling": false,
        "OrderString": "(1)",
        "TicketID": 2992729,
        "ApptID": 3639720,
        "WorkOrdersID": null
    },
    {
        "ID": 981542,
        "MasterID": 981539,
        "PT_ProjectID": 2992728,
        "DisplayOrder": 3,
        "DependencyOrder": 1,
        "SubProjectNumber": null,
        "MasterTicketCodeID": 1032,
        "ChildTicketCodeID": 1033,
        "MasterDependentOn": false,
        "ChildClearOnMaster": false,
        "SiblingClearCreate": false,
        "DependentOnPrevSibling": false,
        "OrderString": "(1)",
        "TicketID": 2992730,
        "ApptID": 3639721,
        "WorkOrdersID": null
    },
    {
        "ID": 981543,
        "MasterID": 981541,
        "PT_ProjectID": 2992728,
        "DisplayOrder": 1,
        "DependencyOrder": 1,
        "SubProjectNumber": null,
        "MasterTicketCodeID": 1032,
        "ChildTicketCodeID": 1035,
        "MasterDependentOn": false,
        "ChildClearOnMaster": false,
        "SiblingClearCreate": false,
        "DependentOnPrevSibling": true,
        "OrderString": "(1.1)",
        "TicketID": 2992731,
        "ApptID": 3639722,
        "WorkOrdersID": null
    },
    {
        "ID": 981544,
        "MasterID": 981541,
        "PT_ProjectID": 2992728,
        "DisplayOrder": 2,
        "DependencyOrder": 2,
        "SubProjectNumber": null,
        "MasterTicketCodeID": 1032,
        "ChildTicketCodeID": 1034,
        "MasterDependentOn": false,
        "ChildClearOnMaster": false,
        "SiblingClearCreate": false,
        "DependentOnPrevSibling": true,
        "OrderString": "(1.2)",
        "TicketID": 2992732,
        "ApptID": 3639723,
        "WorkOrdersID": null
    }
]

Was this article helpful?

Yes No

Related Articles